User List 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

Required

Function:

Specifies if the field is mandatory.

Accepted Values:

• Deselected - The field is not mandatory.
• Selected - The field is mandatory.

Default Value:

Deselected

Example:

Refer to:

• The videos on this page
• (Example) How Can I Map a Repeating Schema Element to Data Population?
• (Example) Create an eForm to Start the Process (Create Absence Request)
• (Example) Create an eForm (Set Available Leave Hours)

Mandatory Field Validation Message

Function:

Specifies the message to show if the form user does not enter data in a mandatory form control.

Accepted Values:

More than one line of text that can have letters, numbers, spaces, and special characters.

Default Value:

Select an option from ${L}

${L} is a process data variable that shows the label for a form control.

Example:

Refer to:

• The videos on this page

Select People Source

Function:

Specifies the repository where your users are stored.

Accepted Values:

• Registered Users - Shows the list of AgilePoint NX users at runtime.
• SharePoint - Shows the list of SharePoint users at runtime.

Default Value:

Registered Users

Example:

Refer to:

• (Example) Configure the User List Form Control

Map Properties for Name and Value - Name

Function:

Specifies the label for the user information in the source repository.

Accepted Values:

• User Name
• E-mail Address
• Registered Date
• Full Name
• Manager
• Department
• Title
• Locale
• Time Zone
• Online Contact
• Ref ID
• UAL Expiration Date
• UAL Never Expires
• User Org Info

Default Value:

None

Example:

Refer to:

• (Example) Configure the User List Form Control

Map Properties for Name and Value - Value

Function:

Specifies the value to give the user information from the source repository.

Accepted Values:

• User Name
• E-mail Address
• Registered Date
• Full Name
• Manager
• Department
• Title
• Locale
• Time Zone
• Online Contact
• Ref ID
• UAL Expiration Date
• UAL Never Expires
• User Org Info

Default Value:

None

Example:

Refer to:

• (Example) Configure the User List Form Control

Group/Role Filters

Opens this Screen:

Pick Group/Role Filters

Function:

Specifies the AgilePoint groups or roles that can show on the eForm.

Search By

Function:

Specifies whether the people source search is with name or value.

Accepted Values:

• Name - Searches for name.
• Value - Searches for value.
• Name/Value - Searches for name or value.

Default Value:

Name

Limitations:

This field is available in these releases:

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

Sort By

Function:

Specifies whether to sort the users in the list based on user information.

Accepted Values:

The user information from the list.

This field completes when you select the user information from the Name or Value field.

Default Value:

None

Limitations:

This field is available in these releases:

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

Sort Order

Function:

Specifies whether to sort the result set in ascending or descending order.

Accepted Values:

Ascending - Sorts the result set in ascending order.

Descending - Sorts the result set in descending order.

Default Value:

Ascending.

Limitations:

This field is available in these releases:

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

Enable Multiple User Selection

Function:

Specifies if the form user can select more than one user in the form.

Accepted Values:

• Deselected - You can not select more than one user in the form.
• Selected - You can select more than one user in the form.

Default Value:

Deselected

Include Disabled Users

Function:

Specifies whether you can select disabled users.

To select disabled user, the user must be disabled in Manage Center. For more information, refer to Create New User screen.

Accepted Values:

• Selected - Lets you select disabled users.
• Deselected - Lets you select only active users.

Default Value:

Deselected

Maximum number of users to display by default

Function:

Specifies the maximum number of users to show in the list by default.

Accepted Values:

An integer.

Default Value:

100

Enable Group Filtering

Function:

Shows a list of the groups to filter the users that show on the form control.

Accepted Values:

• Deselected - Does not show a list of the groups.
• Selected - Shows a list of the groups.

Default Value:

Deselected

Enable Role Filtering

Function:

Shows a list of roles to filter the users that show on the form control.

Accepted Values:

• Deselected - Does not show a list of roles.
• Selected - Shows a list of roles.

Default Value:

Deselected

Users From the Selected Group/Roles

Function:

Specifies whether to show only the users from a specified group or role, or to show all users on the form control.

Accepted Values:

• Users from ANY of the selected group or roles - Shows only the users from a specified group or role on the control.
• Users from ALL of the selected group or roles - Shows all users on the form control.

Default Value:

Users from any of the selected Group/Roles

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 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

Background Color

Function:

Specifies the background 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

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)

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

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)

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

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.
• Blur - When a form user leaves an input field.
• Change - When a form user changes the content of an input field or selects a value.
• Click - When the form user clicks a button.
• Double Click - When the form user double-clicks text.
• Focus - When an input field gets focus.
• Keydown - When a form user holds down a key.
• Keypress - When the form user presses a key.
• Keyup - When the form user releases a key.

Default Value:

None

Example:

Refer to:

• The videos on this page

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