Hitachi

JP1 Version 12 JP1/Service Support Configuration and Administration Guide


9.16.1 Setting an environment for linking with JP1/IM - Manager

You can register the JP1 events detected by JP1/IM - Manager as incidents (Items) of JP1/Service Support. Also, JP1/Service Support can issue JP1 events, depending on the status of registered Items. The following environment settings are required to link with JP1/IM - Manager.

Organization of this subsection

(1) Settings in JP1/Service Support

No environment settings are required in JP1/Service Support to link with JP1/IM - Manager and to register JP1 events as incidents. However, if you want JP1/Service Support to issue JP1 events depending on the Item's status in order to link with JP1/IM - Manager, you need to set the environment in definition files.

The following are the settings in JP1/Service Support when you want JP1/Service Support to issue JP1 events.

(a) Settings of issuance of JP1 events for completed-action linkage

The procedure below specifies the settings for each process work board so that JP1/Service Support will issue a JP1 event when an automatically-registered Item is closed. Before performing this procedure, you need to set up JP1/IM - Manager. For details, see (3) Settings in JP1/IM - Manager.

To specify these settings:

  1. Specify the necessary settings in the configuration file for issuing JP1 events.

    Specify the settings in this file, including the setting of the event server to be connected for issuing JP1 events. For details about the configuration file for issuing JP1 events, see Configuration file for issuing JP1 events (hptl_jp1_imss_jp1event_setting.properties) in Chapter 13. Definition Files.

  2. On the Basic settings tab of the New process work board window or the Edit the process work board window, select the Issue JP1 event check box.

  3. Execute the jssitementry command with the -evt option specified.

    Items are then registered. For details about the jssitementry command, see jssitementry (registers an Item) in Chapter 12. Commands.

    A JP1 event is issued when the status of a registered Item is changed to Close.

(b) Settings for issuing status change JP1 events

To configure JP1/Service Support to issue a JP1 event when the status of an Item for a process or process work board changes, and to specify the Item information to be stored in the JP1 event:

  1. Specify the necessary settings in the configuration file for issuing JP1 events.

    Specify the settings in this file, including the setting of the event server to be connected for issuing JP1 events. For details about the configuration file for issuing JP1 events, see Configuration file for issuing JP1 events (hptl_jp1_imss_jp1event_setting.properties) in Chapter 13. Definition Files.

  2. In the definition file for status-change JP1 events, specify the Item information you want to store in the JP1 event to be issued.

    Users can set 0 to 90 units of unique information with a total size that is less than 10,000 bytes. For details about the definition file for status-change JP1 events, see Definition file for status-change JP1 events (hptl_jp1_imss_jp1event_status.properties) in Chapter 13. Definition Files.

  3. On the Basic settings tab in the New process work board window or the Edit the process work board window, select the Issue JP1 event check box.

  4. In the Status management window for each process or process work board, specify the status for issuing JP1 events.

    Select the JP1 event issuance check box corresponding to the Item status being used. In the Status management window for each process work board, if you select the Use the settings common among processes check box, the Item status set in the process that the relevant process work board belongs to will be set.

Note:

If a large number of JP1 events are issued, transfer delays might occur, or registration delays might occur at the transfer destination. In such cases, check and, if necessary, revise the Item information to be stored in JP1 events and the transfer setting to the higher-level hosts.

(2) Settings in JP1/Base

JP1 events are issued from JP1/Service Support to JP1/IM - Manager via JP1/Base. The following JP1/Base settings are required to issue JP1 events from JP1/Service Support:

(a) Settings of start sequence of services

To issue JP1 events from JP1/Service Support, first you need to start JP1/Base services on the JP1/Service Support host. This is because, if issuance of JP1 events is requested before the JP1/Base services start up, the JP1 events cannot be registered in JP1/Base.

If the JP1/Service Support services have been configured to automatically start up, set the start sequence of services in the start sequence definition file (JP1SVRPR.DAT) so that JP1/Base services start before the JP1/Service Support services.

For details about the start sequence definition file, see the JP1/Base User's Guide.

The following shows an example setting of the start sequence definition file: (JP1SVRPR.DAT) of JP1/Base:

[Jp1ServiceSupportDB]
NAME=JP1/Service Support - DB Server
ServiceName=HiRDBEmbeddedEdition_JS0
 
[Jp1ServiceSupport]
NAME=JP1/Service Support
ServiceName=JP1_ServiceSupport
 
[Jp1ServiceSupportWeb]
NAME=JP1/Service Support - Web Service
ServiceName=JP1_ServiceSupport-WebService
 
[Jp1ServiceSupportTask]
NAME=JP1/ServiceSupport - Task Service
ServiceName=JP1_ServiceSupport-TaskService
Notes:
  • Make sure to specify the above settings after the definition of JP1/Base ([Jp1Base] section). The order of the sections must be the same as in the above example.

  • Do not set the start sequence of JP1/Base services when you use JP1/Service Support in a cluster environment. If you want to set the start sequence of services in a cluster environment, set it by using Windows' WSFC. For details about issuance of JP1 events in a cluster environment, see 10.7 Issuing JP1 events in a cluster environment.

(b) Settings for forwarding of JP1 events

By default, JP1/Base forwards only important JP1 events to the higher-level host according to the hierarchy defined in the configuration definition of the JP1/IM - Manager. For this reason, JP1 events issued by JP1/Service Support when the severity is Information, are not forwarded to the higher-level host.

Therefore, if JP1/Service Support and JP1/IM - Manager are running on different hosts, you need to specify the forwarding condition in the forwarding setting file to forward JP1 events.

For details about the forwarding setting file, see the JP1/Base User's Guide.

The following shows an example setting of forwarding a status-change JP1 event (event ID: 00005F01) to the higher-level host:

to-upper
B.ID IN 5F01
E.PRODUCT_NAME IN /HITACHI/JP1/IM/SS
end-to
Note:

The above example assumes that JP1/IM - Manager is running on the higher-level host and JP1/Service Support is running on the lower-level host.

(3) Settings in JP1/IM - Manager

When you register JP1 events in JP1/IM - Manager, execute the Item registration command using the automated action definition of JP1/IM - Manager.

You can also specify various settings. For example, JP1/IM - Manager can receive a JP1 event from JP1/Service Support and execute an automated action to change the action status to Processed on JP1/IM - Manager when a registered Item is closed. JP1/IM - Manager is also able to execute an automated action corresponding to the change of Item status.

Note that, in order to display the extended attributes added by JP1/Service Support users in JP1/IM - Manager (JP1/IM - View), the names of those extended attributes must be set in the definition file for the extended event attributes of JP1/IM - Manager.

For details about the automated action definition, the system configuration definition, and the definition of the extended event attributes of JP1/IM - Manager, see the following individual manuals.

(a) Defining automated actions

To define automated actions of JP1/IM - Manager:

  1. Set the system configuration definition.

    Specify the settings so that the Item management server is included in the hosts managed by JP1/IM - Manager. If JP1/Service Support and JP1/IM - Manager run on different hosts, define JP1/Service Support host as the lower-level host.

  2. Define automated actions used to register Items.

    Set the JP1 events to be registered as incidents in the automated action definition. To execute an automated action to change the action status to Processed when an Item automatically registered is closed, execute the Item registration command with the -evt option specified.

    Example definition:

    jssitementry -b honsyasystem -r jp1admin -ch jp1admin -cht USER -t IM-Mentry -evt $ACTHOST $EVSEQNO
  3. Define the automated action to be used to change the action status of a JP1 event that triggered automatic registration of an Item, to Processed.

    Define this if you want to change the action status to Processed when the Item is closed.

  4. Define automated actions that correspond to a change of Item status.

    Define this if you want to execute some action that is triggered by a change of Item status.

(b) Defining extended event attributes

JP1/Service Support provides a model file of the definition file for the extended event attributes. This model file can be used to display the extended attributes added by users in JP1/IM - View. If necessary, edit the definition file for the extended event attributes and copy this file to a specified folder of JP1/IM - Manager. For example, if you customize an Item form and change the element names, also change the element names in the definition file for the extended event attributes.

Copy-source file:
  • JP1/SS-path\conf\event\hitachi_jp1_im_ss_attr_ja.conf (for Japanese environment)

  • JP1/SS-path\conf\event\hitachi_jp1_im_ss_attr_en.conf (for English environment)

  • JP1/SS-path\conf\event\hitachi_jp1_im_ss_attr_zh.conf (for Chinese environment)

Copy-destination folder:

IM-M-path\JP1cons\conf\console\attribute

Note:
  • After you copy the definition file for the extended event attributes of JP1/Service Support to JP1/IM - Manager, you need to restart the JP1/IM-Manager services to enable the settings of the definition file.

  • When you perform a version upgrade from a version of JP1/Service Support earlier than 10-50, you need to add parameters to the definition file for the extended event attributes. This is so that the system can display the program-specific information in the consolidated JP1 event for completed-action linkage. Add the underlined parts of the text below to the definition file for the extended event attributes. The text below is an extract of the relevant parts of the file.

    :

    @define-block type="event-attr-def";

    @file type="extended-attributes-definition", version="0300";

    @product name="/HITACHI/JP1/IM/SS";

    @define-block type="event-attr-def";

    block lang="Japanese", platform="base", extended="false";

    attr name="E.REGISTRANT", title="Registrant";

    attr name="E.ITEMENTRY_ACTHOST", title="JP1/IM-M host name";

    attr name="E.ITEMENTRY_SEQNO", title="Linked serial number";

    attr name="E.ITEMENTRY_ITEMID", title="Item ID list";

    :

    @define-block type="event-attr-group-def";

    block platform="base", extended="false";

    group name="ITEM_IMM", attrs="E.REGISTRANT|E.ITEMENTRY_ACTHOST|E.ITEMENTRY_SEQNO";

    group name="ITEM_BATCHOPE", attrs="E.ITEMENTRY_ACTHOST|E.ITEMENTRY_SEQNO|E.ITEMENTRY_ITEMID";

    :

    @define-block type="event-attr-order-def";

    block platform="base", extended="false";

    order id="00005F00", attrs="ITEM_IMM";

    order id="00005F01", attrs="ITEM_STATUS01|ITEM_STATUS02|ITEM_STATUS03|...

    order id="00005F02", attrs="ITEM_BATCHOPE";

    @define-block-end;