CRMProcess.CreateActionParameter Method
The CreateActionParameter method creates a parameter for an action.
Syntax
[Visual Basic .NET]
Public Function CreateActionParameter(
ByVal Caller As CUserAuth,
ByVal Parameter As String
) As String
[C#]
public string CreateActionParameter(
CUserAuth Caller,
string Parameter
);
[C++]
public: String* CreateActionParameter(
CUserAuth* Caller,
String* Parameter
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvCreateWorkflowProcess privilege to perform this action. See CUserAuth.
Parameter
Specifies an XML string describing the action parameter. The XML schema is described by wfparameter.xsd.
Return Value
Returns a String type that specifies the ID of the new parameter.
Remarks
For more information about parametertype, see WORKFLOW_PARAMETER_TYPE.
For more information about actiontype, see WORKFLOW_ACTION_TYPE.
For more information about datatype, see WORKFLOW_DATA_TYPE.
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 strActionId = "{13B74186-DB40-480F-AD31-F20432502F97}";
string strXml = " <wfparameter>";
strXml += "<actionid>" + strActionId + "</actionid>";
strXml += "<parametertypecode>" + Microsoft.CRM.Flags.WORKFLOW_PARAMETER_TYPE.WFPM_VALUE.ToString() + "</parametertypecode>";
strXml += "<value>Parameter Value</value>";
strXml += "</wfparameter>";
// Create the parameter
string strActionParameterId = process.CreateActionParameter(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
- CreateAction
- CRMProcess Class
- UpdateActionParameter
- Workflow Reference