CRMProcess.CreateAndRetrieve Method
The CreateAndRetrieve method creates a workflow process and then returns it. This creates a workflow process and an initial step.
Syntax
[Visual Basic .NET]
Public Function CreateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal InProcessXML As String
) As String
[C#]
public string CreateAndRetrieve(
CUserAuth Caller,
string InProcessXML
);
[C++]
public: String* CreateAndRetrieve(
CUserAuth* Caller,
String* InProcessXML
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvCreateWorkflowProcess and prvReadWorkflowProcess privileges to perform this action. See CUserAuth.
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 new 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();
process.Timeout = -1;
// Set up the XML string for the process
string strXml = "<wfprocess>";
strXml += "<name>My Process Name</name>";
strXml += "<description>My New Process Adventure Works</description>";
strXml += "<processtypecode>" + Microsoft.CRM.Flags.WORKFLOW_PROCESS_TYPE.WFPT_WORKFLOW_PROCESS.ToString() + "</processtypecode>";
strXml += "<entitytype>" + Microsoft.CRM.Flags.ObjectType.otLead.ToString() + "</entitytype>";
strXml += "<eventtypecode>" + Microsoft.CRM.Flags.WORKFLOW_EVENT_TYPE.WFET_CREATED.ToString() + "</eventtypecode>";
strXml += "<usercontext>" + userAuth.UserId + "</usercontext>";
strXml += "<businessunitid>" + userAuth.MerchantId + "</businessunitid>";
strXml += "</wfprocess>";
// Create and then retrieve the process
string strProcessXml = process.CreateAndRetrieve(userAuth, 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
- Create
- CRMProcess Class
- UpdateAndRetrieve
- Workflow Reference