CRMProcess.RetrieveSteps Method

  • Article

The RetrieveSteps method retrieves all steps of a process.

Syntax

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

Parameters

Caller

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

ProcessId

Specifies the ID of the process.

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

Return Value

Returns a String type that specifies the XML data containing the set of steps associated with the specified process. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. The XML schema is described by wfstep.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";

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

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

   string strProcessId = "{93639AD8-CA01-4B16-B09C-EFEE53FA8799}";

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

   // Retrieve the steps
   string strStepsXml = process.RetrieveSteps(userAuth, strProcessId, 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.