Hitachi

JP1 Version 12 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. Note that you can select a different presentation format depending on the data type of a property.

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

Item

Description

Definitions

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, when the related step of the property is using a service component 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.8 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.8 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 of this item when the property has a related step, when the related step of the property is using a service component 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 of this item when the property has a related step, when the related step of the property is using a service component 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 in the following cases:

  • If the related step of the property is using a service component
  • Some properties of a basic component (with type definition)
  • The property is a shared built-in service property

Restrictions

Minimum Length

Specify the restrictions of the input property. The setting items to be displayed vary depending on the data type.

You cannot change the value if:

  • The value is already specified for the property of the basic component.

Maximum Length

Restricted Character

Minimum Value

Maximum Value

Value and Presentation

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.

Presentation

Select the presentation format when displaying the input property in the Service Definition window (creating, editing, or copying) or Submit Service window. The selectable values vary depending on the data type.

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.

Data Source

This item is displayed only when Selection is selected in Presentation.

You can select either of the following. The setting items are displayed according to the selected item.

  • Static

  • Dynamic

Static

Specify List Items

Specify List Items.

Dynamic

External Resource

Select the External Resource Provider.

Options (1) and (2) below are displayed. If (2) is selected, the Create External Resource Provider dialog box is opened.

(1) defined-External-Resource-Provider

(2) Create External Resource Provider

Extra Path

Specify Extra Path.

Query Param

Specify Query Param.

Name Field

Specify Name Field.

Value Field

Specify Value Field.

#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, the editor for entering the default value appears. In this case, even if the property key is specified as the default value, 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.

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

composite

Minimum Length

Y

N

N

N

N

Y

N

Maximum Length

Y

N

N

N

N

Y

N

Minimum Value

N

N

Y

Y

Y

N

N

Maximum Value

N

N

Y

Y

Y

N

N

Restricted Character#

Y

N

N

N

N

Y

N

#

Specify the restricted characters in regular expression conforming to PCRE.

Legend:

Y: Displayed. N: Not displayed.

The following shows the correspondence between the data types and specifiable presentations of service input properties. If you wish to use the data type "list" in JP1/AO V12 or later, select the presentation "Selection" for the data type "string".

Table 4‒3: Data types and specifiable presentations (service input properties)

Data type

Presentation

Text Box

Text Box (hex)

Text Area

URL Anchor

Selection

Radio Button

Check Box

Spin Box

Capacity#1

Date Picker

Pass word

File Chooser#2

string

Y

N

Y

Y

Y

Y

N

N

N

N

N

N

boolean

N

N

N

N

Y

Y

Y

N

N

N

N

N

integer

Y

Y

N

N

Y

Y

N

Y

Y

N

N

N

double

Y

N

N

N

Y

Y

N

N

N

N

N

N

date

N

N

N

N

Y

Y

N

N

N

Y

N

N

password

N

N

N

N

N

N

N

N

N

N

Y

N

composite

N

N

Y

N

Y

N

N

N

N

N

N

Y

Legend:

Y: Can be specified. N: Cannot be specified.

#1

Capacity(Byte), Capacity(KB), Capacity(MB), Capacity(GB), Capacity(TB), Capacity(BinaryByte), Capacity(KiB), Capacity(MiB), Capacity(GiB), Capacity(TiB)

#2

Base64 encodes the data obtained from the selected file.