2.2.2 Setup for mail system linkage (when not using Outlook)

When linking with a mail system to send email without Outlook, perform the setup procedure described below on hosts that will execute email sending jobs.

If you intend to use Outlook to send email, or will be using email reception monitoring jobs to receive email, see 2.3 Setup for linking mail systems (for a Windows host when using Outlook).

Figure 2‒9: Setup for linking mail systems

Organization of this subsection

(1) Setting environment setting parameters
(2) Creating profiles
(3) Setting profile permissions
(4) Setting up the communication environment

(1) Setting environment setting parameters

Execute the following command to set the environment setting parameters required for mail system linkage:

jajs_config -k [{JP1_DEFAULT|logical-host-name}\JP1AOMAGENT\mail_link]
"environment-setting-parameter-1"=definition-content-1
["environment-setting-parameter-2"=definition-content-2]
["environment-setting-parameter-3"=definition-content-3]
["environment-setting-parameter-4"=definition-content-4]
["environment-setting-parameter-5"=definition-content-5]
["environment-setting-parameter-6"=definition-content-6]
["environment-setting-parameter-7"=definition-content-7]
["environment-setting-parameter-8"=definition-content-8]

You do not need to restart the JP1/AJS3 service after setting these parameters.

The table below describes each of the environment setting parameters required for environment system linkage.

Table 2‒1: Environment setting parameters used for mail system linkage
No.	Definition key	Environment setting parameter	Defined information
1	`[{JP1_DEFAULT\|logical-host-name}\JP1AOMAGENT\mail_link]`	`"EmbeddedMailSender"=`	Whether to run email sending jobs without Outlook
2		`"ConnectTimeout"=`	Connection timeout
3		`"RecvTimeout"=`	Timeout when waiting for a response
4		`"RetryInterval"=`	How long the system waits before trying again after an attempt to send an email fails
5		`"RetryCount"=`	How many times the system tries sending an email if previous attempts have failed
6		`"EmbeddedMailTimeout"=`	Timeout for email sending jobs
7		`"LogSize_EmbeddedMail"=`	Size of operations logs for sending email without using Outlook
8	`[JP1_DEFAULT\JP1AOMAGENT\mail_link]`	`"SendCutOffExcessiveData"=`	Whether to send an email whose data size exceeds a prescribed number of bytes

The following describes details of the environment setting parameter definitions:

"EmbeddedMailSender"="{Y|N}"

Specify whether to send emails without using Outlook.

If you specify Y in this parameter, JP1/AJS3 will send email without using Outlook regardless of the value specified in the ExecMode parameter.

If you specify N or omit this environment setting parameter, mail system linkage will operate using Outlook.

Specifiable values

Y

Send email without using Outlook.

N

Operate mail system linkage through Outlook.

Default value

N

Recommended value

Set a value appropriate for the operating environment.

When the setting takes effect

When an email sending job is executed.

Cautionary note

Make sure that all email sending jobs have ended before you change the setting for this parameter.

"ConnectTimeout"=dword:setting-value

When sending email without using Outlook, specify how long before the connection to the mail server times out.

Specifiable values: 000003E8 to 0036EE80 in hexadecimal (1,000 to 3,600,000 in decimal) (in milliseconds)
Default value: dword:00002710 (10,000 in decimal, which is 10 seconds)
Recommended value: Set a value appropriate for the operating environment.
When the setting takes effect: When an email sending job is executed.
Cautionary note: If you specify a small value for ConnectTimeout, a timeout might occur before the connection is completed, and a TCP/IP connection error might result. If the TCP/IP connection timeout period set in the OS is shorter than the period specified in this environment setting parameter, the setting in the OS overrides this environment setting parameter.

"RecvTimeout"=dword:setting-value

When sending email without using Outlook, specify how much time must pass before the system times out when waiting for a response from the mail server.

Specifiable values: 000003E8 to 0036EE80 in hexadecimal (1,000 to 3,600,000 in decimal) (in milliseconds)
Default value: dword:00002710 (10,000 in decimal, which is 10 seconds)
Recommended value: Set a value appropriate for the operating environment.
When the setting takes effect: When an email sending job is executed.

"RetryInterval"=dword:setting-value

When sending email without using Outlook, specify how long (in seconds) to wait after a failed attempt to send an email before trying again.

Specifiable values: 000003E8 to 0000EA60 in hexadecimal (1,000 to 60,000 in decimal) (in milliseconds)
Default value: dword:00001388 (5,000 in decimal, which is 5 seconds)
Recommended value: Set a value appropriate for the operating environment.
When the setting takes effect: When an email sending job is executed.

"RetryCount"=dword:setting-value

When sending email without using Outlook, specify how many times to try connecting to the mail server when previous attempts have failed.

Specifiable values: 00000000 to 000005A0 in hexadecimal (0 to 1,440 in decimal) (number of times)
Default value: dword:00000000 (0 in decimal)
Recommended value: Set a value appropriate for the operating environment.
When the setting takes effect: When an email sending job is executed.

"EmbeddedMailTimeout"=dword:setting-value

When sending email without using Outlook, specify the total time after which an email sending job times out.

Specifiable values: 00002710 to 0036EE80 in hexadecimal (10,000 to 3,600,000 in decimal) (in milliseconds)
Default value: dword:000927C0 (600,000 in decimal, which is 600 seconds)
Recommended value: Set a value appropriate for the operating environment.
When the setting takes effect: When an email sending job is executed.
Cautionary note: If the total size of the attachments for an email sending job exceeds 10 megabytes, specify a value in seconds of at least the attached file size (in megabyte) x 2.

"LogSize_EmbeddedMail"=dword:log-size

When sending email without using Outlook, specify the size of output log files.

Specifiable values: 00080000 to 009C3C00 in hexadecimal (524,288 to 10,238,976 in decimal) (in bytes)
Default value: dword:00200000 (2,097,152 in decimal) (in bytes)
Recommended value: Set a value appropriate for the operating environment.
When the setting takes effect: When an email sending job is executed.

"SendCutOffExcessiveData"="{Y|N}"

When executing an email sending job that contains a macro variable in the message text or subject line, specify whether to send the email with excess data truncated in the following cases:

The following data exceeds 512 bytes:

- The message text

- The character strings that replace the macro variables in the message text at job execution
The following data exceeds 256 bytes:

- The subject line

- The character strings that replace the macro variables in the subject line at job execution

Specifiable values

Y

The email sending job sends the email with the excess data truncated.

The message KAVT3207-W is output to the integrated trace log and the Execution Result Details dialog box.

N

The email sending job does not send the mail and its status changes to Ended abnormally.

The message KAVT4255-E is output to the Execution Result Details dialog box.

Default value

N

Recommended value

Set a value appropriate for the operating environment.

When the setting takes effect

When an email sending job is executed.

To Page Top

(2) Creating profiles

To create a profile, execute the jpomailprof command with the -add option and the necessary parameters (such as the source email address and the SMTP server name) specified in the command line. You can create a maximum of 16 profiles.

The following is an example of creating a profile with the name profile1 for a mail server that does not require authentication.

jpomailprof -add -n profile1 -m mail@mail.com -s smtp.com

To display a list of profiles or check the contents of a profile, execute the jpomailprof command with the -show option specified.

For details about the jpomailprof command, see jpomailprof (Windows only) in 3. Commands Used for Normal Operations in the manual JP1/Automatic Job Management System 3 Command Reference.

In a cluster environment, create profiles on the executing host only, while the shared disk is accessible. There is no need to create profiles on the standby host.

To Page Top

(3) Setting profile permissions

When you execute the jpomailprof command, JP1/AJS3 creates the following folder in which to store profiles and log files.

profile-storage-folder\sys\prf

In the command line above, replace profile-storage-folder with the value specified in the WaitInfFileOutDir environment setting parameter in the definition key [{JP1_DEFAULT|logical-host-name}\JP1AOMAGENT]. For details on the WaitInfFileOutDir parameter, see 20.6.2(14) WaitInfFileOutDir (for agent processes) in the JP1/Automatic Job Management System 3 Configuration Guide.

All users will initially have read, write, and delete permissions for the folder created by the jpomailprof command and its contents. If allowing all users to have read and write permissions is a problem in your environment, you can change the permissions for the folder and files provided that the following criteria are met.

Table 2‒2: Permissions required for the profile storage folder
Folder or file	Permission required by	Required permissions
`prf_path` folder Files in the `prf_path` folder	User with Administrators permission	Read Write Delete
`prf_path\profile-name` folder Folders and files in the `prf_path\profile-name` folder	User with Administrators permission OS user mapped to the JP1 user who executes email sending jobs that specify the profile with the same name as the `profile-name` folder.	Read Write Delete

Legend:: prf_path: The folder containing the profiles.
Cautionary note: In a cluster environment, these permissions must be assigned to users on the standby host as well as the executing host.

To Page Top

(4) Setting up the communication environment

The following describes the setup required to send email without using Outlook.

(a) Name resolution

Configure the hosts file or DNS so that the name of the mail server can be resolved.

If you send email without using Outlook, JP1/AJS3 will not reference the jp1hosts or jp1hosts2 information when performing name resolution.

If the host name resolves to multiple IP addresses, JP1/AJS3 will attempt to access each IP address in the order in which they were acquired until a connection is established.

(b) Firewall

Because email sending jobs communicate directly with the mail server, the firewall must be configured to allow communication between the execution host and the mail server.

As shown in the table below, the default port numbers and connection-target mail servers differ according to the used authentication method.

Table 2‒3: Connection-target port numbers
No.	Authentication method	Port number	Target mail server
1	None	25/tcp	SMTP server
2	POP before SMTP	110/tcp	POP3 server
2	POP before SMTP	25/tcp	SMTP server
3	SMTP-AUTH PLAIN or SMTP-AUTH LOGIN	587/tcp	SMTP server

For details on using JP1/AJS3 behind a firewall, see 2.3.2 Firewall and communication basics in the JP1/Automatic Job Management System 3 System Design (Configuration) Guide.

To Page Top