CRMProcess.RetrieveSteps Method
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. To perform this action, the caller must have the prvReadWorkflowProcess privilege and access rights on the objects to be retrieved. See CUserAuth.
ProcessId
Specifies the ID of the process.
ColumnSetXML
Specifies an XML string describing the set of columns to be retrieved. Passing an empty string or null returns all columns (Nothing or "" in VB .NET). 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. This XML string is in the format
<wfsteps> + wfstep1..N + </wfsteps>
where the XML schema for each step is described by wfstep.xsd.
Remarks
The XML string returned from this method may contain multiple objects. If no objects are returned the method simply returns an XML document for the object type with no data.
The XML string returned from this method does not contain elements for fields where the value is null or contains empty strings. This improves performance by not sending more XML data than is necessary from the server to the client.
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.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMProcess proxy object
Microsoft.Crm.Platform.Proxy.CRMProcess process = new Microsoft.Crm.Platform.Proxy.CRMProcess();
process.Credentials = System.Net.CredentialCache.DefaultCredentials;
process.Url = strDir + "CRMProcess.srf";
string strErrorMsg;
try
{
Microsoft.Crm.Platform.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.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also