Get User Profile activity

An activity that gets user profile information from SharePoint.

Configure the Get User Profile activity

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

Examples

(Example) Create a SharePoint Access Token

Prerequisites

SharePoint 2013 or later is required.

Good to Know

To send an e-mail notification, click Advanced > E-mail Notifications .
For more information, refer to Configure E-mail Notifications for Any Activity.
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?
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?

How to Start

On the Application Explorer screen, do one of these:
- Open a Process.
- Create a Process.
Do one of these:
- Add an activity:
  1. In the Process Builder, go to the Activity Library, and open the SharePoint tab.
  2. On the SharePoint tab, drag the Get User Profile activity onto your process.
- Change an activity:
  1. In your process, double-click your activity.

General Configuration

Specifies the basic settings for the Get User Profile activity.

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

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:

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

SharePoint Get User Profile Configuration

Specifies user profile information to get from SharePoint.

Figure: SharePoint Get User Profile Configuration screen

Fields

Field Name	Definition
SharePoint	Function: Specifies the access token that connects to your SharePoint site. Accepted Values: A list of access tokens configured for your environment. Default Value: None Accepts Process Data Variables: No Example: Refer to: (Example) Configure a Create List Item Activity to Put the Leave Information in the SharePoint List Form Based Applications – SharePoint Data Source (Example) Create a SharePoint Access Token
Add Token	Opens this Screen: Access Token for SharePoint Function of this Screen: Configure an access token to connect to SharePoint. Example: Refer to: (Example) Create a SharePoint Access Token
Site URL	Function: Specifies the URL for your SharePoint site. Accepted Values: A valid SharePoint site URL. Default Value: None Accepts Process Data Variables: Yes Example: http://[machine name]:[port]/sites/[site name] Note: You must include the /sites in the Site URL for the site to be created successfully. Form Based Applications – SharePoint Data Source
User	Function: Specifies the user name to associate with the action. Accepted Values: A SharePoint user ID An AgilePoint user name A process data variable that represents a SharePoint user ID or AgilePoint user name. Default Value: None Accepts Process Data Variables: Yes 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?
Click to Load Fields	Function: Updates the available user profile information on the screen.
Move All	Function: Moves all the user information to the User Profile Data field.
User Profile Data	Function: Specifies the user profile data of the selected SharePoint user. Accepted Values: Valid user information. Default Value: None Accepts Process Data Variables: No
Process Data	Function: Gives a list of process data variables that stores the user information. Accepted Values: A valid process data variable. Default Value: None Accepts Process Data Variables: Yes