Configuration file for issuing JP1 events (hptl_jp1_imss_jp1event_setting.properties)

Organization of this page

Description
Format
File names
Storage folder
When the definition is applied
What is described
Definition example
Notes

Description

This file defines whether to issue a JP1 event from JP1/Service Support, the name of the event server to connect to issue the JP1 event, the number of log files used when issuing JP1 events, the maximum size of a log file used when issuing a JP1 event, and whether to consolidate JP1 events.

For the following cases, if you want to issue a JP1 event from JP1/Service Support, you need to edit this file:

When the status of an event registered automatically from JP1/IM - Manager changes to Close, and the response status changes to Processed (via automated action).
When an Item status is changed, it is reported to an external system.
When Items are closed in a batch operation, JP1 events are consolidated.

For details about JP1 events, see Appendix E.1 List of JP1 Events.

To Page Top

Format

hptl_jp1_imss_je_def_flag=Whether to issue a JP1 event
hptl_jp1_imss_je_def_jp1base=Event server name
hptl_jp1_imss_je_log_file_num=Number of log files
hptl_jp1_imss_je_log_file_size=Maximum size of a log file
hptl_jp1_imss_je_def_batch=Whether to consolidate JP1 events

To Page Top

File names

hptl_jp1_imss_jp1event_setting.properties
hptl_jp1_imss_jp1event_setting.properties.model (Model configuration file for issuing JP1 events)^#

#

You can use the model file to reset the contents of the configuration file for issuing JP1 events. To do so, delete the existing configuration file for issuing JP1 events, then copy and rename the model file.

To Page Top

Storage folder

JP1/SS-path\conf\

To Page Top

When the definition is applied

The definition is applied after the JP1/Service Support service is restarted.

JP1/Service Support - Web Service service
JP1/Service Support service

To Page Top

What is described

Do not edit any specification keys other than those explained in the following table. Use an equal sign (=) to connect a specification key and its value.

Table 13‒10: List of specification keys that can be set in the configuration file for issuing JP1 events
Specification key name	Description	Default value
`hptl_jp1_imss_je_def_flag`	Sets whether to issue a JP1 event from JP1/Service Support. `false`: No events are issued. When `false` is specified, no JP1 events are issued from all processes and process work boards. `true`: Events are issued. When `true` is specified, you can set whether to issue JP1 events for each process work board. In addition, you can set the status for issuing status-change JP1 events for each process or process work board.	`false`
`hptl_jp1_imss_je_def_jp1base`	Specifies the name of the event server on a host where JP1/Service Support to be connected for issuing JP1 events operates. Connect to the specified event server to issue a JP1 event. When you use JP1/Base in a cluster configuration, specify the logical host name. If you omit this specification, the name of the host where JP1/Service Support operates is assumed.	--
`hptl_jp1_imss_je_log_file_num`	Specifies the number of log files (`jp1imssevent[n].log`) for the JP1 event issuing function. You can specify a half-width numeric character (integer) from 1 to 16.	`8`
`hptl_jp1_imss_je_log_file_size`	Specifies the maximum size of a log file (`jp1imssevent[n].log`) for the JP1 event issuing function in bytes. You can specify a half-width numeric character (integer) from 4096 to 2147483647.	`4194304`
`hptl_jp1_imss_je_def_batch`	Specifies whether to consolidate JP1 events for completed-action linkage which are issued when batch operation on Items is performed. `false`: Events are not consolidated. When `false` is specified, a JP1 event for completed-action linkage is issued for individual Items subject to batch operation. `true`: Events are consolidated. When `true` is specified, among JP1 events for Items subject to batch operation, JP1 events for completed-action linkage for Items with the same JP1/IM - Manager host name (element ID: `JIMSD_FORM_IMHOSTNAME`) are consolidated, and then issued.	`true`

Legend:: --: No default value

To Page Top

Definition example

The following is a definition example when Server is assumed as the server name:

hptl_jp1_imss_je_def_flag=true
hptl_jp1_imss_je_def_jp1base=Server
hptl_jp1_imss_je_log_file_num=8
hptl_jp1_imss_je_log_file_size=4194304
hptl_jp1_imss_je_def_batch=false

To Page Top

Notes

If JP1/Service Support and JP1/IM - Manager are on different hosts, you must specify the forward conditions in the forward settings file (forward) for JP1/Base in order to forward JP1 events.
Specify the name of the event server on the host where JP1/Service Support operates as the event server name in hptl_jp1_imss_je_def_jp1base. If you specify the name of an event server on another host, events will not be issued.
Even when consolidation of JP1 events is enabled, if only one Item is closed in a batch operation on Items, JP1 events for completed-action linkage are not consolidated. In this case, a JP1 event for completed-action linkage for that closed Item is issued. For details about JP1 events issued when batch operation is performed on Items, see 3.7 Batch operations on Items.
The Configuration file for issuing JP1 events (hptl_jp1_imss_jp1event_setting.properties) must be created or edited with a character encoding that is compatible with the system locale of the machine on which JP1/Service Support is installed. You can use one of the following character encodings:
- In a Japanese environment: MS932
- In an English environment: ISO-8859-1
- In a Chinese environment: GB18030

To Page Top