15.4.26 Detailed Definition - [Send JP1 Event] dialog box
The Detailed Definition - [Send JP1 Event] dialog box defines the details on sending a JP1 event.
This dialog box contains the items displayed in common, and also contains the following pages:
-
Definition page
-
Attributes page
- Organization of this subsection
(1) Items displayed in common
The following figure shows the items displayed in common.
|
The following explains the items displayed in common.
- Unit name
-
Specify a unit name. Use a character string of up to 30 bytes. The default is Send-JP1-Event.
- Comment
-
Specify a comment for the unit. Use a character string of up to 80 bytes. The default is a blank.
- Exec-agent
-
Specify the execution agent name or execution agent group name to be assigned the task of sending a JP1 event. Use a character string of up to 255 bytes. You can specify a macro variable in this field if the version of the connection-target JP1/AJS3 - Manager is 09-50 or later, and Standard is specified for Exec. service. The default is a blank.
This item appears as a text box when either of the following applies:
-
The version of JP1/AJS - View or the connection-target JP1/AJS - Manager is earlier than 09-50
-
The unit is being defined under a remote jobnet
Otherwise, this item appears as a combo box in which you can select an execution agent. You can also directly enter an execution agent name into the combo box. The content of the list component of the combo box differs depending on whether execution agent profiles are enabled, and the contents of those profiles.
- When execution agent profiles are disabled
-
The list is empty.
- When execution agent profiles are enabled
-
-
If the specified job is associated with an execution agent profile
The list displays the execution agents permitted for the specified job.
-
If the specified job is not associated with an execution agent profile
If the upper-level unit is associated with an execution agent profile, the list displays the execution agents permitted for the upper-level unit.
If the upper-level unit is not associated with an execution agent profile, the list will be empty.
-
For details about execution agents, see 5.1.1 Execution agents in the manual Job Management Partner 1/Automatic Job Management System 3 Overview.
- Cautionary note
-
If you have selected Queueless Agent in Exec. service on the Attributes page, specify the name of an execution host.
-
(2) Definition page
The following figure shows the Definition page in the Detailed Definition - [Send JP1 Event] dialog box.
|
The following explains the displayed items.
- Event destination host
-
Specify the name of the host to which you want to send the event. Use a character string of up to 255 bytes. You can use a macro variable. The default is a blank.
- Event ID
-
Specify the ID of the event to be sent using a hexadecimal string in the format of basic-code. You can set 00000000 to 00001FFF, and 7FFF8000 to 7FFFFFFF. You must specify this item. The default is a blank.
- Message
-
Specify an event message. Use a character string of up to 1,023 bytes. You can use a macro variable. The default is a blank.
- Event level
-
Select the severity level of the JP1 event to be sent. The default is Notice. You can select the following items.
-
Emergency
Select this for sending a JP1 event that severity level is Emergency.
-
Alert
Select this for sending a JP1 event that severity level is Alert.
-
Critical
Select this for sending a JP1 event that severity level is Critical.
-
Error
Select this for sending a JP1 event that severity level is Error.
-
Warning
Select this for sending a JP1 event that severity level is Warning.
-
Notice
Select this for sending a JP1 event that severity level is Notice.
-
Information
Select this for sending a JP1 event that severity level is Information.
-
Debug
Select this for sending a JP1 event that severity level is Debug.
-
- Check event arrivals
-
Specify whether to confirm arrival of JP1 events. You can select No or Yes. The default is No. When Yes is selected, whether a JP1 event has arrived is checked within 3 seconds of sending the JP1 event.
- Check interval
-
Specify the arrival confirmation interval in seconds if a JP1 event does not arrive. You can specify this item when you select Yes for Check event arrivals. You can specify 3 to 600. The default is 10.
- Check count
-
Specify the number of times of arrival confirmations are performed if a JP1 event does not arrive. You can specify this item if you select Yes for Check event arrivals. You can specify 0 to 999. The default is 0.
- Extended attribute
-
Specify a user-defined extended attribute. The default is a blank. Defined data is stored if the extended attribute is in the format of evsfr=extended-attribute-name:"value";. The maximum length must be within 128 bytes.
In the Detailed Definition - [Send JP1 Event] dialog box, specify only extended-attribute-name and value.
Use a character string of up to 32 bytes consisting of uppercase alphabetic characters (A to Z), numeric characters (0 to 9), and underscores (_). The character string must begin with an uppercase alphabetic character.
Specify value using any character string. The maximum length must not exceed 128 bytes. You can use a macro variable.
- Platform
-
Select the platform on which you want to execute jobs. You can select PC or UNIX. The default is PC.
-
PC
A Windows environment is used.
-
UNIX
A UNIX environment is used.
-
- Supplementary notes
-
-
You can also use blanks and symbols for Event destination host, Message, and value in Extended attribute. However, if you use any of the following special characters as an ordinary character, specify a backslash (\) before the special character.
Windows:
double quotation mark (")
UNIX:
', $, backslash (\), and double quotation mark (")
-
For sending of a JP1 event, the specifications of Event destination host, Message, and value in Extended attributes are enclosed in double-quotes ("), considering that the specifications may contain blanks and symbols. If you want to specify a backslash (\) as an ordinary character at the end of a character string in Windows, prefix another backslash (\) to it.
-
If passing information contains any of the above special characters, the information might fail to be passed correctly or the job might fail and end abnormally.
However, if you use the option to enable double quotation marks ("), the passing information including double quotation marks will be passed correctly.
-
(3) Attributes page
The following figure shows the Attributes page in the Detailed Definition - [Send JP1 Event] dialog box.
|
The following explains the displayed items.
- Hold
-
Specify whether to place the unit in the hold status in advance. You can specify No or Yes. The default is No.
- Type
-
Set the unit type to Normal or Recovery. The default is Normal.
- Exec. service
-
Select the target service. You can specify Standard or Queueless Agent. The default is Standard. Note that this text box appears for connection target JP1/AJS3 - Manager, or JP1/AJS2 - Manager 07-00-/C or later.
- Set timeout period
-
Select whether to set a time-out period for job execution. You can specify No or Yes. The default is No.
- Timeout period
-
If you select Yes in Set timeout period, specify a time-out period in minutes. You can set 1 to 1,440 minutes. The default is a blank.
- Delayed end
-
Specify whether to monitor delayed end of jobs based on time required for execution. Select the Time-required-for-execution check box to monitor delayed end of jobs. The check box is not selected by default.
When you select the Time-required-for-execution check box, specify the time required for execution for a job from 1 to 1,440 (in minutes).
This section appears for the JP1/AJS3 - View, or JP1/AJS2 - View of version 08-50 or later. For details about cautionary notes on monitoring of delayed end of jobs based on time required for execution, see 5.1.1(3) End delay monitoring based on time-required-for-execution in the Job Management Partner 1/Automatic Job Management System 3 System Design (Work Tasks) Guide.
- Owner
-
Specify the owner of the unit. Use a character string of up to 31 bytes. The default is the login JP1 user name. Note that if the upper-level unit-attribute inheritance function has been set for the upper-level jobnet, the default is the owner of the upper-level unit.
- JP1 resource group
-
Specify a JP1 resource group name. Use a character string of up to 63 bytes. You can specify alphanumeric characters and underscores (_). The default is the JP1 resource group name of the upper-level unit. If you specify a blank, you are not authorized to access this group.
- Executed by
-
Select the user who executes the job. The default is User who registered. You can select the following items.
-
User who registered
The JP1 user who registered the job executes the job.
-
User who owns
The JP1 user who owns the job executes the job.
You must perform user mapping on the host where you want to execute the job so that the specified user is converted to a OS user.
If the execution-user fixing function is configured for the upper-level unit, the execution user conforms to the unit-attribute profile regardless of the contents of this field.
-