Hitachi

JP1 Version 12 JP1/Automatic Job Management System 3 Command Reference


6.6.1 List of API configuration components

The following lists and describes the APIs, resources, objects, and constants.

Organization of this subsection

(1) List of APIs

The following table lists and describes the APIs that can be used.

Table 6‒12: List of APIs

No.

Category

API

Description

API type

See

1

Unit information acquisition

Unit list acquisition

Acquires information about the jobnet groups, jobnets, and jobs of the specified unit or under the specified unit.

SC-004

7.1.1

2

Unit information acquisition

Acquires information about the specified unit.

SC-007

7.1.2

3

Execution result details acquisition

Acquires details about the job for which execution has ended.

SC-010

7.1.3

4

Wait condition status list acquisition

Acquires a list of the wait conditions for the specified unit and the statuses of the units that are specified in the wait conditions as the units whose end is to be waited for.

SC-046

7.1.4

5

Execution registration of a jobnet and cancellation of the execution registration

Planned execution

Performs planned execution registration of the specified jobnet.

SC-017

7.1.5

6

Fixed execution

Performs fixed execution registration of the specified jobnet.

SC-018

7.1.6

7

Immediate execution

Performs immediate execution registration of the specified jobnet.

SC-019

7.1.7

8

Registration cancellation

Cancels the execution registration of the specified jobnet for which execution registration has been performed.

SC-020

7.1.8

9

Unit operation

Change hold attribute

Changes the hold attribute of the specified jobnet or job.

SC-012

7.1.9

10

Change delay monitor

Temporarily changes the delay monitoring settings for the specified jobnet registered for execution.

SC-024

7.1.10

11

Change job status

Changes the status of the specified job.

SC-025

7.1.11

12

Change plan (change time)

Temporarily changes the scheduled execution start time of the specified jobnet registered for execution.

SC-026

7.1.12

13

Change plan (execute immediately)

Temporarily changes the execution schedule of the specified jobnet registered for execution, and then immediately executes the jobnet.

SC-027

7.1.13

14

Change plan (execution prohibited)

Temporarily changes the execution schedule of the specified jobnet registered for execution, and then prohibits execution.

SC-028

7.1.14

15

Change plan (release change)

Releases the temporary change in the execution schedule of the unit to resume according to the information before the change.

SC-029

7.1.15

16

Interrupt

Interrupts the specified root jobnet being executed.

SC-030

7.1.16

17

Kill

Kills the specified job and root jobnet that are being executed.

SC-031

7.1.17

18

Rerun

Reruns the specified jobnet or job.

SC-032

7.1.18

19

Wait status change

Temporarily changes the wait status of the specified unit.

SC-047

7.1.19

20

Execution order control method change

Temporarily changes the execution order control method for the specified root jobnet.

SC-045

7.1.20

21

Execution agent operation

Execution agent status list acquisition

Acquires a list of the statuses of the execution agents that are registered in the connection-destination JP1/AJS3 - Manager.

AG-001

7.1.21

22

Execution agent status acquisition

Acquires the statuses of the execution agents that are registered in the connection-destination JP1/AJS3 - Manager.

AG-002

7.1.22

23

Execution agent definition acquisition

Acquires the definitions of the execution agents that are registered in the connection-destination JP1/AJS3 - Manager.

AG-003

7.1.23

24

Execution agent addition

Adds an execution agent to the connection-destination JP1/AJS3 - Manager.

AG-004

7.1.24

25

Execution agent deletion

Deletes the specified execution agent from the connection-destination JP1/AJS3 - Manager.

AG-005

7.1.25

26

Execution agent reconfiguration

Changes the settings of an execution agent that is registered in the connection-destination JP1/AJS3 - Manager.

AG-006

7.1.26

27

Change the job transfer restriction status of an execution agent

Changes the job transfer restriction status of an execution agent that is registered in the connection-destination JP1/AJS3 - Manager.

AG-007

7.1.27

28

Execution agent status change

Changes the status of an execution agent that is registered in the connection-destination JP1/AJS3 - Manager.

AG-008

7.1.28

29

Checks the communication status of the job distribution delay reduction function

Checks the communication status of the job distribution delay reduction function on the connection-destination JP1/AJS3 - Manager host.

AG-016

7.1.29

30

Execution agent group status list acquisition

Acquires a list of the statuses of the execution agent groups that are registered in the connection-destination JP1/AJS3 - Manager.

AG-009

7.1.30

31

Execution agent group definition acquisition

Acquires the definitions of the execution agent groups that are registered in the connection-destination JP1/AJS3 - Manager.

AG-010

7.1.31

32

Execution agent group addition

Adds an execution agent group to the connection-destination JP1/AJS3 - Manager.

AG-011

7.1.32

33

Execution agent group deletion

Deletes the specified execution agent group from the connection-destination JP1/AJS3 - Manager.

AG-012

7.1.33

34

Execution agent group reconfiguration

Changes the settings of an execution agent group that is set in the connection-destination JP1/AJS3 - Manager.

AG-013

7.1.34

35

Changes the job transfer restriction status of an execution agent group

Changes the job transfer restriction status of an execution agent group that is registered in the connection-destination JP1/AJS3 - Manager.

AG-014

7.1.35

36

Exclude or add execution agents, or to change their priority levels

Excludes or adds execution agents for an execution agent group that is registered in the connection-destination JP1/AJS3 - Manager, or changes the priority level of such execution agents.

AG-015

7.1.36

37

Other

Version information acquisition

Acquires the version information of the product.

OT-003

7.1.37

38

JP1/AJS3 - Manager protocol version acquisition

Acquires the protocol version of connection-destination JP1/AJS3 - Manager.

OT-005

7.1.38

(2) List of resources

The following table lists and describes the resources that can be used.

Table 6‒13: List of resources

No.

Resource

Description

See

1

Resource for status monitoring

Indicates the unit for status monitoring, or generation information. The resource for status monitoring contains the following objects:

  • Unit definition information

  • Status information

  • Release information

7.2.1

2

Resource for unit definition

Indicates the resource for unit definition. This resource is specified for the API for which execution registration of the jobnet is performed.

None

(3) List of objects

The following table lists and describes the objects that can be used.

Table 6‒14: List of objects

No.

Object

Description

See

1

Unit definition information

Indicates the unit definition information, such as the unit name and unit type.

7.3.1

2

Status information

Indicates the status information of a unit, such as the start time and status.

7.3.2

3

Release information

Indicates the release information of a unit, such as the release date and release ID.

7.3.3

4

Start condition parameter

Indicates the setting values, such as the count and time in the start condition.

7.3.4

5

Macro variable

Indicates the macro variable name and passing information.

7.3.5

6

Execution agent operation result

Indicates the result of operating an execution agent or execution agent group.

7.3.6

7

Execution agent definition information

Indicates the definition information of an execution agent or execution agent group.

7.3.7

8

Execution agent status

Indicates the status of an execution agent or execution agent group.

7.3.8

(4) List of constants

The following table lists and describes the constants that can be used.

Table 6‒15: List of constants

No.

Category

Constant

Description

See

1

Constant commonly used by various APIs

DateType

Indicates the type of specifying the start and end times.

7.4.1

2

Constants used by the unit list acquisition API

LowerType

Indicates how to acquire the units under the specified unit.

7.4.2

3

SearchTargetType

Indicates the range of the units to be acquired.

4

MatchMethods

Indicates how to collate the character string.

5

UnitType

Indicates the unit type.

6

GenerationType

Indicates how to acquire the generation.

7

UnitStatus

Indicates the unit status.

8

DelayType

Indicates whether the start delay or end delay is specified.

9

HoldPlan

Indicates whether there is a hold plan.

10

ReleaseInfoSearchMethods

Indicates how to acquire release information.

11

Constant used by the execution registration API

PlannedTimePassedType

Indicates the execution timing of the unit for which the planned time has passed when the scheduler service starts and when the execution registration is performed.

7.4.3

12

Constants used by the unit definition information object

Type

Indicates the unit type.

7.4.4

13

RegisterStatus

Indicates the registration status of the unit.

14

Constants used by the status information object

Status

Indicates the unit status.

7.4.5

15

DelayStart

Indicates whether the start delayed.

16

DelayEnd

Indicates whether the end delayed.

17

ChangeType

Indicates whether the plan was temporarily changed.

18

HoldAttr

Indicates the hold attribute.

19

HoldPlan

Indicates whether there is a hold plan.

20

ExecutionType

Indicates the registration type.

21

StatusInSummary

Indicates the summary (status category and whether a delay occurred).

22

TimeType

Indicates the time type for the valid range of start condition.

23

Waiting

Indicates whether there are wait conditions that have not been met.

24

JobnetDelayMonitorType

Indicates the method of monitoring delays for jobnets.

25

TimeRequiredForExecutionType

Indicates whether jobnet execution end delays are monitored based on the time required for jobnet execution.

26

ExecOrderMethod

Indicates the execution order control method of a jobnet.

27

Constant used by the release information object

ReleaseStatus

Indicates the release status.

7.4.6

28

Constant used by the start condition parameter object

TimeType

Indicates the time type for the valid range of start condition.

7.4.7

29

Constant used for changing the hold attribute

ChangeHoldAttr

Indicates a change in the hold attribute.

7.4.8(1)

30

Constants used for temporarily changing a plan

ChangeStartTimeType

Indicates the type of execution start time when the plan is temporarily changed.

7.4.9(1)

31

ChangePushedAheadType

Indicates how the schedule is pushed ahead when the plan is temporarily changed.

7.4.9(2)

32

ChangeLowerType

Indicates whether to change the start time of lower jobnets when the plan is temporarily changed.

7.4.9(3)

33

Constants used by the rerun API

RootRerunType

Indicates how to rerun a root jobnet.

7.4.10(1)

34

RerunType

Indicates how to rerun a nested jobnet or job.

7.4.10(2)

35

RerunOption

Indicates the rerun option.

7.4.10(3)

36

Constants used for changing delay monitoring

DelayMonitorType

Indicates the method of monitoring delays for jobnets.

7.4.11(1)

37

MonitoringJobnetType

Indicates the method of end delay monitoring based on the time required for executing the jobnet.

7.4.11(2)

38

Constant used for job status change

ChangeStatus

Indicates the job status after the change.

7.4.12(1)

39

Constants used for waiting

WaitMethod

Indicates the conditions under which a unit can wait.

7.4.13

40

WaitingAction

Indicates the behavior of a unit with wait conditions.

41

WaitingStatus

Indicates a unit with wait conditions and the statuses of the units whose end is being waited for.

42

WaitingStatusAction

Indicates whether to waiting is enabled or disabled.

43

Constants used for execution agent objects

ExecAgentStatus

Indicates the job transfer restriction status of an execution agent or execution agent group.

7.4.14

44

ComStatus

Indicates the status of an execution agent.

45

Constant used by the unit information acquisition API

ConnectInfoType

Indicates whether to obtain connection information when obtaining the Status information object (unitStatus) of the Resource for status monitoring.

7.4.16