Job Management Partner 1/Automatic Job Management System 3 Command Reference 2
This paragraph explains how to specify an email reception monitoring job definition.
The following gives the format of, and the parameters for an email reception monitoring job definition.
- Format
[pfm={u|p};] [mlprf="profile-name";] [mladr="sender";] [mlsbj="subject";] [mltx="text";] [mlsav={y|n};] [mllst="received-email-list";] [mlstx="name-of-text-file";] [mlsfd="name-of-folder-to-save-attached-file";] [mlafl="name-of-list-file";] [jpoif=?macro-variable-name?:take-over-information-name;] [etm=n;] [fd=time-required-for-execution;] [ex="execution-agent-name";] [ha={y|n};] [eu={ent|def};] [ets={kl|nr|wr|an};]
- Parameters
- pfm={u|p};
- Specify email reception definitions for each platform. The default is p.
- p: Provides definitions for email reception in the Windows environment.
- u: Provides definitions for email reception in the UNIX environment.
- mlprf="profile-name";
- Specify one of the profile names set in the ProfileName1 to ProfileName4 environment setting parameters on the agent host on which the email reception monitoring job is executed.
- This parameter is valid only if you specify pfm=p;. Note also that this is a required parameter if you specify pfm=p;.
- You can set a character string of 1 to 256 bytes.
- If you want to use a double quotation mark (") or a number sign (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.
- For details about the environment setting parameters, see 2.2.4 Setting up the environment for the mail system linkage in the Job Management Partner 1/Automatic Job Management System 3 Linkage Guide.
- mladr="sender";
- Define the sender of email.
- You can set a character string of 1 to 256 bytes. You can specify up to 20 sender names at the same time in the format of mladr="sender";.
- You cannot omit all of mladr="sender";, mlsbj="subject"; and mltxt="text";. You must define at least one of the items.
- If you want to use a double quotation mark (") or a number sign (#) in the sender, prefix the character by #. That is, use #" instead of " and use ## instead of #.
- mlsbj="subject";
- Define the subject of received email.
- You can set a character string of 1 to 256 bytes. You can specify up to 20 subjects at the same time in the format of mlsbj="subject";.
- You cannot specify all of mladr="sender";, mlsbj="subject"; and mltxt="text";. You must define at least one of the items.
- If you want to use a double quotation mark (") or a number sign (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.
- mltxt="text";
- Define the text of received email.
- You can set a character string of 1 to 512 bytes. You can specify up to 20 messages at the same time in the format of mltxt="text";.
- You cannot specify all of mladr="sender";, mlsbj="subject"; and mltxt="text";. You must define at least one of the items.
- If you want to use a double quotation mark (") or a number sign (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.
- If a UNIX host performs email reception monitoring, do not enter a line feed in the text. The text containing a line feed becomes inconsistent with the email monitoring conditions, causing the system to remain in the email monitoring status.
- mlsav={y|n};
- Define whether to save received emails. The default is y. This parameter is valid only when you specify pfm=u;.
- y: Saves emails.
- n: Does not save emails.
- mllst="received-email-list";
- When creating a list of emails which match monitoring conditions, define a received-email list name. This parameter is valid only when you specify pfm=u;.
- You can set a character string of 1 to 255 bytes.
- If you want to use a double quotation mark (") or a number sign (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.
- mlstx="text-file-name";
- When saving received email text in a file, specify a file name. This parameter is valid only when you specify pfm=p;.
- You can set a character string of 1 to 256 bytes. Specify a full-path file name.
- If you want to use a double quotation mark (") or a number sign (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.
- mlsfd="name-of-folder-to-save-attached file";
- Define the folder name of a folder to save the attached file of received email. This parameter is valid only when you specify pfm=p;.
- You can set a character string of 1 to 256 bytes. Specify a full-path folder name.
- If you want to use a double quotation mark (") or a number sign (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.
- mlafl="list-file-name";
- Define the file name of a file to list the received attached file names for received email. This parameter is valid only when you specify pfm=p;.
- You can set a character string of 1 to 256 bytes. Specify a full-path file name.
- If you want to use a double quotation mark (") or a number sign (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.
- jpoif=?macro-variable-name?:take-over-information-name;
- Define a macro variable name in the ?AJS2xxxxxxxxx? format. That is, the character string xxxxxxxxx is preceded by AJS2 and it is entirely enclosed in a pair of question marks (?). Note that only uppercase alphabetic and numeric characters and periods (.) can be used in the xxxxxxxxx part.
- You can set a character string of 1 to 64 bytes as the macro variable name, which corresponds to the ?AJS2xxxxxxxxx? part.
- This parameter can contain up to 2,048 bytes in the "jpoif=?macro-variable-name?:take-over-information-name;" format.
- This parameter makes it possible to take over event information of subsequent Unix jobs, PC jobs, and action jobs.
- etm=n;
- Define the time-out period using the relative minutes from the start time. You can set 1 to 1,440 minutes. This parameter is invalid for a job within the start condition.
- fd=time-required-for-execution;
- Define the time-required-for-execution within which the job is expected to be terminated.
- You can specify a decimal value between 1 and 1,440 (minutes).
- ex="execution-agent-name";
- Define the name of the execution agent that is used to execute jobs. You can set a character string of 1 to 255 bytes.
- ha={y|n};
- Define whether to suspend job execution. The default is n. This parameter is invalid for a job within the start condition.
- y: Suspends jobnet execution.
- n: Does not suspend jobnet execution.
- eu={ent|def};
- Define the JP1 user who executes the job. The default is ent. This parameter is ignored in an event job.
- ent: The JP1 user who registered the jobnet executes the job.
- def: The JP1 user who owns the job executes the job.
- ets={kl|nr|wr|an};
- Define the state of the event job after the execution time-out period elapses. The default is kl. This parameter is invalid for a job within the start condition.
- kl: Killed
- nr: Ended normally
- wr: Ended with warning
- an: Ended abnormally
Copyright (C) 2009, 2010, Hitachi, Ltd.
Copyright (C) 2009, 2010, Hitachi Solutions, Ltd.