CRMProcess.UpdateAll Method
The UpdateAll method updates (overwrites) a workflow process and all of its sub-elements.
Syntax
[Visual Basic .NET]
Public Sub UpdateAll(
ByVal Caller As CUserAuth,
ByVal ProcessId As String,
ByVal Process As CWorkflowProcess
)
[C#]
public void UpdateAll(
CUserAuth Caller,
string ProcessId,
CWorkflowProcess Process
);
[C++]
public: void UpdateAll(
CUserAuth* Caller,
String* ProcessId,
CWorkflowProcess* Process
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvWriteWorkflowProcess privilege to perform this action. See CUserAuth.
ProcessId
Specifies the ID of the process that is to be updated.
Process
Specifies a CWorkflowProcess structure that stores a flat workflow process. See CWorkflowProcess.
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;
string strProcessId = "{9B4CCEEC-AB41-4463-B3DF-F3C21CD9C6C3}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
Microsoft.CRM.Proxy.CWorkflowProcess wfProcess = new Microsoft.CRM.Proxy.CWorkflowProcess();
// Set up the XML string to update the process and all of its elements
wfProcess.Steps = "<wfsteps><wfstep><name>" + "My Step Name" + "</name>description>" + "A description of my step" + "</description></wfstep></wfsteps>";
wfProcess.ActionParameters = "<wfparameters></wfparameters>";
wfProcess.Actions = "<wfactions></wfactions>";
wfProcess.ConditionParameters = "<wfparameters></wfparameters>";
wfProcess.Conditions = "<wfconditions><wfcondition><name>" + "My Condition Name" + "</name></wfcondition></wfconditions>";
// Update the process and all of its elements
process.UpdateAll (userAuth, strProcessId, wfProcess);
}
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
- CreateAll
- CRMProcess Class
- Update
- UpdateRule
- Workflow Reference