The  supports multiple methods of configuration.

Do not make changes through multiple configuration interfaces at the same time. Saved changes can completely overwrite the platform configuration file, removing any unsaved changes from another method.

Admin Settings page

Through the Admin Settings page in the application, platform administrators can perform most configuration tasks. 

NOTE: The Admin Settings page is the recommended method for applying configuration changes to the . Entries are validated against known types, and the platform is automatically restarted when you save your changes.

Minimum requirements

To use the Admin Settings page, please verify that the following have been completed:

  1. Install and initialize the databases. See Install Databases.
  2. Install or upgrade the  on the node. See Install.
  3. Start the platform. See .Start and Stop the Platform.
  4. See below for access.

Access

  1. Login to the application as an administrator.
  2. Select Settings menu > Admin Settings.
  3. Perform your configuration tasks as needed.

In the documentation, JSON configuration items that are available through this page are described using dot notation, as in the following example:

"webapp.bodyParser.json.limit": "10mb",

Tip: In the Admin Settings page, you can paste the property name without quotes into the search box: webapp.bodyParser.json.limit

Limitations

The Admin Settings page is not useful for the following configuration scenarios:

In the above scenarios, you should apply your changes through .

NOTE: When a change is saved through the Admin Settings page, the entire file is overwritten.

For more information, see Admin Settings Page.

Workspace Admin Page

In the Workspace Admin page, you can review a set of feature enablement and  settings that can be modified on a per-workspace basis.

Tip: Over time, more settings from the Admin Settings page and will be migrated to this page. For more information, see Changes to Configuration.

For more information, see Workspace Admin Page

On the , you can edit the configuration file directly if necessary. 

  1. Login to the  as an administrator. 
  2. Edit the following file: .
  3. Make changes as necessary. 
  4. In the documentation, configuration items may be listed in either JSON dot notation or in hierarchical JSON notation, as in the following:

    "webapp": {
      ...
      "timeoutMilliseconds": 2000,
      ...
     
    },

    NOTE: The ellipses in the configuration indicate that there are unlisted parameters in the actual configuration. Typically, you should search for the final parameter name.

    NOTE: In , all values in the spark.props section or hadoopConfig section must be quoted values, as these values are passed to services external to the platform.

  5. Save the file and restart the platform. See Start and Stop the Platform.

Database Configuration

Where possible, you should use the Admin Settings page for making configuration changes to the databases. See Admin Settings Page.

For more information, see Install Databases.