Workflow settings and parameters

Parameters can either be provided directly in the URL or as an XML file (in this case the URL has to contain the parameter settings with the name and path of that file).

Note: You can have multiple settings XML files for a single workflow.

Note: For example, you can have one settings XML file for exchanging Opportunities (e.g. y1_settings.xml) with the 3rd party system and another for exchanging contact persons (e.g. kp_settings.xml).

If a parameter both is specified in the URL string and in the settings XML file, the value defined in the URL string replaces the particular value of the settings file. If a parameter is provided in the URL and is not found in the settings XML file, then its value is added to the list of parameters. If a parameter is solely defined in the settings XML file, its value will be added to the list of parameters.

Note: If you want to omit a parameter, which is defined in the settings XML file, you have to omit the parameter settings in the URL and provide all required parameters directly in the URL.

The following parameters are understood by the "synchronize" workflow

Table 1. "synchronize" workflow parameters
Parameter	Meaning
loggingEnabled	Boolean indicator if the logging is on or off. This parameter is optional.
query	Path to the query template XML file
outTransformation	Path to the XSLT file for transforming CRM.interface XML into 3rd party system XML format. Note: if this parameter is not provided no message will be sent at all.
inTransformation	Path to the XSLT file for transforming 3rd party system XML into CRM.interface format
useSoap	if true SOAP messaging will be used. Otherwise a (normal) Web Request will be sent to the 3rd party system.
targetUrl	URL of 3rd party system. A "normal" Web Request will be sent to this URL if useSoap set to false.
soapUrl	URL of the 3rd party web service. A SOAP message will be sent to this URL if useSoap set to true.
soapAction	method of the 3rd party web service, which should be executed. If useSoap set to true, but no soapAction is provided then a regular Web Request will be sent to targetUrl as a fallback solution.
useSoapTransformation	if true the SOAP message will be created by applying the XSLT stylesheet as defined in the parameter soapOutTranformation. Otherwise the SOAP message will be generated based on the XML template as defined in the parameter soapTemplate.
soapTemplate	Path to XML template file used to create the SOAP message. If useSoapTransformation set to true this parameter is ignored.
soapOutTranformation	Path to XSLT used to create the SOAP message. Only used if useSoapTransformation is set to true.

Note: Support for SOAP messaging is available of version 8.1.7.433 and higher.

Note: If relative file paths are used these paths have to be relative to the root directory of the CRM.interface web application (and not relative to the location of the workflow XAML file).

The settings file of the "synchronize" workflow has the following structure

Figure: settings file of workflow

<?xml version="1.0"?>
<settings> 
    <loggingEnabled></loggingEnabled> <!--  indicator if the logging is on or off--> 
    <query></ query> <!--  path to the query template xml file  --> 
    <outTransformation></ outTransformation> <!--  path to XSLT file responsible for transformation from update.CRM format into 3rd party system format        --> 
    <inTransformation></ inTransformation> <!--  path to XSLT file responsible for transformation from 3rd party system into format update.CRM format --> 
    <targetUrl></ targetUrl> <!--  URL of 3rd party system--> 
    <useSoap></ useSoap> <!--  indicator if SOAP messaging will be used   --> 
    <soapAction></ soapAction> <!--  method of the 3rd party web service to invoke --> 
    <soapTemplate></ soapTemplate> <!--  XML template file used to create SOAP message--> 
    <soapUrl></ soapUrl> <!--  URL of web service endpoint --> 
    <useSoapTransformation></ useSoapTransformation> <!-- indicator, if XSLT file (soapOutTranformation) or XML template (soapTemplate) should be used --> 
    <soapOutTranformation></ soapOutTranformation> <!--  path to the XSLT file for transforming from update.CRM format into SOAP message -->
</settings>