CRMProcessController.Execute Method

  • Article

The Execute method executes a process manually.

Syntax

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

Parameters

Caller

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

ProcessId

Specifies the ID of the process that is to be executed.

Object

Specifies the object on which the workflow process is to be run. See CObjectName.

Params

[Not supported in this version; reserved for future use.]

Return Value

Returns a String type that specifies the new process instance ID.

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 strProcessId = "{B2BB383D-C9F2-4235-98DE-4A59F7569432}";
   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;

   // Create the process
   // The process should be activate to execute the process
   string strInstanceId = processcontroller.Execute(userAuth, strProcessId, objName, "");
}
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.