Configure the Socket JSON Output adapter by specifying values for the ESP connector, formatter, and transporter modules in the adapter configuration file. The Socket JSON Output adapter uses SimpleDateFormat formatting codes.
XML Element | Description |
---|---|
Log4jProperty |
Type: string (Optional) Specify a full path to the log4j.properties logging file you wish to use. The default value is STREAMING_HOME/adapters/framework/config/log4j.properties. |
XML Element | Description |
---|---|
Cipher |
Type: string (Optional) Specify a full path to the adapter.key encryption file you wish to use. The default value is $STREAMING_HOME/adapters/framework/adapter.key. |
The ESP Subscriber module obtains data from the SAP Event Stream Processor project and passes it along to a transporter or formatter module.
XML Element | Description |
---|---|
Module |
(Required) Element containing all information for this module. It contains a type attribute for specifying the module type. For example, espconnector. |
InstanceName |
Type: string (Required) Instance name of the specific module you want to use. For example, MyInputTransporter. |
Name |
Type: string (Required) Name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter. |
Next |
Type: string (Required) Instance name of the module that follows this one. |
BufferMaxSize |
Type: integer (Advanced) Capacity of the buffer queue between this module and the next. The default value is 10240. |
Parameters |
(Required) Element containing the EspSubscriberParameters element. |
EspSubscriberParameters |
(Required) Element containing elements 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, StreamingProject2. This is the same project tag that you specify later in the adapter configuration file in the Name element within the Event Stream Processor (EspProjects) element. 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 element 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 te 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 element as the adapter automatically detects the stream name. |
OutputBase |
Type: boolean (Optional) If set to true, the adapter outputs the initial stream contents in addition to stream updates. If this option is enabled and the adapter is running in GD mode, once the adapter has done a GD commit on the entire base data, the ESP Server does not redeliver the base data on adapter restart and only sends deltas that are saved for delivery. The default value is false. |
OnlyBase |
Type: boolean (Advanced) Sends a one-time snapshot of initial contents in a stream. Default value is false. If set to true, OutputBase automatically becomes true. |
The ESP to JSON Stream formatter translates AepRecord objects to JSON strings, and sends the JSON strings to next streaming output transporter that is configured in the adapter configuration file.
XML Element | Description |
---|---|
Module |
(Required) Element containing all information for this module. It contains a type attribute for specifying the module type. For example, formatter. |
InstanceName |
Type: string (Required) Instance name of the specific module you want to use. For example, MyInputTransporter. |
Name |
Type: string (Required) Name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter. |
Next |
Type: string (Required) Instance name of the module that follows this one. |
BufferMaxSize |
Type: integer (Advanced) Capacity of the buffer queue between this module and the next. The default value is 10240. |
Parameters |
(Required) Element containing the EsptoJsonStreamFormatterParameters element. |
EsptoJsonStreamFormatterParameters |
(Required) Element containing the ESP to JSON Stream formatter elements. |
ColsMapping |
Type: complextype (Required) Specify JSONPath expressions for the JSON data that you want to map to columns of the a stream. You can have multiple Column elements. For example, if you had the following JSON data about a
person,
{ "firstName": "John", "lastName": "Smith", "phoneNumbers": [ { "type": "home", "number": "212 555-1234" }, { "type": "fax", "number": "646 555-4567" } ], "friends": [ ["female1","female2","female3"], ["male1","male2","male3"] ] } The first <Column/> element and its value are mapped to the first column of a stream, the second <Column/> element and its value are mapped to the second column of a stream, and so on. |
SecondDateFormat |
Type: string (Advanced) The format string for SecondDate values. For example, yyyy-MM-dd'T'HH:mm:ss is the default value. |
MsDateFormat |
Type: string (Advanced) The format string for MsDate values. For example, yyyy-MM-dd'T'HH:mm:ss.SSS is the default value. |
The Socket Output transporter obtains data from the previous module configured in the adapter configuration file, and outputs it using the socket interface.
XML Element | Description |
---|---|
Module |
(Required) Element containing all information for this module. It contains a type attribute for specifying the module type. For example, transporter. |
InstanceName |
Type: string (Required) Instance name of the specific module you want to use. For example, MyInputTransporter. |
Name |
Type: string (Required) Name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter. |
BufferMaxSize |
Type: integer (Advanced) Capacity of the buffer queue between this module and the next. The default value is 10240. |
Parameters |
(Required) Element containing the SocketOutTransporterParameters element. |
SocketOutputTransporterParameters |
(Required) Element containing the Socket Output transporter elements. |
Host |
Type: string (Required if EpFile is set to null) Specify the socket server name. 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 element. 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. If sandboxing is enabled, this file must reside in the <sandbox-base-directory>/adapters/<workspace-name> or $STREAMING_HOME/adapters/framework directory or one of their subdirectories. If the file is in a different location, the adapter will not be able to successfully connect to Event Stream Processor. Specify only host and port information, on separate lines, in this
file. For example, the syntax
is
host=hostName port=portNumber No default value. |
Retryperiod |
Type: integer (Advanced) Designates the time period for attempting to reestablish 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. |
SAP Event Stream Processor elements configure communication between Event Stream Processor and the Socket JSON Output adapter.
XML Element | Description |
---|---|
EspProjects |
(Required) Element containing elements for connecting to Event Stream Processor. |
EspProject |
(Required) Element containing the Name and Uri elements. 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 ESP project. For example, if you have SSL enabled, use esps://localhost:19011/ws1/p1. |
Security |
(Required) Element containing all the authentication elements 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 AuthType). Includes an "encrypted" attribute indicating whether the Password value is encrypted. The default value is false. If set to true, the password value is decrypted using RSAKeyStore and RSAKeyStorePassword. |
AuthType |
Type: string (Required) Method used to authenticate to 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 the 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. |