See $ESP_HOME/lib/adapters/simple_ext.cnxml.template for a sample cnxml file that may be copied and customized. It has all possible internal parameters embedded in it, and has comment blocks indicating their usage.
| Property Id | Type | Description |
|---|---|---|
| x_addParamFile | boolean | Determines if the parameter file name is automatically appended to all x_cmd* strings. For example, if you specify the command as cmd -f, and this is set to true, the actual command is executed as cmd -f <value of x_paramFile>. |
| x_initialOnly | boolean | If true, does initial loading only. Set to false for continuous loading. Initial loading is useful for adapters that start, load some static data, then finish, which allows another adapter group to start-up in a staged loading scenario. |
| x_killRetryPeriod | integer | If this parameter is >0 the x_{unix,win}CmdStop command is retried every x_killRetry seconds, until the framework detects that the x_{unix,win}CmdExec command has returned. If it is equal to zero, run the x_{unix,win}CmdStop command once and assume it has stopped the x_{unix,win}CmdExec command. |
| x_paramFile | string | Specifies the file name of the
adapter framework, which writes all internal and user-defined
parameters. It may use other internal parameters in specifying
the file name. For
example:/tmp/mymodel.$platformStream. $platformConnection.$platformCommandPort.cfg |
| x_paramFormat | string | Stops the adapter, and runs in a separate thread, which returns and stops processes created with x_{unix,win}CmdExec. |
| x_unixCmdClean/x_winCmdClean | string | Specifies the command executed to perform cleanup after the adapter stops (x_{unix,win}CmdExec returns). |
| x_unixCmdConfig/x_winCmdConfig | string | Specifies the command executed to pre-process the parameter file prior to starting the adapter, such as parsing and checking parameters. It may convert the parameters to real format, which is required by the execution command, by reading, parsing, and re-writing the parameter file. If the configure command fails (non-zero return), the adapter fails to start. |
| x_unixCmdDisc/x_winCmdDisc | string | Specifies the command executed to perform discovery. This command adds -o "<temporary disc filename>" argument before it is executed, which writes the discovery XML to a file. |
| x_unixCmdExec/x_winCmdExec | string | Specifies the command executed to start the adapter. If the command returns, the adapter is done running. |
| x_unixCmdStop/x_winCmdStop | string | Specifies the command executed to stop the adapter. The stop command runs from a separate thread and stops all processes created with the x_{unix,win}CmdExec command, which returns the x_{unix,win}CmdExec command. |