Formula form control

Label

Function:

Specifies the text label that shows on your form for the control.

Accepted Values:

One line of text that can have spaces.

Default Value:

Different for different controls.

Example:

This is a common configuration field that is used in many examples. Refer to:

• Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Internal Name

Function:

Specifies a unique, technical name for your control.

Accepted Values:

One line of text (a string) with no spaces.

Default Value:

Different for different controls.

Example:

This is a common configuration field that is used in many examples. Refer to:

• Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Help Text

Function:

Specifies the text to shows when a runtime app user hovers their cursor over the form control.

Accepted Values:

More than one line of text.

Default Value:

None

Example:

Refer to:

• The videos on this page

Help Text Display

Function:

Specifies if the field shows the text in Help Text field when the form user puts the mouse on the label or field.

Accepted Values:

• None - Does not show the help text.
• Hover On Label - Shows the help text when you put your mouse on the label.
• Hover On Field - Shows the help text when you put your mouse on the field.
• Hover On Both - Shows the help text when you put your mouse on the label and Field.

Default Value:

None

Example:

Refer to:

• The videos on this page

Override Help Text Description

Function:

Specifies whether to show the calculated value when a form user hovers his or her mouse over the field.

Calculates the value with the formula configured in Formula Builder screen.

Accepted Values:

• Selected - Shows the calculated value when a form user hovers his or her mouse over the field.

  In the Help Text Display field, Hover On Field and Hover On Both option gets disabled.

• Deselected - Does not show the calculated value on the field.

  In the Help Text Display field, Hover On Field and Hover On Both option gets enabled.

Default Value:

Deselected

Limitations:

This field is available in these releases:

• AgilePoint NX OnDemand (public cloud)
• AgilePoint NX Private Cloud or AgilePoint NX OnPremises v7.0 or higher

Execute formula on

Function:

Specifies whether to run the formula to calculate data from the other fields.

Accepted Values:

• Both - The formula runs when you enter or change the values in other fields.
• Related field value gets changed - The formula runs when you change the values in other fields.
• Related field value gets entered - The formula runs when you enter the values in other fields.

Default Value:

Both

Font Family

Function:

Specifies the font family of the input text and label.

Accepted Values:

A font name from the list.

Default Value:

• Modern theme - Roboto
• Classic theme - Arial

Example:

Refer to:

• The videos on this page

Font Size (px)

Function:

Specifies the size of the input text and label for your form control.

Accepted Values:

A positive integer.

Default Value:

• Classic theme - 12
• Modern theme - 14

Example:

Refer to:

• The videos on this page

Font Style

Function:

Specifies the style of the font for the input text and label.

Accepted Values:

• Bold - Shows the input text and label in bold.
• Underline - Shows the label underlined.
• Italic - Shows the label in italic.

Default Value:

None

Example:

Refer to:

• The videos on this page

Border Color

Function:

Specifies the border color for your control.

Accepted Values:

A color value using a hex code, RGB code, or RGBA code.

You can enter a color code, or select a color from the palette.

Default Value:

#ff0000

Example:

Refer to:

• The videos on this page

Foreground Color

Function:

Specifies the foreground color for your control.

Accepted Values:

A color value using a hex code, RGB code, or RGBA code.

You can enter a color code, or select a color from the palette.

Default Value:

#ff0000

Example:

Refer to:

• The videos on this page

Apply Font Properties To Control

Function:

Specifies if the control gets the font properties from the properties set in the form settings.

Accepted Values:

• Selected - The control gets the font properties from the properties set in the form settings.
• Deselected - The control does not get the font properties from the properties set in the form settings.

Default Value:

Deselected

Example:

Refer to:

• The videos on this page

Label CSS Class

Function:

Specifies a CSS class for the label of your control.

Accepted Values:

A valid CSS class.

Default Value:

None

If you specify your CSS on the top menu, the CSS is populated.

Example:

Refer to:

• The videos on this page

Field CSS Class

Function:

Specifies a CSS class for the field in your control.

Accepted Values:

A valid CSS class.

Default Value:

None

If you specify your CSS on the top menu, the CSS is populated.

Example:

Refer to:

• The videos on this page
• (Example) Use Custom CSS in a Form Control

Container CSS Class

Function:

Specifies a CSS class for the container of your control.

Accepted Values:

A valid CSS class.

Default Value:

None

If you specify your CSS on the top menu, the CSS is populated.

Example:

Refer to:

• The videos on this page
• (Example) Use Custom CSS in a Form Control
• (Example) Create an eForm to Start the Process (Create Absence Request)

Enabled

Function:

Specifies if the form user can change the value of a field.

Accepted Values:

• Selected - The form user can change the value.
• Deselected - The input cannot change the value.

Default Value:

Selected

Example:

Refer to:

• The videos on this page
• (Example) Create an eForm to Start the Process (Create Absence Request)

Read-Only

Function:

Specifies if the field accepts user input.

Accepted Values:

• Selected - A user cannot enter a value for the field. The field shows as read-only.
• Deselected - A user can enter a value for the field.

Default Value:

Selected

Right To Left

Function:

Specifies if the text for this control, including user input, shows from right to left.

Accepted Values:

• Deselected - The text shows from left to right.
• Selected - The text shows from right to left.

Default Value:

Deselected

Example:

Refer to:

• The videos on this page

Visible

Function:

Specifies if the form user sees the field.

Accepted Values:

• Selected - The form user sees the field.
• Deselected - The form user does not see the field.

Default Value:

Selected

Example:

Refer to:

• The videos on this page

Text Align

Function:

Specifies the horizontal alignment of user input for this control.

Accepted Values:

• Left - Aligns the text to the left.
• Center - Centers the text.
• Right - Aligns the text to the right.

Default Value:

Left

Example:

Refer to:

• The videos on this page

Label Position

Function:

Specifies the position of the text label that shows on your form for the control.

Accepted Values:

• Inherit - The position of the label is as specified in the form settings.
• Left - Specifies that the position of the label is to the left of the container.
• Top - Specifies that the position of the label is to the top of the container.

Default Value:

Inherit

Example:

Refer to:

• The videos on this page

Field ID

Function:

Shows an ID of the control.

Accepted Values:

Read only.

Default Value:

Different for different controls.

Example:

Refer to:

• The videos on this page

JavaScript Event

Function:

Specifies the JavaScript event that causes an effect.

Accepted Values:

• None - No action.
• Change - When a form user changes the content of an input field or selects a value.

Default Value:

None

Example:

Refer to:

• The videos on this page

Limitations:

These JavaScript events can not be used with this form control in AgilePoint NX OnDemand (public cloud) and AgilePoint NX Private Cloud or AgilePoint NX OnPremises v8.0 because these events do not serve a function for this form control:

• Blur
• Click
• Double Click
• Focus
• Keydown
• Keypress
• Keyup

JavaScript Function

Function:

Specifies the name of a JavaScript function to complete the activity.

Accepted Values:

The name of a Javascript function that exists in your app.

For more information, refer to (Example) Use Custom JavaScript in an eForm.

Default Value:

None

Example:

ConfirmSubmission where one of these is your function:

function ConfirmSubmission()
  {
    alert ('Are you sure to submit this form?');
    return true;
  }

function ConfirmSubmission(parameter1,parameter2)
  {
    window.alert ( parameter1 * parameter2);
    
  }

Also refer to:

• The videos on this page

Data Security Settings

Function:

Specifies whether to store information from the field in the process schema, so the app can use it again, or to simply pass on the information after the form is submitted without storing the information. This option helps to protect sensitive user information.

Accepted Values:

• Persist - Stores the data from the field in the process schema, so the app can use it again.
• Do Not Persist - Does not store the data from the field in the process schema. This option provides greater security for sensitive user information.

Default Value:

Persist

Example:

Refer to:

• The videos on this page

Show On Tablet Devices

Function:

Specifies if the form field shows on a tablet.

Accepted Values:

• Selected - The form field shows on a tablet.
• Deselected - The form field does not show on a tablet.

Default Value:

Selected

Example:

Refer to:

• The videos on this page

Show On Mobile Phone Devices

Function:

Specifies if the form field shows on a mobile device.

Accepted Values:

• Selected - The form field shows on a mobile device.
• Deselected - The form field does not show on a mobile device.

Default Value:

Selected

Example:

Refer to:

• The videos on this page