Hitachi

JP1 Version 12 JP1/Automatic Operation Service Template Developer's Guide 


3.6.8 List of reserved properties

A reserved property is a special service property whose property key has a specific definition or purpose in JP1/AO. The property key of a reserved property begins with "reserved". You can use reserved properties by mapping them to step properties in the Specify Component Input Property Mapping Parameters dialog box or Specify Component Output Property Mapping Parameters dialog box. Users do not need to define or assign values to reserved properties.

When you map a reserved property to an input property, the value of the reserved property is assigned to a plug-in property when the plug-in is executed.

To use a reserved property, select the View Property radio button in the Specify Component Input Property Mapping Parameters dialog box.

Alternatively, select the Direct Input option, and then click the Insert Property button. If you select a reserved property in the Select Reference Property dialog box#, you can specify (in the Value text box) the reserved property in the format "?dna_reserved-property-key?". In this case, the value of the reserved property supplies part of the value of the plug-in properties at plug-in execution.

#
In the Step Tree area, if you select a step of a repeated execution plug-in, the RESERVED PROPERTY dialog box is displayed. In this dialog box, reserved properties related to repeated execution plug-ins are displayed.

[Figure]

When you use a reserved property as an output property, the reserved property stores the value of a designated plug-in property. By selecting the View Property radio button in the Specify Component Output Property Mapping Parameters dialog box, you can specify a reserved property to which the value of the output property is passed.

Table 3‒13: List of reserved properties

Reserved property key

Description

reserved.external.hcmds.dir

Supplies the internal directory (HiCommand) that is created in the same layer as the JP1/AO installation directory. This property is used to add new External Resource Provider.

Example: C:\\Program Files\\Hitachi\\HiCommand

reserved.external.path

Supplies the additional path of the REST API request that was specified for Additional Path. This property is used to add new External Resource Provider.

reserved.external.query

Supplies the query parameter to be passed to the REST API request that was specified for Query parameter. This property is used to add new External Resource Provider.

reserved.external.resource.dir

Supplies the resource directory of an external resource. This property is used to add new External Resource Provider.

Example:

C:\\Program Files\\Hitachi\\JP1AO\\contents\\ExternalResources\\6e29b455-90ef-45d7-b973-458f5ba5320d

reserved.external.userName

Supplies the user that is logged in to JP1/AO from the REST API. This property is used to add new External Resource Provider.

reserved.loop.index#1

References a numerical value from 1 to 99 that indicates how many times a repeated execution plug-in located one level above the selected plug-in has repeated.

Of the comma-delimited values specified in the inputProperties property of the repeated execution plug-in, this property stores the position of the parameter to which the current execution applies. You can also reference this value when parallel is set as the execution method of the repeated execution plug-in. To reference this reserved property, specify the property key in the format ?dna_reserved.loop.index?. Like the reserved.loop.input property, you can use this property in any plug-in within the flow of the repeated execution plug-in, provided that service properties can be mapped to the plug-in.

reserved.loop.indexN#1

References a numerical value from 1 to 99 that indicates the number of times that a repeated execution plug-in located N levels above the selected plug-in has been executed.

Of the comma-delimited values specified in the inputProperties property of the repeated execution plug-in, this property stores the position of the parameter to which the current execution applies. You can also reference this value when parallel is set as the execution method of the repeated execution plug-in. To reference this reserved property, specify the property key in the format ?dna_reserved.loop.indexN?. Like the reserved.loop.input property, you can use this property in any plug-in within the flow of the repeated execution plug-in, provided that service properties can be mapped to the plug-in.

Note: Above, N represents the integer 2 or 3.

reserved.loop.input#1

References the value of the inputProperties input property of a repeated execution plug-in located one level above the selected plug-in.

As one of the comma-delimited values specified in the input properties of the repeated execution plug-in, this property stores the value of the element that corresponds to the current iteration of the flow. For example, if the input property is "A, B, C", the values A, B, and C are input in the order corresponding to the repetition count of the flow. The repeated execution plug-in can be executed a maximum of 99 times. To reference this reserved property, specify the property key in the format ?dna_reserved.loop.input?.

reserved.loop.inputN#1

References the value of the inputProperties property of a repeated execution plug-in that is located N levels above the selected plug-in.

As one of the comma-delimited values specified in the input properties of the repeated execution plug-in, this property stores the value of the element that corresponds to the current iteration of the flow. For example, if the input property is "A, B, C", the values A, B, and C are input in the order corresponding to the repetition count of the flow. The repeated execution plug-in can be executed a maximum of 99 times. To reference this reserved property, specify the property key in the format ?dna_reserved.loop.inputN?.

Note: Above, N represents the integer 2 or 3.

reserved.loop.output

Passes values to the outputProperties output property of a repeated execution plug-in.

The values output to this property are assigned to the output property as a comma-separated value. For example, if the values of the output property of the plug-in are X, Y, and Z for successive iterations, the value "X, Y, Z" is assigned to the output property.

reserved.service.name

References the name of the service from which a task was generated.

To reference this reserved property, specify the property key in the format ?dna_reserved.service.name?. You can use this property in any plug-in to which service properties can be mapped.

reserved.step.path

References the ID of the step that is currently being executed.

To reference this reserved property, specify the property key in the format ?dna_reserved.step.path?. The value of this property is the same as the step ID displayed in the messages output to the task log when plug-in execution begins and ends. You can use this property in any plug-in to which service properties can be mapped.

reserved.service.serviceGroupName

References the service group in which the service from which a task was generated is registered.

To reference this reserved property, specify the property key in the format ?dna_reserved.service.serviceGroupName?. You can use this property in any plug-in to which service properties can be mapped.

reserved.step.prevReturnCode

Supplies the return value of the preceding step (the step that is the origin of the relational line connected to the plug-in).

To reference this reserved property, specify the property key in the format ?dna_reserved.step.prevReturnCode?. If there are multiple preceding steps, the property is assigned the logical sum of all the return values. If there is no preceding step, 0 is assigned. You can use this property in any plug-in to which service properties can be mapped.

If you retry a task from a step that references this reserved property without executing the preceding step, the return value from the last time the preceding step was executed is set in this reserved property as the return value of the preceding step.#

reserved.task.description

Supplies the description of a task.

To reference this reserved property, specify the property key in the format ?dna_reserved.task.description?. You can use this property in any plug-in to which service properties can be mapped.

reserved.task.dir

Supplies the path of the temporary data folder created during task execution.

This property provides a unique folder path at the execution of each task.

The folder referenced by this property is created on the JP1/AO server when the task is executed, and deleted when the task is archived.

Note that files and folders that start with "task" are reserved in JP1/AO, and cannot be created by the user.

reserved.task.id

Supplies the task ID.

To reference this reserved property, specify the property key in the format ?dna_reserved.task.id?. You can use this property in any plug-in to which service properties can be mapped.

reserved.task.name

Supplies the task name.

To reference this reserved property, specify the property key in the format ?dna_reserved.task.name?. You can use this property in any plug-in to which service properties can be mapped.

reserved.task.submitter

Supplies the user ID of the user who submitted the task for execution.

If the task was retried, this property references the user ID of the user who submitted the task, not the user who retried the task.

To reference this reserved property, specify the property key in the format ?dna_reserved.task.submitter?. You can use this property in any plug-in to which service properties can be mapped.

reserved.task.tags

Supplies the tags set for the task.

To reference this reserved property, specify the property key in the format ?dna_reserved.task.tags?. You can use this property in any plug-in to which service properties can be mapped.

reserved.task.url

Supplies the URL for accessing the Task Details window.

To reference this reserved property, specify the property key in the format ?dna_reserved.task.url?. You can use this property in any plug-in to which service properties can be mapped.

reserved.terminal.account

References the user ID used by a terminal connect plug-in.

This property is used by the commandLine input property of a terminal command plug-in.

It stores the login name of the user account used to connect to the terminal.

reserved.terminal.password

References the password used by a terminal connect plug-in.

This property is used by the commandLine input property of a terminal command plug-in.

It stores the password of the user account used to connect to the terminal.

reserved.terminal.suPassword

References the administrator password used by the terminal connect plug-in.

This property is used by the commandLine input property of a terminal command plug-in.

It stores the password of the superuser used to connect to the terminal.

#1
If the definition of repeated execution plug-ins is nested, the input value of a repeated execution plug-in (reserved.loop.input, reserved.loop.inputN) and a value that indicates how many times the repeated execution plug-in has been repeated (reserved.loop.index, reserved.loop.indexN) are displayed together in a pull-down menu. In this case, the step names of repeated execution plug-ins are displayed in parentheses. The following figure shows the details.

[Figure]

#2

The following shows examples of the values assigned to the reserved property when a task is retried:

[Figure]

The illustrated flow consists of Step 1, Step 2, and Step 3. The reserved.step.prevReturnCode property is defined for Step 2 and Step 3. The return value of Step 1 is 0, and the return value of Step 2 is 63, indicating an error. The task fails with Step 3 in Unexecuted status.

In this scenario, if you use the Retry the Task From the Failed Step option, the value of reserved.step.prevReturnCode (the return value of Step 1) is 0 from the perspective of Step 2. If you use the Retry the Task From the Step After the Failed Step option, the value of reserved.step.prevReturnCode (the return value of Step 2) is 63 from the perspective of Step 3.