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.
Minimal YAML configuration file
Connector
Several connector settings can be configured in theconnector 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 theautomation 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 setsimulator-executable-path, the connector starts and terminates the simulator processes, which reduces orphaned processes and licenses being held after runs complete.
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.