Overview

DeploySystemView creates, updates or deletes a system view. These views are contained in the SavedQueryBase table.

The activity can be set to run on any entity.

Parameters

Parameters rules are different depending on whether the request contains a View Id or not.

View Id is empty

When this mode is selected, the activity will create or update a System View.

Parameter Required Direction Default Description
View Id No Input null Must be null.
When Existing Yes Input null The action to perform when a matching view (based on Name, Query Type and Returned Entity) is already in the database. Can be "Update" (the existing view will be updated), "Ignore" (nothing happens) or "Error" (the activity will throw an exception).
System View Name No Input null The name of the system view to create or update. When this parameter is null and "View Definition" is populated, the Name attribute of the deserialized view is used in place of this parameter.
System View Returned Entity No Input null The target entity of the created view, i.e. 'account' or 'contact' etc. When this parameter is null and "View Definition" is populated, the ReturnedType attribute of the deserialized view is used in place of this parameter. This parameter must agree with the FetchXml "entity name" attribute. Failing this, the API might return an error, but it might not, and you can find yourself with a view that shows contacts displayed under the accounts tab or viceversa.
System View Query Type No Input null The QueryType of the created view. See Query Types for possible values. When this parameter is null and "View Definition" is populated, the QueryType attribute of the deserialized view is used in place of this parameter.
Fetch XML No Input null The FetchXml attribute of the system view to create or update. When this parameter is null and "View Definition" is populated, the FetchXml attribute of the deserialized view is used in place of this parameter.
Layout XML No Input null The LayoutXml attribute of the system view to create or update. When this parameter is null and "View Definition" is populated, the LayoutXml attribute of the deserialized view is used in place of this parameter.
View Definition No Input null An entire SavedQuery serialized via DataContractSerializer. This will be used to derive most of the other parameters if they're not specified explicitly. The most straightforward way to populate this parameter is by linking it to the correspondent output parameter of the RetrieveView activity.
Output View Id N/A Output N/A The Id of the created or updated view.
Result Action N/A Output N/A The actual action performed by the activity. Can be "Create", "Update", "Ignore".

View Id is populated

When this mode is selected, the activity will delete or update a System View.

Parameter Required Direction Default Description
View Id Yes Input null The Id of the view to update or delete.
When Existing Yes Input null The action required. Can be "Update" or "Delete"
System View Name No Input null When action is "Update" this is the new name of the system view. When action is "Delete" this parameter is ignored. When this parameter is null and "View Definition" is populated, the Name attribute of the deserialized view is used in place of this parameter.
System View Returned Entity No Input null When action is "Update" this is the new target entity of the view. When action is "Delete" this parameter is ignored. When this parameter is null and "View Definition" is populated, the ReturnedType attribute of the deserialized view is used in place of this parameter. This parameter must agree with the FetchXml "entity name" attribute. Failing this, the API might return an error, but it might not, and you can find yourself with a view that shows contacts displayed under the accounts tab or viceversa.
System View Query Type No Input null When action is "Update" this is the new QueryType of the view. See Query Types for possible values. When action is "Delete" this parameter is ignored. When this parameter is null and "View Definition" is populated, the QueryType attribute of the deserialized view is used in place of this parameter. Note that updating this to a different value does not seem to work. The API does not complain but its value remain unchanged.
Fetch XML No Input null When action is "Update" this is the new FetchXml attribute of the view. When action is "Delete" this parameter is ignored. When this parameter is null and "View Definition" is populated, the FetchXml attribute of the deserialized view is used in place of this parameter.
Layout XML No Input null When action is "Update" this is the new LayoutXml attribute of the view. When action is "Delete" this parameter is ignored. When this parameter is null and "View Definition" is populated, the LayoutXml attribute of the deserialized view is used in place of this parameter.
View Definition No Input null An entire SavedQuery serialized via DataContractSerializer. This will be used to derive most of the other parameters if they're not specified explicitly. The most straightforward way to populate this parameter is by linking it to the correspondent output parameter of the RetrieveView activity.
Output View Id N/A Output N/A The Id of the created or updated view.
Result Action N/A Output N/A The actual action performed by the activity. Can be "Delete" and "Update".

Last edited Sep 13, 2011 at 1:21 PM by gemina, version 3

Comments

No comments yet.