Common argument formats for various commands
This section explains the common argument formats: for the commands of the job control function, and for the command of the InfoPackage control function and the process chain control function.
- Organization of this page
(1) Common argument format for job control function commands
The following provides the detailed formats for R/3 destination information, R/3 logon information, and redirection information. These formats are common to all job control function commands.
The R/3 destination information is an argument for establishing a connection to the R/3 system. The R/3 destination information format is explained below.
- R/3 destination information
-
-h host-name [-s NN]|-d destination
The R/3 destination information options must be used as described below depending on the method of connection to the R/3 system.
-
When connecting to the R/3 system using the specified host name
Connects to the application server with the specified system number running on the specified host.
To connect to the R/3 system using the specified host name, use the format -h host-name[-s NN].
The -d option cannot be specified at the same time.
- -h host-name
-
Enter the R/3 system host name in the host-name position. Host names in the following formats can be used:
- hosts address (e.g., r3host1)
- IP address (e.g., 123.123.123.123)
- SAP router address
For the SAP router address, see the R/3 manual or online help.
- -s NN
-
The system number for R/3 system identification must be entered in the NN position. A character string of 1 or 2 bytes can be entered. Only numerals can be used. If this entry is omitted, system number 0 is automatically set.
-
When connecting to the R/3 system using the sapnwrfc.ini file
Depending on what is defined in the sapnwrfc.ini file, the system connects to either a specific application server or the application server determined by the load-balancing function of the message server.
To connect to the R/3 system using the sapnwrfc.ini file, use the format -d destination.
The -h option cannot be specified at the same time.
- -d destination
-
The DEST value specified in the sapnwrfc.ini file must be entered in the destination position. A sapnwrfc.ini file search is conducted as follows. Be sure that the destination has been entered in advance as the DEST value in the sapnwrfc.ini file.
When the sapnwrfc.ini file is specified by environment variable RFC_INI
Only the sapnwrfc.ini file specified in environment variable RFC_INI is searched for. The sapnwrfc.ini file in the work directory of JP1/AJS3 for EAP is not searched for.
When the sapnwrfc.ini file is not specified by environment variable RFC_INI
The sapnwrfc.ini file in the JP1/AJS3 for EAP work directory is searched for.
-
When omitting R/3 destination information as part of the command line
If the R/3 destination information is not specified as part of the command line, all options are omitted and the destination information (address section information) specified in the r3defcon file will be used. Since the r3defcon file must exist, create the r3defcon file beforehand in the home directory of the user executing the command.
For the creation of the sapnwrfc.ini file and r3defcon file, see 2. Installation and Setup.
The R/3 logon information is an argument that specifies user information for logging on to the R/3 system.
The R/3 logon information format is explained below.
- R/3 logon information
-
{-c R/3-client -u R/3-user-name {-p password | -p2 extended-password} [-l language] | -dl}
- -c R/3-client
-
Specify the client number of an R/3 client that is valid for logon to the R/3 system. A character string of 1 to 3 bytes can be entered for the client number specification. Only numerals can be used.
Note that a 1- or 2-byte R/3 client number sent to the R/3 system is converted to a 3-byte number.
For example, if the client number is 001, you can specify 1, 01, or 001. However, the 3-byte client number 001 is sent to the R/3 system.
The -dl option cannot be specified at the same time.
- -u R/3-user-name
-
Specify the name of an R/3 user that is valid in the R/3 system that you log on to.
For details about the R/3 users who can be specified, see 2.2.9 Providing a SAP user for job control.
A character string of 1 to 12 bytes can be entered for the R/3 user name specification.
R/3 system control will be executed under authority of this R/3 user.
The -dl option cannot be specified at the same time.
- -p password
-
Enter the password for the R/3 user that is specified by the -u option.
Specify this option when a conventional password rule is applied to the SAP system.
For details about the characters that can be specified for the password, see 2.2.9 Providing a SAP user for job control.
A character string of 1 to 8 bytes can be entered for the password.
The -dl option cannot be specified at the same time.
- -p2 extended-password
-
Specify an extended password that corresponds to the R/3 user specified by the -u option.
Specify this option when the extended password rule is applied to the SAP system.
For details about the characters that can be specified for the extended password, see 2.2.9 Providing a SAP user for job control.
A character string of 1 to 40 bytes can be entered for the extended password.
The -dl option cannot be specified at the same time.
- -l language
-
Enter a single-byte alphabetic character to specify the language to be used. You can use either Japanese or English. Specify the following language supported by the R/3 system as the language to be used.
-
For Japanese: J
-
For English: E
In the following cases, the default language type defined by the application server at the logon destination is used:
-
The -l option is omitted.
-
A language type not defined by the application server at the logon destination is specified.
The language type specified for this option affects the language for the R/3 job log. It also affects the language for the error details that are returned by the SAP system and inserted into a message, such as KAJM0802-E and KAJM0813-E.
The -dl option cannot be specified at the same time.
-
- -dl
-
Specify this option when you define R/3 logon information by using the sapnwrfc.ini file.
This option is enabled when the -d option is specified for the R/3 destination information. If the -dl option is specified for the R/3 destination information instead of the -d option, the processing terminates abnormally. The -c, -u, -p, -p2, or -l option cannot be specified at the same time.
If the R/3 logon information is not specified as part of the command line, the logon information (logon section information) specified by the r3defcon file is used. The r3defcon file must therefore be created beforehand in the home directory of the user executing the command.
For r3defcon file creation, see 2. Installation and Setup.
Use this argument to specify the standard output and standard error output files that will be used when the command is being executed. The specification format is as follows:
- -so standard-output-file-name
-
Specify a standard output file for command execution.
The lengths of character strings that can be specified as standard output file names vary depending on whether the OS is Windows or a Linux:
-
For Windows:
The lengths of character string you can specify as standard output file names are from 1 to 259 bytes.
-
For a Linux:
The lengths of character string you can specify as standard output file names are from 1 to 255 bytes.
If you do not use the full path to specify the standard output file name, the file is created in the work directory of JP1/AJS3 for EAP. (If the JP1/AJS3 for EAP working directory is not available, the file will be created in the current directory.)
For the standard output file name, do not specify a device file, such as /dev/null. If a standard output file is not needed, delete the file that is created.
You can also write standard output messages for command execution in this file.
-
- -se standard-error-output-file
-
Specify a standard error output file for command execution.
The lengths of character strings that can be specified as standard error output file names vary depending on whether the OS is Windows or a Linux:
-
For Windows:
The lengths of character string you can specify as standard error output file names are from 1 to 259 bytes.
-
For a Linux:
The lengths of character string you can specify as standard error output file names are from 1 to 255 bytes.
If you do not use the full path to specify the standard error output file name, the file is created in the work directory of JP1/AJS3 for EAP. (If the JP1/AJS3 for EAP working directory is not available, the file will be created in the current directory.)
For the standard error output file name, do not specify a device file, such as /dev/null. If the standard error output file is not needed, delete the file that is created.
You can also write standard error output messages for command execution in this file.
-
(2) Argument formats for the command of the InfoPackage control function and the process chain control function
The following provides the detailed formats for SAP BW destination information and SAP BW logon information. These formats are applied to the command of the InfoPackage control function and the process chain control function.
SAP BW destination information
The SAP BW destination information is an argument for establishing a connection to the SAP BW system. The detailed format for SAP BW destination information is explained below.
- SAP BW destination information
-
-h host-name [-s NN]|-d destination
The SAP BW destination information options must be used as described below depending on the method of connection to the SAP BW system.
-
When connecting to the SAP BW system using the specified host name
Connects to the application server with the specified system number running on the specified host.
To connect to the SAP BW system using the specified host name, use the format -h host-name[-s NN].
The -d option cannot be specified at the same time.
- -h host-name
-
Enter the SAP BW system host name in the host-name position. Host names in the following formats can be used:
- hosts address (e.g., bwhost1)
- IP address (e.g., 123.123.123.123)
- SAP router address
For the format of the SAP router address, see the SAP BW manual or online help.
- -s NN
-
Enter the system number for identifying the SAP BW system in the NN position. You can enter a character string of 1 or 2 bytes. Only numerals can be used. If this entry is omitted, system number 0 is automatically set.
-
When connecting to the SAP BW system using the sapnwrfc.ini file
Depending on what is defined in the sapnwrfc.ini file, the system connects to either a specific application server or the application server determined by the load-balancing function of the message server.
To connect to the SAP BW system using the sapnwrfc.ini file, use the format -d destination.
The -h option cannot be specified at the same time.
- -d destination
-
Specify the value specified for DEST in the sapnwrfc.ini file in the destination position. A sapnwrfc.ini file search is conducted as follows. Make sure that the destination has been entered in advance as the DEST value in the sapnwrfc.ini file.
When the sapnwrfc.ini file is specified by environment variable RFC_INI
Only the sapnwrfc.ini file specified in environment variable RFC_INI is searched for. The sapnwrfc.ini file in the work directory of JP1/AJS3 for EAP is not searched for.
When the sapnwrfc.ini file is not specified by environment variable RFC_INI
The sapnwrfc.ini file in the JP1/AJS3 for EAP work directory is searched for.
-
When omitting SAP BW destination information as part of the command line
If the SAP BW destination information is not specified as part of the command line, all options are omitted and the destination information (address section information) specified in the r3defcon file will be used. Since the r3defcon file must exist, create the r3defcon file beforehand in the home directory of the user executing the command.
For the creation of the sapnwrfc.ini file and r3defcon file, see 2. Installation and Setup.
The SAP BW logon information is an argument that specifies user information for logging on to the SAP BW system. The detailed format for SAP BW logon information is explained below.
- SAP BW logon information
-
{-c SAP-BW-client -u SAP-BW-user-name {-p password | -p2 extended-password} [-l language] | -dl}
- -c SAP-BW-client
-
Specify the client number of a SAP BW client that is valid for logon to the SAP BW system. You can enter a character string of 1 to 3 bytes for the client number. Only numerals can be used. Note that a 1- or 2-byte SAP BW client number sent to the SAP BW system is converted to a 3-byte number.
If, for instance, the client number is 001, you can enter 1, 01, or 001. However, when this client number is sent to the SAP BW system, it is sent as the 3-byte client number 001.
The -dl option cannot be specified at the same time.
- -u SAP-BW-user-name
-
Specify the name of a SAP BW user that is valid for logon to the SAP BW system.
For details about the SAP BW users who can be specified, see 2.3.9 Providing a SAP user for InfoPackage control or process chain control.
You can enter a character string of 1 to 12 bytes for the user name.
SAP BW system control will be executed under authority of this SAP BW user.
The -dl option cannot be specified at the same time.
- -p password
-
Enter the password for the SAP BW user that is specified by the -u option.
For details about the characters that can be specified for the password, see 2.3.9 Providing a SAP user for InfoPackage control or process chain control.
Specify this option when a conventional password rule is applied to the SAP system.
You can enter a character string of 1 to 8 bytes for the password.
The -dl option cannot be specified at the same time.
- -p2 extended-password
-
Specify an extended password that corresponds to the SAP BW user specified by the -u option.
For details about the characters that can be specified for the extended password, see 2.3.9 Providing a SAP user for InfoPackage control or process chain control.
Specify this option when the extended password rule is applied to the SAP system.
You can enter a character string of 1 to 40 bytes for the extended password.
The -dl option cannot be specified at the same time.
- -l language
-
Enter a single-byte alphabetic character to specify the language to be used. You can use either Japanese or English. Specify the following language supported by the SAP BW system as the language to be used.
-
For Japanese: J
-
For English: E
In the following cases, the default language type defined by the SAP BW system at the logon destination is used:
-
The -l option is omitted.
-
A language type not defined by the SAP BW system at the logon destination is specified.
The language type specified for this option affects the language for the error details that are returned by the SAP system and inserted into a message, such as KAJM0802-E and KAJM0813-E.
The -dl option cannot be specified at the same time.
-
- -dl
-
Specify this option when you define SAP BW logon information by using the sapnwrfc.ini file.
This option is enabled when the -d option is specified for the SAP BW destination information. If the -dl option is specified for the SAP BW destination information instead of the -d option, the processing terminates abnormally. The -c, -u, -p, -p2, or -l option cannot be specified at the same time.
If the SAP BW logon information is not specified as part of the command line, the logon information (logon section information) specified by the r3defcon file is used. The r3defcon file must therefore be created beforehand in the home directory of the user executing the command.
For the creation of the r3defcon file, see 2. Installation and Setup.