In this section: |
In this section: |
How to: |
You must create a project before you can design a process flow. If you have not created a project, see Creating a Project for instructions.
Creating a process flow in iIT Designer is a drag-and-drop operation. Every process flow begins with a Start object, which appears in the workspace by default when you create a new process flow. A process flow must also contain at least one end object, which you can add to the workspace at any time. You cannot validate or publish a process flow without an end object.
To create a process flow, you will include one or more of the objects provided by iIT Designer. After you add an object to the process flow, you then establish a relationship between that object, and the previous object in the flow. This relationship defines how, and under what conditions, you can route the document through the process flow.
There are two methods to create a new Process Flow:
You are ready to add objects to the process flow.
Once you have created a process flow, you can continue to modify its design by adding objects according to your requirements. Every process flow requires at least one End object to terminate the flow. This section describes how to include an object in your process flow. For details about each object available to you in iIT Designer, see Defining Process Flow Objects .
To add an object to the process flow:
Note: You can also right-click a blank area of the workspace. Select the object you wish to add from the New Process Flow Object dialog box.
The New (type) Object dialog box for the selected object opens. The following image shows an example of this dialog box for a new File object.
See Defining Process Flow Objects for details on defining the objects that are available in Designer.
Depending on the object you are adding, this dialog box also includes the following option.
Depending on the object you choose, there are one or more dialog boxes that present the parameter options for the object.
The new object appears in the workspace. You can drag it to any position in the workspace.
The relationship between two or more objects in a process flow is represented by a color-coded line with an arrow that directs the flow of the XML input document. You define the relationships between objects as you build your process flow. If necessary, you can change the line properties, just as you can the object properties, of an existing process flow.
This section explains how to create a relationship between objects and how to edit existing relationships.
To build a relationship between objects:
The Relation Configuration dialog box opens. The following image is an example of this dialog box with an OnCompletion Event.
The default (stock) events that appear depend on the objects you are working with. For instance, the first relationship you build between a Start object and another object allows only the OnCompletion event for that relationship. The lines in the workspace that represent the relationship between two objects are color coded for quick identification. The following list describes the available events and the corresponding color.
If you select OnCustom, a list of Case of options appears, allowing you to customize the event for a particular condition, such as true or false. The following image shows this dialog box for the line configuration between a Decision Switch object and an End object, and contains an Event drop-down list, and a table with three columns: Case, Type, and Description.
Note: The cases listed in the Case column are based on the agent. For example, the cases listed for HTTP and SQL are different.
The New Custom Event dialog box opens, as shown in the following image.
The Object Relation: OnCustom dialog box opens, as shown in the following image.
You can use the Label field to show a label on the relationship line, as shown in the following image. The relationship line will now route only a 204 return code.
Note: The emit agent returns two edges at the same time, the specific HTTP status code followed by a more generic edge like you see in the Object Relation: OnCustom dialog box. For example, 404 and then fail_client. Since 404 appears first, if you wire it, it will be followed in preference to fail_client. In this case, you would get 204 and then success. If you wire 204, it will be followed in preference to success, which is shown as OnSuccess in the GUI.
A line appears between the two objects to indicate a relationship is established.
If you want to change the properties of an existing relationship:
The Properties pane provides an Event drop-down list, along with Case of and Description fields.
The new line properties are now in place.
To save a process flow, highlight the process flow node, and select Save from the File menu.
Validating a process flow determines that the process flow structure is correct. For example, validating a process flow determines that all objects are connected.
To validate a process flow, right-click the Flows node and select Validate from the list. A pop-up window appears, as shown in the following image.
Compiling a process flow sends the flow to iWay Service Manager to verify that it works in a run-time environment. Compiling as part of creating a process flow is optional, since it is automatically done as part of the test option. The compile option is useful if you are debugging a process flow. It allows you to check the flow using a step-by-step approach.
To compile a process flow, right-click the process flow you want to compile. Select Integration Tools from the list, and then select Compile, as shown in the image below.
How to: |
iIT Designer provides a test feature to test the function of a process flow using an input XML document.
The following procedure explains how to use the Test feature.
The Edit configuration and launch dialog box opens, as shown in the following image.
All. Traces all active objects.
Select. Traces all debug enabled objects.
None. Disables tracing.
Debug. Reports progress traces of the test.
Deep Debug. Reports additional traces and details about errors.
This determines whether or not the work scheduled in the process flow is actually performed during the test, for example, inputting records to a database.
The test results appear in the Console tab of the Properties pane.
How to: |
Publishing a process flow makes the process flow available to either a system or to a channel that was created in Service Manager. A process flow published to a system can run as a global document or be used by an iWay adapter to create a web service.
You can only publish valid and compiled process flows. A single process flow can be published to multiple listeners and systems. See Validating a Process Flow for the validation procedure and Compiling a Process Flow for information on compiling a process flow.
There are three options to publish a process flow:
Designer provides a tool called Publication Management that allows you to view the process flows published to a particular Service Manager configuration. Through this tool, you can also unpublish any process flow currently published to a Service Manager configuration. This section provides the procedures to publish and unpublish a process flow.
To publish a process flow:
The Publishing Resource Wizard dialog box opens. An example of this dialog box is shown in the following image.
The Publish To dialog box opens, as shown in the following image.
The Select Publication Location(s) dialog box opens, as shown in the following image. This dialog box shows the publication locations (systems and listeners) for the selected Service Manager and configuration. The locations are listed in a table with three columns; Name, Type, and Description.
You can publish a flow to a system, a configured listener, and (if defined) a global document. You can also choose to overwrite any flows that are currently published.
The Message Log pane displays the publishing status.
An example of the status display when publishing to a system is shown in the following image.
Note: You can publish only one process flow to a listener.
This option uses the default publication server (Service Manager) and configuration, but allows you to select the publication locations.
The Select Publication Location(s) dialog box opens, as shown in the following image. This dialog box shows the publication locations (system and listener(s)) for the default Service Manager and configuration. The publication locations are listed in a table with three fields: Name, Type, and Description.
The Message Log pane displays the publishing status.
To republish a process flow:
The publication process uses the previous publication settings (publication server and locations) to publish the process flow. The publication results appear in the Message Log pane.
For an example of publication results, see How to Publish a Process Flow.
You can only unpublish a process flow from a run-time configuration. To remove a process flow from a Registry, use the iWay Service Manager console, as described in the iWay Service Manager User’s Guide.
Use the following procedure to view the published process flows on a particular publication server and to unpublish a process flow that is currently published.
The Unpublishing Process(es) - Locate a Publication Server dialog box opens, as shown in the following image.
The Select Server Configuration dialog box opens, as shown in the following image.
The Unpublish Operation dialog box opens. An example of this dialog box is shown in the following image. The processes are listed in a table with three fields: Name, Type, and Description.
The Publication Management tool closes and the results appear in the Message Log pane. The following image shows an example of the results for a process flow named SWIFT_ROUTER..
The process flow has been removed from the publication server.
How to: |
A process flow can be exported as an XML file where it is accessible by another Service Manager or a version control system, such as Microsoft Visual SourceSafe.
To export a process flow:
The standard Windows Save As window opens.
The process flow is saved as an XML document in the designated directory.
|
iWay Software |