Retrieve User Profile activity

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:

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.

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, representing a number of seconds.

Default Value:

600

Accepts Process Data Variables:

No

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

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 button to open the Schema Mapper.

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

Default Value:

None

Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

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