CRMProcessController.RetrieveProcessInstancesSummary Method

  • Article

The RetrieveProcessInstancesSummary method retrieves a summary of the process instances. The workflow summary is the result of an aggregate query and returns an array of summaries that group the process instances by objecttype and statecode.

Syntax

[Visual Basic .NET]
Public Function RetrieveProcessInstancesSummary(
  ByVal Caller As CUserAuth
) As CWorkflowSummary()
[C#]
public CWorkflowSummary[] RetrieveProcessInstancesSummary(
  CUserAuth  Caller
);
[C++]
public: CWorkflowSummary* RetrieveProcessInstancesSummary(
  CUserAuth*  Caller
)  __gc[];

Parameters

Caller

Specifies the identity of the caller. The caller must have the prvReadWorkflowProcessInstance privilege to perform this action. See CUserAuth.

Return Value

Returns a CWorkflowSummary[] type that specifies an array of summaries. See CWorkflowSummary.

Remarks

If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.

All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}

Example

[C#]
// strServer should be set with the name of the platform Web server
string strServer = "myservername";

// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "https://" + strServer + "/" + virtualDirectory + "/";

// BizUser proxy object
Microsoft.CRM.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";

// CRMProcessController proxy object
Microsoft.CRM.Proxy.CRMProcessController   processcontroller  = new Microsoft.CRM.Proxy.CRMProcessController();
processcontroller.Credentials = System.Net.CredentialCache.DefaultCredentials;
processcontroller.Url = strDir + "CRMProcessController.srf";

string strErrorMsg;
try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
   Microsoft.CRM.Proxy.CWorkflowSummary[] summary;

   // Retrieve the process instance summary
   summary = processcontroller.RetrieveProcessInstancesSummary(userAuth);

}
catch (System.Web.Services.Protocols.SoapException err)
{
   // Process the platform error here
   strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
   // Process other errors here
   strErrorMsg = ("ErrorMessage: " + err.Message );
}

Requirements

Namespace: Microsoft.CRM.Proxy

Assembly: microsoft.crm.proxy.dll

See Also

© 2003 Microsoft Corporation. All rights reserved.