2.3.4 Setting up the environment for the mail system linkage

This subsection describes the environment setup procedure in JP1/AJS3 and items to be specified for linking a mail system on a Windows host.

Organization of this subsection

(1) Procedure for environment setup
(2) Registering the mail system linkage function
(3) Setting environment setting parameters for the mail system linkage function
(4) Environment setting parameters used by the mail system linkage function

(1) Procedure for environment setup

To set up the environment:

Register the mail system linkage function in Windows.

For details on how to register the mail system linkage function, see (2) Registering the mail system linkage function.
Set the environment setting parameters required by the mail system linkage function.

For details on setting these parameters, see (3) Setting environment setting parameters for the mail system linkage function.

For details on the environment setting parameters that the mail system linkage function uses, see (4) Environment setting parameters used by the mail system linkage function.
Set up Windows automatic logon.

If you are using desktop-based mail system linkage, set up Windows automatic logon as required. The user account specified in the Windows automatic logon settings will be used to execute the JP1/AJS3 mail monitoring process. At this stage, specify the user account that you used to create the profile. If you specify any other user account, the system cannot reference the profile when starting the JP1/AJS3 mail monitoring process, and cannot connect to the mail server. This prevents the JP1/AJS3 mail monitoring process from starting.

For details on how to set up Windows automatic logon, see the documentation provided by Microsoft.
Restart the JP1/AJS3 service and the JP1/AJS3 mail monitoring process or JP1/AJS3 Mail service.

After restarting the JP1/AJS3 service, restart the JP1/AJS3 mail monitoring process if implementing mail system linkage from the desktop, and the JP1/AJS3 Mail service if implementing mail system linkage with a service. The environment is set up with the defined information, and you can now use the mail system linkage function.

Also restart the process or service described above not only when mail system linkage is initially set up, but also after you have changed the settings of the environment setting parameters for mail system linkage. Restarting the process or service enables you to use mail system linkage with the new parameter settings.

To use Outlook 2019 or Outlook 2016, see 2.3.8(16) Notes regarding the use of Outlook 2019 and Outlook 2016.

To Page Top

(2) Registering the mail system linkage function

The following describes how to register the mail system linkage function in Windows.

When using the mail system linkage function from the desktop

The following shows the procedure for using the mail system linkage function from the desktop. Note that each user who has created a profile used for mail system linkage must log on separately to perform the following procedure:
1. Create a shortcut file for JP1/AJS3-installation-folder\bin\jpomldsk.exe.
2. Rename the shortcut file Mail Monitoring Process.
3. Store the shortcut file.
  
  Store the created shortcut file in the following folder:
  
  %USERPROFILE%\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\StartUp
  
  The default of the %USERPROFILE% value is system-drive\Users\user-name.
If you might terminate and then restart the mail monitoring process while you are logged on, use the following procedure to make it possible to start the process by opening the Windows Start menu, and then selecting Mail Monitoring Process:
1. Open the Windows Start screen.
2. If the Start screen does not include a shortcut to the mail monitoring process, create a shortcut, and then pin the shortcut you created to the Start screen or task bar.
Supplementary note

If you are no longer using the mail system linkage function on the desktop or if you have uninstalled JP1/AJS3, delete the folder and the shortcut file.
When using the mail system linkage function from a service

Execute the following command to register the JP1/AJS3 Mail service:
```
sc create JP1_AJS2_MAIL binPath= "\"JP1/AJS3-installation-folder\bin\jpomlsrv.exe\"" type= own start= demand error= normal obj= LocalSystem DisplayName= "JP1/AJS3 Mail"
```
For example, if JP1/AJS3 is installed in C:\Program Files (x86)\HITACHI\JP1AJS2, execute the command as follows:
```
sc create JP1_AJS2_MAIL binPath= "\"C:\Program Files (x86)\HITACHI\JP1AJS2\bin\jpomlsrv.exe\"" type= own start= demand error= normal obj= LocalSystem DisplayName= "JP1/AJS3 Mail"
```
Because the JP1/AJS3 Mail service must be run from the account that you used to log on to Windows when you created the profile used by the mail system linkage function, ensure that this user account is set in the properties window of the JP1/AJS3 Mail service.

The sc command is provided by Microsoft. For details on this command, see the Microsoft documentation.

Also, when you execute the sc command, specify the settings (other than the JP1/AJS3 installation folder name) as shown in the above example. If you change the settings other than the JP1/AJS3 installation folder name, you might not be able to use the mail system linkage function.

To Page Top

(3) Setting environment setting parameters for the mail system linkage function

Execute the following command:

jajs_config -k definition-key-name "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]
["environment-setting-parameter-9"=definition-content-9]
["environment-setting-parameter-10"=definition-content-10]
["environment-setting-parameter-11"=definition-content-11]
["environment-setting-parameter-12"=definition-content-12]

For details, see (4) Environment setting parameters used by the mail system linkage function.

To Page Top

(4) Environment setting parameters used by the mail system linkage function

The table below describes the environment setting parameters for the mail system linkage function that are related to event and action control. For details on the environment setting parameters that relate to event/action control in general, see 20.6 Setting up the event/action control environment in the JP1/Automatic Job Management System 3 Configuration Guide.

Parameters not described in the manual are intended for maintenance purposes. Do not change these values.

Table 2‒6: Environment setting parameters used for mail system linkage
No.	Definition key	Environment setting parameter	Defined information
1	`[JP1_DEFAULT\JP1AOMAGENT\mail_link]`	`"ExecMode"=`	Whether to use the mail system linkage function
2		`"ProfileName1"=`	The name of the profile used to log in to the mail system
3		`"ProfileName2"=`
4		`"ProfileName3"=`
5		`"ProfileName4"=`
6		`"WINMAILCLIENT"=`	Specify an Outlook client compatible with the linked mail system.
7		`"AfterReceiveMail"=`	Handling applied to received messages that match the monitoring conditions
8		`"NextAddress"=`	The type of information set as the `MLRCVADDRESS` passing information of the email reception monitoring job
9		`"ReceiveIntervalC"=`	Interval at which email reception is monitored
10		`"ImmediateSendRecv"=`	Whether to send and receive email immediately
11		`"SendCutOffExcessiveData"=`	Whether to send email if the data size exceeds the predefined number of bytes
12		`"WrapTextWithOutlookOption"=`	Whether to wrap message text according to the Outlook options

The following describes details of the environment setting parameter definitions:

(a) ExecMode

Specify whether to enable or disable the mail system linkage function. The default is N.

Format

"ExecMode"="{S|D|N}"

Specifiable values

S: Use the mail system linkage function with a service.
D: Use the mail system linkage function from the desktop.
N: Do not use the mail system linkage function.

Default value

N

Recommended value

Set a value appropriate for the operating environment.

When the setting takes effect

The next time the JP1/AJS3 service is started, or the next time the JP1/AJS3 mail monitoring process or the JP1/AJS3 Mail service is started.

(b) ProfileName1

Specify the name of the profile to use to log in to the mail system.

You can specify a maximum of four profiles using the parameters ProfileName1 to ProfileName4.

Specify a profile name that is different from the environment setting parameters ProfileName2 to 4. If profile names are not unique, you might not be able to use the mail system linkage function.

Format

"ProfileName1"="profile-name"

Specifiable values

A character string of no more than 256 bytes

Multi-byte characters are specifiable.

Default value

Blank

Recommended value

Set a value appropriate for the operating environment.

When the setting takes effect

The next time the JP1/AJS3 service is started, or the next time the JP1/AJS3 mail monitoring process or the JP1/AJS3 Mail service is started.

(c) ProfileName2

Specify a profile name that is different from the environment setting parameters ProfileName1, and 3 to 4. If profile names are not unique, you might not be able to use the mail system linkage function.

Format: "ProfileName2"="profile-name"

(d) ProfileName3

Specify a profile name that is different from the environment setting parameters ProfileName1 to 2, and 4. If profile names are not unique, you might not be able to use the mail system linkage function.

Format: "ProfileName3"="profile-name"

(e) ProfileName4

Specify a profile name that is different from the environment setting parameters ProfileName1 to 3. If profile names are not unique, you might not be able to use the mail system linkage function.

Format: "ProfileName4"="profile-name"

(f) WINMAILCLIENT

When using the mail system linkage function from the desktop, specify an Outlook client compatible with the linked mail system.

For details on the versions of Outlook that each mail system supports, see 2.3.1(1) Mail systems that support linkage.

The version of Outlook has no effect on the service-based mail system linkage function. For this reason, you do not need to set this parameter when using the mail system linkage function with a service.

Format

"WINMAILCLIENT"=dword:{2|3}

Specifiable values

2: Specify 2 to use the 32-bit edition of Outlook 2010.
3: Specify 3 to use the 32-bit edition of Outlook 2019, the 32-bit edition of Outlook 2016, or the 32-bit edition of Outlook 2013.

Default value

2: If JP1/AJS3 is installed as a new installation, 2 is the initial value. If JP1/AJS3 is installed as an overwrite installation, the previously set value is retained.

Recommended value

Specify 2, or 3 according to the operating environment.

When the setting takes effect

The next time the JP1/AJS3 service is started, or the next time the JP1/AJS3 mail monitoring process is started.

(g) AfterReceiveMail

Determine how to treat received mail that matches the monitoring conditions after the email reception monitoring job has terminated.

Format

"AfterReceiveMail"="{O|D}"

Specifiable values

O: Mail that matches the monitoring conditions is marked as read.
D: Mail that matches the monitoring conditions is deleted.

Default value

O

Recommended value

Set a value appropriate for the operating environment.

When the setting takes effect

The next time the JP1/AJS3 service is started, or the next time the JP1/AJS3 mail monitoring process is started.

(h) NextAddress

Select the type of information to be set in the passing information MLRCVADDRESS of the email reception monitoring job.

MLRCVADDRESS is information representing the sender specified in the email reception monitoring job.
This setting affects all email reception monitoring jobs that run on the host where the setting has been made.

For details about MLRCVADDRESS, see B. Information Passed by Event Jobs in the JP1/Automatic Job Management System 3 System Design (Work Tasks) Guide.

Format

"NextAddress"="{Address|Nickname}"

Specifiable values

Address

Sets the mail address as passing information.

If the Internet Mail profile is used, the succeeding email sending job can use the mail address as the destination.

Nickname

Sets the display name (nickname) as passing information.

If Exchange Server is specified in the profile as the connection destination, the succeeding email sending job can use the nickname as the destination.

If the connection destination specified in the profile is not Exchange Server, the succeeding email sending job inherits a null value.

Default value

Address

Recommended value

Set a value appropriate for the operating environment.

When the setting takes effect

The next time the JP1/AJS3 service is started, or the next time the JP1/AJS3 mail monitoring process or the JP1/AJS3 Mail service is started.

(i) ReceiveIntervalC

Specify the time interval for checking whether email has been received, as a hexadecimal value. Specify a value from 1 to 5A0 (in minutes).

Format: "ReceiveIntervalC"=dword:time-interval
Specifiable values: 1 to 5A0 in hexadecimal (1 to 1,440 in decimal) (in minutes)
Default value: A (10 in decimal) (in minutes)
Recommended value: Set a value appropriate for the operating environment.
When the setting takes effect: The next time the JP1/AJS3 service is started, or the next time the JP1/AJS3 mail monitoring process or the JP1/AJS3 Mail service is started.

(j) ImmediateSendRecv

Specify whether to send and receive mail immediately when using the mail system linkage function on the desktop.

Format

"ImmediateSendRecv"="{Y|N}"

Specifiable values

Y

When email sending and email reception monitoring jobs are running as JP1/AJS3 jobs, the Send/Receive button of Outlook can be used from JP1/AJS3 to immediately send and receive emails.

N

When email sending and email reception monitoring jobs are running as JP1/AJS3 jobs, Outlook is started from JP1/AJS3 and sending and receiving emails becomes the responsibility of Outlook.

Outlook sends and receives emails at the send and receive intervals defined as options in Outlook.

For details about the Outlook option settings, see the Help in Outlook.

After the jobs end, Outlook remains active and the Outlook icon remains on the taskbar.

Note that if Outlook is already running when a job starts, Outlook is not started a second time when the job starts.

Default value

Y

Recommended value

Set a value appropriate for the operating environment.

When the setting takes effect

The next time the JP1/AJS3 service is started, or the next time the JP1/AJS3 mail monitoring process is started.

For details about this parameter, see 2.3.5 Setup for operation while Outlook is running.

(k) SendCutOffExcessiveData

Specify whether to truncate mail data when the email sending job sends mail for which macro variables are defined in the body and subject line in the following cases:

When the following data length exceeds 512 bytes:

The length of the text in the body + the length of the character strings that replace the macro variables in the body during job execution
When the following data length exceeds 256 bytes:

The length of the text in the subject line + the length of the character strings that replace the macro variables in the subject line during job execution

Format

"SendCutOffExcessiveData"="{Y|N}"

Specifiable values

Y

The email sending job sends the mail minus the excess data.

The KAVT3207-W message, which reports that data has been truncated, is output to the integrated trace log and Execution Result Details dialog box.

N

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

The KAVT4255 message, which reports an invalid data length, is output to Execution Result Details dialog box.

Default value

N

Recommended value

Set a value appropriate for the operating environment.

When the setting takes effect

The next time the JP1/AJS3 service is started, or the next time the JP1/AJS3 mail monitoring process or the JP1/AJS3 Mail service is started.

(l) WrapTextWithOutlookOption

Specify whether to wrap text as defined in the Outlook options when you use mail system linkage from the desktop and connect to the mail server using standard Internet email protocols (SMTP/POP3).

Format

"WrapTextWithOutlookOption"="{Y|N}"

Specifiable values

Y: The message text of an email sending job is wrapped after the number of characters specified in the Automatically wrap text at field in the Internet Format dialog box, accessed from the Mail Format page of the Outlook options.
N: The message text of an email sending job is wrapped after 72 bytes.

Default value

N

Recommended value

Set a value appropriate for the operating environment.

When the setting takes effect

The next time the JP1/AJS3 service is started, or the next time the JP1/AJS3 mail monitoring process is started.

Cautionary notes

Text wrapping is applied to incoming email.
In the following circumstances, text wrapping is not applied regardless of the value specified in this parameter:

- You use the mail system linkage function from a service

- You connect to a mail server running Exchange Server

To Page Top