Hitachi

JP1 Version 12 JP1/Service Support Configuration and Administration Guide


Email definition file (jp1imss_mail_setting.conf)

Organization of this page

Description

This file defines the email server, timing of email sending, sender, whether to send email by the function for sending email, and the subject and body of a sent email. It also defines whether to register Items by email, operation mode for registration, the details of email notification before deadlines, details of email notification of held Items, and the details of user authentication for sent email.

Format

hptl_jp1_imss_mail_server=Mail server
hptl_jp1_imss_mail_port=Port to use for email transmissions
hptl_jp1_imss_mail_user_max=Maximum number of users to whom you can send an email message in a batch
hptl_jp1_imss_mail_form_name=Name of the sender of an email message
hptl_jp1_imss_mail_form_address=Address of the sender of an email message
 
hptl_jp1_imss_mail_auth_method=Authentication method for sending email
hptl_jp1_imss_mail_smtp_auth_port=Submission port number for sending email by SMTP-AUTH authentication
hptl_jp1_imss_mail_smtp_user=User ID for sending email by POP before SMTP or SMTP-AUTH authentication
hptl_jp1_imss_mail_smtp_password=Password for sending email by POP before SMTP or SMTP-AUTH authentication
hptl_jp1_imss_mail_connect_timeout=Timeout time to wait for connection completion with the SMTP server and the POP3 server.
hptl_jp1_imss_mail_socket_timeout=Timeout time until a response is received from the SMTP server and the POP3 server.
 
hptl_jp1_imss_mail_charaset=Character encoding of email messages for notification before a deadline
hptl_jp1_imss_mail_notice_charaset=Character encoding of email messages for other than notification before a deadline
hptl_jp1_imss_mail_format=Email format
hptl_jp1_imss_mail_failure_display_flag=Whether to display a message in a window when email sending fails
 
hptl_jp1_imss_mail_user_delete_flag=Whether to send an email message when a user is deleted
hptl_jp1_imss_mail_user_delete_title=Title of an email message to be sent when a user is deleted
hptl_jp1_imss_mail_user_delete_text=Body of an email message to be sent when a user is deleted
 
hptl_jp1_imss_mail_role_delete_flag=Whether to send an email message when a role is deleted
hptl_jp1_imss_mail_role_delete_title=Title of an email message to be sent when a role is deleted
hptl_jp1_imss_mail_role_delete_text=Body of an email message to be sent when a role is deleted
 
hptl_jp1_imss_mail_item_create_flag=Whether to send an email message when an Item is created
hptl_jp1_imss_mail_item_create_title=Title of an email message to be sent when an Item is created
hptl_jp1_imss_mail_item_create_text=Body of an email message to be sent when an Item is created
 
hptl_jp1_imss_mail_item_escalation_flag=Whether to send an email message when an Item is escalated
hptl_jp1_imss_mail_item_escalation_title=Title of an email message to be sent when an Item is escalated
hptl_jp1_imss_mail_item_escalation_text=Body of an email message to be sent when an Item is escalated
 
hptl_jp1_imss_mail_item_charge_flag=Whether to send an email message when the person in charge is changed
hptl_jp1_imss_mail_item_charge_title=Title of an email message to be sent when the person in charge is changed
hptl_jp1_imss_mail_item_charge_text=Body of an email message to be sent when the person in charge is changed
 
hptl_jp1_imss_mail_item_close_flag=Whether to send an email message when an Item is closed
hptl_jp1_imss_mail_item_close_title=Title of an email message to be sent when an Item is closed
hptl_jp1_imss_mail_item_close_text=Body of an email message to be sent when an Item is closed
 
hptl_jp1_imss_mail_item_recall_flag=Whether to send an email message when an Item is recalled
hptl_jp1_imss_mail_item_recall_title=Title of an email message to be sent when an Item is recalled
hptl_jp1_imss_mail_item_recall_text=Body of an email message to be sent when an Item is recalled
 
hptl_jp1_imss_mail_item_sendback_flag=Whether to send an email message when an Item is sent back
hptl_jp1_imss_mail_item_sendback_title=Title of an email message to be sent when an Item is sent back
hptl_jp1_imss_mail_item_sendback_text=Title of an email message to be sent when an Item is sent back
 
hptl_jp1_imss_mail_inform_deadline_mail_maximum_num=Maximum number of Items to be described in an email message to the person in charge (Notification by email before a deadline)
hptl_jp1_imss_mail_inform_deadline_assigned_title=Title of an email message to the person in charge (Notification by email before a deadline)
hptl_jp1_imss_mail_inform_deadline_assigned_text=Body of an email message to the person in charge (Notification by email before a deadline)
hptl_jp1_imss_mail_inform_deadline_assigned_text_rep=Body of an email message to the person in charge (sections to be repeated) (Notification by email before a deadline)
hptl_jp1_imss_mail_inform_deadline_assigned_text_over=Body of an email message to the person in charge (when the maximum number of Items that are described in a message is exceeded) (Notification by email before a deadline)
hptl_jp1_imss_mail_inform_deadline_pwb_title=Title of an email message to the process work board manager (Notification by email before a deadline)
hptl_jp1_imss_mail_inform_deadline_pwb_text=Body of an email message to the process work board manager (Notification by email before a deadline)
 
hptl_jp1_imss_mail_inform_leave_mail_maximum_num=Maximum number of Items to be described in an email message to the person in charge (Notification of held Items by email)
hptl_jp1_imss_mail_inform_leave_assigned_title=Title of an email message to the person in charge (Notification of held Items by email)
hptl_jp1_imss_mail_inform_leave_assigned_text=Body of an email message to the person in charge (Notification of held Items by email)
hptl_jp1_imss_mail_inform_leave_assigned_text_rep=Body of an email message to the person in charge (sections to be repeated) (Notification of held Items by email)
hptl_jp1_imss_mail_inform_leave_assigned_text_over=Body of an email message to the person in charge (when the maximum number of Items that are described in a message is exceeded) (Notification of held Items by email)
hptl_jp1_imss_mail_inform_leave_pwb_title=Title of an email message to the process work board manager (Notification of held Items by email)
hptl_jp1_imss_mail_inform_leave_pwb_text=Body of an email message to the process work board manager (Notification of held Items by email)
 
hptl_jp1_imss_mail_use_jssitementrybymail=Whether to register an Item by mail
hptl_jp1_imss_mail_pop3_server=Email address of the POP3 server
hptl_jp1_imss_mail_pop3_port=Port number of the POP3 server
hptl_jp1_imss_mail_pop3_domain=Domain of a user who can register Items by email
hptl_jp1_imss_mail_pop3_address=Email address of a user who can register Items by email
hptl_jp1_imss_mail_pop3_user=User account of the mail server to which email messages for registering Items by mail are sent
hptl_jp1_imss_mail_pop3_password=Password for the mail server to which email messages for registering Items by email are sent
hptl_jp1_imss_mail_receive_number=Number of email messages to be obtained from a mail server at a time
hptl_jp1_imss_mail_messageid_maxlen=Message ID length of an email message that is used to suppress duplicated registration
hptl_jp1_imss_mail_tmp_file_max_size=Maximum size of a file in megabytes where an email message is saved temporally
hptl_jp1_imss_mail_tmp_file_max_num=Maximum number of files to be output as a file in which an email message is saved temporally
hptl_jp1_imss_mail_append_file_output_path=Path to the output destination folder of an attached file
hptl_jp1_imss_mail_append_file_output_folder_max=Maximum number of folders to which attached files are output
hptl_jp1_imss_mail_append_file_output_max_size=Maximum size of an attached file to be output
hptl_jp1_imss_mail_operation_mode=Operation mode for Item registration by email
hptl_jp1_imss_mail_source_address=Item element specification ID of the Item element to set the sender's email address
hptl_jp1_imss_mail_itemdata_set_form=Item element specification ID of the Item element to set the contents of the email text
hptl_jp1_imss_mail_format_error_string=String to be added to the beginning of the title of the Item if an error is detected in an element when the format of the email text was checked

Lines starting with a hash mark (#) are treated as comments.

File names

Storage folder

JP1/SS-path\conf

When the definition is applied

The definition is applied after the following JP1/Service Support services are restarted:

For the following commands, the definition is applied when they are executed:

#

For the jssitementry (registering an Item) command and the jssitemedit (editing an Item) command, the definition is applied when they are executed with the -mail option specified.

What is described

You can specify the specification keys described in the table below. Use an equal sign (=) to connect a specifiable key and its value.

Settings for the mail server and for sending email messages

Table 13‒52: List of specification keys that can be set in the email definition file (Settings for a mail server and for sending email messages)

Specification key name

Description

Default value

Specify or not

hptl_jp1_imss_mail_server

Specifies the name of the SMTP server to which you send email messages.

localhost

Δ

hptl_jp1_imss_mail_port

Specifies the port number of the SMTP server to which you send email messages.

A value from 1 to 65535 can be specified.

25

Δ

hptl_jp1_imss_mail_user_max

Specifies the maximum number of users to whom you can send an email message in a batch. If you want to send a message to users exceeding the number specified here, separate users by the number you specify here.

Specify a value from 0 to 1000.

When 0 is set, the maximum number of users to whom you can send a message is unlimited.

256

Δ

hptl_jp1_imss_mail_form_name

Specifies the email sender name that will be displayed by email software.

JP1/SS

Δ

hptl_jp1_imss_mail_form_address

Specifies the email address of the sender to be displayed by email software.

Example: administrator@hitachi.com

Note that even if you specify a wrong address, email messages are sent to the entered address.

--

Y

hptl_jp1_imss_mail_charaset

Specifies the character encoding of email notification before a deadline and email notification of held Items. Select from one of the following codes:

  • us-ascii: ANSI code

  • iso-8859-1: Latin 1 code

  • iso-2022-jp: JIS code

  • shift_jis: Shift JIS

  • euc-jp: EUC

  • utf-8: Unicode UTF-8

  • Windows-31J: Windows-31J

  • GB18030: GB18030 code

  • GB2312: GB2312 code

  • GBK: GBK code

In a Jananese environment:

iso-2022-jp

In an English environment:

ISO-8859-1

In a Chinese environment:

GB18030

Δ

hptl_jp1_imss_mail_notice_charaset

Specifies the character encoding of email messages(except notification before a deadline and regarding held Items) that are sent when the following operations are performed:

  • Creating an Item

  • Escalating an Item

  • Changing the person in charge

  • Closing an Item

  • Deleting a user

  • Deleting a role

You can specify one of the following codes:

  • us-ascii: ANSI code

  • iso-8859-1: Latin 1 code

  • iso-2022-jp: JIS code

  • shift_jis: Shift JIS

  • euc-jp: EUC

  • utf-8: Unicode UTF-8

  • Windows-31J: Windows-31J

  • GB18030: GB18030 code

  • GB2312: GB2312 code

  • GBK: GBK code

In a Jananese environment:

Windows-31J

In an English environment:

ISO-8859-1

In a Chinese environment:

GB18030

Δ

hptl_jp1_imss_mail_format

Specifies the email format.

text/plain

Δ

hptl_jp1_imss_mail_failure_display_flag

Specifies whether to display a message indicating that email sending failed in a window when the following email sending failed.

For ON, a message is displayed. For values other than ON, no message is displayed.

  • Item making notification#

  • Item escalation notification

  • Notification of change of the person in charge of an Item#

  • Item close notification#

  • Notification of recalled item

  • Notification of sent back item

#

When you execute a command with the email notification option specified and email sending fails, even if hptl_jp1_imss_mail_failure_display_flag is set to ON, no message is displayed in a window.

OFF

Δ

Legend:

Y: Must be specified.

Δ: Specify if necessary.

--: No default value

Settings of user authentication for sending email messages

Table 13‒53: List of specification keys that can be set in the email definition file (Settings of user authentication for sending email messages)

Specification key name

Description

Default value

Specify or not

hptl_jp1_imss_mail_auth_method

Specifies the authentication method for email sending.

  • none: No authentication

    User authentication is not performed for email sending.

  • pop-before-smtp: POP before SMTP authentication

    User authentication is performed by POP before SMTP authentication.

  • smtp-auth: SMTP-AUTH authentication

    User authentication is performed by SMTP-AUTH authentication.

none

Y

hptl_jp1_imss_mail_smtp_auth_port

Specifies the submission port number for email sending when you use SMTP-AUTH authentication for user authentication.

587

Δ

hptl_jp1_imss_mail_smtp_user

Specifies the user ID for email sending when you use POP before SMTP or SMTP-AUTH authentication for user authentication.

At this time, set the value of hptl_jp1_imss_mail_smtp_user by executing the jssauthusersetup command. For details about the jssauthusersetup command, see jssauthusersetup (authentication-user setting) in Chapter 12. Commands.

--

Δ

hptl_jp1_imss_mail_smtp_password

Specifies the password for email sending when you use POP before SMTP or SMTP-AUTH authentication for user authentication.

At this time, set the value of hptl_jp1_imss_mail_smtp_password by executing the jssauthusersetup command. Executing the command changes the specified value to the program-converted value. For details about the jssauthusersetup command, see jssauthusersetup (authentication-user setting) in Chapter 12. Commands.

--

Δ

hptl_jp1_imss_mail_connect_timeout

Specifies timeout time to wait for connection completion with the SMTP server and the POP3 server in milliseconds.

Specify a value from 1000 to 3600000.

10000

Δ

hptl_jp1_imss_mail_socket_timeout

Specifies timeout time until a response is received from the SMTP server and the POP3 server in milliseconds.

Specify a value from 1000 to 3600000.

10000

Δ

Legend:

Y: Must be specified.

Δ: Specify if necessary.

--: No default value

Settings for sending an email message when a user is deleted

Table 13‒54: List of specification keys that can be set in the email definition file (Settings for sending an email message when a user is deleted)

Specification key name

Description

Default value

Specify or not

hptl_jp1_imss_mail_user_delete_flag

Specifies whether to send an email message when a user is deleted. When ON is set, the message is sent. When a value other than ON is set, the message is not sent.

OFF

Δ

hptl_jp1_imss_mail_user_delete_title

Specifies the title of the email message to be sent when a user is deleted.

You can specify a string that does not contain control characters (0x00 to 0x1F, and 0x7F). The title can be replaced with variables.#

If you want to use %, specify %%.

If you specify \\, they are converted to \.

If you specify \ only, it is not displayed.

[ User deletion notification ]

Δ

hptl_jp1_imss_mail_user_delete_text

Specifies the body of the email message to be sent when a user is deleted.

The body can be replaced with variables.#

You can specify a string that does not contain control characters (0x00 to 0x1F, and 0x7F).

If you want to use %, specify %%.

If you want to use a linefeed character, specify \n.

If you want to use a tab, specify \t.

If you specify \\, they are converted to \.

If you specify \ only (the next character is other than n, t, or \), it is not displayed.

User [%USERID%(%USERNAME%)] was deleted. \nPlease confirm the item that relates to the user [%USERID%(%USERNAME%)].

Δ

Legend:

Δ: Specify if necessary.

#

For details about variables, see Converting information by using variables.

Settings for sending an email message when a role is deleted

Table 13‒55: List of specification keys that can be set in the email definition file (Settings for sending an email message when a role is deleted)

Specification key name

Description

Default value

Specify or not

hptl_jp1_imss_mail_role_delete_flag

Specifies whether to send an email message when a role is deleted. When ON is set, the message is sent. When a value other than ON is set, the message is not sent.

OFF

Δ

hptl_jp1_imss_mail_role_delete_title

Specifies the title of the email message to be sent when a role is deleted.

You can specify a string that does not contain control characters (0x00 to 0x1F, and 0x7F). The title can be replaced with variables.#

If you want to use %, specify %%.

If you specify \\, they are converted to \.

If you specify \ only, it is not displayed.

[ Roll deletion notification ]

Δ

hptl_jp1_imss_mail_role_delete_text

Specifies the body of the email message to be sent when a role is deleted.

You can specify a string that does not contain control characters (0x00 to 0x1F, and 0x7F). You can use a variable to replace the body.#

If you want to use %, specify %%.

If you want to use a linefeed character, specify \n.

If you want to use a tab, specify \t.

If you specify \\, they are converted to \.

If you specify \ only (the next character is other than n, t, or \), it is not displayed.

Roll [%ROLEID%(%ROLENAME%)] was deleted. \nPlease confirm the item that relates to the roll [%ROLEID%(%ROLENAME%)].

Δ

Legend:

Δ: Specify if necessary.

#

For details about variables, see Converting information by using variables.

Settings for sending an email message when an Item is created

Table 13‒56: List of specification keys that can be set in the email definition file (Settings for sending an email message when an Item is created)

Specification key name

Description

Default value

Specify or not

hptl_jp1_imss_mail_item_create_flag

Specifies whether to send an email message when an Item is created. When ON is set, the message is sent. When a value other than ON is set, the message is not sent.

OFF

Δ

hptl_jp1_imss_mail_item_create_title

Specifies the title of the email message to be sent when an Item is created.

You can specify a string that does not contain control characters (0x00 to 0x1F, and 0x7F). The title can be replaced with variables.#

If you want to use %, specify %%.

If you specify \\, they are converted to \.

If you specify \ only, it is not displayed.

[ Item making notification %ITEMID% ]%TITLE%

Δ

hptl_jp1_imss_mail_item_create_text

Specifies the body of the email message to be sent when an Item is created.

You can specify a string that does not contain control characters (0x00 to 0x1F, and 0x7F). The body can be replaced with a variables.#

If you want to use %, specify %%.

If you want to use a linefeed character, specify \n.

If you want to use a tab, specify \t.

If you specify \\, they are converted to \.

If you specify \ only (the next character is other than n, t, or \), it is not displayed.

[%SYSTEM%] The new item was made in the [%PROCESS%] process of the system. \nItem ID:%ITEMID%\nTitle: %TITLE%\nPriority: %PRIORITY%\nStatus: %STATUS%\nPerson in charge: %CHARGE%\nDeadline: %PERIOD%\n

Δ

Legend:

Δ: Specify when necessary.

#

For details about variables, see Converting information by using variables.

Settings for sending an email message when an Item is escalated

Table 13‒57: List of specification keys that can be set in the email definition file (Settings for sending an email when an Item is escalated)

Specification key name

Description

Default value

Specify or not

hptl_jp1_imss_mail_item_escalation_flag

Specifies whether to send an email message when an Item is escalated. When ON is set, the message is sent. When a value other than ON is set, the message is not sent.

OFF

Δ

hptl_jp1_imss_mail_item_escalation_title

Specifies the title of the email message to be sent when an Item is escalated.

You can specify a string that does not contain control characters (0x00 to 0x1F, and 0x7F). The title can be replaced with variables.#

If you want to use %, specify %%.

If you specify \\, they are converted to \.

If you specify \ only, it is not displayed.

[ Item escalation notification %ITEMID% ]%TITLE%

Δ

hptl_jp1_imss_mail_item_escalation_text

Specifies the body of the email message to be sent when an Item is escalated.

You can specify a string that does not contain control characters (0x00 to 0x1F, and 0x7F). The body can be replaced with a variables.#

If you want to use %, specify %%.

If you want to use a linefeed character, specify \n.

If you want to use a tab, specify \t.

If you specify \\, they are converted to \.

If you specify \ only (the next character is other than n, t, or \), it is not displayed.

[%SYSTEM%] The item was done in the [%PROCESS%] process of the system and escalation was done. \nItem ID:%ITEMID%\nTitle: %TITLE%\nPriority: %PRIORITY%\nStatus: %STATUS%\nPerson in charge: %CHARGE%\nDeadline: %PERIOD%\n

Δ

Legend:

Δ: Specify if necessary.

#

For details about variables, see Converting information by using variables.

Title and body of the message to be sent when the person in charge is changed

Table 13‒58: List of specification keys that can be set in the email definition file (Title and body of a message to be sent when the person in charge is changed)

Specification key name

Description

Default value

Specify or not

hptl_jp1_imss_mail_item_charge_flag

Specifies whether to send an email message when the person in charge is changed. When ON is set, the message is sent. When a value other than ON is set, the message is not sent.

OFF

Δ

hptl_jp1_imss_mail_item_charge_title

Specifies the title of the email message to be sent when the person in charge is changed.

You can specify a string that does not contain control characters (0x00 to 0x1F, and 0x7F). The title can be replaced with variables.#

If you want to use %, specify %%.

If you specify \\, they are converted to \.

If you specify \ only, it is not displayed.

[ Item change of the person in charge notification %ITEMID% ]%TITLE%

Δ

hptl_jp1_imss_mail_item_charge_text

Specifies the message body to be sent when the person in charge is changed.

You can specify a string that does not contain control characters (0x00 to 0x1F, and 0x7F). The body can be replaced with variables.#

If you want to use %, specify %%.

If you want to use a linefeed character, specify \n.

If you want to use a tab, specify \t.

If you specify \\, they are converted to \.

If you specify \ only (the next character is other than n, t, or \), it is not displayed.

The person in charge of the item of [Item ID:%ITEMID%] changed. \nSystem: %SYSTEM%\nProcess: %PROCESS%\nTitle: %TITLE%\nPriority: %PRIORITY%\nStatus: %STATUS%\nPerson in charge: %CHARGE%\nDeadline: %PERIOD%\n

Δ

Legend:

Δ: Specify if necessary.

#

For details about variables, see Converting information by using variables.

Title and body of an email message to be sent when an Item is closed

Table 13‒59: List of specification keys that can be set in the email definition file (Title and body of a message to be sent when an Item is closed)

Specification key name

Description

Default value

Specify or not

hptl_jp1_imss_mail_item_close_flag

Specifies whether to send an email message when an Item is closed. When ON is set, the message is sent. When a value other than ON is set, the message is not sent.

OFF

Δ

hptl_jp1_imss_mail_item_close_title

Specifies the title of the email message to be sent when an Item is closed.

You can specify a string that does not contain control characters (0x00 to 0x1F, and 0x7F). The title can be replaced with variables.#

If you want to use %, specify %%.

If you specify \\, they are converted to \.

If you specify \ only, it is not displayed.

[ Item close notification %ITEMID% ]%TITLE%

Δ

hptl_jp1_imss_mail_item_close_text

Specifies the message body to be sent when an Item is closed.

You can specify a string that does not contain control characters (0x00 to 0x1F, and 0x7F). The body can be replaced with variables.#

If you want to use %, specify %%.

If you want to use a linefeed character, specify \n.

If you want to use a tab, specify \t.

If you specify \\, they are converted to \.

If you specify \ only (the next character is other than n, t, or \), it is not displayed.

The item of [Item ID:%ITEMID%] was closed. \nSystem: %SYSTEM%\nProcess: %PROCESS%\nTitle: %TITLE%\nPriority: %PRIORITY%\nStatus: %STATUS%\nPerson in charge: %CHARGE%\nDeadline: %PERIOD%\n

Δ

Legend:

Δ: Specify if necessary.

#

For details about variables, see Converting information by using variables.

List of specification keys that can be set in the email definition file (Title and body of an email message to be sent when an Item is recalled)

Table 13‒60: List of specification keys that can be set in the email definition file (Title and body of an email message to be sent when an Item is recalled)

Specification key name

Description

Default value

Specify or not

hptl_jp1_imss_mail_item_recall_flag

Specifies whether to send an email message when an Item is recalled. For ON, an email message is sent. For values other than ON, no email message is sent.

OFF

Δ

hptl_jp1_imss_mail_item_recall_title

Specifies the title of an email message to be sent when an Item is recalled.

You can specify character strings except for control characters (0x00 to 0x1F, 0x7F). Characters in a title can be replaced by a variable.#

If you want to use %, specify %%.

If you specify \\, the string is converted to \.

If you specify only \, nothing is displayed.

[ Item recalled notification %ITEMID% ]%TITLE%

Δ

hptl_jp1_imss_mail_item_recall_text

Specifies the body of an email message to be sent when an Item is recalled.

You can specify character strings except for control characters (0x00 to 0x1F, 0x7F). Characters in a body can be replaced by a variable.#

If you want to use %, specify %%.

If you want to use a line feed code, specify \n.

If you want to use a tab character, specify \t.

If you specify \\, the string is converted to \.

If you specify only \ (and the next character is not n, t, or \), nothing is displayed.

The item [Item ID:%ITEMID%] was successfully recalled. \nSystem: %SYSTEM%\nProcess: %PROCESS%\nTitle: %TITLE%\nPriority: %PRIORITY%\nStatus: %STATUS%\nPerson in charge: %CHARGE%\nDeadline: %PERIOD%\n

Δ

Legend:

Δ: Specify if necessary.

#

For details about variables, see Converting information by using variables.

List of specification keys that can be set in the email definition file (Title and body of an email message to be sent when an Item is sent back)

Table 13‒61: List of specification keys that can be set in the email definition file (Title and body of an email message to be sent when an Item is sent back)

Specification key name

Description

Default value

Specify or not

hptl_jp1_imss_mail_item_sendback_flag

Specifies whether to send an email message when an Item is sent back. For ON, an email message is sent. For values other than ON, no email message is sent.

OFF

Δ

hptl_jp1_imss_mail_item_sendback_title

Specifies the title of an email message to be sent when an Item is sent back.

You can specify character strings except for control characters (0x00 to 0x1F, 0x7F). Characters in a title can be replaced by a variable.#

If you want to use %, specify %%.

If you specify \\, the string is converted to \.

If you specify only \, nothing is displayed.

[ Item sent back notification %ITEMID% ]%TITLE%

Δ

hptl_jp1_imss_mail_item_sendback_text

Specifies the body of an email message to be sent when an Item is sent back.

You can specify character strings except for control characters (0x00 to 0x1F, 0x7F). Characters in a body can be replaced by a variable.#

If you want to use %, specify %%.

If you want to use a line feed code, specify \n.

If you want to use a tab character, specify \t.

If you specify \\, the string is converted to \.

If you specify only \ (and the next character is not n, t, or \), nothing is displayed.

The item [Item ID:%ITEMID%] was successfully sent back. \nSystem: %SYSTEM%\nProcess: %PROCESS%\nTitle: %TITLE%\nPriority: %PRIORITY%\nStatus: %STATUS%\nPerson in charge: %CHARGE%\nDeadline: %PERIOD%\n

Δ

Legend:

Δ: Specify if necessary.

#

For details about variables, see Converting information by using variables.

Settings for sending notification by email before a deadline

Table 13‒62: List of specification keys that can be set in the email definition file (Settings for sending notification by email before the deadline)

Specification key name

Description

Default value

Specify or not

hptl_jp1_imss_mail_inform_deadline_mail_maximum_num

Specifies the maximum number of Items to be sent by an email message to the person in charge of notification by mail before the deadline.

A half-width integer from 1 to 100 can be specified.

20

Δ

hptl_jp1_imss_mail_inform_deadline_assigned_title

Specifies the title of the email message to be sent to the person in charge of notification before the deadline.

[Notification of deadline for person in charge] The item deadline is approaching.

Δ

hptl_jp1_imss_mail_inform_deadline_assigned_text

Specifies the body of the message to be sent to the person in charge of notification by email before the deadline.#

If you want to use %, specify %%.If you want to use a linefeed character, specify \n.

The number of items whose deadlines are approaching is %ITEMNUM_ASSIGNED%.\n

The number of items whose priority is Very urgent is %ITEMNUM_PRIHIGH_ASSIGNED%.\n

The number of items whose priority is urgent is %ITEMNUM_PRIMID_ASSIGNED%.\n

The number of items whose priority is standard is %ITEMNUM_PRINOR_ASSIGNED%.\n

System: %SYSTEM%\nProcess: %PROCESS%\n--------\n

Δ

hptl_jp1_imss_mail_inform_deadline_assigned_text_rep

Specifies the body (sections to be repeated) of the message to the person in charge of notification by email before the deadline.#

If you want to use %, specify %%.If you want to use a linefeed character, specify \n.

The deadline of the item, %ITEMID%, is approaching. \nTitle: %TITLE%\n

Priority: %PRIORITY%\nStatus: %STATUS%\nPerson in charge: %CHARGE%\nDeadline: %PERIOD%\n--------\n

Δ

hptl_jp1_imss_mail_inform_deadline_assigned_text_over

Specifies the body of the email message which is output when the maximum number of Items that are described in a single message is exceeded to a person in charge of notification by email that the deadline is coming closer.#

If you want to use %, specify %%.If you want to use a linefeed character, specify \n.

The number of items that can be displayed in this notification exceeded the upper limit.\nThere are %ITEMNUM_ASSIGNED_REMAIN% items whose deadlines are approaching.\n

Δ

hptl_jp1_imss_mail_inform_deadline_pwb_title

Specifies the title of the email message notifying that the deadline is coming closer to a process work board manager #

If you want to use %, specify %%.If you want to use a linefeed character, specify \n.

[Notification of deadline for process work board administrator] The deadlines of %ITEMNUM_PWB% items are approaching.

Δ

hptl_jp1_imss_mail_inform_deadline_pwb_text

Specifies the body of the email message notifying that the deadline is coming closer to a process work board manager.#

If you want to use %, specify %%.If you want to use a linefeed character, specify \n.

This email notifies you of the number of items whose deadlines are approaching.\nNumber of days before deadline: Before %BEFORE_DAYS% days\nEmail notifications frequency setting: %SEND_FREQUENCY%\nSystem: %SYSTEM%\nProcess: %PROCESS%\nNumber of items: %ITEMNUM_PWB% items:\n The number of items whose priority is very urgent is %ITEMNUM_PRIHIGH_PWB%.\n The number of items whose priority is urgent is %ITEMNUM_PRIMID_PWB%.\n The number of items whose priority is standard is %ITEMNUM_PRINOR_PWB%.\n

Δ

Legend:

Δ: Specify if necessary.

#

For details about variables, see Converting information by using variables.

Settings for sending notification of held Items by email

Table 13‒63: List of specification keys that can be set in the email definition file (Settings for sending notification of held Items by email)

Specification key name

Description

Default value

Specify or not

hptl_jp1_imss_mail_inform_leave_mail_maximum_num

Specifies the maximum number of Items to be sent by a single email message to the person in charge of notification of held Items by email.

A half-width integer from 1 to 100 can be specified.

20

Δ

hptl_jp1_imss_mail_inform_leave_assigned_title

Specifies the title of the email message to be sent to the person in charge of notification of held Items by email.

[Notification of held item for person in charge] The processing of the item is delayed.

Δ

hptl_jp1_imss_mail_inform_leave_assigned_text

Specifies the body of the email message to be sent to the person in charge of notification of held Items by email.#

If you want to use %, specify %%.If you want to use a linefeed character, specify \n.

The number of items whose processing is delayed is %ITEMNUM_ASSIGNED%.\n%ITEMNUM_LEAVE_DETAIL%\nPriority to be monitored: %PRIORITY_LIST%\nTime when item is not updated:\n%ITEM_LEAVE_THRESHOLD%\nSystem: %SYSTEM%\nProcess: %PROCESS%\n--------\n

Δ

hptl_jp1_imss_mail_inform_leave_assigned_text_rep

Specifies the body (the part to be repeated) of the email message to be sent to the person in charge of notification of held Items by email.#

If you want to use %, specify %%.If you want to use a linefeed character, specify \n.

The processing of the item, %ITEMID%, is delayed.\nTitle: %TITLE%\nPriority: %PRIORITY%\nStatus: %STATUS%\nPerson in charge: %CHARGE%\nUpdate date and time: %LASTUPDATE%\n--------\n

Δ

hptl_jp1_imss_mail_inform_leave_assigned_text_over

Specifies the body of the email message to the person in charge notification of held Items by email, which is sent when the maximum number of Items that are described in a single message is exceeded.#

If you want to use %, specify %%.If you want to use a linefeed character, specify \n.

The number of items that can be displayed in this notification exceeded the upper limit.\nThere are %ITEMNUM_ASSIGNED_REMAIN% items whose processing is delayed.\n

Δ

hptl_jp1_imss_mail_inform_leave_pwb_title

Specifies the title of the email message to the person in charge of notification of held Items by email.#

If you want to use %, specify %%.If you want to use a linefeed character, specify \n.

[Notification of the number of held items for process work board administrator] %ITEMNUM_PWB% items are delayed in processing.

Δ

hptl_jp1_imss_mail_inform_leave_pwb_text

Specifies the body of the email message to be sent to the process work board manager for notification of held Items by email.#

If you want to use %, specify %%.If you want to use a linefeed character, specify \n.

This email notifies you of the number of items whose processing is delayed.\nThe number of items whose processing is delayed is %ITEMNUM_PWB%.\n%ITEMNUM_LEAVE_DETAIL%\nPriority to be monitored: %PRIORITY_LIST%\nTime when item is not updated: \n%ITEM_LEAVE_THRESHOLD%\nSystem: %SYSTEM%\nProcess: %PROCESS%\n

Δ

Legend:

Δ: Specify if necessary.

#

For details about variables, see Converting information by using variables.

Settings for registering Items by email

Table 13‒64: List of specification keys in the email definition file (Settings for registering Items by email)

Specification key name

Description

Default value

Specify or not

hptl_jp1_imss_mail_use_jssitementrybymail

Specifies whether to allow use of a command to register Items by email. When a value other than ON is set, the command cannot be used to register Items by email.

OFF

Y

hptl_jp1_imss_mail_pop3_server

Specifies the address of the POP3 server.

--

Δ

hptl_jp1_imss_mail_pop3_port

Specifies the port number of the POP3 server.

Specify a half-width integer from 1 to 65535.

110

Y

hptl_jp1_imss_mail_pop3_domain

Specifies the domain of a user who can register Items by email. To specify multiple users, separate them with semicolons (;). You can specify a maximum of 100 domains (strings that conform to RFC822).#1

--

Δ

hptl_jp1_imss_mail_pop3_address

Specifies the email address of a user who can register Items by email. To specify multiple users, separate them with semicolons (;). You can specify a maximum of 1,000 email addresses (strings that conforms to RFC822).#1

--

Y

hptl_jp1_imss_mail_pop3_user

Specifies the user account of a mail server to which an email message for registering Items by mail is sent.

At this time, set the value of hptl_jp1_imss_mail_pop3_user by executing the jssauthusersetup command. For details about the jssauthusersetup command, see jssauthusersetup (authentication-user setting) in Chapter 12. Commands.

--

Y

hptl_jp1_imss_mail_pop3_password

Specifies the password for a mail server to which an email message for registering an Item by email is sent.

At this time, set the value of hptl_jp1_imss_mail_pop3_password by executing the jssauthusersetup command. Executing the command changes the specified value to the program-converted value.

--

Y

hptl_jp1_imss_mail_receive_number

Specifies the number of email messages to be obtained from the mail server at a time.

Specify a half-width integer from 1 to 100.

50

Y

hptl_jp1_imss_mail_messageid_maxlen

Specifies the message ID length (in bytes) of an email message that is used to suppress duplicated registration.

Specify a half-width integer from 1 to 255.

64

Y

hptl_jp1_imss_mail_tmp_file_max_size

Specifies the maximum size of a file where an email message is saved temporarily (in megabytes).

Specify a half-width integer from 1 to 10.

5

Y

hptl_jp1_imss_mail_tmp_file_max_num

Specifies the maximum number of files to be output as a file in which an email message is saved temporarily.

Specify a half-width integer from 1 to 200.

100

Y

hptl_jp1_imss_mail_append_file_output_path

Specifies the path to the output destination folder for the attached file(s) within 100 characters. Separate paths with slashes (/).

--

Y

hptl_jp1_imss_mail_append_file_output_folder_max

Specifies the maximum number of folders to which attached files can be output.

Specify a half-width integer from 1 to 999.

200

Y

hptl_jp1_imss_mail_append_file_output_max_size

Specifies the maximum size of an attached file that can be output (in megabytes).

Specify a half-width integer from 1 to 5.

5

Y

hptl_jp1_imss_mail_operation_mode

Specifies the operation mode for Item registration by email.

  • apd: Attached-file mode

    The text of an email message is registered as an attached file in an Item.

  • single: Single-element mode

    The text of an email message is set in an Item element to be registered.

  • multi: Multi-element mode

    In the text of an email message in XML format, the contents enclosed by the start tag and the end tag are set in each element of an Item to be registered.

apd

Y

hptl_jp1_imss_mail_source_address

Specifies the Item element specification ID of the Item element to set the sender's email address. #2

You can specify Item element specification IDs whose Item elements are text type or textarea type.

--

Δ

hptl_jp1_imss_mail_itemdata_set_form

Specifies the Item element specification ID of the Item element to set the contents of the email text only if the operation mode for Item registration by email is single-element mode. #2

You can specify Item element specification IDs whose Item elements are textarea type.

SUMMARY

Δ

hptl_jp1_imss_mail_format_error_string

Specifies a string within 20 bytes to be added to the beginning of the title of the Item if an error is detected in an element when the format of the email text is checked. Specify this key only when the operation mode for Item registration by email is single-element or multi-element mode. Note that if the specified string contains a full-width character, the character is converted into 3 or 4 bytes.

[!]

Δ

Legend:

Y: Must be specified.

Δ: Specify if necessary.

--: No default value

#1

If both hptl_jp1_imss_mail_pop3_domain and hptl_jp1_imss_mail_pop3_address are specified, Item registration will be requested by emails with both of those specifications.

#2

For details about the specifiable Item elements and Item element specification IDs, see 3.5.3 Creating an Item by sending an email.

Converting information by using variables

For the title and body of an email message, you can specify information contained in Item information by using variables. When an email message is sent, variables are converted to information contained in Item information. To describe variables, use a format like %USERID%. The following table lists the variables you can use and the table after that shows the results after conversion.

Table 13‒65: Variables you can use in the title or body of email messages

Information to be sent

Name of keys for which variables can be specified

Specifiable variable name

User deletion

  • hptl_jp1_imss_mail_user_delete_title

  • hptl_jp1_imss_mail_user_delete_text

%USERID%

%USERNAME%

Role deletion

  • hptl_jp1_imss_mail_role_delete_title

  • hptl_jp1_imss_mail_role_delete_text

%ROLEID%

%ROLENAME%

Item creation

  • hptl_jp1_imss_mail_item_create_title

  • hptl_jp1_imss_mail_item_create_text

%ITEMID%

%TITLE%

%SYSTEM%

%PROCESS%

%PROCESSITEMID%

%SEVERITY%

%SEVERITYREASON%

%IMPACT%

%IMPACTREASON%

%PRIORITY%

%PRIORITYREASON%

%ITEMCATEGORY%

%ISSUECATEGORY%

%CHANGESCALE%

%RELEASETYPE%

%STATUS%

%RESULT%

%ACCRUALDATE%

%PHENOMENON%

%SOLUTION%

%REGISTRANT%

%REGISTDATE%

%CHARGE%

%PERIOD%

%RESPONDENT%

%STARTDATE%

%COMPDATE%

%CUSTOMERNAME%

%INQUIRYNAME%

%ESTIMATEDCOST%

%ACTUALCOST%

%EFFECTSERVICE%

(Cannot be specified for the email title.)

%FAILURELOCATION%

(Cannot be specified for the email title.)

%SUMMARY%

(Cannot be specified for the email title.)

%AVOIDANCECODE%

%AVOIDANCE%

(Cannot be specified for the email title.)

%SITUATION%

(Cannot be specified for the email title.)

%MEASURES%

(Cannot be specified for the email title.)

%CAUSE%

%ROOTCAUSE%

(Cannot be specified for the email title.)

%SOLUTION%

(Cannot be specified for the email title.)

%SCHEDULE%

(Cannot be specified for the email title.)

%IMPACTEVAL%

(Cannot be specified for the email title.)

%DELIBERATIONRST%

(Cannot be specified for the email title.)

%FREEDESCRIPTION%

(Cannot be specified for the email title.)

%JP1PRODUCTNAME%

%JP1JOBNETNAME%

%JP1JOBNAME%

%JP1SNMPSRC%

%JP1NODENAME%

%JP1ALARMNAME%

%LASTUPDATE%

%IMEVENTNO%

%IMHOSTNAME%

%USERTEXT01% to %USERTEXT20%

(Cannot be specified for the email title.)

%USERINT01% to %USERINT05%

%USEREXTTYPE01% to USEREXTTYPE05

%USERCODE01% to %USERCODE05%

%USERTIME01% to %USERTIME05%

Escalation of an Item

  • hptl_jp1_imss_mail_item_escalation_title

  • hptl_jp1_imss_mail_item_escalation_text

%ITEMID%

%TITLE%

%SYSTEM%

%PROCESS%

%PROCESSITEMID%

%SEVERITY%

%SEVERITYREASON%

%IMPACT%

%IMPACTREASON%

%PRIORITY%

%PRIORITYREASON%

%ITEMCATEGORY%

%ISSUECATEGORY%

%CHANGESCALE%

%RELEASETYPE%

%STATUS%

%RESULT%

%ACCRUALDATE%

%PHENOMENON%

%SOLUTION%

%REGISTRANT%

%REGISTDATE%

%CHARGE%

%PERIOD%

%RESPONDENT%

%STARTDATE%

%COMPDATE%

%CUSTOMERNAME%

%INQUIRYNAME%

%ESTIMATEDCOST%

%ACTUALCOST%

%EFFECTSERVICE%

(Cannot be specified for the email title.)

%FAILURELOCATION%

(Cannot be specified for the email title.)

%SUMMARY%

(Cannot be specified for the email title.)

%AVOIDANCECODE%

%AVOIDANCE%

(Cannot be specified for the email title.)

%SITUATION%

(Cannot be specified for the email title.)

%MEASURES%

(Cannot be specified for the email title.)

%CAUSE%

%SOLUTION%

(Cannot be specified for the email title.)

%SCHEDULE%

(Cannot be specified for the email title.)

%IMPACTEVAL%

(Cannot be specified for the email title.)

%DELIBERATIONRST%

(Cannot be specified for the email title.)

%FREEDESCRIPTION%

(Cannot be specified for the email title.)

%JP1PRODUCTNAME%

%JP1JOBNETNAME%

%JP1JOBNAME%

%JP1SNMPSRC%

%JP1NODENAME%

%JP1ALARMNAME%

%LASTUPDATE%

%IMEVENTNO%

%IMHOSTNAME%

%USERTEXT01% to %USERTEXT20%

(Cannot be specified for the email title.)

%USERINT01% to %USERINT05%

%USEREXTTYPE01% to USEREXTTYPE05

%USERCODE01% to %USERCODE05%

%USERTIME01% to %USERTIME05%

Changes of the person in charge

  • hptl_jp1_imss_mail_item_charge_title

  • hptl_jp1_imss_mail_item_charge_text

%ITEMID%

%TITLE%

%SYSTEM%

%PROCESS%

%PROCESSITEMID%

%SEVERITY%

%SEVERITYREASON%

%IMPACT%

%IMPACTREASON%

%PRIORITY%

%PRIORITYREASON%

%ITEMCATEGORY%

%ISSUECATEGORY%

%CHANGESCALE%

%RELEASETYPE%

%STATUS%

%RESULT%

%ACCRUALDATE%

%PHENOMENON%

%SOLUTION%

%REGISTRANT%

%REGISTDATE%

%CHARGE%

%PERIOD%

%RESPONDENT%

%STARTDATE%

%COMPDATE%

%CUSTOMERNAME%

%INQUIRYNAME%

%ESTIMATEDCOST%

%ACTUALCOST%

%EFFECTSERVICE%

(Cannot be specified for the email title.)

%FAILURELOCATION%

(Cannot be specified for the email title.)

%SUMMARY%

(Cannot be specified for the email title.)

%AVOIDANCECODE%

%AVOIDANCE%

(Cannot be specified for the email title.)

%SITUATION%

(Cannot be specified for the email title.)

%MEASURES%

(Cannot be specified for the email title.)

%CAUSE%

%ROOTCAUSE%

(Cannot be specified for the email title.)

%SOLUTION%

(Cannot be specified for the email title.)

%SCHEDULE%

(Cannot be specified for the email title.)

%IMPACTEVAL%

(Cannot be specified for the email title.)

%DELIBERATIONRST%

(Cannot be specified for the email title.)

%FREEDESCRIPTION%

(Cannot be specified for the email title.)

%JP1PRODUCTNAME%

%JP1JOBNETNAME%

%JP1JOBNAME%

%JP1SNMPSRC%

%JP1NODENAME%

%JP1ALARMNAME%

%LASTUPDATE%

%IMEVENTNO%

%IMHOSTNAME%

%USERTEXT01% to %USERTEXT20%

(Cannot be specified for the email title.)

%USERINT01% to %USERINT05%

%USEREXTTYPE01% to USEREXTTYPE05

%USERCODE01% to %USERCODE05%

%USERTIME01% to %USERTIME05%

Closing an Item

  • hptl_jp1_imss_mail_item_close_title

  • hptl_jp1_imss_mail_item_close_text

%ITEMID%

%TITLE%

%SYSTEM%

%PROCESS%

%PROCESSITEMID%

%SEVERITY%

%SEVERITYREASON%

%IMPACT%

%IMPACTREASON%

%PRIORITY%

%PRIORITYREASON%

%ITEMCATEGORY%

%ISSUECATEGORY%

%CHANGESCALE%

%RELEASETYPE%

%STATUS%

%RESULT%

%ACCRUALDATE%

%PHENOMENON%

%SOLUTION%

%REGISTRANT%

%REGISTDATE%

%CHARGE%

%PERIOD%

%RESPONDENT%

%STARTDATE%

%COMPDATE%

%CUSTOMERNAME%

%INQUIRYNAME%

%ESTIMATEDCOST%

%ACTUALCOST%

%EFFECTSERVICE%

(Cannot be specified for the email title.)

%FAILURELOCATION%

(Cannot be specified for the email title.)

%SUMMARY%

(Cannot be specified for the email title.)

%AVOIDANCECODE%

%AVOIDANCE%

(Cannot be specified for the email title.)

%SITUATION%

(Cannot be specified for the email title.)

%MEASURES%

(Cannot be specified for the email title.)

%CAUSE%

%ROOTCAUSE%

(Cannot be specified for the email title.)

%SOLUTION%

(Cannot be specified for the email title.)

%SCHEDULE%

(Cannot be specified for the email title.)

%IMPACTEVAL%

(Cannot be specified for the email title.)

%DELIBERATIONRST%

(Cannot be specified for the email title.)

%FREEDESCRIPTION%

(Cannot be specified for the email title.)

%JP1PRODUCTNAME%

%JP1JOBNETNAME%

%JP1JOBNAME%

%JP1SNMPSRC%

%JP1NODENAME%

%JP1ALARMNAME%

%LASTUPDATE%

%IMEVENTNO%

%IMHOSTNAME%

%USERTEXT01% to %USERTEXT20%

(Cannot be specified for the email title.)

%USERINT01% to %USERINT05%

%USEREXTTYPE01% to USEREXTTYPE05

%USERCODE01% to %USERCODE05%

%USERTIME01% to %USERTIME05%

Recalling an item

  • hptl_jp1_imss_mail_item_recall_title

  • hptl_jp1_imss_mail_item_recall_text

%ITEMID%

%TITLE%

%SYSTEM%

%PROCESS%

%PROCESSITEMID%

%SEVERITY%

%SEVERITYREASON%

%IMPACT%

%IMPACTREASON%

%PRIORITY%

%PRIORITYREASON%

%ITEMCATEGORY%

%ISSUECATEGORY%

%CHANGESCALE%

%RELEASETYPE%

%STATUS%

%RESULT%

%ACCRUALDATE%

%PHENOMENON%

%SOLUTION%

%REGISTRANT%

%REGISTDATE%

%CHARGE%

%PERIOD%

%RESPONDENT%

%STARTDATE%

%COMPDATE%

%CUSTOMERNAME%

%INQUIRYNAME%

%ESTIMATEDCOST%

%ACTUALCOST%

%EFFECTSERVICE%

(Cannot be specified for the email title.)

%FAILURELOCATION%

(Cannot be specified for the email title.)

%SUMMARY%

(Cannot be specified for the email title.)

%AVOIDANCECODE%

%AVOIDANCE%

(Cannot be specified for the email title.)

%SITUATION%

(Cannot be specified for the email title.)

%MEASURES%

(Cannot be specified for the email title.)

%CAUSE%

%ROOTCAUSE%

(Cannot be specified for the email title.)

%SOLUTION%

(Cannot be specified for the email title.)

%SCHEDULE%

(Cannot be specified for the email title.)

%IMPACTEVAL%

(Cannot be specified for the email title.)

%DELIBERATIONRST%

(Cannot be specified for the email title.)

%FREEDESCRIPTION%

(Cannot be specified for the email title.)

%JP1PRODUCTNAME%

%JP1JOBNETNAME%

%JP1JOBNAME%

%JP1SNMPSRC%

%JP1NODENAME%

%JP1ALARMNAME%

%LASTUPDATE%

%IMEVENTNO%

%IMHOSTNAME%

%USERTEXT01% to %USERTEXT20%

(Cannot be specified for the email title.)

%USERINT01% to %USERINT05%

%USEREXTTYPE01% to USEREXTTYPE05

%USERCODE01% to %USERCODE05%

%USERTIME01% to %USERTIME05%

Sending back an item

  • hptl_jp1_imss_mail_item_sendback_title

  • hptl_jp1_imss_mail_item_sendback_text

%ITEMID%

%TITLE%

%SYSTEM%

%PROCESS%

%PROCESSITEMID%

%SEVERITY%

%SEVERITYREASON%

%IMPACT%

%IMPACTREASON%

%PRIORITY%

%PRIORITYREASON%

%ITEMCATEGORY%

%ISSUECATEGORY%

%CHANGESCALE%

%RELEASETYPE%

%STATUS%

%RESULT%

%ACCRUALDATE%

%PHENOMENON%

%SOLUTION%

%REGISTRANT%

%REGISTDATE%

%CHARGE%

%PERIOD%

%RESPONDENT%

%STARTDATE%

%COMPDATE%

%CUSTOMERNAME%

%INQUIRYNAME%

%ESTIMATEDCOST%

%ACTUALCOST%

%EFFECTSERVICE%

(Cannot be specified for the email title.)

%FAILURELOCATION%

(Cannot be specified for the email title.)

%SUMMARY%

(Cannot be specified for the email title.)

%AVOIDANCECODE%

%AVOIDANCE%

(Cannot be specified for the email title.)

%SITUATION%

(Cannot be specified for the email title.)

%MEASURES%

(Cannot be specified for the email title.)

%CAUSE%

%ROOTCAUSE%

(Cannot be specified for the email title.)

%SOLUTION%

(Cannot be specified for the email title.)

%SCHEDULE%

(Cannot be specified for the email title.)

%IMPACTEVAL%

(Cannot be specified for the email title.)

%DELIBERATIONRST%

(Cannot be specified for the email title.)

%FREEDESCRIPTION%

(Cannot be specified for the email title.)

%JP1PRODUCTNAME%

%JP1JOBNETNAME%

%JP1JOBNAME%

%JP1SNMPSRC%

%JP1NODENAME%

%JP1ALARMNAME%

%LASTUPDATE%

%IMEVENTNO%

%IMHOSTNAME%

%USERTEXT01% to %USERTEXT20%

(Cannot be specified for the email title.)

%USERINT01% to %USERINT05%

%USEREXTTYPE01% to USEREXTTYPE05

%USERCODE01% to %USERCODE05%

%USERTIME01% to %USERTIME05%

Notification by email before the deadline

  • hptl_jp1_imss_mail_inform_deadline_assigned_title

  • hptl_jp1_imss_mail_inform_deadline_assigned_text_over

  • hptl_jp1_imss_mail_inform_deadline_assigned_text

%SYSTEM%

%PROCESS%

%ITEMNUM_ASSIGNED%

%ITEMNUM_PRIHIGH_ASSIGNED%

%ITEMNUM_PRIMID_ASSIGNED%

%ITEMNUM_PRINOR_ASSIGNED%

%ITEMNUM_ASSIGNED_REMAIN%

%ITEMNUM_PWB%

%ITEMNUM_PRIHIGH_PWB%

%ITEMNUM_PRIMID_PWB%

%ITEMNUM_PRINOR_PWB%

  • hptl_jp1_imss_mail_inform_deadline_pwb_title

  • hptl_jp1_imss_mail_inform_deadline_pwb_text

%SYSTEM%

%PROCESS%

%ITEMNUM_ASSIGNED%

%ITEMNUM_PRIHIGH_ASSIGNED%

%ITEMNUM_PRIMID_ASSIGNED%

%ITEMNUM_PRINOR_ASSIGNED%

%ITEMNUM_PWB%

%BEFORE_DAYS%

%SEND_FREQUENCY%

%ITEMNUM_PRIHIGH_PWB%

%ITEMNUM_PRIMID_PWB%

%ITEMNUM_PRINOR_PWB%

  • hptl_jp1_imss_mail_inform_deadline_assigned_text_rep

%ITEMID%

%TITLE%

%PRIORITY%

%STATUS%

%CHARGE%

%PERIOD%

%ITEMURL%

Notification of a held Item

  • hptl_jp1_imss_mail_inform_leave_assigned_title

  • hptl_jp1_imss_mail_inform_leave_assigned_text

  • hptl_jp1_imss_mail_inform_leave_assigned_text_over

%ITEMNUM_ASSIGNED%

%ITEM_LEAVE_THRESHOLD%

%PRIORITY_LIST%

%ITEMNUM_LEAVE_DETAIL%

%SYSTEM%

%PROCESS%

%ITEMNUM_ASSIGNED_REMAIN%

%ITEMNUM_PWB%

  • hptl_jp1_imss_mail_inform_leave_pwb_title

  • hptl_jp1_imss_mail_inform_leave_pwb_text

%ITEMNUM_ASSIGNED%

%ITEM_LEAVE_THRESHOLD%

%PRIORITY_LIST%

%ITEMNUM_LEAVE_DETAIL%

%SYSTEM%

%PROCESS%

%ITEMNUM_PWB%

  • hptl_jp1_imss_mail_inform_leave_assigned_text_rep

%ITEMID%

%TITLE%

%PRIORITY%

%CHARGE%

%LASTUPDATE%

%PERIOD%

%ITEMURL%

Table 13‒66: Conversion results of variables

Specifiable variable name

Contents after conversion

%USERID%

Converted to the user ID of a user to be deleted.

%USERNAME%

Converted to the user name of a user to be deleted.

%ROLEID%

Converted to the role ID of a role to be deleted.

%ROLENAME%

Converted to the role name of a role to be deleted.

%ITEMID%

Converted to the Item ID of the applicable Item.

%TITLE%

Converted to the string to be displayed for Title of the applicable Item.

%SYSTEM%

Converted to the string to be displayed for System of the applicable Item.

%PROCESS%

Converted to the string to be displayed for Process of the applicable Item.

%PROCESSITEMID%

Converted to the string to be displayed for Inter-process ID of the applicable Item.

%SEVERITY%

Converted to the string to be displayed for Severity of the applicable Item.

%SEVERITYREASON%

Converted to the string to be displayed for Reason for severity of the applicable Item.

%IMPACT%

Converted to the string to be displayed for Impact level of the applicable Item.

%IMPACTREASON%

Converted to the string to be displayed for Reason for Impact level of the applicable Item.

%PRIORITY%

Converted to the string to be displayed for Priority of the applicable Item.

%PRIORITYREASON%

Converted to the string to be displayed for Reason for priority of the applicable Item.

%ITEMCATEGORY%

Converted to the string to be displayed for Item type of the applicable Item.

%ISSUECATEGORY%

Converted to the string to be displayed for Problem domain of the applicable Item.

%CHANGESCALE%

Converted to the string to be displayed for Scale of change of the applicable Item.

%RELEASETYPE%

Converted to the string to be displayed for Release type of the applicable Item.

%STATUS%

Converted to the string to be displayed for Status of the applicable Item.

%RESULT%

Converted to the string to be displayed for Result of the applicable Item.

%ACCRUALDATE%

Converted to the string to be displayed for Occurrence date and time of the applicable Item.

%PHENOMENON%

Converted to the string to be displayed for Occurred type of the applicable Item.

%SOLUTION%

Converted to the string to be displayed for Solution category of the applicable Item.

%REGISTRANT%

Converted to the string to be displayed for Registrant of the applicable Item.

%REGISTDATE%

Converted to the string to be displayed for Registration date and time of the applicable Item.

%CHARGE%

Converted to the string to be displayed for Person in charge of the applicable Item.

%PERIOD%

Converted to the string to be displayed for Deadline of the applicable Item.

%ITEMURL%

Converted to the string to be displayed for URL of the applicable Item.

%RESPONDENT%

Converted to the string to be displayed for Answerer of the applicable Item.

%STARTDATE%

Converted to the string to be displayed for Start date and time of the applicable Item.

%COMPDATE%

Converted to the string to be displayed for End date and time of the applicable Item.

%CUSTOMERNAME%

Converted to the string to be displayed for Customer name of the applicable Item.

%INQUIRYNAME%

Converted to the string to be displayed for Inquirer of the applicable Item.

%ESTIMATEDCOST%

Converted to the string to be displayed for Cost (planned) of the applicable Item.

%ACTUALCOST%

Converted to the string to be displayed for Cost (actual) of the applicable Item.

%EFFECTSERVICE%

Converted to the string to be displayed for Impact service of the applicable Item.

%FAILURELOCATION%

Converted to the string to be displayed for Problem component and version of the applicable Item.

%SUMMARY%

Converted to the string to be displayed for Overview of the applicable Item.

%AVOIDANCECODE%

Converted to the string to be displayed for Workaround type of the applicable Item.

%AVOIDANCE%

Converted to the string to be displayed for Workaround of the applicable Item.

%SITUATION%

Converted to the string to be displayed for Work status of the applicable Item.

%MEASURES%

Converted to the string to be displayed for How to avoid the problem in the future of the applicable Item.

%CAUSE%

Converted to the string to be displayed for Cause of the applicable Item.

%ROOTCAUSE%

Converted to the string to be displayed for Fundamental cause of the applicable Item.

%SOLUTION%

Converted to the string to be displayed for Solution of the applicable Item.

%SCHEDULE%

Converted to the string to be displayed for Schedule and main steps of the applicable Item.

%IMPACTEVAL%

Converted to the string to be displayed for Impact assessment for change of the applicable Item.

%DELIBERATIONRST%

Converted to the string to be displayed for Discussions result of the applicable Item.

%FREEDESCRIPTION%

Converted to the string to be displayed for Free memo column of the applicable Item.

%JP1PRODUCTNAME%

Converted to the string to be displayed for Product name of the applicable Item.

%JP1JOBNETNAME%

Converted to the string to be displayed for Jobnet name of the applicable Item.

%JP1JOBNAME%

Converted to the string to be displayed for Job name of the applicable Item.

%JP1SNMPSRC%

Converted to the string to be displayed for SNMP source of the applicable Item.

%JP1NODENAME%

Converted to the string to be displayed for Monitored node name of the applicable Item.

%JP1ALARMNAME%

Converted to the string to be displayed for Alarm name of the applicable Item.

%LASTUPDATE%

Converted to the string to be displayed for Update date and time of the applicable Item.

%IMEVENTNO%

Converted to the string to be displayed for Serial number of the applicable Item.

%IMHOSTNAME%

Converted to the string to be displayed for JP1/IM-M host name of the applicable Item.

%USERTEXT01% to %USERTEXT20%

Converted to the string to be displayed for Extended text 01 to Extended text 20 of the applicable Item.

%USERINT01% to %USERINT05%

Converted to the string to be displayed for Extended numerical data 01 to Extended numerical data 05 of the applicable Item.

%USEREXTTYPE01% to USEREXTTYPE05

Converted to the string to be displayed for Extended user information type 01 to Extended user information type 05 of the applicable Item.

%USERCODE01% to %USERCODE05%

Converted to the string to be displayed for Extended code 01 to Extended code 05 of the applicable Item.

%USERTIME01% to %USERTIME05%

Converted to the string to be displayed for Extended time 01 to Extended time 05 of the applicable Item.

%ITEMNUM_ASSIGNED%

Converted to the total number of target Items assigned to the applicable person in charge.

%ITEMNUM_PRIHIGH_ASSIGNED%

Converted to the number of Items whose priority set by the person in charge is Very urgent.

%ITEMNUM_PRIMID_ASSIGNED%

Converted to the number of Items whose priority set by the person in charge is Urgent.

%ITEMNUM_PRINOR_ASSIGNED%

Converted to the number of Items whose priority set by the person in charge is Standard.

%ITEMNUM_ASSIGNED_REMAIN%

Converted to the number of remaining Items which are not contained in the email message to the person in charge.

%ITEMNUM_PWB%

Converted to the total number of target Items assigned to the process work board manager.

%ITEMNUM_PRIHIGH_PWB%

Converted to the number of Items whose priority set by the process work board manager is Very urgent.

%ITEMNUM_PRIMID_PWB%

Converted to the number of Items whose priority set by the process work board manager is Urgent.

%ITEMNUM_PRINOR_PWB%

Converted to the number of Items whose priority set by the process work board manager is Standard.

%BEFORE_DAYS%

Converted to the number of days before sending the notification by email before the deadline.

%SEND_FREQUENCY%

Converted to the frequency for sending notification by email.

%ITEM_LEAVE_THRESHOLD%

Converted to a list of periods for an Item to be regarded as held after the Item is left unprocessed for each status.

%PRIORITY_LIST%

Converted to a list of priorities to be monitored.

%ITEMNUM_LEAVE_DETAIL%

Converted to the number of held Items for each status.

%LASTUPDATE%

Converted to the update date and time of the Item.

Notes
  • If % exists only at the beginning of a variable, such as %USERID, it is sent without being converted.

  • If a variable name contains an error, it is sent without being converted.

Note

Definition example

The following is a definition example when you set to send an email message when the person in charge is changed. Note that this example shows only the part that is necessary for the setting.

hptl_jp1_imss_mail_server=MailServer1
hptl_jp1_imss_mail_port=25
hptl_jp1_imss_mail_user_max=256
hptl_jp1_imss_mail_form_address=administrator@hitachi.com
hptl_jp1_imss_mail_notice_charaset=Windows-31J
hptl_jp1_imss_mail_failure_display_flag=ON
hptl_jp1_imss_mail_item_charge_flag=ON
hptl_jp1_imss_mail_item_charge_title=[the person in charge change notification %ITEMID%]%TITLE%
hptl_jp1_imss_mail_item_charge_text= the person in charge (Item ID: %ITEMID%) changed.\nSystem: %SYSTEM%\nProcess: %PROCESS%\nTitle: %TITLE%\nPriority: %PRIORITY%\nStatus: %STATUS%\nPerson in charge: %CHARGE%\nDeadline: %PERIOD%\n

The following is a definition example of an email message to be used when notification is sent by email before the deadline:

hptl_jp1_imss_mail_form_name=JP1/SS
hptl_jp1_imss_mail_form_address=administrator@hitachi.com
hptl_jp1_imss_mail_charaset=iso-2022-jp
hptl_jp1_imss_mail_format=text/plain
hptl_jp1_imss_mail_inform_deadline_mail_maximum_num=20
hptl_jp1_imss_mail_inform_deadline_assigned_title=[Deadline notification for the person in charge] Item - Deadline is coming closer.
hptl_jp1_imss_mail_inform_deadline_assigned_text=The number of Items whose deadline is coming closer is %ITEMNUM_ASSIGNED%.\n  The number of Items whose priority is Very urgent is %ITEMNUM_PRIHIGH_ASSIGNED%.\n  The number of Items whose priority is Urgent is %ITEMNUM_PRIMID_ASSIGNED%.\n  The number of Items whose priority is Standard is %ITEMNUM_PRINOR_ASSIGNED%.\nSystem: %SYSTEM%\n
Process: %PROCESS%\n--------\n
hptl_jp1_imss_mail_inform_deadline_assigned_text_rep=Item - Deadline for %ITEMID% is coming closer.\nTitle: %TITLE%\nPriority: %PRIORITY%\nStatus: %STATUS%\nPerson in charge: %CHARGE%\nDeadline: %PERIOD%\nItem URL:%ITEMURL%\n--------\n
hptl_jp1_imss_mail_inform_deadline_assigned_text_over=The maximum number of Items that can be described in this message is exceeded.\nThere are %ITEMNUM_ASSIGNED_REMAIN% Items whose deadline is coming closer.\n
hptl_jp1_imss_mail_inform_deadline_pwb_title=[Deadline notification for the process work board manager] The Item deadline for %ITEMNUM_PWB% Items is coming closer.
hptl_jp1_imss_mail_inform_deadline_pwb_text=Advise the number of Items whose deadline is coming closer.\nNumber of days before the deadline:%BEFORE_HOURS%\nSettings for the number of email notifications: %SEND_FREQUENCY%\nSystem: %SYSTEM%\nProcess: %PROCESS%\nNumber of Items: %ITEMNUM_PWB%\n  The number of Items whose priority is set to Very urgent is %ITEMNUM_PRIHIGH_ASSIGNED%.\n  The number of Items whose priority is set to Urgent is %ITEMNUM_PRIMID_ASSIGNED%.\n  The number of Items whose priority is set to Standard is %ITEMNUM_PRINOR_ASSIGNED%.\n

The following is an example of an email notification of held Items:

hptl_jp1_imss_mail_form_name=JP1/SS
hptl_jp1_imss_mail_form_address=administrator@hitachi.com
hptl_jp1_imss_mail_charaset=iso-2022-jp
hptl_jp1_imss_mail_format=text/plain
hptl_jp1_imss_mail_inform_leave_mail_maximum_num=20
hptl_jp1_imss_mail_inform_leave_assigned_title=[Held Item notification for a person in charge] Processing of Items is being delayed.
hptl_jp1_imss_mail_inform_leave_assigned_text=The number of Items whose processing is being delayed is %ITEMNUM_ASSIGNED%.\n%ITEMNUM_LEAVE_DETAIL%\nPriority to be monitored: %PRIORITY_LIST%\nTime that is not updated: \n%ITEM_LEAVE_THRESHOLD%\nSystem: %SYSTEM%\nProcess: %PROCESS%\n--------\n
hptl_jp1_imss_mail_inform_leave_assigned_text_rep=Processing to the %ITEMID% Item is being delayed.\nTitle: %TITLE%\nPriority: %PRIORITY%\nStatus: %STATUS%\nPerson in charge: %CHARGE%\nUpdate date and time: %LASTUPDATE%\nItem URL:%ITEMURL%\n--------\n
hptl_jp1_imss_mail_inform_leave_assigned_text_over=The maximum number of Items that can be described in this notification is exceeded.\nThe remaining number of Items whose processing is being delayed is %ITEMNUM_ASSIGNED_REMAIN%.\n
hptl_jp1_imss_mail_inform_leave_pwb_title=[Deadline notification for the process work board manager] Processing of %ITEMNUM_PWB% Items is being delayed.
hptl_jp1_imss_mail_inform_leave_pwb_text=Advise the number of Items whose processing is being delayed.\nThe number of Items whose processing is being delayed is %ITEMNUM_PWB%.\n%ITEMNUM_LEAVE_DETAIL%\nPriority to be monitored: %PRIORITY_LIST%\nTime that is not updated: \n%ITEM_LEAVE_THRESHOLD%\nSystem: %SYSTEM%\nProcess: %PROCESS%\n

The following is an example of an email message that is used for registering an Item by email (operation mode: attached-file mode). Note that this example shows only the part required for the setting is.

hptl_jp1_imss_mail_use_jssitementrybymail=ON
hptl_jp1_imss_mail_pop3_server=MailServer2
hptl_jp1_imss_mail_pop3_port=110
hptl_jp1_imss_mail_pop3_user=sender@hitachi.co.jp
hptl_jp1_imss_mail_pop3_password=sender_pswd
hptl_jp1_imss_mail_receive_number=50
hptl_jp1_imss_mail_messageid_maxlen=64
hptl_jp1_imss_mail_tmp_file_max_size=5
hptl_jp1_imss_mail_tmp_file_max_num=100
hptl_jp1_imss_mail_append_file_output_path=C:/jp1_imss/mail/append_file
hptl_jp1_imss_mail_append_file_output_folder_max=200
hptl_jp1_imss_mail_append_file_output_max_size=5
hptl_jp1_imss_mail_operation_mode=apd
hptl_jp1_imss_mail_source_address=JIMSD_FORM_USERTEXT01

The following is an example of an email message that is used for registering an Item by email (operation mode: single-element mode). Note that this example shows only the part required for the setting.

hptl_jp1_imss_mail_use_jssitementrybymail=ON
hptl_jp1_imss_mail_pop3_server=MailServer2
hptl_jp1_imss_mail_pop3_port=110
hptl_jp1_imss_mail_pop3_address=user1@hitachi.com;user2@hitachi.com
hptl_jp1_imss_mail_pop3_domain=hitachi.co.jp
hptl_jp1_imss_mail_receive_number=50
hptl_jp1_imss_mail_messageid_maxlen=64
hptl_jp1_imss_mail_tmp_file_max_size=5
hptl_jp1_imss_mail_tmp_file_max_num=100
hptl_jp1_imss_mail_append_file_output_path=C:/jp1_imss/mail/append_file
hptl_jp1_imss_mail_append_file_output_folder_max=200
hptl_jp1_imss_mail_append_file_output_max_size=5
hptl_jp1_imss_mail_operation_mode=single
hptl_jp1_imss_mail_source_address=JIMSD_FORM_USERTEXT01
hptl_jp1_imss_mail_itemdata_set_form=JIMSD_FORM_SUMMARY
hptl_jp1_imss_mail_format_error_string=[!]

The following is an example of an email message that is used for registering an Item by email (operation mode: multi-element mode). Note that this example shows only the part required for the setting.

hptl_jp1_imss_mail_use_jssitementrybymail=ON
hptl_jp1_imss_mail_pop3_server=MailServer2
hptl_jp1_imss_mail_pop3_port=110
hptl_jp1_imss_mail_pop3_address=user1@hitachi.com;user2@hitachi.com
hptl_jp1_imss_mail_pop3_domain=hitachi.co.jp
hptl_jp1_imss_mail_receive_number=50
hptl_jp1_imss_mail_messageid_maxlen=64
hptl_jp1_imss_mail_tmp_file_max_size=5
hptl_jp1_imss_mail_tmp_file_max_num=100
hptl_jp1_imss_mail_append_file_output_path=C:/jp1_imss/mail/append_file
hptl_jp1_imss_mail_append_file_output_folder_max=200
hptl_jp1_imss_mail_append_file_output_max_size=5
hptl_jp1_imss_mail_operation_mode=multi
hptl_jp1_imss_mail_source_address=JIMSD_FORM_USERTEXT01
hptl_jp1_imss_mail_format_error_string=[!]

The following is an example of specifying the settings to use POP before SMTP authentication for sending email. Note that this example shows only the part required for the setting.

hptl_jp1_imss_mail_auth_method=pop-before-smtp
hptl_jp1_imss_mail_connect_timeout=12000
hptl_jp1_imss_mail_socket_timeout=12000