Search Results

Retrieve Entity

The Retrieve Entity activity is used to retrieve entity records from the Microsoft Dynamics CRM server with entity records IDs.

This activity supports batch operations, which means you can retrieve multiple entity records at a time. If you want to retrieve a data collection from the Microsoft Dynamics CRM server in a batch, use the For-Each statement to map the data collection to the elements in the Input field in the Retrieve Entity activity.

General

In the General tab, you can establish a connection to the Microsoft Dynamics CRM server, and specify the type of entity records you want to retrieve.

The following table lists the configurations in the General tab of the Retrieve Entity activity:

Field Module Property? Description
Name No Specify the name of the activity in the process definition.
Dynamics CRM Connection Yes Specify a shared connection resource.

Click the icon to select a Dynamics CRM connection. If no matching Dynamics CRM connections are found, click Create Shared Resource in the Select DynamicscrmResource Resource Template dialog to create one. See Creating a Dynamics CRM Connection for more details.

Dynamics CRM Entity No Specify the type of the entity records you want to retrieve.

Click Fetch Entity to open the Entity Selection Dialog dialog that contains all the available entities. Select an entity from the list and click OK. The selected entity is automatically specified in this field.

After selecting the entity, click Build Schema to open the Attributes Selection Dialog dialog that contains all the available attributes associated with the entity. Select the attributes you want and click OK. The selected attributes are displayed in the Output tab.

Description

In the Description tab, enter a short description for the Retrieve Entity activity.

Input

Enter the ID of the entity record in the Input tab. This is a required field. The field name that indicates the entity record ID varies depending on the entity selected when configuring the General tab.

Output

In the Output tab, the output of this activity varies depending on the entity and attributes selected when configuring the General tab. See the Microsoft Dynamics CRM documentation for more details.

Fault

The Fault tab dsiplays the error code and error message of the Retrieve Entity activity. See Error Codes for a more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the Retrieve Entity activity:

Error Schema Element Data Type Description
message String The error message returned by the plug-in.
messageCode String The error code returned by the plug-in.