This project is read-only.

Overview

RetrieveView searches for and retrieves a view or a filter from the database and returns it in several ways through workflow parameters, so that the view can be used in further processing steps. The activity can be set to run on any entity.

Parameters

Parameters rules are different depending on whether the request is to retrieve a system view (published views managed by the System Administrator) or a personal view (Views that the users can save and edit).

System Views

Parameter Required Direction Default Description
System View Yes Input null A reference to the system view to retrieve.
Personal View Name No Input null Must be null.
Personal View Owner No Input null Must be null.
Personal View Returned Entity No Input null Must be null.
Personal View Query Type No Input null Must be null.
Count of Views N/A Output N/A This is always 1, unless the view was not found, in which case the activity throws an exception.
Output View Id N/A Output N/A The retrieved view's GUID.
Returned Entity N/A Output N/A The target entity of the retrieved view, i.e. 'account' or 'contact' etc.
Fetch XML N/A Output N/A The FetchXml attribute of the retrieved view.
Layout XML N/A Output N/A The LayoutXml attribute of the retrieved view.
Query Type N/A Output N/A The QueryType attribute of the retrieved view. See Query Types for possible values.
View Definition N/A Output N/A The entire retrieved SavedQuery serialized through DataContractSerializer.

Personal Views

Parameter Required Direction Default Description
System View No Input null Must be null.
Personal View Name Yes Input null The name of the saved view (i.e. personal view) to retrieve.
Personal View Owner Yes Input null The user who owns the personal view to retrieve. This parameter is mandatory. Note that if the view exists in CRM but it is not owned by the user specified here, the system will throw a security exception.
Personal View Returned Entity No Input null The target entity of the view to retrieve, i.e. 'account' or 'contact' etc. If this parameter is omitted, the search will be performed against any type.
Personal View Query Type No Input null The QueryType attribute of the view to retrieve. See Query Types for possible values. If this parameter is omitted, the search will be performed against any type.
Count of Views N/A Output N/A The number of views found. If this is 0, no view was found that matched the conditions. If this is > 1 there were multiple views found. If this value is 1 there was just one view found, and the rest of the parameters below are populated.
Output View Id N/A Output N/A The retrieved view's GUID.
Returned Entity N/A Output N/A The target entity of the retrieved view, i.e. 'account' or 'contact' etc.
Fetch XML N/A Output N/A The FetchXml attribute of the retrieved view.
Layout XML N/A Output N/A The LayoutXml attribute of the retrieved view (if any).
Query Type N/A Output N/A The QueryType attribute of the retrieved view. See Query Types for possible values.
View Definition N/A Output N/A The entire retrieved UserQuery serialized via DataContractSerializer.

Last edited Sep 13, 2011 at 2:20 PM by gemina, version 10

Comments

No comments yet.