Configure the Socket JSON Output adapter by specifying values for the ESP connector, formatter, and transporter modules in the adapter configuration file.
| Parameter | Description |
|---|---|
| Log4jProperty |
Type: string (Optional) Specify the path to the log4j.properties logging file you wish to use. The default value is $ESP_HOME/adapters/framework/config/log4j.properties. |
| Parameter | Description |
|---|---|
| Module |
(Required) Section containing all information for this module. It contains a type attribute for specifying the module type. For example, espconnector. |
| InstanceName |
Type: string (Required) Specify the instance name of the specific module you wish to use. For example, MyInputTransporter. |
| Name |
Type: string (Required) The name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter. |
| Next |
Type: string (Required) Specify the instance name of the module that follows this one. |
| Parameters |
Section containing the EspSubscriberParameters parameter. |
| EspSubscriberParameters |
(Required) Section containing parameters for the ESP subscriber. |
| ProjectName |
Type: string (Required if running adapter in standalone mode; optional if running in managed mode) Specifies the unique project tag of the ESP project to which the adapter is connected. For example, EspProject2. This is the same project tag that you specify later in the adapter configuration file in the Name parameter of the Event Stream Processor (EspProjects) parameters section. If you are starting the adapter with the ESP project to which it is attached (running the adapter in managed mode), you do not need to set this property as the adapter automatically detects the project name. |
| StreamName |
Type: string (Required if running adapter in standalone mode; optional if running in managed mode) Name of the ESP stream from which the adapter subscribes to data. If you are starting the adapter with the ESP project to which it is attached (running the adapter in managed mode), you do not need to set this property as the adapter automatically detects the stream name. |
| Parameter | Description |
|---|---|
| Module |
(Required) Section containing all information for this module. It contains a type attribute for specifying the module type. For example, formatter. |
| InstanceName |
Type: string (Required) Specify the instance name of the specific module you wish to use. For example, MyInputTransporter. |
| Name |
Type: string (Required) The name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter. |
| Next |
Type: string (Required) Specify the instance name of the module that follows this one. |
| Parameters |
(Required) Section containing the EsptoJsonStreamFormatterParameters parameter. |
| EsptoJsonStreamFormatterParameters |
(Required) Section containing the ESP to JSON Stream formatter parameters. |
| ColsMapping |
Type: complextype (Required) Specify which columns of an ESP row you wish to map to JSON data. These values are matched by a pattern path expression. For example, [<Column>JSONPath expression</Column>]+. The first <Column/> is mapped to the first column of an ESP row, the second <Column/> is mapped to the second column of an ESP row, and so on. |
| DateFormat |
Type: string (Advanced) The format string for date values. For example, yyyy-MM-dd'T'HH:mm:ss. |
| TimestampFormat |
Type: string (Advanced) Format string for timestamp values. For example, yyyy-MM-dd'T'HH:mm:ss.SSS. |
| Parameter | Description |
|---|---|
| Module |
(Required) Section containing all information for this module. It contains a type attribute for specifying the module type. For example, transporter. |
| InstanceName |
Type: string (Required) Specify the instance name of the specific module you wish to use. For example, MyInputTransporter. |
| Name |
Type: string (Required) The name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter. |
| Parameters |
(Required) Section containing the SocketOutTransporterParameters parameter. |
| SocketOutputTransporterParameters |
(Required) Section containing the Socket Output transporter parameters. |
| Host |
Type: string (Required if EpFile is set to null) If the transporter is acting as a socket client, specify the socket server name. If the transporter is acting as a socket server, do not set this parameter. No default value. |
| Port |
Type: integer (Required if EpFile is set to null) Specify the socket server port. If you set this to -1, the adapter reads from the ephemeral port file which is specified in the EpFile parameter. The default value is 12345. |
| EpFile |
Type: string (Required if Host and Port are set to null) Specify the file that contains the socket server name/IP and port number. No default value. |
| Retryperiod |
Type: integer (Advanced) When the transporter is acting as a socket server, this parameter designates the length of time to wait for the first incoming connection before switching to the continuous state. When the transporter is acting as a socket client, this parameter designates the time period for attempting to re-establish an outgoing connection, in seconds. The default value is 0. |
| KeepAlive |
Type: boolean (Advanced) If set to true, the adapter disconnects from the socket server if there are no data transports for the duration of time specified in your router configuration. For example, if you set your router configuration to two hours and there are no messages during that time, the adapter disconnects from the socket server. The default value is false. |
Event Stream Processor parameters configure communication between Event Stream Processor and the Socket JSON Output adapter.
| Parameter | Description |
|---|---|
| EspProjects |
Section containing parameters for connecting to Event Stream Processor. |
| EspProject |
Section containing the Name and Uri parameters. Specifies information for the ESP project to which the adapter is connected. |
| Name |
Type: string (Required) Specifies the unique project tag of the ESP project which the espconnector (publisher/subscriber) module references. |
| Uri |
Type: string (Required) Specifies the total project URI to connect to the Event Stream Processor cluster. For example, esp://localhost:19011/ws1/p1. |
| Security |
Section containing all the authentication parameters below. Specifies details for the authentication method used for Event Stream Processor. |
| User |
Type: string (Required) Specifies the user name required to log in to Event Stream Processor (see AuthType). No default value. |
| Password |
Type: string (Required) Specifies the password required to log in to Event Stream Processor (see espAuthType). Includes an "encrypted" attribute indicating whether the Password value is encrypted. Default value is false. If set to true, the password value is decrypted using RSAKeyStore and RSAKeyStorePassword. |
| AuthType |
Type: string (Required) Specifies method used to authenticate to the
Event Stream Processor. Valid values are:
If the adapter is operated as a Studio plug-in, AuthType is overridden by the Authentication Mode Studio start-up parameter. |
| RSAKeyStore |
Type: string (Dependent required) Specifies the location of the RSA keystore, and decrypts the password value. Required if AuthType is set to server_rsa, or the encrypted attribute for Password is set to true, or both. |
| RSAKeyStorePassword |
Type:string (Dependent required) Specifies the keystore password, and decrypts the password value. Required if AuthType is set to server_rsa, or the encrypted attribute for Password is set to true, or both. |
| KerberosKDC |
Type: string (Dependent required) Specifies host name of Kerberos key distribution center. Required if AuthType is set to kerberos. |
| KerberosRealm |
Type: string (Dependent required) Specifies the Kerberos realm setting. Required if AuthType is set to kerberos. |
| KerberosService |
Type: string (Dependent required) Specifies the Kerberos principal name that identifies an Event Stream Processor cluster. Required if AuthType is set to kerberos. |
| KerberosTicketCache |
Type: string (Dependent required) Specifies the location of the Kerberos ticket cache file. Required if AuthType is set to kerberos. |
| EncryptionAlgorithm |
Type: string (Optional) Used when the encrypted attribute for Password is set to true. If left blank, RSA is used as default. |