Share via

CRMProcess.UpdateRule Method

  • Article

The UpdateRule method updates a rule for a process step.

Syntax

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

Parameters

Caller

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

RuleId

Specifies the ID of the rule that is to be updated.

Rule

Specifies an XML string describing the rule. The XML schema is described by wfrule.xsd.

Return Value

No return value.

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 strRuleId = "{FC0C4939-7AD1-4BA8-B418-6D4D55459833}";

   // Set up the XML string for the rule
   string strRuleXml = "<wfrule>";
   strRuleXml += "<orderofevaluation>1</orderofevaluation>";
   strRuleXml += "<name>name 1</name>";
   strRuleXml += "</wfrule>";

   // Update the rule
   process.UpdateRule(userAuth, strRuleId, strRuleXml);
}
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.