CRMProcessController.RetrieveProcessesByObject Method

The RetrieveProcessesByObject method retrieves all of the workflow processes that can be run by an object.

Syntax

[Visual Basic .NET]
Public Function RetrieveProcessesByObject(
  ByVal Caller As CUserAuth,
  ByVal ProcessType As WORKFLOW_PROCESS_TYPE,
  ByVal Object As CObjectName,
  ByVal ColumnSetXML As String
) As String
[C#]
public string RetrieveProcessesByObject(
  CUserAuth  Caller,
  WORKFLOW_PROCESS_TYPE  ProcessType,
  CObjectName  Object,
  string  ColumnSetXML
);
[C++]
public: String* RetrieveProcessesByObject(
  CUserAuth*  Caller,
  WORKFLOW_PROCESS_TYPE  ProcessType,
  CObjectName*  Object,
  String*  ColumnSetXML
);

Parameters

Caller

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

WORKFLOW_PROCESS_TYPE

Specifies the process type. See WORKFLOW_PROCESS_TYPE.

Object

Specifies the object to find. See CObjectName.

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 wfprocess.xsd. See also ColumnSetXML Schema.

Return Value

Returns a String type that specifies the XML data containing the set of processes. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. The XML schema is described by wfprocess.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();

   string strLeadId = "{4AAD6AD1-244C-4270-86A2-046BF3CAC92F}";

   Microsoft.CRM.Proxy.CObjectName objName = new Microsoft.CRM.Proxy.CObjectName();
   objName.Id = strLeadId;
   objName.Type = Microsoft.CRM.Proxy.ObjectType.otLead;

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

   // Retrieve by object
   string strProcessXml = processcontroller.RetrieveProcessesByObject (userAuth, Microsoft.CRM.Proxy.WORKFLOW_PROCESS_TYPE.WFPT_WORKFLOW_PROCESS, objName, 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.