Hitachi

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


4.2.4 Items set for input properties of services

The following table describes the items that can be set in the Create Input Property for Service dialog box or Edit Input Property for Service dialog box.

Table 4‒1: Items set for the input property of a service

Item

Description

Related Step

Displays the related step of the property.

This item is displayed when you edit a property for which the GUI Visibility check box is selected in the Step Properties area in the Flow tab of the Service Builder Edit window.

Key

Enter the property key.

You cannot change the value for this item when the property has a related step, or when the property is a shared built-in service property.

Display Name#1

Enter the property name.

Description#1

Enter the description for the property.

Property Group

Select the property group that the property is to belong to.

You cannot change the value for this item when the related step of the property is using a service component.

You can also set a property group by dragging the service property and dropping it on a property group in the Property tab of the Service Builder Edit window.

Visibility#1

Set the visibility in the Create Service window and Submit Service window. Set the visibility when you want to restrict the role of users who are allowed to view the input property. Whether the input property is displayed in each window differs, depending on the combination of the settings for Display Settings and this item. For details about the combination of Visibility and Display Settings, see 4.2.7 Visibility and display settings for properties.

You cannot change the value for this item when the related step of the property is using a service component, or when the property is a shared built-in service property.

Display Settings#1

Select the display settings in the Create Service window and Submit Service window. Set the display settings when you want to restrict the operations the users can perform on the input property. Whether the input property is displayed in each window and whether the value can be changed differ, depending on the combination of the settings for Visibility and this item. For details about the combination of Visibility and Display Settings, see 4.2.7 Visibility and display settings for properties.

Service Share Property

If you select this item, the input property becomes a shared service property.

You cannot change the value for this item when the property has a related step, or when the property is a shared built-in service property. If composite is selected for the data type, you cannot select this item.

Required

If you select this item, the input property becomes a required property.

You cannot change the value for this item when the property has a related step, or when the property is a shared built-in service property.

Data Type

Select the data type of the input property.

You cannot change the value for this item when the related step of the property is using a service component, or when the property is a shared built-in service property. In addition, for a basic plug-in, you cannot change the data type of some properties.

Setting Method

Select the setting method of the input property.

This item is displayed if all the following conditions are satisfied:

  • The property has a related step.

  • The property is not a shared service property.

  • The property is not mapped (in the service component) to another property.

Note that if you select View Property for the setting method, you will not be able to change the default value in the Create Service window or Submit Service window.

Default Value#1#2

Specify the default value of the property.

This item is not displayed when the property is a shared built-in service property.

If the related step of the property being edited is using a service component, and the property is mapped (in the service component) to another property, (Internal Property) is displayed as the default value and it cannot be changed.

Validation Script

Specify the validation script of the property.

Clicking the Generate button displays an editor used to input the validation script.

This item is not displayed for service share properties.

#1

You can also edit the item in the Properties area in the Property tab of the Service Builder Edit window.

#2

If composite is selected for the data type and Direct Input is selected for the setting method, you can upload a file for the default value. In this case, even if the property key is specified in the uploaded file, the property key is treated as a character string and the property value cannot be obtained.

Tip

The difference between the string type and composite type is the number of characters you can specify. For the string type, you can specify 1,024 or fewer characters. For the composite type, you can specify a character string whose size is 30 MB or less. For example, if you want to map an output property that has more than 1,024 characters to the input property of another step, specify the composite type for the data type of the input property. If you select the composite type in the Create Input Property for Service dialog box, specify the default value by uploading a file.

The following table lists the items displayed according to the selected data type.

Table 4‒2: Items set for the input property of a service (whether the items are displayed differs depending on the data type)

Item

Data type

string

boolean

integer

double

date

password

list

composite

Minimum Length

Y

N

N

N

N

Y

N

N

Maximum Length

Y

N

N

N

N

Y

N

N

Minimum Value

N

N

Y

Y

Y

N

N

N

Maximum Value

N

N

Y

Y

Y

N

N

N

Specify List Items

N

N

N

N

N

N

Y

N

Restricted Character#

Y

N

N

N

N

Y

N

N

#

Specify the restricted characters in regular expression conforming to PCRE.

Legend:

Y: Displayed. N: Not displayed.