People Picker form control

A form control that lets a form user find information about a user in a data source for people.


People Picker form control

Configure the People Picker form control

To configure the People Picker People Picker icon control, do the procedure in this topic.

Video: Common Configuration Settings in eForm Controls

Examples

How to Start

  1. Open eForm Builder.

    For information about how to open this screen, refer to eForm Builder screen.


    Eform Builder screen
  2. On the eForm Builder screen, in the Toolbox, open the Advanced Controls tab.

    Advanced Controls tab
  3. On the Advanced Controls tab, drag a People Picker People Picker icon form control onto your eForm.

    People Picker Form Control

Procedure

  1. Complete the settings on the configuration screens.

    You can use the Data screen screen to specify a variable.

General

Specifies the basic configuration for the People Picker form control.

Figure: General tab

General tab

Fields

Field NameDefinition

Label
Description:
Specifies the text label that shows on your form for the control.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • 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
Description:
Specifies a unique, technical name for your control.
Allowed Values:
One line of text (a string).

Not Accepted:

  • 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
Description:
Specifies the text to shows when a runtime app user hovers their cursor over the form control.
Allowed Values:
More than one line of text.
Default Value:
None
Example:
Refer to:

Help Text Display
Description:
Specifies if the field shows the text in the Help Text field when the runtime app user hovers over the label or field.
Allowed 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:

Configure

Configures advanced settings for your form control.

Figure: Configure tab

Configure tab

Fields

Field NameDefinition

Javascript To Execute After User Selection
Description:
Specifies a JavaScript method to run after a user is selected.
Allowed 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:

On Selection Complete, Trigger Change Event For
Description:
The change event JavaScript function runs when the value of a People Picker is changed.

You can add the change event function in your app. For more information, refer to (Example) Use Custom JavaScript in an eForm.

Allowed Values:
  • None - The value of the form controls do not change based on people selection.
  • All Target Controls - The value of the form controls change based on people selection.
Default Value:
None

Select People Source
Description:
Specifies the repository where your users are stored.
Allowed 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:

Map the Properties to Controls - Property
Description:
Specifies the label for the user information in the source repository.
Allowed 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:

Map the Properties to Controls - Display Name
Description:
Specifies the name that shows for the user information in the source repository at runtime.

When you select the value on the Map the Properties to Controls - Property field, this field shows the display name by default. You can also specify a custom display name that overrides the value you selected in the Map the Properties to Controls - Property field.

Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Limitations:

This field is available in these releases:

Map the Properties to Controls - Control
Description:
Specifies the name of the form control to show the user information in this control from the source repository.
Allowed Values:
A valid form control name.
Default Value:
None
Example:
Refer to:

Group/Role Filters
Opens this Screen:
Pick Group/Role Filters
Description:
Specifies the AgilePoint groups or roles that can show on the eForm.

Include Disabled Users
Description:
Specifies whether you can select disabled users.

To select disabled user, the user must be disabled in Manage Center. For more information, refer to Users.

Allowed Values:
  • Selected - Lets you select disabled users.
  • Deselected - Lets you select only active users.
Default Value:
Deselected

Select Property to Search With
Description:
Specifies the data to search in the people source.
Allowed 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:

Maximum number of users to display by default
Description:
Specifies the maximum number of users to show in the list by default.
Allowed Values:
An integer.
Default Value:
100

Show As Image Button
Description:
Specifies whether the form control shows as an image.
Allowed Values:
  • Selected - Shows the form control as an image.
  • Deselected - Does not show the form control as an image.
Default Value:
Deselected

Pick Group/Role Filters screen

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

Figure: Pick Group/Role Filters screen

Pick Group Role Filters screen

Fields

Field NameDefinition

Enable Group Filtering
Description:
Shows a list of the groups to filter the users that show on the form control.
Allowed Values:
  • Deselected - Does not show a list of the groups.
  • Selected - Shows a list of the groups.
Default Value:
Deselected

Enable Role Filtering
Description:
Shows a list of roles to filter the users that show on the form control.
Allowed Values:
  • Deselected - Does not show a list of roles.
  • Selected - Shows a list of roles.
Default Value:
Deselected

Users From the Selected Group/Roles
Description:
Specifies whether to show only the users from a specified group or role, or to show all users on the form control.
Allowed 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

Appearance

Specifies the look and feel for your form control.

Figure: Appearance tab

Appearance tab

Fields

Field NameDefinition

Font Family
Description:
Specifies the font family of the input text and label.
Allowed Values:
A font name from the list.
Default Value:
  • Modern theme - Roboto
  • Classic theme - Arial
Example:
Refer to:

Font Size (px)
Description:
Specifies the size of the input text and label for your form control.
Allowed Values:
An integer.

Range

  • Greater than 0
Default Value:
  • Classic theme - 12
  • Modern theme - 14
Example:
Refer to:

Font Style
Description:
Specifies the style of the font for the input text and label.
Allowed 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:

Background Color
Description:
Specifies the background color for your control.
Allowed 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:

Border Color
Description:
Specifies the border color for your control.
Allowed 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:

Foreground Color
Description:
Specifies the foreground color for your control.
Allowed 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:

Field CSS Class
Description:
Specifies a CSS class for the field in your control.
Allowed Values:
A valid CSS class.
Default Value:
None

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

Example:
Refer to:

Container CSS Class
Description:
Specifies a CSS class for the container of your control.
Allowed Values:
A valid CSS class.
Default Value:
None

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

Example:
Refer to:

Behavior

Specifies how the control shows on your form.

Figure: Behavior tab

Behavior tab

Fields

Field NameDefinition

Enabled
Description:
Specifies if the form user can change the value of a field.
Allowed Values:
  • Selected - The form user can change the value.
  • Deselected - The input cannot change the value.
Default Value:
Selected
Example:
Refer to:

Right To Left
Description:
Specifies if the text for this control, including user input, shows from right to left.
Allowed Values:
  • Deselected - The text shows from left to right.
  • Selected - The text shows from right to left.
Default Value:
Deselected
Example:
Refer to:

Visible
Description:
Specifies if the runtime app user sees the field.
Allowed Values:
  • Selected - The runtime app user sees the field.
  • Deselected - The runtime app user does not see the field.
Default Value:
Selected
Example:
Refer to:

Advanced

Specifies advanced settings for your form control.

Figure: Advanced tab

Advanced tab

Fields

Field NameDefinition

Field ID
Description:
Shows an ID of the control.
Allowed Values:
Read only.
Default Value:
Different for different controls.
Example:
Refer to:

JavaScript Event
Description:
Specifies the JavaScript event that causes an effect.
Allowed Values:
  • None - No action.
  • Blur - When a form user leaves an input field.
  • Click - When the form user clicks a button.
  • Focus - When an input field gets focus.
Default Value:
None
Example:
Refer to:
Limitations:
These JavaScript events can not be used with this form control in AgilePoint NX OnDemand (public cloud) and AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v8.0 because these events do not serve a function for this form control:
  • Change
  • Double Click
  • Keydown
  • Keypress
  • Keyup

JavaScript Function
Description:
Specifies the name of a JavaScript function to complete the activity.
Allowed 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:

Show On Tablet Devices
Description:
Specifies if the form field shows on a tablet.
Allowed 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:

Show On Mobile Phone Devices
Description:
Specifies if the form field shows on a mobile device.
Allowed 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: