Inputs and Outputs for Web Forms

You can use the Designer to create web-based forms. Then you use these forms in a Form activity to make them available to an operator during run time. The input and output parameters based on the selected form or display are shown in a workflow Form activity.

Text

Input Parameters

Inputs	Data Type	Description
`Name`.Value	String	Specifies the text value for a named text field in a form. You can perform a bind, build an expression, or set a literal value against this parameter.

Image

Input Parameters

Inputs	Data Type	Description
`Name`.URL	String	Specifies the web address where the image is located. You can perform a bind, build an expression, or set a literal value against this parameter.

Inputs

Data Type

Description

Name.URL

String

Specifies the web address where the image is located.

You can perform a bind, build an expression, or set a literal value against this parameter.

List Boxes

Input Parameters

Note: If both the initial index and value are set, and they both are different, then the index takes precedence over the value.

Inputs	Data Type	Description
`Name`.Value	String	Specifies the initial selection for a named control by string value. The initial value is the default selection displayed when a form loads. If an invalid value is set, no selection is made. You can perform a bind, build an expression, or set a literal value against this parameter.
`Name`.InitialIndex	String	Specifies an initial selection for a named control by 0-based index value. The initial value is the default selection displayed when a form loads. If an invalid value is set, no selection is made. You can perform a bind, build an expression, or set a literal value against this parameter.
`Name`.Label	String	Specifies the label text for a named control in a form. You can perform a bind, build an expression, or set a literal value against this parameter.
`Name`.OptionNames	String[]	Specifies the complete list of display name options available for this form control. To modify these options, click the ellipsis button to open the String Collection Editor, and then enter other options. You can bind this item to defined variables. Note: For custom forms, plain text option names only are supported, not arbitrary HTML.
`Name`.OptionValues	String[]	Specifies the complete list of internal option values available for this form control. To modify these options, click the ellipsis button to open the String Collection Editor, and then enter other options. You can bind this item to defined variables.

Output Parameters

Outputs	Data Type	Description
`Name`.Value	String	Contains the first user-defined text value for the named control in a form. For example, the output property ListBox001.Value contains the user supplied value for a list box with name of ListBox001.
`Name`.Values	String[]	Contains the user-defined text values for the named control in a form. These values are used for the multiple entry selection feature of the list box control. If no selection is made, then this array is empty.
`Name`.SelectedIndex	Int32	Contains the 0-based index of the first user selection for the named control in a form. If no selection is made, then this value is set to -1.
`Name`.SelectedIndexes	Int32[]	Contains the 0-based indexes of all user selections for the named control in a form. These values are used for the multiple entry selection feature of the list box control. If no selection is made, then this array is empty.

Radio Buttons

Input Parameters

Note: If both the initial index and value are set, and they both are different, then the index takes precedence over the value.

Inputs	Data Type	Description
`Name`.Value	String	Specifies the initial selection for a named control by string value. The initial value is the default selection displayed when a form loads. If an invalid value is set, no selection is made. You can perform a bind, build an expression, or set a literal value against this parameter.
`Name`.InitialIndex	String	Specifies an initial selection for a named control by 0-based index value. The initial value is the default selection displayed when a form loads. If an invalid value is set, no selection is made. You can perform a bind, build an expression, or set a literal value against this parameter.
`Name`.Label	String	Specifies the label text for a named control in a form. You can perform a bind, build an expression, or set a literal value against this parameter.
`Name`.OptionNames	String[]	Specifies the complete list of display name options available for this form control. To modify these options, click the ellipsis button to open the String Collection Editor, and then enter other options. You can bind this item to defined variables. Note: For custom forms, plain text option names only are supported, not arbitrary HTML.
`Name`.OptionValues	String[]	Specifies the complete list of internal option values available for this form control. To modify these options, click the ellipsis button to open the String Collection Editor, and then enter other options. You can bind this item to defined variables.

Output Parameters

Outputs	Data Type	Description
`Name`.Value	String	Contains the user-defined text value for the named control in a form. For example, the output property Radio001.Value contains the user supplied value for a radio button with name of Radio001.
`Name`.SeletedIndex	Int32	Contains the 0-based index of the first user selection for the named control in a form. If no selection is made, then this value is set to -1.

Combo Boxes

Input Parameters

Note: If both the initial index and value are set, and they both are different, then the index takes precedence over the value.

Inputs

Data Type

Description

Name.Value

String

Specifies the initial selection for a named control by string value. The initial value is the default selection displayed when a form loads. If an invalid value is set, no selection is made.

You can perform a bind, build an expression, or set a literal value against this parameter.

Name.InitialIndex

String

Specifies an initial selection for a named control by 0-based index value. The initial value is the default selection displayed when a form loads. If an invalid value is set, no selection is made.

You can perform a bind, build an expression, or set a literal value against this parameter.

Name.Label

String

Specifies the label text for a named control in a form.

You can perform a bind, build an expression, or set a literal value against this parameter.

Name.OptionNames

String[]

Specifies the complete list of display name options available for this form control. To modify these options, click the ellipsis button to open the String Collection Editor, and then enter other options.

You can bind this item to defined variables.

Note: For custom forms, plain text option names only are supported, not arbitrary HTML.

Name.OptionValues

String[]

Specifies the complete list of internal option values available for this form control. To modify these options, click the ellipsis button to open the String Collection Editor, and then enter other options.

You can bind this item to defined variables.

Output Parameters

Outputs	Data Type	Description
`Name`.Value	String	Contains the user-defined text value for the named control in a form. For example, the output property ComboBox001.Value contains the user supplied value for a combo box with name of ComboBox001.
`Name`.SelectedIndex	Int32	Contains the 0-based index of the first user selection for the named control in a form. If no selection is made, then this value is set to -1.

Check Boxes

Input Parameters

Inputs	Data Type	Description
`Name`.Value	String	Specifies the initial activation state of a named control in a form. You can perform a bind, build an expression, or set a literal value against this parameter.
`Name`.Label	String	Specifies the label text for a named control in a form. You can perform a bind, build an expression, or set a literal value against this parameter.

Inputs

Data Type

Description

Name.Value

String

Specifies the initial activation state of a named control in a form.

You can perform a bind, build an expression, or set a literal value against this parameter.

Name.Label

String

Specifies the label text for a named control in a form.

You can perform a bind, build an expression, or set a literal value against this parameter.

Output Parameters

Outputs	Data Type	Description
`Name`.Value	Boolean	Contains true or false depending on whether the operator selected or cleared the named control in a form.

Text Area

Input Parameters

Inputs	Data Type	Description
`Name`.Value	String	Specifies the initial text value for a named control in a form. You can perform a bind, build an expression, or set a literal value against this parameter.
`Name`.Label	String	Specifies the label text for a named control in a form. You can perform a bind, build an expression, or set a literal value against this parameter.

Inputs

Data Type

Description

Name.Value

String

Specifies the initial text value for a named control in a form.

You can perform a bind, build an expression, or set a literal value against this parameter.

Name.Label

String

Specifies the label text for a named control in a form.

You can perform a bind, build an expression, or set a literal value against this parameter.

Output Parameters

Outputs	Data Type	Description
`Name`.Value	String	For example, the output property TextArea001.Value contains the user supplied value for a text area with name of TextArea001.

Text Boxes

Input Parameters

Inputs	Data Type	Description
`Name`.Value	String	Specifies the initial text value for a named control in a form. You can perform a bind, build an expression, or set a literal value against this parameter.
`Name`.Label	String	Specifies the label text for a named control in a form. You can perform a bind, build an expression, or set a literal value against this parameter.

Inputs

Data Type

Description

Name.Value

String

Specifies the initial text value for a named control in a form.

You can perform a bind, build an expression, or set a literal value against this parameter.

Name.Label

String

Specifies the label text for a named control in a form.

You can perform a bind, build an expression, or set a literal value against this parameter.

Output Parameters

Outputs	Data Type	Description
`Name`.Value	String	Contains the user-defined text value for the named control in a form. For example, the output property TextBox001.Value contains the user supplied value for a text box with name of TextBox001.