Connector-specific configuration properties

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 52 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 52. 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
Language E All
MaxNumberOfConnections 2 ABAP Extension,
ALE (request processing only),
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 (request processing only)
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 All
DateTimeFormat nothing or legacy All
TransIdCollabName No longer supported
UpdateIDocStatus true or false True ALE
IDocSuccessCode 12 ALE
IDocFailureCode 11 ALE
IDocSuccessText Dispatched Okay ALE
IDocFailureText Dispatch failed ALE
UseDefaults true or false false ABAP Extension
ALE
BAPI

ABAPDebug

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:

Note:
You can add breakpoints only after the debugger opens.

Important:
This property should always be set to false in a production environment.

The default value is false.

AleEventDir

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

AleUpdateStatus

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.

AleSelectiveUpdate

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.

AleStatusMsgCode

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.

AleSuccessCode

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.

AleFailureCode

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.

AleSuccessText

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.

AleFailureText

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.

ApplicationPassword

Password for the connector's user account on the SAP application. The default is SOFTWARE.

ApplicationUserName

Name of the connector's user account on the SAP application. The default is CROSSWORLDS.

ArchiveDays

The ArchiveDays connector configuration property determines the number of days after which TID Management files should be deleted from the request directory. The default value maintained internally is seven days. You can also specify partial day values, for example 1.234.

Client

Client number under which the connector logs in, often 100.

Group

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.

gwService

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.

Hostname

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.

Language

Language in which the connector logs in. The default is E, for English.

MaxNumberOfConnections

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.

If no value is specified for this property, the connector uses the default value of 2.

Modules

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

Hierarchical Dynamic Retrieve Module--Bapi

Note:
When you run the Hierarchical Dynamic Retrieve Module, add the value of Bapi to this property so as to establish at least one connector thread during processing, thus allowing the initialization and termination of the connector. The Hierarchical Dynamic Retrieve Module performs service call requests, so the business object handler is invoked through the meta-data in the business object being sent. However, by adding the value Bapi to the Modules property, you establish a connector thread, and thus if any issues arise during Hierchical Dynamic Retrieve Module processing, you can easily shut down the connector by calling the terminate() method on the running connector thread.

Namespace

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.

NumberOfListeners

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.

PollQuantity

Defines the maximum number of events picked up for a single poll. The default is 20.

RefreshLogonCycle

Specifies whether all resources are to be freed for an SAP client connection. The default is false.

RfcProgramId

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.

RfcTraceOn

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.

SAPALE_Archive_Queue

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.

SAPALE_Event_Queue

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.

SAPALE_Wip_Queue

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, seeOverview of the ALE Module.

There is no default value.

SAPALE_Error_Queue

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.

SAPALE_Unsubscribed_Queue

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.

SAPSystemID

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.

SAPtid_MQChannel

Specifies the Client channel for the MQ Series queue manager. For more information, seeOverview of the ALE Module.

There is no default value.

SAPtid_MQPort

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.

SAPtid_Queue

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.

SAPtid_QueueManager

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.

SAPtid_QueueManagerHost

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.

SAPtid_QueueManagerLogin

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.

SAPtid_QueueManagerPassword

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.

Sysnr

System number of the application server. The value is a two-digit number, often 00. The default is 00.

DateTimeFormat

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.

TransIdCollabName

Important:
The connector no longer supports this property.

TransIdCollabName

Important:
The connector no longer supports this property.

UpdateIDocStatus

States whether or not an audit trail is required for all message types.

IDocSuccessCode

The standard IDoc status code for dispatched okay.

IDocFailureCode

The standard IDoc status code for dispatched failure.

IDocSuccessText

The IDoc status message text associated with the IDocSuccessCode for dispatched okay.

IDocFailureText

The IDoc status message text associated with the IDocFailureCode for dispatched failure.

UseDefaults

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.

Copyright IBM Corporation 1997, 2004. All Rights Reserved.