CRMProcessController.RetrieveProcessInstancesByCategory Method

  • Article

The RetrieveProcessInstancesByCategory method retrieves workflow process instances by category.

Syntax

[Visual Basic .NET]
Public Function RetrieveProcessInstancesByCategory(
  ByVal Caller As CUserAuth,
  ByVal EntityType As ObjectType,
  ByVal ColumnSetXML As String
) As String
[C#]
public string RetrieveProcessInstancesByCategory(
  CUserAuth  Caller,
  ObjectType  EntityType,
  string  ColumnSetXML
);
[C++]
public: String* RetrieveProcessInstancesByCategory(
  CUserAuth*  Caller,
  ObjectType  EntityType,
  String*  ColumnSetXML
);

Parameters

Caller

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

EntityType

Specifies the type of the object to find. See ObjectType. Set the object type to otNone to retrieve all the process instances.

ColumnSetXML

Specifies an XML string describing the set of columns that is to be retrieved. Passing "" or null returns all columns. You can find the valid column names in wfprocessinstance.xsd. See also ColumnSetXML Schema.

Return Value

Returns a String type that specifies the XML data containing the set of process instances associated with the specified category. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. The XML schema is described by wfprocessinstance.xsd.

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();

   // Set up the columns that you want to retrieve
   string strColumnSetXml = "<columnset>";
   strColumnSetXml += "<column>parentid</column>";
   strColumnSetXml += "<column>processid</column>";
   strColumnSetXml += "<column>objectid</column>";
   strColumnSetXml += "</columnset>";

   // Retrieve the process instance
   string strResultsXml = processcontroller.RetrieveProcessInstancesByCategory (userAuth, Microsoft.CRM.Proxy.ObjectType.otLead, strColumnSetXml);
}
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.