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. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add a People Picker People Picker icon control:
      1. On the eForm Builder screen, in the Toolbox, open the Advanced Controls Advanced Controls icon tab.
      2. On the Advanced Controls Advanced Controls icon tab, drag a People Picker People Picker icon form control onto your eForm.
    • Change a People Picker People Picker icon control:
      1. On your eForm, click the control, and click Edit Edit icon.

Procedure

  1. Complete the settings on the configuration screens. You can use the Process Data screen to specify a variable.

    For more information, refer to Use Process Variables to Configure an Activity or a Form Control.

General

Specifies the basic configuration for the People Picker form control.

Figure: General tab

General tab

Fields

Field Name Definition

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:
Refer to:

Internal Name

Function:
Specifies a unique, technical name for your control.
Accepted Values:
One line of text with no spaces.
Default Value:
Different for different controls.
Example:
Refer to:

Help Text

Function:
A description for your control.
Accepted Values:
More than one line of text.
Default Value:
None

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

Configure

Configures advanced settings for your form control.

Figure: Configure tab

Configure tab

Fields

Field Name Definition

Javascript To Execute After User Selection

Function:
Specifies a JavaScript method to run after a user is selected.
Accepted Values:
The name of a Javascript function that exists in your application.

For more information, refer to Add a JavaScript Code Snippet to 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);
    
  }

On Selection Complete, Trigger Change Event For

Function:
The change event JavaScript function runs when the value of a People Picker is changed.

You can add the change event function in your application. For more information, refer to Add a JavaScript Code Snippet to an eForm

Accepted 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

Function:
Specifies the repository where your users are stored.
Accepted Values:
Read only.
Default Value:
Registered Users

Map the Properties to Controls - Property

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

Map the Properties to Controls - Display Name

Function:
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.

Accepted Values:
One line of text that can have spaces.
Default Value:
None
Limitations:

This field is available in these releases:

Map the Properties to Controls - Control

Function:
Specifies the name of the form control to show the user information in this control from the source repository.
Accepted Values:
A valid form control name.
Default Value:
None

Group/Role Filters

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

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 Disable a User.

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

Select Property to Search With

Function:
Specifies the data to search in the people source.
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

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

Show As Image Button

Function:
Specifies if the form control shows as an image.
Accepted 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 Name Definition

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/Roles - Shows only the users from a specified group or role on the control.
  • Users from all the selected Groups/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 Name Definition

Font Family

Function:
Specifies the font family of the input text and label.
Accepted Values:
A valid font name from the list.
Default Value:
Arial

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

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:

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

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

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 CSS icon on the top menu, the CSS is populated.

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 CSS icon on the top menu, the CSS is populated.

Example:
Refer to:

Font Size (px)

Function:
Specifies the size of the input text and label for your form control.
Accepted Values:
A valid positive integer.
Default Value:
12

Behavior

Specifies how the control shows on your form.

Figure: Behavior tab

Behavior tab

Fields

Field Name Definition

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

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

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

Advanced

Specifies advanced settings for your form control.

Figure: Advanced tab

Advanced tab

Fields

Field Name Definition

Field ID

Function:
Shows an ID of the control.
Accepted Values:
Read-only.
Default Value:
Different for different controls.

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

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

For more information, refer to Add a JavaScript Code Snippet to 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);
    
  }

Show In Tablet

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

Show In Mobile

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