Specify/Edit Input Property for Custom Plug-in dialog box

Ops Center Automator Service Builder User Guide

Version
11.0.x
Audience
anonymous
Part Number
MK-99AUT002-18

The following table describes the Specify/Edit Input Property for Custom Plug-in dialog box fields, subfields, and field groups.

When you enter information in a dialog box, if the information is not valid, errors include a description of the problem at the right side of the box.

Field Group Field Description
Definitions Key: * Input property key name.
Display Name: * Name of the input property.
Description: Description of the input property.
Visibility: Choose whether the input property is visible on both the Edit and Submit windows [Edit and Submit Window], or just in the Edit window [Edit Window Only].
Display Settings: Specifies the display setting for the input property. The choices are:
  • Editable
  • Read only
  • Hide
Required: Specifies that the property is required when this check box is checked.
Data Type: Select a data type of the property: string, boolean, integer, double, date, password, composite. Various options are presented for specifying restrictions on the data entry, depending on the options you chose.

When dealing with arrays, you can verify the Array Type option for the data type to be treated as an array. A set of the properties of the same type (Number of elements is a variable) can be handled as a single property to make data mapping easier, especially when passing data between a service and the plug-ins.

Verifying the File Reference check box specifies that the value of the property is expressed as the file path. The value of the property is automatically stored in a file, and you can retrieve the path of the file as an input property. For example, you can use a file path in the command line instead of a direct value.

Content Type: Select the content type:
  • application/json
  • application/javascript
  • application/xml
  • text/html
  • text/plain
  • text/csv
  • application/octet-stream
Domain Type: Enter the domain type from the list or add a new domain type by clicking the Plus Sign and entering the details from the Create Domain Type Definition dialog box. This option is available when you choose composite for the Data Type and application/json for the Content Type.
Restrictions Minimum Value/Length: Specifies the minimum value for an integer and double. If the data type is string or password, then enter the minimum length of the property. If the data type is date, then enter the earliest date.
Maximum Value/Length: Specifies the maximum value for an integer and double. If the data type is string or password, then enter the maximum length of the property. If the data type is date, then enter the current date.
Restricted Character: If the data type is string or password, then enter the allowed characters by using a regular expression.

Example: ^[0-9a-zA-Z\.\-]*$

Minimum Array Length: Specifies the minimum length of array elements.
Maximum Array Length: Specifies the maximum length of array elements.
Validation Script: Validates the property based on the associated javascript code.
Value and Presentation Presentation: Specifies options that determine how the property selection is presented, depending on the selected Data Type.
Default Value: Specifies the default value for the property. The values that can be specified differ depending on the data type.

When specifying the Array Type option, the default value must be written as a comma-separated string value surrounded by brackets.

Example: ["1","2","3"]

Data Source: Specifies the data as Static or Dynamic and derived from an external resource provider.
Specify List Items: Specifies the "Specify List Items" when the data source for the property is derived statically (when choosing the Static option for the Data Source).
External Resource: Specifies the external resource provider when the data source for the property is derived dynamically (when choosing the Dynamic option for the Data Source.

In the list, you can also add, edit, upload, or delete for the external resource provider.

Extra Path: Specifies the extra path portion of the request URL. Leave it empty if it is not required. The extra path is the path that follows the external resource provider ID in a URL as follows:

/Automation/v1/objects/ExternalResources/<external resource provider ID>/<extra path>?<query parameters>

Query Param: Specifies the query parameter for the external resource provider. The serviceID and serviceTemplateID parameters are added automatically. You can specify {$ref:keyName} to embed the property value of other properties. For a JSON value, you can specify {$ref:keyName#json path}.
Name Field: Specifies the field name of the object collection to use the label of the selection. If omitted, uses the name field.
Value Field: Specifies the field name of the object collection to use the label of the selection. If omitted, uses the instance ID field.
Show If: Show the property entry if the conditions are met.
Enable If: Enable the property if the conditions are met.
Fields marked with an asterisk (*) are required.