Hitachi

JP1 Version 12 JP1/Service Support Configuration and Administration Guide


9.15.1 Setting an environment for registering Items by email

The following environment setting actions are required in order to register Items by email:

The following subsections provide details about individual settings.

Organization of this subsection

(1) Setting up the email management server

If you want to register Items by email, you need to set up the email management server to which emails are to be sent. Prepare an email server that can receive emails by using the POP3 protocol.

(2) Creating the attached file management folder

Attached files of emails are not saved in JP1/Service Support for security reasons. Therefore, do not attach files to emails that will be sent for registering Items. However, in case files should be attached to such emails, create a folder for storing attached files on the Item management server. Allow people in charge view permission for this folder.

(3) Setting email clients that can send emails

On email clients that send emails, use a software program that enables sending emails using the SMTP protocol.

(4) Creating a temporary receipt process work board and a master system by using commands

When you register an Item by email, if you do not specify the ID of the registration-destination process work board in the subject of the email, the Item will be registered in the temporary receipt process work board.

If you want to register Items by email, you need to create a temporary receipt process work board and a master system. You can use commands to create them. Use the setup command to create them during setup. At times other than during setup, use the command for creating a master system and the command for creating a temporary receipt process work board. For details, see. jsssetup.bat (sets up JP1/Service Support) and jsscreatesysandpwb (creates the master system and the temporary receipt process work board) in Chapter 12. Commands.

(5) Settings in the email definition file

You must specify the settings in the table below in the Email definition file. For details about the Email definition file, see Email definition file (jp1imss_mail_setting.conf) in Chapter 13. Definition Files.

Table 9‒8: Settings, in the Email definition file, that are required for Item registration by email

Setting

Description

Whether to register Items by email

Sets whether Items can be registered by email.

Setting of the email management server that receives emails

Sets the address and port number of the email management server.

Setting of users who register Items by email

Sets the users who can register Items by email. The following two methods can be used:

  • Setting email addresses of users who can register Items by email

  • Setting the domains of the users who can register Items by email

Destination address of emails

Sets the destination email address for emails when registering Items by email.

User name and password used to obtain emails

Sets the user name and password required for obtaining emails sent from the email management server. Use the jssauthusersetup command to set the user name and password. The password is converted by a program when the jssauthusersetup command is executed.

Number of emails that can be obtained from the email management server at a time

Sets the number of emails that can be obtained from the email management server at a time.

Length of message ID of emails

Sets the length of message ID, which is used for preventing duplicated registration of emails.

The maximum size of temporary email save files and the maximum number of the output files

If Item registration by email fails, the header information and body of an email is output as a temporary email save file. Set the maximum size of an output temporary email save file and the maximum number of the output temporary email save files.

Output-destination folder of attached files

Sets the folder in which attached files of the received emails are stored.

The maximum number of folders to which attached files are output, and the maximum size of an attached file

Sets the maximum number of output-destination folders for attached files, and the maximum size of an attached file. Note that the total size of emails by which Items can be registered is no more than 5 megabytes. The total size includes the size of the title, email body, email header, and attached files.

Operation mode for Item registration by email

Sets the operation mode for Item registration by email. Available operation modes are as follows:

  • Attached-file mode

  • Single-element mode

  • Multi-element mode

Item element specification ID of the Item element in which to set the email sender's address

Sets the Item element specification ID of the Item element in which the email sender's address is to be set.

Item element specification ID of the Item element in which to set the text of an email

Sets the Item element specification ID of the Item element in which the text of an email is to be set when the operation mode for Item registration by email is the single-element mode.

Character string to be added at the beginning of the Item title when an error is found in an element by the format check on the text of an email

Sets the character string to be added at the beginning of the Item title when an error is found in an element by the format check on the text of an email. This setting applies when the operation mode for Item registration by email is the single-element or multi-element mode.

(6) Setting up the Definition file for the task practice service

In the Definition file for the task practice service, you can set whether JP1/Service Support - Task Service service regularly executes the Item registration command based on emails, and the execution interval of the command. The default interval is 60 minutes.

For details about the Definition file for the task practice service, see Definition file for the task practice service (jp1imss_service_setting.conf) in Chapter 13. Definition Files.

When the command to register an Item by email is executed by using the JP1/Service Support - Task Service service, an email is sent after Item registration to notify the person in charge of the Item of Item registration. If email notification is unnecessary, use the Windows task scheduler instead of the JP1/Service Support - Task Service service, and execute the jssitementrybymail command without the -mail option specified.

(7) Settings in the User log definition file

You can output the execution results of the jssitementrybymail command to a log file (jssitementrybymail_infonumber.log). You can also output the execution results of email notification to a log file if the email notification function is used when the jssitementrybymail command is executed.

Note that you can also output the execution results of the jssauthusersetup command to a log file (jssauthusersetup_infonumber.log). The jssauthusersetup command is used to set the user name and password to obtain emails defined in the email definition file.

Outputting the execution results to log files requires the setting of the user log definition file. For details about the log file for the jssitementrybymail command, see User log definition file (jp1itementrybymail.conf) in Chapter 13. Definition Files. For details about the email notification log file for the jssitementrybymail command, see User log definition file (jp1mailnotification.conf) in Chapter 13. Definition Files. For details about the log file for the jssauthusersetup command, see User log definition file (jp1authusersetup.conf) in Chapter 13. Definition Files.

(8) Settings in the New process work board window or the Edit the process work board window

You must specify the settings in the table below in the New process work board window or the Edit the process work board window. For details about the setting procedure, see 9.6 Creating process work boards.

Table 9‒9: Settings that must be specified in the New process work board window or the Edit the process work board window that are required for registering Items by email

Setting

Description

Item form

Items that are registered by email must have attached files. For the temporary receipt process work board and the destination process work board for Item registration by email, you need to set Item forms that allow the attached files as the Item forms to be used.

Person in charge of the registered item from email

This setting is displayed only when the Item registration command is used by email.

For Items registered by email, the users or roles that have been defined by this setting are set as the people in charge of the Items. In a temporary receipt process work board or a process work board to which Items are registered by email, you need to set the people in charge of the Items registered by email.