Configuration settings

Beta

The features described in this section are currently in beta testing and are subject to change.

To configure the GAP connector, you must create a configuration file with the parameters listed below and the common connector configuration parameters. The file must be in YAML format.

Minimal YAML configuration file

Use the minimal configuration file as a starting point for your configuration settings.

version: 1

cognite:
    # The project to connect to in the API, uses the environment variable COGNITE_PROJECT.
    project: ${COGNITE_PROJECT

    # The API host to connect to example: https://api.cognitedata.com
    host: ${COGNITE_HOST}

    # This is for Microsoft as IdP, to use a different provider,
    # set implementation: Basic, and use token-url instead of tenant.
    # See the example config for the full list of options.
    idp-authentication:
        # Directory tenant
        tenant: ${COGNITE_TENANT_ID}
        # Application Id
        client-id: ${COGNITE_CLIENT_ID}
        # Client secret
        secret: ${COGNITE_CLIENT_SECRET}
        # List of resource scopes, ex:
        # scopes:
        #   - scopeA
        #   - scopeB
        scopes:
          - ${COGNITE_SCOPE}

connector:
  # Enter the data set ID to read the model files and simulator routines from.
  # Result inputs and outputs will be written to this data set. (required)
  data-set-id: ${COGNITE_GAP_DATASET}

Connector

Several connector settings can be configured in the connector section of the configuration file. The only required parameter is connector.data-set-id.

Parameter	Description
connector.data-set-id	Enter the data set ID to read the simulation resources from. Result inputs and outputs will be written to this data set.

Automation

This section includes the parameters for configuring the PETEX OpenServer connection. This is configured in the automation section of the configuration file.

Parameter	Description
automation.num-retries	If any calculation failed because of unavailable licenses, retry the calculation this amount of times.
automation.retry-delay	Set the delay in seconds between consecutive tries to connect to PETEX OpenServer.