CRMProcess.CreateStep Method
The CreateStep method creates a step in a workflow process.
Syntax
[Visual Basic .NET]
Public Function CreateStep(
ByVal Caller As CUserAuth,
ByVal Step As String
) As String
[C#]
public string CreateStep(
CUserAuth Caller,
string Step
);
[C++]
public: String* CreateStep(
CUserAuth* Caller,
String* Step
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvCreateWorkflowProcess privilege to perform this action. See CUserAuth.
Step
Specifies an XML string describing the step. The XML schema is described by wfstep.xsd.
Return Value
Returns a String type that specifies the ID of the new step.
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;
string strProcessId = "{93639AD8-CA01-4B16-B09C-EFEE53FA8799}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the XML string for the step
string strStepXml = "<wfstep>";
strStepXml += "<processid>" + strProcessId + "</processid>";
strStepXml += "<name>Step 1</name>";
strStepXml += "</wfstep>";
// Create the step
string strStepId = process.CreateStep(userAuth, strStepXml);
}
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
- Create
- CRMProcess Class
- UpdateStep
- Workflow Reference