ProcessSession entity messages and methods

 

Applies To: Dynamics CRM 2013

A process session is created every time you run a dialog process. It contains the log about the session such as the user who ran it, the time when it was started and completed, the actions performed during the running of the dialog process, and so on. The schema name for this entity is ProcessSession. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

Message

Description

AssignRequest

Assigns a process session to another user or team.

CreateRequest

Creates a process session. You can also call the IOrganizationService.Create method.

DeleteRequest

Deletes a process session. You can also call the IOrganizationService.Delete method.

GrantAccessRequest

Shares a process session with another security principal (user or team).

ModifyAccessRequest

Changes the access rights for a process session previously shared with another security principal (user or team).

RetrieveRequest

Retrieves a process session. You can also call the Retrieve method.

RetrieveMultipleRequest

Retrieves a collection of process sessions. You can also call the IOrganizationService.RetrieveMultiple method.

RetrievePrincipalAccessRequest

Retrieves the access the specified security principal (user or team) has to a process session.

RetrieveSharedPrincipalsAndAccessRequest

Retrieves the security principals (users or teams) that have access to a process session, together with their access rights to the process session.

RevokeAccessRequest

Removes all access to a process session for the specified security principal (user or team).

SetStateRequest

Sets the state of a process session. The possible states are defined in the ProcessSession.State attribute. If you are using early bound types, use the ProcessSessionState enumeration. You can find this information in the metadata for your organization. See the preceding metadata browser information.

UpdateRequest

Updates a process session. You can also call the IOrganizationService. Update method.

VerifyProcessStateDataRequest

Verifies the state of a process session .

See Also

Use dialogs for guided processes
Workflow and process entities
Workflow (process) entity messages and methods
WorkflowLog (process log) entity messages and methods
Workflow (process) entity privileges