Hitachi

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


7.3.1 Unit definition information object

This object indicates unit definition information.

For details about whether the API can acquire the unit definition information object, see D.2 List of members of the unit definition information object that can be acquired by the API.

Format
{
  "unitName":"unit-full-path-name",
  "unitComment":"comment-of-the-unit",
  "unitType":"unit-type",
  "owner":"Owner",
  "execAgent":"execution-agent-name",
  "execFileName":"execution-file-name-or-script-file-name",
  "parameters":"Parameter",
  "customJobType":"custom-job-type",
  "registerStatus":"registration-status-of-the-unit",
  "recoveryUnit":whether-the-unit-is-a-recovery-unit,
  "unitID":unit-ID,
  "wait":whether-the-unit-is-a-unit-with-wait-condition,
  "jobnetReleaseUnit":whether-release-entry-has-been-performed-for-the-unit,
  "jp1ResourceGroup":"JP1-resource-group-name",
  "simpleUnitName":"unit-name",
  "rootJobnetName":"full-name-of-the-unit-of-the-root-jobnet"
}
Member

The following table lists and describes the members to be returned.

Table 7‒41: List of members of the unit definition information object

Member

Data type

Description

unitName

string

Returns the full name of the unit, by using a character string in the range from 1 to 930 bytes. If information cannot be acquired, a character string of 0 bytes is returned.

unitComment

string

Returns the comment for the unit, by using a character string in the range from 0 to 80 bytes. If information cannot be acquired, or if no comment is defined for the unit, a character string of 0 bytes is returned.

unitType

string

Returns the unit type, by using a character string constant specified for the Type constant. For details about the Type constant, see 7.4.4(1) Type.

If information cannot be acquired, NONE (not applicable) is returned.

owner

string

Returns the owner name defined for the unit, by using a character string in the range from 0 to 31 bytes. If information cannot be acquired, or if no owner name is defined for the unit, a character string of 0 bytes is returned.

execAgent

string

Returns the execution agent (execution agent name or execution agent group name) defined for the unit, by using a character string in the range from 0 to 255 bytes.

If information cannot be acquired, or if no execution agent is defined for the unit, a character string of 0 bytes is returned.

execFileName

string

Returns the execution file name or script file name that is defined for the unit, by using a character string in the range from 0 to 511 bytes.

In the following cases, a character string of 0 bytes is returned:

  • When information cannot be acquired

  • When no execution file name or no script file name is defined

  • When the unit is other than the Unix job, PC job, flexible job, and QUEUE job

parameters

string

Returns the parameter defined for the PC job, Unix job, flexible job, or QUEUE job, by using a character string in the range from 0 to 1,023 bytes.

In the following cases, a character string of 0 bytes is returned:

  • When information cannot be acquired

  • When no parameter is defined

  • When the unit is other than the Unix job, PC job, flexible job, and QUEUE job

customJobType

string

Returns the type of the custom job by using a character string when the value of the unitType member is CUSTOM (custom job). For details about the list of custom job types, see Table 7-42.

If information cannot be acquired, or if the value of the unitType member is not CUSTOM, a character string of 0 bytes is returned.

registerStatus

string

Returns the execution registration status of the unit, by using a character string constant specified for the RegisterStatus constant. For details about the RegisterStatus constant, see 7.4.4(2) RegisterStatus.

If information cannot be acquired, NONE (not applicable) is returned.

recoveryUnit

boolean

Returns whether the recovery attribute is set for the unit.

If the recovery attribute is set for the unit, true is returned.

If information cannot be acquired, or if no recovery attribute is set for the unit, false is returned.

unitID

int

Returns the unit ID in number.

If information cannot be acquired, -1 is returned.

wait

boolean

Returns whether the unit is a unit with wait condition.

If the unit is a unit with wait condition, true is returned.

If information cannot be acquired, or if the unit is not a unit with wait condition, false is returned.

jobnetReleaseUnit

boolean

Returns whether release entry has been performed for the unit.

If release entry has been performed for the unit, true is returned. If information cannot be acquired or if release entry has not been performed for the unit, false is returned.

jp1ResourceGroup

string

Returns the JP1 resource group name defined for the unit, by using a character string in the range from 0 to 63 bytes.

If information cannot be acquired, or if no JP1 resource group is defined for the unit, a character string of 0 bytes is returned.

simpleUnitName

string

Returns the unit name, by using a character string in the range from 1 to 30 bytes. If information cannot be acquired, a character string of 0 bytes is returned.

rootJobnetName

string

Returns the full name of the unit of the root jobnet, by using a character string in the range from 1 to 930 bytes.

If information cannot be acquired, a character string of 0 bytes is returned.

Table 7‒42: List of custom job types

Category

Description

Standard Custom Job

CUSTOM_PC_ADSHPC

CUSTOM_PC_ADSHAPPEXEC

CUSTOM_PC_ADSHUX

CUSTOM_PC_COSMNGAP

CUSTOM_PC_COSMNGSV

CUSTOM_PC_CPALINK

CUSTOM_PC_DHAJEL

CUSTOM_PC_DHAJEW

CUSTOM_PC_DMSV

CUSTOM_PC_JP1AMOAP

CUSTOM_PC_JP1AMR3

CUSTOM_PC_JP1AMR3BW

CUSTOM_PC_JP1AMR3CP

CUSTOM_PC_JP1FTP

CUSTOM_PC_JP1SOVAR

CUSTOM_PC_MFJOB

CUSTOM_PC_OAP_JOB

CUSTOM_PC_R3_JOB

CUSTOM_PC_VOS1JOB

CUSTOM_PC_VOS1NET

CUSTOM_PC_VOS3JOB

CUSTOM_PC_VOSKJOB

CUSTOM_PC_VOSKNET

CUSTOM_UX_JP1AMOAP

CUSTOM_UX_JP1AMR3

CUSTOM_UX_JP1AMR3BW

CUSTOM_UX_JP1AMR3CP

CUSTOM_UX_JP1FTP

User Custom Job

Custom PC Job

CUSTOM_PC_USER_class-name

Custom UNIX Job

CUSTOM_UX_USER_class-name

Note

The class name differs, depending on the program that JP1/AJS3 links with. For details, see 12.13.2 Set Properties of Custom Job dialog box in the JP1/Automatic Job Management System 3 Operator's Guide.