Retrieve User Profile activity

An activity that gets user profile information from Windows Azure Active Directory.


Retrieve User Profile activity

Configure the Retrieve User Profile activity

To configure the Retrieve User Profile activity, do the procedure in this topic.

Prerequisites

Good to Know

  • In most text fields, you can use process data variables as an alternative to literal data values.
  • You can configure whether this activity waits for other activities before it runs.

    For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?

  • Documentation for Integrations with Third-Party, External, or Open Source Technologies

    The highest priority for AgilePoint NX Product Documentation is accuracy. Whenever feasible, AgilePoint provides input details, business rules, or example values for third-party integrations. These can include any technology that is not native to AgilePoint NX, such as Salesforce, Active Directory, or REST. However this information is subject to change without notice to AgilePoint. Because we can not guarantee the accuracy of this information, the details provided for third-party product input values, as well as examples for third-party product integrations, are limited in the AgilePoint documentation. It is the responsibility of third-party vendors to provide documentation related to these aspects of their software and services.

    For examples of use case implementations or configuration field input values for third-party products, AgilePoint recommends these resources:

    • AgilePoint Community Forums - An AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
    • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
    • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.
    • Third-Party Vendor Documentation - Whenever feasible, AgilePoint provides links to third-party vendor documentation.

      This does not include technology standards or protocols, such as JavaScript, REST, or FTP. Resources for these technical standards are publicly available on the Internet.

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the Windows Azure Active Directory Windows Azure Active Directory icon tab.
      2. On the Windows Azure Active Directory Windows Azure Active Directory icon tab, drag the Retrieve User Profile Retrieve User Profile icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

Procedure

  1. Complete the fields on the General Configuration screen.

    For more information, refer to Configure General Options for a System Activity.

  2. Click Retrieve User Profile Retrieve User Profile icon
  3. Complete the fields on the Retrieve User Configuration screen.

    For more information, refer to Get User Information from Active Directory.

  4. (Optional) Click Advanced Advanced icon > E-mail Notifications E-mail Notifications icon.

    For more information, refer to Configure E-mail Notifications for Any Activity.

General Configuration

Specifies the basic settings for the Retrieve User Profile activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field Name Definition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Connection Timeout (Seconds)

Function:
Specifies the number of seconds permitted to complete an action before the connection stops.
Accepted Values:
An integer that represents a number of seconds.
Default Value:
600
Accepts Process Data Variables:
No

Retrieve User Profile Configuration > Response tab

Specifies user profile information to get from Windows Azure Active Directory.

Figure: Retrieve User Profile Configuration > Response tab

Retrieve User Profile Configuration Response tab

Fields

Field Name Definition

Windows Azure Active Directory

Function:
Specifies the access token that connects to your Windows Azure Active Directory.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Process Data Variables:
No

Add Token Add Token icon

Opens this Screen:
Access Token for Windows Azure Active Directory
Function of this Screen:
Configure an access token to connect to Windows Azure Active Directory.

By User ID / By User Name

Function:
Specifies whether to retrieve one or more users based on a user ID or user name in Windows Azure Active Directory.
Accepted Values:
  • Retrieve User By User ID - Retrieves a user in Windows Azure Active Directory based on user ID.
  • Retrieve User By User Name - Retrieves a user in Windows Azure Active Directory based on user name.
Default Value:
Retrieve User By User ID
Accepts Process Data Variables:
No

User Name or User ID

Function:
Specifies the Windows Azure Active Directory user name or user ID whose information to get.

If you want to register this user in AgilePoint NX who is not an AgilePoint NX registered user, select Register user to AgilePoint NX, and complete the fields in the User Information tab.

Accepted Values:
A valid user name in Windows Azure Active Directory.
Default Value:
None
Accepts Process Data Variables:
Yes

Response

Function:
This tab is used to connect the response to the data model for your process to get the user profile information.

Map Response to AgilePoint Schema

Function:
Specifies the connection from the Windows Azure Active Directory API response parameter to your schema.
To Open this Field:
  1. On the Retrieve User Configuration screen, click the Response tab.
Accepted Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

Use this screen to connect the response to the data model for your process.

Default Value:
None

Retrieve User Profile Configuration > User Information tab

Configures the user profile information to get in Windows Azure Active Directory.

Figure: Retrieve User Profile Configuration > User Information tab

Retrieve User Profile Configuration User Information tab

Fields

Field Name Definition

User Information

Function:
This tab is used to register and store information about the Windows Azure Active Directory user in AgilePoint NX.

Register user to AgilePoint NX

Function:
Specifies whether to register the Windows Azure Active Directory user in AgilePoint NX.
Accepted Values:
  • Selected - Registers and stores information about the Windows Azure Active Directory user in AgilePoint NX.
  • Deselected - Does not register and store information about the Windows Azure Active Directory user in AgilePoint NX.
Default Value:
Deselected
Accepts Process Data Variables:
Yes

User Name

Function:
Specifies the process data variable that stores the Windows Azure Active Directory user name to register in AgilePoint NX.

The user name in this field must be the same as the user name specified in the User Name (Login ID) field.

To Open this Field:
  1. Select Register user to AgilePoint NX.
Accepted Values:
A process data variable.
Default Value:
None
Accepts Process Data Variables:
Yes

Full Name

Function:
Specifies the process data variable that stores the Windows Azure Active Directory user's full name.
To Open this Field:
  1. Select Register user to AgilePoint NX.
Accepted Values:
A process data variable.
Default Value:
None
Accepts Process Data Variables:
Yes

Manager

Function:
Specifies the process data variable that stores the name of the Windows Azure Active Directory user's manager.
To Open this Field:
  1. Select Register user to AgilePoint NX.
Accepted Values:
A process data variable.
Default Value:
None
Accepts Process Data Variables:
Yes

Department

Function:
Specifies the process data variable that stores the name of the Windows Azure Active Directory user's department.
To Open this Field:
  1. Select Register user to AgilePoint NX.
Accepted Values:
A process data variable.
Default Value:
None
Accepts Process Data Variables:
Yes

Language

Function:
Specifies the process data variable that stores the Windows Azure Active Directory user's language.
To Open this Field:
  1. Select Register user to AgilePoint NX.
Accepted Values:
A process data variable.
Default Value:
None
Accepts Process Data Variables:
Yes

E-mail Address

Function:
Specifies the process data variable that stores the Windows Azure Active Directory user's e-mail address.
To Open this Field:
  1. Select Register user to AgilePoint NX.
Accepted Values:
A process data variable.
Default Value:
None
Accepts Process Data Variables:
Yes