> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cognite.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuration settings

> Learn how to configure the PROSPER connector with YAML parameters for automation and OpenServer connection settings.

### Minimal YAML configuration file

```yaml theme={"languages":{"custom":["/_languages/kuiper.json","../_languages/kuiper.json"]}}
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_PROSPER_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.terminate-process**                 | Set to terminate the PROSPER and OpenServer process at the end of usage (model revision validation / simulation run)                                                                                                         |
| **automation.license-hold-time**                 | Time in seconds to hold the license for after an action (model revision validation / simulation run).                                                                                                                        |
| **automation.simulator-retries**                 | Set the simulator connection retries.                                                                                                                                                                                        |
| **automation.simulator-retries.max-tries**       | Maximum amount of times to retry a connection failure to the simulator.                                                                                                                                                      |
| **automation.simulator-retries.max-delay**       | Maximum delay before each retry attempt to the simulator. For example, "10s" , "1m".                                                                                                                                         |
| **automation.open-server-async-command-timeout** | Maximum number of seconds to wait before timing out a "DoCommand" operation. For example,  "600s".                                                                                                                           |
| **automation.simulator-executable-path**         | Path to the PROSPER executable. When set, the connector manages the simulator process lifecycle directly. Use official PETEX binaries because the connector verifies the executable's digital signature before launching it. |

## Recommended configuration for simulation stability

For stable runs, let the connector manage the simulator process lifecycle. When you set `simulator-executable-path`, the connector starts and terminates the simulator processes, which reduces orphaned processes and licenses being held after runs complete.

```yaml theme={"languages":{"custom":["/_languages/kuiper.json","../_languages/kuiper.json"]}}
connector:
  automation:
    simulator-executable-path: "C:\\Program Files\\Petroleum Experts\\IPM 12\\prosper.exe"
    license-hold-time: 120
    terminate-process: true
```

<Info>
  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.
</Info>