CDC-SAP Listener Activity

The CDC SAP Listener activity listens to Change Data Capture data from SAP using the SAP ODP 2.0 framework.
The ODP sources supported are datasources/extractors that are provided by SAP or custom. The Change Data Capture data can either be a full extract (snapshot) or a delta.

General

The General tab contains the following fields.

Property	Module Property?	Visual Diff?	Description
Name	No	Yes	Name of the palette activity
CDC Resource	Yes	Yes	The CDC Connection shared resource establishes connections between the plug-in and the SAP system at run time. Ensure that you have created a CDC Connection shared resource.
Subscriber Type	No	Yes	Subscriber Type desribes the target application that processes the Change Data Capture data. Important: The Subsriber type must match the value defined in SAP transaction ODQMON that is relevant for the receipt of data from the plug-in.
Subscriber Name	Yes	Yes	Subscriber Name is the subcription name associated to the target application that processes the Change Data Capture data. Important: The Subsriber Name must match the Subscription value defined in SAP transaction ODQMON that is relevant for the receipt of data from the plug-in.
Context	No	Yes	The type of the ODP source that generates the Change Data Capture data.
ODP Name	No	Yes	Name of the ODP source
ODP Mode	No	Yes	Mode to extract data from a SAP ODP source, the valid values include Full and Delta.
Output Format	No	Yes	The following are the output formats JSON XML Avro

Description

Provide a short description for the activity.

Advanced

The Advanced tab contains the following fields.

Property	Module Property?	Visual Diff?	Description
Sequence Key	No	Yes	This field contains an XPath expression that specifies the order in which the process runs. Process instances with sequencing keys that have the same value are run sequentially in the order in which the process instances were created.
Custom Job Id	No	Yes	This field contains an XPath expression that specifies a custom job ID for the process instance. This ID is displayed in the $_processContext process variable. The custom job ID for the process instance.
Batch Size	Yes	Yes	The number of records that a job can contain, it defaults to -1, which means that a job contains all of the data from the ODP source.
Explicit Close	No	Yes	Do not close the request automatically, receipt of data is confirmed separately.
Return Error on Close	No	Yes	Subscriber is canceled and data is not collected
Trigger Event	No	Yes	Specifies when to process the data from the ODP source. The valid values include Local and SAP. It defaults to Local. Local means that the extraction is triggered by local timer. SAP means the receipt of data by an event from SAP server.
Start Time	Yes	Yes	Time to start the receipt of data, it is available only when the trigger event Local is selected.
Run Once	No	Yes	Indicates if the receipt of data runs only once. It defaults to true, it is available only when the trigger event Local is selected.
Time Interval	Yes	Yes	The time interval between processing, it is available only when the trigger event Local is selected.
Interval Unit	No	Yes	Time unit for timer, it is available only when the trigger event Local is selected.
End After	No	Yes	Specify the action after the receipt of data, the following are the valid values available only when the trigger event Local is selected. • Never: The connection never ends • Occurrences: When Occurences is selected, the Occurences field is enabled, enter the preferred Occurences value. • End time: When End time is selected, the End time field is enabled. You can choose a date and time.

Tags

Conversations

You can use the Conversations tab to initiate or join a conversation.

Conversations receive a message after the creation of the process instance, which is initiated or joined by an activity. This activity can be used to initiate a conversation. Click the Add New Conversation icon to initiate a conversation. For more information about conversations, see TIBCO ActiveMatrix BusinessWorks™ Application Design.

Output

The following is the output for the activity.

Output Item	Data Type	Description
Header	String	SAPName?: The SAP system ID with which the activity is performed ODPSource?: Name of the ODP source ODPMode?: Type of extract data from SAP ODP source, the valid values include Full and Delta. SubscriberName: timestamp?: The time at which an event occurs date?: The date when an event is performed time?: The time when an event is performed messageID?: It is a Unique ID for an event Important: When data from an ODP source is proessed across multiple jobs, the messageID value would be the same in all the jobs. recordCount?: The count of the records that a job contains Based on the output format selected, the Output item and corresponding Body Data section would undergo changes respectively. For JSON: data?: The Change Data Capture data is transformed into a JSON object that is subsequently serialized into a string. For XML: Records: Records of the data section Items: One or more records from the SAP ODP source. The schema is dependent on the schema of the ODP source. For Avro: data?: The Change Data Capture data is transformed into a JSON object that is subsequently serialized into Avro as a binary string.

Fault

The Fault tab lists exceptions that are generated by this activity.

Error Schema Element	Data Type	Description
msg	string	The error message is returned by the plug-in.
msgCode	string	The error code returned by the plug-in

• CDCPluginException: The exception is generated when the plug-in cannot send the request or parse the response.

• CDCSAPException: The exception is generated when any SAP related error occurs.

SAP ODP Change Event Information

To identify the type of change event from the SAP ODP Source, the below fields are provided in the output regardless of output format. These fields are provided from the ODP Source.

SAP ODP Field	Data Type	Description
ODQ_CHANGEMODE	String	Identifies the type of change event. Possible values are ‘C for create, ‘U’ for update, and ‘D’ for delete.
ODQ_ENTITYCNTR	Integer	Value sent from SAP ODP Source is used in conjunction with the ODQ_CHANGEMODE to further describe the change event.

Supported Datatypes

Datatype	Meaning
INT1	1-byte integer
INT2	2-byte integer
INT8	4-byte integer
DEC	Decimal floating point number stored in BCD format
DF16_DEC	Decimal floating point number stored in binary format
DF16_RAW	Decimal floating point number stored in binary format
DF34_DEC	Decimal floating point number stored in BCD format
DF34_RAW	Decimal floating point number stored in binary format
FLTP	Binary floating point number
CHAR	Character string
LCHR	Long character string
STRING	Character string
SSTRING	Character string (CLOB)
RAW	Byte string
LRAW	Long byte string
RAWSTRING	Byte string (BLOB)
DATS	Date in the format YYYYMMDD
TIMS	Time in the format HHMMSS
ACCP	Posting period in the format YYYYMM
NUMC	Numeric text
CLNT	Client
LANG	Language key
CURR	Currency field in BCD format
CUKY	Currency key for currency fields
QUAN	Quantity field in BCD format
UNIT	Unit key of a quantity field

Preparing SAP System

Before using the plug-in, you have to ensure that your SAP account and your SAP system meet the following requirements.
No modifications of code are required in the SAP system itself.

SAP Account Requirements
An SAP account is required to connect to the SAP system to communicate with the plug-in.

Before configuring the plug-in at design time, ensure that your SAP account and your SAP system meet the following requirements:
Your SAP account has access to a dedicated SAP application server and has permission to extract metadata for SAP ODP Datasources or Extractors by using TIBCO Business Studio for BusinessWorks.

• If you want to use different connections between design-time and runtime, obtain the relevant connection information.

• If you want to configure a load-balanced inbound activity, obtain the parameters used to connect to a Messaging Server for a specific Logon Group from the SAP Connection shared resource.

• Your SAP account has authorization from the SAP system administrator to execute RFCs in function group RODPS_REPL in the SAP system.

Top