CDC Connection Resource
The CDC Connection Resource is used to maintain additional configuration required by the plug-in for supported CDC source such as SAP. Each CDC source is maintained in its own tab and section.
The CDC connection resource has two sections; General and SAP Connection.
General
The General tab is applicable to all CDC sources. The General panel contains the following fields.
| Property | Module Property? | Description |
|---|---|---|
| Package | No | The name of the package where the CDC connection resource is added. |
| Name | No | The name to be displayed as the label for the CDC shared resource in the process. |
| Description | No | The name to be displayed as the label for the CDC connection resource. |
CDC Source - SAP
The SAP Connection panel allows you to configure the client connection and server connection (if enabled) between the plug-in and SAP server.
SAP Connection
In the SAP Connection panel, you can specify the connection details required to capture and process Change Data Capture data from the SAP server. The SAP Connection includes three tabs: Client Connection, Server Connection, and ODP Sources.
Client Connection
At design-time, the client connection is used to get list of SAP ODP sources and download the metadata of a SAP ODP source.
At runtime, the client connection is used to retrieve CDC data from the SAP server.
The Client Connection tab contains the following fields.
| Property | Module Property? | Description |
|---|---|---|
| Connection Type |
No | The client connection type. The plug-in provides the following client connection types: Dedicated App Server Load Balancing. The default type is Dedicated App Server. |
| Message Server | Yes | An SAP message server can be used for load distribution and communication between individual application servers in an SAP BW system. |
| Application Server | Yes |
The network name of the machine where the SAP system exists. Note: This field is displayed only when you select Dedicated App Server from the Connection Type list.
|
| System Number | Yes |
The SAP system number. Note: This field is displayed only when you select Dedicated App Server from the Connection Type list.
|
| System Name | Yes |
The SAP system ID or the SAP message server tcp/ip port number. Note: This field is displayed only when you select Load Balancing from the Connection Type list.
|
| Client | Yes | The SAP client number |
| User Name | Yes | Enter the username of the database to be used for authentication on to SAP client |
| Password | Yes | Enter the password of the database to be used for authentication |
| Logon Group Name | Yes | The SAP logon group server to be used with the load balancing connection.The default value is PUBLIC. Note: This field is displayed only when you select Load Balancing from the Connection Type list. |
| The following advanced options are displayed when you click Show/Hide Advanced Options | ||
| Language | No | Select the language used to connect to the SAP system. The default language is English. |
| Code Page | Yes |
The character set used by the SAP system. The default value is blank. Note: This field can only be specified in the special cases.
|
| Maximum Number of Reconnection Attempts | Yes | The maximum number of times that the plug-in can retry to establish a connection before sending a request to the SAP system. The default value is -1, which indicates that the plug-in can retry indefinitely. |
| Interval between Reconnection Attempts (ms) | Yes | The time interval in milliseconds between two successive attempts to establish a connection before sending a request to the SAP system. The default value is 30000. |
| Disable Connection Pooling | Yes | Whether to disable connection pooling. If you want to close the connection automatically after the request to SAP is completed, select this checkbox. This checkbox is cleared by default. |
| RFC Trace | Yes | Whether to enable the RFC trace. The value of 1 indicates that the RFC trace is enabled. The value of 0 indicates that the RFC trace is disabled. The default value is 0. |
| Use SAP GUI | Yes |
To enable the SAP GUI.
|
| Third-Party Library Options | Yes |
Specifies SAP JCo properties, which are used by the CDC Connection shared resource. Note: It is a semicolon separated list of SAP JCo properties.
While specifying an SAP JCo property, which is available as a property in the CDC Connection shared resource then the value specified with the SAP JCo property is used. If an SAP JCo property is specified more than once then the last value is used. |
| Enable | Yes | If the Enable checkbox is selected then the Change Data Capture data would be processed by a SAP event sent from SAP server as a RFC call. To support the RFC call, the properties maintained in the Server Connection tab need to be maintained accordingly. The event must be sent from SAP using function module BAPI_XBP_EVENT_RAISE. No export parameters are required on the RFC call. Default value is unselected. |
Server Connection
If enabled, the server connection is only used during runtime and in scenario where proessing in BusinessWorks should be executed following an event from SAP server. The Server Connection tab contains the following fields.
| Property | Module Property? | Description |
|---|---|---|
| Enable | Yes | If the Enabled checkbox is selected then the Change Data Capture data would be processed by a SAP event sent from SAP server as a RFC call. To support the RFC call, the properties maintained in the Server Connection tab need to be maintained accordingly. The event must be sent from SAP using function module BAPI_XBP_EVENT_RAISE. No export parameters are required on the RFC call. Default value is unselected. |
| Connection Type |
No | The client connection type. The plug-in provides the following client connection types: Dedicated App Server Load Balancing. The default type is Dedicated App Server. |
| Program ID | Yes |
The program ID that identifies the RFC server program for the SAP system. The Program ID is required by the plug-in but it is up to you to define the Program ID based on the requirements. The program ID is case sensitive. Note: RFC destination corresponding to the program ID must exist in the SAP system. If a server connection is not used by an activity, the program ID is ignored and not registered in the SAP system.
Important: If configuring the Trigger Event in the CDC SAP listener activity as SAP then ensure that the program ID is unique across all CDC SAP listener activities.
|
| Gateway Service | Yes |
The SAP gateway service or SAP Gateway tcp/ip port number.The default service is sapgw00. Note: When specifying a value as a service name, the service name must exist in the services file maintained at the operating system level. To avoid having to maintain the services file, the TCP/IP port number such as 33xx, where xx is the range from 00 to 99, depending on the instance number of the SAP server, can be specified as a value instead.
|
| Gateway Host | Yes | The Gateway host name, IP address, or router string. If no machine exists as a gateway host, this field is specified as the application server. |
| The following advanced options are displayed when you click Show/Hide Advanced Options: | ||
| Maximum time between two startup attempts in case of failure (secs) | Yes |
The maximum time interval in seconds between two successive attempts to establish a connection with the gateway host. If the connection cannot be established after the maximum time interval, the server connection is suspended. The default value is 60. |
| Max Connections | The number of SAP connections in the server connection. The default value is 1. | |
| RFC Trace | Yes | Whether to enable the RFC trace. The value of 1 indicates that the RFC trace is enabled. The value of 0 indicates that the RFC trace is disabled. The default value is 0. |
| Third-Party Library Options | Yes |
Specifies SAP JCo properties, which are used by the CDC Connection shared resource. Note: It is a semicolon separated list of SAP JCo properties.
While specifying an SAP JCo property, which is available as a property in the CDC Connection shared resource then the value specified with the SAP JCo property is used. If an SAP JCo property is specified more than once then the last value is used. |