W4 – Trigger Configuration (Magic xpi 3.x)
You can use the W4 component as a trigger. In this case, the W4 component lets the Magic xpi Server accept a request from the server where W4 is installed. The request prompts the component to invoke the flow based on the defined business process model.
Before you configure the Magic xpi W4 trigger, you must first manually define the variables in the Magic xpi Studio to match the variables defined in the W4 workcase. Also, you must define an additional variable named ' OutValue'. This is the value that will be passed to the next W4 task after the completion of the Magic xpi flow. If a W4 variable has not been defined in the Magic xpi flow, this variable (unchanged) will be part of the variables list that is passed as an argument to the End Task method.
The Component Configuration: W4 dialog box contains the following fields:
|
|
|
|
Service name
|
Read-only. The service name that you entered in the Service Repository.
|
|
Endpoint name
|
Select an endpoint from the drop-down list. Endpoints are created in the Service Repository. Click here for more information.
|
|
Argument Name
|
The name of the argument. Arguments are defined as Flow, Model, or Global variables. You cannot change this column, it is automatically filled in according to the flow variables defined for that flow.
|
|
Data Type
|
The variable's data type. This is automatically filled in according to the type defined for the flow variable.
|
|
Format
|
The number of characters that the data type holds.
|
|
Mandatory
|
This read-only field displays either No or Yes, depending on whether you selected the Mandatory check box in the Endpoint dialog box. Click here for more information.
|
|
Mapping Variable
|
The arguments should be mapped to an internal Magic xpi variable by selecting the variable selection box in this column. These are the parameters sent from the external Internet browser to Magic xpi and will then be used within the flow. Each mandatory argument should be mapped to a variable.
Click  to open the Variables List. Choose the required variable, and click Select.
|
The following are the translated variable types that are passed from W4 to Magic xpi:
|
|
|
|
|
String
|
Alpha
|
|
|
Integer
|
Numeric
|
|
Date
|
Date
|
|
Document
|
Alpha
|
It is important to define a meaningful name to enable the user to distinguish between a W4 string variable and a W4 document variable.
|
|
Multi-value Variable
|
BLOB
|
A multi-value variables type is represented by an XSD file, which is located in the component's W4 subdirectory. The XSD name is W4MultiVariables.xsd.
Multi-value variables are updated through the Data Mapper service. The other variable types are updated through the flow data.
|
The variable names must be identical to the variables that you defined in the W4 task that will trigger Magic xpi. If a variable name is not identical in both W4 and Magic xpi, this variable will not be processed.
To configure the W4 component as a trigger:
-
Define W4 as a service in the Service Repository. For more information, click here.
-
Place the W4 component into a flow's trigger area to open the Component Properties dialog box.
-
Click the Settings tab, and select the required Service Name from the drop-down list. Click Configuration to open the Component Configuration: W4 dialog box. Enter the relevant information.
-
When you have finished configuring your W4 trigger, click OK to save the settings and to exit the dialog box. Alternatively, you can click Cancel to exit the dialog box without saving your settings.
