External Adapter Properties
See $STREAMING_HOME/lib/adapters/simple_ext.cnxml.template for a sample cnxml file that you can copy and customize. It includes all possible internal parameters, along with comment blocks that include usage notes for each parameter.
| 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 parameter is set to true, the actual command is executed as cmd -f <value of x_paramFile>. |
| x_initialOnly | boolean | If true, performs only initial loading. Set to false for continuous loading. Initial loading is useful for adapters that start, load some static data and then finish; therefore, allowing another adapter group to startup in a staged loading scenario. |
| x_killRetryPeriod | integer | If this parameter is greater than 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 the parameter is 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 to specify 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 that preprocess (for example, parsing and checking parameters) the parameter file before the adapter starts. such as parsing and checking parameters. This command might convert the parameters to real format (by reading, parsing, and rewriting the parameter file), which is required by the execution command. If the configure command fails (non-zero return), the adapter fails to start. |
| x_unixCmdDisc/x_winCmdDisc | string | Specifies the command that performs discovery. This command adds the -o "<temporary disc filename>" argument, which writes the discovery XML to a file, before it executes. |
| x_unixCmdExec/x_winCmdExec | string | Specifies the command that starts the adapter. When the command returns, it indicates that the adapter is done running. |
| x_unixCmdStop/x_winCmdStop | string | Specifies the command that stops 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. |
Note Some of the commands have both Windows or Unix formats because their paths,
environment variables, and script files differ. At runtime,
SAP Event Stream Processor determines which command to use based on
the operating system it is running on. All commands have substituted parameters
and environment variables. When a command is passed to shell or
cmd.exe, it runs its own round of substitution.