Share via

CRMProcessController.SetStep Method

  • Article

The SetStep method sets a step of a process instance manually. See Remarks.

Syntax

[Visual Basic .NET]
Public Sub SetStep(
  ByVal Caller As CUserAuth,
  ByVal ProcessInstanceId As String,
  ByVal ProcessStepId As String
)
[C#]
public void SetStep(
  CUserAuth  Caller,
  string  ProcessInstanceId,
  string  ProcessStepId
);
[C++]
public: void SetStep(
  CUserAuth*  Caller,
  String*  ProcessInstanceId,
  String*  ProcessStepId
);

Parameters

Caller

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

ProcessInstanceId

Specifies the ID of the process instance.

ProcessStepId

Specifies the ID of the process step.

Return Value

No return value.

Remarks

The SetStep method bypasses the process logic by manually setting the process instance to the specified step. This can have unexpected results.

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 strStepId = "{4AAD6AD1-244C-4270-86A2-046BF3CAC92F}";
   string strProcessInstanceId = "{A8CB383D-C9F2-2344-34KE-4A59F7569432}";

   // Set the step
   processcontroller.SetStep (userAuth, strProcessInstanceId, strStepId);
}
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.