You must configure the connector's standard and connector-specific connector configuration properties before you can run it. To configure connector properties, use Connector Designer. Access this tool from the System Manager.
As you enter configuration values, they are saved in the repository.
Standard configuration properties provide information that all connectors use. See Appendix B, Standard configuration properties for connectors for documentation of these properties.
Table 4 provides information specific to this connector about
configuration properties in the appendix.
Table 4. Property information specific to this connector
Property | Note |
---|---|
CharacterEncoding | The connector does not use this property. |
Locale | Because this connector has been internationalized, you can change the value of this property. See release notes for the adapter to determine currently supported locales. |
PollFrequency | If using the RFC Server Module or the ALE Module for event processing, do not set this property's value to key or to no. Setting the value to key or no prevents the connector from instantiating these modules at startup. |
You must provide a value for the ApplicationName configuration property before running the connector.
Connector-specific configuration properties provide information needed by the connector at runtime. Connector-specific properties also provide a way of changing static information or logic within the connector framework and the connector's application-specific component without having to recode and rebuild the connector.
Table 5 is a quick reference for the connector-specific
configuration properties. The modules column contains a list of the
connector modules that use the associated property.
Table 5. Quick reference for connector-specific configuration properties
Name | Possible values | Default value | Modules |
---|---|---|---|
ABAPDebug | true or false | false | ABAP Extension
BAPI HDR |
AleEventDir | path |
| ALE |
AleUpdateStatus | true or false | false | ALE |
AleSelectiveUpdate | IDocType:MessageType |
| ALE |
AleStatusMsgCode | MessageCode |
| ALE |
AleSuccessCode | 52 or 53 | 52 | ALE |
AleFailureCode | 68 or 58 | 68 | ALE |
AleSuccessText | SuccessText |
| ALE |
AleFailureText | FailureText |
| ALE |
ApplicationPassword |
| SOFTWARE | All |
ApplicationUserName |
| CROSSWORLDS | All |
ArchiveDays |
|
| ALE |
Client |
|
| All |
Group | any valid name of the logon group that represents a group of application servers |
| All |
gwService | Gateway server identifier | sapgw00 | RFC Server ALE |
Hostname | IP-address or server-name |
| All |
InDoubtEvents | Reprocess, FailOnStartUp, LogError or Ignore | Ignore | ABAP Extension |
Language |
| E | All |
MaxNumberOfConnections |
| 2 | ABAP Extension,
ALE, BAPI HDR |
Modules | ModuleName |
| All |
Namespace | true or false | true | ABAP Extension |
NumberOfListeners | any positive integer | 1 | RFC Server,
ALE |
PollQuantity | any positive integer | 20 | ABAP Extension,
ALE |
RefreshLogonCycle | true | true | All |
RfcProgramId | program ID | CWLDSERVER | RFC Server ,
ALE |
RfcTraceOn | true or false | false | All |
SAPALE_Archive_Queue | any valid MQ Series queue name |
| ALE |
SAPALE_Event_Queue | any valid MQ Series queue name |
| ALE |
SAPALE_Wip_Queue | any valid MQ Series queue name |
| ALE |
SAPALE_Error_Queue |
|
|
|
SAPALE_Unsubscribed_Queue |
|
|
|
SAPSystemID | logical name of the SAP R/3 System |
| All |
SAPtid_MQChannel | any valid MQ channel |
| ALE |
SAPtid_MQPort | any valid MQ port |
| ALE |
SAPtid_Queue | any valid MQ queue name |
| ALE |
SAPtid_QueueManager | any valid MQ queue manager name |
| ALE |
SAPtid_QueueManagerHost | any valid MQ queue manager host name |
| ALE |
SAPtid_QueueManagerLogin | any valid MQ queue manager login name |
| ALE |
SAPtid_QueueManagerPassword | any valid MQ queue manager password |
| ALE |
Sysnr | system-number | 00 | BAPI, RFC Server |
DateTimeFormat | nothing or legacy |
| All |
TransIdCollabName |
|
| No longer supported |
UseDefaults | true or false | false | ABAP Extension
ALE BAPI |
Specifies whether the connector invokes the ABAP Debugger for the appropriate function module when the connector begins processing a business object. When this property is set to true, the connector opens the ABAP Debugger for the following connector modules:
The connector invokes the ABAP Debugger only if you have:
The default value is false.
Specifies the location of the root directory (\ale) for the event directory used by the ALE Module to log and recover events. When the connector starts for the first time, if it does not find the root directory in the directory from which the connector is started, it creates it and the event subdirectory:
For example, if your connector is located in \connectors\SapConnector1 (within the product directory), the connector creates the following directory:
\connectors\SapConnector1\ale
UNIX |
---|
If you are not in the connector's directory when you start the connector for the first time, the connector creates the root directory in the directory from which you start the connector regardless of the value of this property. |
For more information, see Overview of the ALE module.
The default value is:
UNIX |
---|
$<ProductNameDir>/connectors/SAP/ale |
Windows |
---|
%ProductNameDir%\connectors\SAP\ale |
Specifies whether an audit trail is required for all message types. This property must be set to true to cause the connector to update a standard SAP status code after the ALE Module has retrieved an IDoc object for event processing.
For more information, see Overview of the ALE module.
The default value is false.
Specifies which IDocType and MessageType combinations are to be updated when the connector is configured to update a standard SAP status code. You can define values for this property only if AleUpdateStatus has been set to true.
The syntax for this property is:
IDocType:MessageType[,IDocType:MessageType [,...]]
where a colon (:) delimiter separates each IDocType and MessageType, and a comma (,) delimiter separates entries in a set. The example below illustrates two sets. In the example, MATMAS03 and DEBMAS03 are the IDocs, and MATMAS and DEBMAS are the message types:
MATMAS03:MATMAS,DEBMAS03:DEBMAS
For more information, see Overview of the ALE module.
If required, specifies the message code to use when the connector posts the ALEAUD Message IDoc (ALEAUD01). Configure this message code in the receiving Partner Profile. You can set a value for this property only if AleUpdateStatus has been set to true.
For more information, see Configuring SAP To update IDoc status.
Specifies the success status code for Application Document Posted. You must specify a value for this property (52 or 53) to cause the connector to update the SAP success status code after the ALE Module has retrieved an IDoc object for event processing. SAP converts this value to status 41 (Application Document Created in Receiving System).
For more information, see Overview of the ALE module.
Specifies the status code for dispatch failure. You must specify a value for this property (68 or 58) to cause the connector to update the SAP failure status code after the ALE Module has retrieved an IDoc object for event processing. SAP converts this value to 40.
For more information, see Overview of the ALE module.
Specifies the descriptive text for successful Application Document Posted. Specifying a value for this property is optional, even when you set AleUpdateStatus to true.
For more information, see Overview of the ALE module.
Specifies the descriptive text for dispatch failure. Specifying a value for this property is optional, even when you set AleUpdateStatus to true.
For more information, see Overview of the ALE module.
Password for the connector's user account on the SAP application. The default is SOFTWARE.
Name of the connector's user account on the SAP application. The default is CROSSWORLDS.
The ArchiveDays connector configuration property determines the number of days after which TIDManagement files should be deleted from the request directory. The default value maintained internally is seven days.
Client number under which the connector logs in, often 100.
When configuring the connector for load balancing, specifies the name of the logon group that represents a group of application servers. For more information, see Taking advantage of load balancing.
Gateway server identifier; often sapgw00. The 00 is the system number of the server running the SAP Gateway (usually an application server) and may not be 00 if you have more than one. The default is sapgw00.
When configuring the connector for load balancing, specifies the name of the message server. When configuring the connector to run without load balancing, specifies the IP address or the name of the application server that the connector logs in to. In both cases, the connector assumes that the name of the gateway host is the same as the value specified for this property.
InDoubtEvents describes how to handle in-progress events in the events table. Reprocess reprocesses the in-progress events in the events table. FailOnStartup will shut down the connector and log a fatal error when in-progress events are found. LogError logs an error notifying that in-progress events are in the event table. Ignore, ignore the in-progress events.
Language in which the connector logs in. The default is E, for English.
The maximum number of concurrent interactions possible between the connector and the SAP application. These interactions include polling for events and handling service call requests. Only the ABAP Extension, BAPI, and ALE Modules use this property. The ALE Module uses this property only for service call requests.
Because each interaction uses a dialog process on the SAP application server, the number of connections cannot exceed the number of dialog processes available. For more information, see "Processing multiple concurrent interactions" in Chapter 1.
If no value is specified for this property, the connector uses the default value of 2.
Identifies the module used by the connector to carry out the init(), pollForEvents(), and Terminate() requests. Specifically, it specifies the connector module used by the Vision Connector framework. Specify multiple connector modules by separating each value with a comma. Do not add spaces.
The supported connector modules and the syntax to specify them is as follows:
ABAP Extension Module--Extension
ALE Module--ALE
BAPI Module--Bapi
RFC Server Module--RfcServer
Specifies whether or not the connector uses the ABAP components defined in the connector's namespace /CWLD/. The value must be set to true in order for the connector to use the ABAP components defined in the namespace. The default is true.
Specifies the number of listener threads that are created when the connector is initialized. A listener thread can handle one request at a time. Each listener thread handles a single event at a time; therefore, if you have multiple listener threads, the connector can handle multiple events concurrently. The default is 1.
It is recommended that you have no more listener threads than the available work processes in SAP.
Defines the maximum number of events picked up for a single poll. The default is 20.
Specifies whether all resources are to ber freed for an SAP client connection. The default is false.
Identification that the connector registers in the SAP Gateway so that the listener threads can process events from RFC-enabled functions. This value must match the Program ID registered in the SAP application (transaction SM59). The default is CWLDSERVER.
For more information on configuring the Program ID in the SAP application, see Registering the RFC Server Module with the SAP gateway.
Specifies whether or not to generate a text file detailing the RFC activity for each listener thread. You can specify a value of true or false. A value of true activates tracing, which generates a text file. It is recommended that you use these text files in a development environment only, because the files can grow rapidly. The default is false.
Specifies the MQ Series queue that archives TIDs and IDoc data after the ALE Module has finished processing events. For more information, see Overview of the ALE module.
There is no default value.
Specifies the MQ Series queue that stores TIDs and IDoc data during the ALE Module's processing of events. For more information, see Overview of the ALE module.
There is no default value.
Specifies the MQ Series work-in-progress (wip) queue that holds TIDs and IDoc data while the ALE Module builds the MQ message for the event queue. After the connector receives all data for an event, it moves the data in this queue to the SAPALE_Event_Queue. For more information, see Overview of the ALE module.
There is no default value.
Defines a queue to handle MQ messages that fail between the WIP Queue and the Event Queue. For more information, see Overview of the ALE module.
Defines a queue to collect unsubscribed IDoc objects. Unsubscribed IDoc objects previously were placed in the Archive queue. These messages can be resubmitted using the event management utility. The connector now checks for subscriptions when processing the data from SAP to the connector, resulting in transactions remaining in SAP until the collaboration is started. For more information, see Overview of the ALE module.
When configuring the connector for load balancing, specifies the logical name of the SAP R/3 System, which is also known as R3name. For more information, see Taking advantage of load balancing.
Specifies the Client channel for the MQ Series queue manager. For more information, see Overview of the ALE module.
There is no default value.
Specifies the port used to communicate with the MQ Series queue manager that handles the queues for the ALE Module. For more information, see Overview of the ALE module.
There is no default value.
Specifies the MQ Series queue on which messages containing the TID and TID status reside. This property is used by the ALE Module only when processing requests. For more information, see Overview of the ALE module.
There is no default value.
Name of the MQ Series queue manager for the queues that store TIDs and IDoc data. This property is used by the ALE Module to process events and requests. For more information, see Overview of the ALE module.
There is no default value.
Name of the host where the MQ Series queue manager resides. This property is used by the ALE Module to process events and requests. For more information, see Overview of the ALE module.
There is no default value.
User name to log into the MQ Series queue manager. This property is used by the ALE Module to process events and requests. For more information, see Overview of the ALE module.
There is no default value.
Password for the user who logs into the MQ Series queue manager. This property is used by the ALE Module to process events and requests. For more information, see Overview of the ALE module.
There is no default value.
System number of the application server. The value is a two-digit number, often 00. The default is 00.
Preserves the delimiters provided with DATE and TIME field values. If set to Legacy, the connector will preserve the delimiters for DATE and TIME fields. Otherwise, the delimiters will be removed and the value's length will conform to the attribute defined length.
On a Create or Update operation, if UseDefaults is set to true, the Adapter Framework for the integration broker, checks whether a valid value or a default value is provided for each business object attribute marked as required. If a value is provided, the Create or Update operation succeeds. If the parameter is set to false, the connector checks only for a valid value and causes the Create or Update operation to fail if it is not provided. The default is false.