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 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 Designer. After you add an object to the process flow, you then establish a relationship between it and the previous object in the flow. This relationship defines how and under what conditions to route the document through the process flow.
To create a process flow:
The iWay Process Configuration dialog box opens, as shown in the following image.
The new process flow appears under the Processes folder, the workspace displays a Start object, and the Properties pane appears on the right displaying the properties of the Start object. The following image is an example of this display for a new process flow named Order.
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 iWay Designer, see Defining Objects in a Process Flow.
To add an object to the process flow:
Note: You can also right-click a blank area of the workspace, point to New Object, and choose the object you wish to add from the drop-down list.
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 Objects in a Process Flow 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 options:
Warning: If you set a configured object to Design mode, its configuration parameters will be lost.
Note: The run-time behavior of a deactivated object and a Design mode object are identical, but a deactivated object is fully configured.
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 Line Configuration dialog box opens. The bottom of the dialog box shows the two objects joined by a color-coded line with an arrow indicating the direction of the document flow. The following image is an example of this dialog box showing two objects, Transform and NewFile, with an OnCompletion relationship.
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.
OnCompletion (blue line) - indicates there are no conditions; always follow the path.
OnError (red line) - follow the path if there is a JAVA exception.
OnSuccess (green line) - follow the path if there is a normal completion.
OnCustom (brown line) - allows you to customize the path condition.
OnFailure (red line) - follow the path if a coded error occurs, for example, an agent that is coded to issue an error when it is unable to connect to a server.
If you select OnCustom, a list of Case of options becomes available 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.
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 Line Properties dialog box opens, as shown in the following image. This dialog box provides an Event drop-down list, Case of and Description fields, and a representation of the two objects joined by a line.
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, or right-click the process flow node and select Save from the drop-down list.
The Results tab of the Message Log pane displays a status message. An example of a message display is shown in the following image.
iWay Software |