CRMProcess.UpdateAndRetrieve Method

  • Article

The UpdateAndRetrieve method updates a workflow process and then returns it.

Syntax

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

Parameters

Caller

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

ProcessId

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

InProcessXML

Specifies an XML string describing the workflow process. The XML schema is described by wfprocess.xsd.

Return Value

Returns a String type that specifies the XML data containing the updated workflow process. The XML schema is described by wfprocess.xsd.

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 strProcessId = "{93639AD8-CA01-4B16-B09C-EFEE53FA8799}";

   // Set up the XML string for the process;
   string strXml = "<wfprocess>";
   strXml += " <name>lead policy 1</name>";
   strXml += " <description>new lead policy of Adventure Works</description>";
   strXml += " <usercontext>" + userAuth.UserId + "</usercontext>";
   strXml += " <businessunitid>" + userAuth.MerchantId + "</businessunitid>";
   strXml += " </wfprocess>";

   // Update the process
   string strProcessXml = process.UpdateAndRetrieve( userAuth, strProcessId, strXml);
}
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.