Previous Topic: Form ElementsNext Topic: View Form Property Values in a Separate Window


Form Element Properties

Note: Point to a form element attribute to view the element tool-tip description for assistance in completing the form.

Allow Adding of Rows

A Boolean (true or false) value for tables and simple arrays. When true, a button lets form users create rows in the table. When false, users cannot add rows to the table.

Allow Decimals

A Boolean (true or false) value for spinner fields. When true, users can enter numbers with decimals (such as 12.25 or 0.003). When false, users cannot enter decimal numbers in the field; only whole numbers.

Allow Deletion of Rows

A Boolean (true or false) value for tables and simple arrays. When true, a button lets form users remove rows from the table. When false, users cannot remove rows from the table.

Allow Negative Numbers

A Boolean (true or false) value for spinner fields. When true, users can enter numbers less than zero (such as -10). When false, users cannot enter negative numbers; only 0 or positive numbers.

Allow Reordering of Rows

A Boolean (true or false) value for tables and simple arrays. When true, two buttons let form users move entries up and down in the table. When false, users cannot move rows up or down in the table.

Calendar

A Boolean (true or false) value for object reference fields. When true, the Object Browser lookup dialog includes automation objects of the Calendar type. When false or empty, the Calendar type of automation object does not appear. The object properties of object reference fields filter specific types of automation objects when the user views the available options.

CheckBox Label

The text string or name that is applied to a single check box or a check box item in a group.

Created By

The name of the user or user account who created the form.

Created On

The date and time when the form was created.

Custom Icon

A Boolean (true or false) value for object reference fields. When true, the Object Browser lookup dialog includes automation objects of the Custom Icon type. When false or empty, the Custom Icon type of automation object does not appear. The object properties of object reference fields filter specific types of automation objects when the user views the available options.

Custom Operator

A Boolean (true or false) value for object reference fields. When true, the Object Browser lookup dialog includes automation objects of the custom operator type. When false or empty, the custom operator type of automation object does not appear. The object properties of object reference fields filter specific types of automation objects when the user views the available options.

Dataset

A Boolean (true or false) value for object reference fields. When true, the Object Browser lookup dialog includes automation objects of the Dataset type. When false or empty, the Dataset type of automation object does not appear. The object properties of object reference fields filter specific types of automation objects when the user views the available options.

Dataset Expression

A reference to a specific array variable in a dataset object in the library as in the following example:

Datasets["/MyFolder/MyForm/MyDatasetObject"].MyArray
Date Format

The preferred format for dates. For example, enter the value MMM dd, yyyy to format the date 05/01/2014 as May 01, 2014. Enter yyyyMMdd to display the same date as 20140501. The default date format is MM/dd/yyyy.

You can also store time in a Date field. For example, you can set the Date Format property to dd/MM/yyyy hh:mm:ss to display the date and time value 05/01/2014 10:17:43 AM.

Description

Information about the form element in addition to its name or short label.

Disabled

An optional setting that you can apply to a form element. The following behaviors characterize elements with the Disabled property set:

Disable a form element to apply business logic and prevent invalid data.

Editable

A Boolean (true or false) value for a field. When true, users can edit the field. When false, the data is read-only.

Height

The amount of vertical space the form element occupies. Specify a value (in pixels) for this property from the top to the bottom of the form element.

Hidden

A Boolean (true or false) value for a field.

True

Makes the field invisible when the form is rendered.

Hide Label

A Boolean (true or false) value for a field or table with a label. When true, the label is hidden. When false or empty, the label is visible.

_id

A unique read-only identifier for a specific instance of a form element. The _id appends the following items to the name of the form with a period (.) separator:

For example, Form1 has two option button groups with the following _id properties:

Form1.rgName1
Form1.rgName2

A specific option button could have the following _id:

Form1.rgName2.RadioOptionA

A form element in a table named Table_2 could have the following _id:

Form_1.Table_2.Var_3

The _id for a form is the same as its Name property value.

Note: The _id is used in JavaScript functions. When you rename or move an element, be aware that you are also changing its _id.

Increment

For spinner fields, the value of an incremental adjustment, up or down. For example, if the field displays 6.55 and the increment is .02, one click up results in 6.57 and one click down results in 6.53.

Interaction Request Form

A Boolean (true or false) value for object reference fields. When true, the Object Browser lookup dialog includes automation objects of the Interaction Request Form type. When false or empty, automation objects of the Interaction Request Form type do not appear. The object properties of object reference fields filter specific types of automation objects when the user views the available options.

Invisible

Makes a field visible or invisible but read-only within the custom operator forms only.

True

Makes the field invisible within custom operators only.

Note: This attribute is valid only in custom operators. The Hidden attribute only hides a field, where as the Invisible attribute hides the field and also sets the field to read-only.

Within custom operators, the Invisible attribute created in CA Process Automation  Release 3.x and the Hidden attribute created in CA Process Automation Release 4.1 is mapped to this attribute in CA Process Automation Release 4.2.

Label

The short descriptive name that is displayed to the user for a form element.

Label Align

A read-only property that indicates how field labels appear relative to the form elements that they describe. In the Form Designer, you can click toolbar buttons to align labels to the left, right, or the above elements of the selected form.

Label Width

The size (in pixels) of a line of label text. The long labels wrap to the next line.

Layout

A design-only property that determines how multiple pages on a form appear on the Form and Preview tabs.

Card

View one page at a time with Back and Next buttons to navigate pages in a sequence. This setting is how the pages of every form appear to form users. Card is the default Layout setting.

Tab

View the names of available pages in their own tabs. For convenience, designers can click a tab to navigate to the associated page in any order.

Maximum Length

The highest number of characters a user can enter in the field. For example, to require an 8-digit number in a specific field, set the Maximum Length and Minimum Length properties for the field to 8.

Maximum Rows

The highest number of entries that are allowed in a table.

Minimum Length

The lowest number of characters a user can enter in the field. For example, to require an 8-digit number in a specific field, set the Maximum Length and Minimum Length properties for the field to 8.

Minimum Rows

The lowest number of entries that are allowed in a table.

Modified By

The name of the user or user account who modified the form.

Modified On

The date on which the form object was last changed.

Name

A unique string that identifies a form element. The system assigns an initial name (such as Var_3) that you can modify value. Changing the name value also changes the _id value.

Form elements can have two separate names: A Name property and an internal name that identifies the form element in the Form Designer.

Number Format

A string that defines the format for numeric input in the field. For example, enter $#.## to display $3.14.

Orientation

Specifies whether to arrange option groups and check boxes horizontally or vertically on the form. The default is vertical orientation.

Page Size

The number of rows to display on each page of a table or simple array.

Password

A Boolean (true or false) value for a text field, often used with Password fields. When true, user input is displayed as bullet characters to hide input from other users. When false or empty, user input is displayed exactly as typed.

Pattern

An input constraint or validation requirement for the values a user enters in a text field or text area. For example, set Pattern to [a-z] to require only lowercase alphabetic characters in the associated field.

Pattern Message

The on-screen alert or hint to display when a user entry does not match the pattern that is defined in the Pattern property.

Process

A Boolean (true or false) value for object reference fields. When true, the Object Browser lookup dialog includes automation objects of the Process type. When false or empty, automation objects of the Process type do not appear. The object properties of object reference fields filter specific types of automation objects when the user views the available options.

Process Watch

A Boolean (true or false) value for object reference fields. When true, the Object Browser lookup dialog includes automation objects of the Process Watch type. When false or empty, automation objects of the Process Watch type do not appear. The object properties of object reference fields filter specific types of automation objects when the user views the available options.

Render as HTML

A Boolean (true or false) value for multiline text fields. When true, the form interprets the content of the field as HTML code and the product displays the field much as a web browser would. For example, text that you tag with <H2> displays as a second-level heading and text that you tag with <b> displays as bold text.

Required

A Boolean (true or false) value that indicates whether the form element must contain a value or can remain empty.

Resource

A Boolean (true or false) value for object reference fields. When true, the Object Browser lookup dialog includes automation objects of the Resource type. When false or empty, automation objects of the Resource type do not appear. The object properties of object reference fields filter specific types of automation objects when the user views the available options.

Schedule

A Boolean (true or false) value for object reference fields. When true, the Object Browser lookup dialog includes automation objects of the Schedule type. When false or empty, automation objects of the Schedule type do not appear. The object properties of object reference fields filter specific types of automation objects when the user views the available options.

Start Request Form

A Boolean (true or false) value for object reference fields. When true, the Object Browser lookup dialog includes automation objects of the Start Request Form type. When false or empty, automation objects of the Start Request Form type do not appear. The object properties of object reference fields filter specific types of automation objects when the user views the available options.

Style

One or more statements (as in the following examples) that determine how text attributes in a field display to users. Format style attribute assignments in mixed case.

color:blue;
textAlign:center;
textDecoration:underline;
textTransform:uppercase
textIndent:30px;
fontStyle:italic;
fontFamily:"Courier";
fontSize:14px;
Tab Index

A number that controls the tab order of the form at design time and run time. The application does not enforce uniqueness. For example, you can use multiples of 5 or 10 as you set the tab order. Therefore, if you insert a new field in the layout between field 20 and field 25, you can assign its tab index to 22.

You can also leave the Tab Index value empty and click Move Up or Move Down in the toolbar to adjust the tab order. By default, the form tab order follows the layout from top to bottom.

Text Align

Specifies how an image file appears in the portion of the form layout that it occupies. Images can be aligned left or right, centered, or justified.

Text Direction

Specifies how characters appear in a field relative to the left and right borders of the field. Select ltr or leave the property empty to display text from left to right. ltr is the default value and the default text direction for ISO-8859 Latin I codesets. Select rtl to display text from right to left.

Touchpoint

A Boolean (true or false) value for object reference fields. When true, the Object Browser lookup dialog includes automation object types that are set to true. The user can browse touchpoints by domain, environment, and Orchestrator. When false or empty, only objects from the default touchpoint appear and the user cannot select another touchpoint.

Touchpoint Group

A Boolean (true or false) value for object reference fields. When true, the Object Browser lookup dialog includes automation object types that are set to true. The user can browse touchpoint groups by domain, environment, and Orchestrator. When false or empty, only objects from the default touchpoint group appear and the user cannot select another touchpoint group.

URL

For Image form elements, the URL path to an image file as in the following examples:

https://www.<company_name>.com/images/logo1.png

or

http://my.intranet.site/Corporate%20Images/Big2.jpg

Use images to display data, to indicate status, or to provide buttons that users can click.

Value

The stored data for a form element. All elements on a form store their values directly in their visual borders temporarily before committing to the database. Value appears as a property for two specific form elements:

Width

The amount of horizontal space (in pixels) for the form element to occupy. Specify a value for this property from the left edge of the form element.