JMS Map Output Adapter Studio Properties
Adapter type: toolkit_jms_map_output. Configure the adapter properties using the SAP Event Stream Processor Studio. The JMS Map Output adapter uses SimpleDateFormat formatting codes.
| Property Label | Description |
|---|---|
| SecondDate Format | Property ID: mapSecondDateFormat Type: string (Advanced) Specify the format for parsing SecondDate values. For example, yyyy-MM-dd'T'HH:mm:ss is the default value. |
| MsDate Format | Property ID: mapMsDateFormat Type: string (Advanced) Specify the format for parsing MsDate values. For example, yyyy-MM-dd'T'HH:mm:ss.SSS is the default value. |
| Time Format | Property ID: mapTimeFormat Type: string (Advanced) Specify the format for parsing time values. For example, HH:mm:ss is the default value. |
| Prepend stream name, opcode | Property ID: PrependStreamNameOpcode Type: boolean (Optional) If set to true, the adapter inserts the stream name into the field _ESP_STREAM_NAME, and the opcode into the field _ESP_OPS. |
| Value as String | Property ID: valueAsString Type: boolean (Advanced) If set to true, the adapter converts all ESP data type into text string. The default value is true. If set to false, use the Data Type Mapping property to convert ESP data type to JMS map message data type. |
| Data Type Mapping | Property ID: fieldsType Type: string (Advanced) A custom mapping between ESP data type and external data type. Specify the conversion of ESP data type to JMS Map data type in the following format: <stream_column_name1>=<custom_data_type>. For example, streamColumn1=int. When there are multiple pairs in a string, each pair is delimited by a colon ( : ). For example, streamColumn1=int:streamColumn2:long:streamColumn3=string. The column name is case sensitive and must exist in the schema of the attached project, or the pair will be ignored. Valid data types are string, int, short, long, boolean, float, double, byte, and bytes; they are case insensitive. See Data Type Mapping for JMS Map Formatter in the SAP Event Stream Processor: Building Custom Adapters guide for a mapping conversion table listing supported ESP to JMS Map message data types. |
| Batch Size |
Type: integer (Advanced) If the adapter is running in GD (guaranteed delivery) mode, specify the number of message rows after which the adapter issues a commit command to the external data source and a GD commit to the stream to which the adapter is attached. If the adapter is running without GD mode, specify the number of message rows after which the adapter issues a commit command to the external data source. The default value is 1. Increasing this value improves performance at the expense of latency. It also increases memory consumption in the ESP Server because the uncommitted rows need to be preserved for redelivery in case of failure. If the ESP Subscriber module EnableGDMode element is set to true, set either this or the BatchPeriod property to greater than 0. If neither property is set to greater than 0, a warning is sent and this property is set to 1. |
| Batch Period |
Type: integer (Advanced) If the adapter is running in GD mode, specify the number of seconds after which the adapter issues a commit command to the external data source and a GD commit to the stream to which the adapter is attached. If the adapter is running without GD mode, specify the number of seconds after which the adapter issues a commit command to the external data source. The default value is 0. Increasing this value improves performance at the expense of latency. It also increases memory consumption in the ESP Server because the uncommitted rows need to be preserved for redelivery in case of failure. |
| Connection Factory | Property ID: connectionFactory Type: string (Required) Connection factory name. |
| JNDI Context Factory | Property ID: jndiContextFactory Type: string (Required) Context factory for JNDI context initialization. |
| JNDI URL | Property ID: jndiURL Type: string (Required) JNDI URL. |
| JMS Destination Type | Property ID: destinationType Type: string (Required) Specify the destination type. Valid values: QUEUE, TOPIC. |
| Destination Name | Property ID: destinationName Type: string (Required) Specify the destination name. |
| Delivery Mode |
Type: string (Optional) Specify the delivery mode type. Valid values are:
|
| JNDI Security Principal |
Type: string (Advanced) Specify the JNDI security principal that you use for the JMS server. This property corresponds to the JNDI property javax.naming.Context.SECURITY_PRINCIPAL. See your JMS server provider documentation for more information. By default, this property is commented out. Enable this property only if your JMS server requires JNDI credentials. |
| JNDI Security Credentials |
Type: string (Advanced) Specify the JNDI security credentials that you use for the JMS server. Includes an encyrpted attribute which specifies whether the JNDI credentials are encyrpted. This property corresponds to the JNDI property javax.naming.Context.SECURITY_CREDENTIALS. See your JMS server provider documentation for more information. By default, this property is commented out. Enable this property only if your JMS server requires JNDI credentials. |
| JNDI Security Credentials Encrypted |
Property ID: jndiCreEncrypted Type: boolean (Advanced) Specify whether the jndiSecurityCredentials value is encrypted. No default value. Specify this property only if your JMS server requires JNDI credentials. |
| User Name |
Type: string (Advanced) Specify a valid username for connecting to a specific JMS server. |
| Password |
Type: string (Advanced) Specify a valid password for connecting to a specific JMS server. Contains an encrypted attribute which determines whether the Password value is encrypted. |
| Password Encrypted |
Property ID: encrypted Type: boolean (Advanced) Specify whether the Password value is encrypted. |
| Property Set |
Property ID: propertyset Type: string (Advanced) Specifies the name of the property set. Property sets are reusable sets of properties that are stored in the project configuration file. Using these sets allows you to move adapter configuration properties out of the CCL file and into the CCR file. If you specify the same properties in the project configuration file and the ATTACH ADAPTER statement, the values in the property set override the values defined in the ATTACH ADAPTER statement. No default value. |
| Include Base Content |
Property ID: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. |
| Only Base Content |
Property ID: 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. |
| Enable GD Mode |
Property ID: EnableGdMode Type: boolean (Advanced) Specifies whether the adapter runs in guaranteed delivery (GD) mode. GD ensures that data continues to be processed in the case that the ESP Server fails, or the destination (third-party server) fails or does not respond for a long time. See Guaranteed Delivery in the SAP Event Stream Processor: Developer Guide for details on enabling GD for your project. The default value is false. |
| Enable GD Cache |
Property ID: EnableGdCache Type: boolean (Advanced)If set to true, only rows that can be recovered (that is, checkpointed) by the ESP Server on restart are sent to the end source. Other rows are cached internally by the adapter. The default value is false. |
| GD Subscriber Name |
Property ID: GdSubscriberName Type: string (Advanced) If the adapter is running in GD mode (the EnableGDMode property is set to true), specify a unique name to identify the GD subscription client. If this value is empty when running in GD mode, the adapter logs an error and shuts down. |