7.10.1 Notes on defining passing information
Note the following when defining passing information:
-
Passing information can be passed even if the custom event job and the succeeding job are executed on different agent hosts. If the hosts use different character codes, the passing information is converted to the character codes used on the succeeding host. Note, however, that if the passing information contains unsupported characters, JP1/AJS3 might not operate correctly.
-
For details about the characters you can use with JP1/AJS3, see 2.4.2 Language type and character encoding of the system in the JP1/Automatic Job Management System 3 System Design (Configuration) Guide. Characters that are not supported by JP1/AJS3 cannot be used even in a stand-alone configuration. Make sure that passing information does not include such characters.
-
If multiple custom event jobs are related to a single succeeding job, the succeeding job can inherit the information received by all the custom event jobs. However, if multiple custom event jobs define the same macro variable name, the older received information will be overwritten.
-
If the same macro variable name is defined more than once in the passing information of a single custom event job, the information that is defined first is passed.
Example:
Suppose that the following two macro variables are defined in passing information:
-
?AJS2111?:OBJECT01 (This specifies that the information defined in OBJECT01 is passed to the ?AJS2111? macro variable.)
-
?AJS2111?:OBJECT02 (This specifies that the information defined in OBJECT02 is passed to the ?AJS2111? macro variable.)
In this case, ?AJS2111? inherits OBJECT01.
-
-
Do not pass data that contains an escape sequence to the command line. If you pass data that contains a space character, unexpected behavior might result. To prevent this, when you define a macro variable, enclose it in double quotation marks (").
-
When you specify a macro variable in the command line of the succeeding job, the succeeding job cannot correctly inherit passing information if the information contains space characters or single quotation marks ('). Note that macro variables are executed on the agent host that executes the succeeding job of the custom event job by replacing the macro variable in the command line with its value. When defining passing information, define only information that can be treated as command arguments at execution.
-
If there is no information to be inherited from the custom event job or if the custom event job is not executed, the macro variables defined in the succeeding job will not inherit any information. In this case, if you define ?AJS2111? as the macro variable name when you execute the job, the character string ?AJS2111? will be passed.
-
When you pass the information received in a custom event job to the parameters of a standard job or an action job, if the data to be passed contains a double quotation mark ("), you must add a backslash (\) before the double quotation mark. If you do not add a \ before the double quotation mark, the double quotation mark will be ignored when it is passed to a standard job or an action job.
To prevent this, enable the option for handling data containing double quotation marks (as is) in passing information.
For details about how to set this option, see 6.3.4 Passing event data containing double quotation marks in the JP1/Automatic Job Management System 3 Configuration Guide (for Windows systems) or 15.3.4 Passing event data containing double quotation marks in the JP1/Automatic Job Management System 3 Configuration Guide (for UNIX systems).
-
When passing information is used in a command line of a job, even if the passing information contains a double quotation mark ("), the information is passed to the succeeding job without being converted. Therefore, the job might not be executed correctly depending on the command line restrictions of the OS in question. If you want to use passing information that contains a special character, do not use it directly in a command line. Such information must be passed to an environment variable.
-
If you define macro variables in a custom event job defined in a start condition, the information is passed to the entire jobnet that starts when the start condition is satisfied.
-
Make sure that the macro variable names and passing information together do not exceed 4,096 bytes. In particular, if you use the AND condition to define a start condition, the system merges the macro variable names and passing information for all of the custom event jobs in the start condition. For this reason, take care that the macro variable names and passing information do not exceed 4,096 bytes in total.