Hitachi

JP1 Version 12 JP1/Automatic Job Management System 3 Command Reference


5.2.18 Email sending job definition

This paragraph explains how to specify a definition for an email sending job.

The following gives the format of, and the parameters for an email sending job definition.

Format
[mladr={to|cc|bcc}:"address";]
[mlprf="profile-name";]
[mlsbj="subject";]
[mltx="text";]
[mlftx="text-file-name";]
[mlatf="attached-file-name";]
[mlafl="attached-file-list-name";]
[pfm={u|p};]
[etm=n;]
[fd=time-required-for-execution;]
[ex="execution-agent-name";]
[ha={y|n};]
[eu={ent|def};]
[jty={q|n};]
[mm={and|or};]
[nmg={y|n};]
[eun=name-of-the-unit-whose-end-is-being-waited-for;]
[ega={exec|execdeffer|none};]
[uem={y|n};]
Parameters
mladr={to|cc|bcc}:"address";

Define the email address of a destination.

In the format of mladr={to|cc|bcc}:"address";, you can set up to 20 email addresses at one time.

  • to: Sends email to a destination.

  • cc: Sends a copy of email to a destination.

  • bcc: Sends a blind carbon copy of email to a destination.

You can set a character string of 1 to 256 bytes for an address.

If you want to use a double quotation mark (") or a hash mark (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.

You can specify a macro variable in the address.

The following table lists the address formats you can use when pfm=p; is specified:

Profile type

Address format

Exchange Server#

  • Display name

  • Alias

  • Internet mail address

Internet mail

(SMTP/POP3)

Internet mail address

#

Email cannot be sent to X.400 format addresses.

The following is an example of an address in X.400 format:

c=JP;p=MailServer;o=Exchange;g=Taro;s=Hitachi;

If the host that executes the email sending job is a Windows host, and Outlook is used, specify no more than 255 characters for the destination. You can specify 256 or fewer bytes for the destination; however, if you specify 256 or more characters, only the first 255 characters will be assumed as the destination.

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 sending job is executed.

This parameter is valid only when you specify pfm=p;. This parameter becomes necessary item 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 hash mark (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.

You can specify a macro variable.

For details about the environment setting parameters, see 2.3.4 Setting up the environment for the mail system linkage in the JP1/Automatic Job Management System 3 Linkage Guide.

mlsbj="subject";

Define the subject of the email to be sent.

You can set a character string of 0 to 256 bytes.

If you want to use a double quotation mark (") or a hash mark (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.

You can specify a macro variable.

If the host that executes the email sending job is a Windows host, and Outlook is used, specify no more than 255 characters for the subject. You can specify 256 or fewer bytes for the subject; however, if you specify 256 or more characters, only the first 255 characters will be assumed as the subject name.

mltxt="text";

Define the text of the email to be sent.

You can specify a string of 1 to 512 bytes (including the number of linefeeds). In UNIX, the final line always contains a linefeed because without a linefeed, the final line is not handled as a line.

If you want to use a double quotation mark (") or a hash mark (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.

You can specify a macro variable.

mlftx="text-file-name";

Define the text file name of the email to be sent.

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 hash mark (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.

You can specify a macro variable.

mlatf="attached-file-name";

Define an attached file name. This parameter is valid only when you specify pfm=p;.

In the format of mlatf="attached-file-name";, you can set up to 20 file names at one time.

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 hash mark (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.

You can specify a macro variable.

For the format of a list of attached files, see 2.7.3 List of attached files to be sent (Windows only) in the JP1/Automatic Job Management System 3 Linkage Guide.

mlafl="attached-file-list-name";

Define a list file name for an attached file. 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 hash mark (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.

You can specify a macro variable.

pfm={u|p};

Define a platform type for job execution. The default is p.

  • u: UNIX environment

  • p: Windows environment

etm=n;

Define the time-out period using the relative minutes from the start time. You can set 1 to 1,440 minutes.

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 or execution agent group that is used to execute jobs.

You can set a character string of 1 to 255 bytes.

If you want to use a double quotation mark (") or a hash mark (#) as a character, prefix the character with #. That is, use #" instead of ", and use ## instead of #.

If the job has the queuing attribute (jty=q), you can specify a macro variable.

ha={y|n};

Define whether to suspend job execution. The default is n.

  • 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.

  • ent: The JP1 user who registered the jobnet executes the job.

  • def: The JP1 user who owns the job executes the job.

jty={q|n};

Define the queuing attribute type. If you do not specify this option, q is assumed.

  • q: The queuing attribute exists.

  • n: The queuing attribute does not exist.

mm={and|or};

Define the wait method with respect to the specified units whose ends are being waited for.

The default is and.

  • and: Start executing at completion of all units whose ends are being waited for.

  • or: Start executing at completion of one of the units whose ends are being waited for.

nmg={y|n};

Define the behavior when there are no generations of the root jobnet for the specified unit whose end is being waited for.

The default is n.

  • y: Start executing.

  • n: Do not start executing.

eun=name-of-the-unit-whose-end-is-being-waited-for;

Define the full-path name of a unit whose end is being waited for.

To specify multiple units, repeat the parameter. You can specify a maximum of 32 units.

You can use a character string of 1 to 930 bytes as the unit name.

ega={exec|execdeffer|none};

Specify the behavior when a jobnet with start conditions is specified as the jobnet whose end is being waited for and the execution generation ends abnormally.

If you omit this option, the system assumes none.

  • exec: Start executing.

  • execdeffer: Do not start executing. However, if the execution generation is in the Skipped so not exe. status, start executing.

  • none: Do not start executing.

uem={y|n};

Specify the behavior when a jobnet with start conditions is specified as the jobnet whose end is being waited for and the monitoring generation is in the Unmonitored + Ended status.

If you omit this option, the system assumes n.

  • y: Start executing.

  • n: Do not start executing.