Configuring the Studio Connection to the Provisioning Service

In order for users to be able to create data sets using by uploading files or using the Data Source Library, you must first configure the connection to the Provisioning Service.

If the connection configuration is not valid, then when users create an application, the file upload and Data Source Library options are not displayed. Users also cannot create available data sources in the Data Source Library.

The connection is configured using a JSON string. The general connection settings are:

Setting Description
server The name of the server on which the Provisioning Service is running.
port The port on which the Provisioning Service is listening.

For example:

{
"server": "ps.us.acme.com",
"port": "7004"
}

If the Provisioning Service is installed on a context path other than endeca-server, then you need to add a setting to provide the context path:

Setting Description
contextPath The context path for the Provisioning Service.

If this setting is not present, then the context path defaults to eid-ps, which is the Provisioning Service's default context path.

To specify a root context, set the value to either "" or "/".

For example:

{
"server": "ps.us.acme.com",
"port": "7004",
"contextPath": "my-ps-path"
}

By default, the Provisioning Service has SSL enabled, and the configuration must include the sslConfig setting, which contains the following settings:

Setting Description
caFile The name of the truststore file for the SSL connection to the Provisioning Service.

This is the truststore file from the secured Endeca Server configuration. For the default configuration, the file is endcaServerTrustStore.ks.

caPassword The password for the truststore file for the SSL connection to the Provisioning Service.

This is the password generated during the Endeca Server installation.

Note that once you save the Provisioning Service configuration, the value of caPassword is masked as ************. The value also is encrypted in the Studio database.

When you edit the Provisioning Service connection, you must re-type the actual password value before saving. Otherwise, Studio uses the masking asterisks as the password value.

certFile The name of the keystore file for the SSL connection to the Provisioning Service.

This is the keystore file from the secured Endeca Server configuration. For the default configuration, the file is endecaServerClientCert.ks.

certPassword The password for the keystore file for the SSL connection to the Provisioning Service.

This is the password generated during the Endeca Server installation.

Note that once you save the Provisioning Service configuration, the value of certPassword is masked as ************. The value also is encrypted in the Studio database.

When you edit the Provisioning Service connection, you must re-type the actual password value before saving. Otherwise, Studio uses the masking asterisks as the password value.

For example:
{
"server": "ps.us.acme.com",
"port": "7004",
"contextPath": "my-ps-path",
"sslConfig": {
        "caFile":"endecaServerTrustStore.ks",
        "caPassword":"************",
        "certFile":"endecaServerClientCert.ks",
        "certPassword":"************"
    }
}

The Control Panel includes a Provisioning Service page you use to configure the connection.

To configure the Provisioning Service connection:

  1. From the administrator menu, select Control Panel.
  2. In the Control Panel menu, click Provisioning Service.
  3. On the Provisioning Service page, update the placeholder configuration with the connection information for the Provisioning Service.
  4. Click Save.