Skip to main content

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}

    # Configure the number of retry attempts for network requests to CDF.
    # The following configuration results in approximately 5 minutes of exponential backoff
    # before ultimately failing.
    cdf-retries: 
      max-retries: 12
      max-delay: 60000 

    # 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.

ParameterDescription
connector.data-set-idEnter 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.

ParameterDescription
automation.terminate-processSet to terminate the GAP and OpenServer process at the end of usage (model revision validation / simulation run).
automation.license-hold-timeTime in seconds to hold the license for after an action (model revision validation / simulation run).
automation.simulator-retriesSet the simulator connection retries.
automation.simulator-retries.max-triesMaximum amount of times to retry a connection failure to the simulator.
automation.simulator-retries.max-delayMaximum delay before each retry attempt to the simulator. For example, "10s" , "1m".
Note

By default, the connector only obtains a license when needed. However, if the license hold time is set to a period more than 60s, the connector retains the license for the specified period after the last simulation run or model revision validation. This improves throughput for batched simulation runs by avoiding the overhead of repeatedly opening and closing the simulator.

Last updated