Adapter properties and commands

This documentation describes the adapter properties and commands.

Host name

Specifies the host name or SAP route string of the SAP R/3 server. You can use SAP Logon or the SAPGUI parameter.

The corresponding adapter command is -H host_name (or - HOST host_name) .

Client number

Specifies the client number in the SAP R/3 system. This client number is specified in the SAP R/3 login window whenever you log onto your SAP R/3 system.

The corresponding adapter command is -C client_number (or - CLIENT client_number).

System ID

Specifies the system number in the SAP R/3 system. This adapter command is mandatory for connection. Use the value as indicated for the system number in SAP Logon or SAPGUI (for example, 00).

The corresponding adapter command is -S sys_number (or - SYSTEMID sys_number).

User

Specifies the SAP R/3 username for login in the SAP R/3 system. This adapter command is mandatory for SAP R/3 system connection when calling a BAPI. The user is typically a CPIC user. See Basis team or SAP User Authorizations documentation for additional information.

The corresponding adapter command is -U usr_id|@full_path (or -USER usr_id|@full_path).
Note: @full_path can be used to access a security file, which is used to store user IDs with the specified name in the specified directory. (By default, the directory is where the map is located).
Password

Specifies the password assigned to the username for authorization for the SAP R/3 system. This adapter command is mandatory for SAP connection for BAPI sources and all targets.

The corresponding adapter command is -PWS pwd|@full_path (or - PASSWORD pwd|@full_path).
Note: @full_path can be used to access a security file, which is used to store passwords with the specified name in the specified directory. (By default, the directory is where the map is located.)
Program ID

Specifies the program ID that is used for RFC activation when registering through SAP Gateway. The program ID is a unique identifier that is used by the SAP Gateway to identify the listener (the program). The SAP recommends a format of machine.program for the program identifier. This identifier must match the registered Program ID defined in SM59. The SAP R/3 system uses this identifier to distinguish multiple programs registered at the same SAP Gateway.

For example, the program IDs xyz.CREMAS and xyz.MATMAS must be registered at the same SAP Gateway and gateway number.

The corresponding adapter command is - PID prgm_id (or - PROGRAMID prgm_id).
Note: prgm_id is a unique program identifier. The SAP recommends a format of machine.program that has no relationship to the logical system, although a common practice is to name the key similarly to the logical system.
Gateway Host Name

Specifies the host name or SAP route string of the gateway host by using this adapter command. When not using the Saprfc.ini file, it is mandatory for connection purposes for ALE sources (outbound from the SAP R/3 system).

The corresponding adapter command is - GWHOST gtwy_name (or - GATEWAYHOST gtwy_name).

Gateway Service

Specifies the service name or port number of the gateway process at the gateway host by using this adapter command. When not using the Saprfc.ini file, this is a mandatory adapter command for the SAP connection for ALE sources (outbound from the SAP R/3 system).

The corresponding adapter command is - GWSERV gtwy_serv (or - GATEWAYSERVICE gtwy_serv).

IDoc Type

This adapter command is used for ALE sources to designate the document types that can be received.

The corresponding adapter command is - IDOCTYP type.
Note: When using this adapter command to designate the document types, there is a potential for misconfiguration, if the SAP R/3 sends an IDoc type for which there is no handler. In that case, the SAP R/3 adapter would reject the incoming IDoc and it would not be acknowledged.
IDoc XML File

Specifies the IDoc XML file.

If specified in target mode, the specified IDoc XML file sent as a raw IDoc to the SAP R/3 system.

If specified in source mode, the specified IDoc XML file sent as a raw IDoc to the SAP R/3 system, and the transaction ID of the sent IDoc would be returned as result.

The corresponding adapter command is – IDOCF file_name|file_path (or - IDOCFILE file_name|file_path).