In this section: |
This topic provides step-by-step instructions on how to configure a basic inbound message flow for the iWay Integration Solution for SWIFT. The message flow represents the movement and tasks in the conversion of a message from SWIFT FIN format to XML format.
To access the iWay Service Manager Administration Console, you must first make sure that the iWay Service Manager service is running.
For instructions on starting iWay Service Manager, see the iWay Service Manager User's Guide.
or,
from a browser such as Microsoft Internet Explorer, enter the following URL,
http://host:port
where:
The following image shows the URL with the default values.
Note: The default user name and password is iway.
The iWay Service Manager Administration Console opens, as shown in the following image.
The iWay e-Business Information Exchange (Ebix) framework supplies several Ebix files for the iWay Integration Solution for SWIFT.
An Ebix file for SWIFT is named SWIFT_ccyy.ebx, where ccyy is the release year. For example, an Ebix file for the 2009 SWIFT FIN message is named SWIFT_2009.ebx.
For details on the supported SWIFT FIN messages, see Ebix-Supported Transaction Sets.
This topic describes how to add an Ebix to the Registry on Windows and UNIX.
Note: Ebix archives are not packaged with the iWay Service Manager installation. You can download all Ebix archives from the following Web site, which is hosted and maintained by iWay Software:
http://techsupport.informationbuilders.com
The Ebix pane opens, as shown in the following image.
You are prompted for the name of the Ebix and an optional description.
Note: This step must be repeated for each SWIFT document that is added to the Registry.
On the Ebix pane, you will see that the Ebix was successfully added. Later you will associate it with the channel for inbound processing.
Depending on your system configuration, there are two methods that you can use to add an Ebix to the Registry on UNIX and z/OS.
An inlet defines how a message enters a channel. It typically contains a:
Select File from the Type drop-down list and click Next.
The configuration parameters pane opens.
Parameter |
Value |
---|---|
Input Path * |
C:\File_in This value is the directory in which input messages are received. Make sure that you have created this directory; otherwise, errors will occur during deployment. |
Destination * |
C:\File_out This value is the directory in which output files are stored after transformation. Make sure that you have created this directory; otherwise, errors will occur during deployment. |
Removal Destination |
C:\File_removal This value is the directory to which input messages are moved if they fail during transformation. Make sure that you have created this directory; otherwise, errors will occur during deployment. It is recommended to configure a removal destination when you are constructing a basic channel. |
Suffix In |
* Input files with any file extension are allowed. |
Suffix Out |
xml The extension for output files is .xml. |
Accepts non-XML (flat) only |
true If true, listener expects flat (non-XML). Automatic parsing is not performed. |
You are prompted for the name of the listener and an optional description.
The XDSWIFTpreParser parses a SWIFT input message into an XML output.
For details on the supported SWIFT FIN messages, see Ebix-Supported Transaction Sets.
The Preparsers configuration parameters pane opens.
The following table lists and describes the available configuration parameters for the preparser:
Parameter |
Description |
---|---|
version * |
Represents the SWIFT release you are using. |
template * |
Represents the template to use for the SWIFT to XML transform. Enter the following: MT%toXML.xch |
validateoff |
Select false to validate the structure. |
You are prompted for a name and optional description for the new preparser.
Now that you have added a File listener and a preparser to the Registry, you are ready to add and define an inlet. You will associate the previously created listener and preparser with the inlet.
Parameter |
Value |
---|---|
Name * |
SWIFTtoXML_Inlet |
Description |
Inlet for SWIFT to XML. |
The next pane prompts you for the component type.
The next pane prompts you to select a listener.
The listener is associated with the inlet. Now you need to associate the preparser created earlier with the inlet.
The next pane prompts you for the component type.
On the next pane, you are prompted to select a preparser.
You have now successfully completed definition of the inlet.
A route defines the path a message takes through a channel.
The route for the channel for inbound processing consists of a process. A process is a stateless, lightweight, short-lived microflow executed by iWay Service Manager on a message as it passes through the system. A service is an executed procedure that handles the business logic of a message.
This section describes how to create a process flow with iWay Designer and bind it to a sample channel as a route.
For details on the full features of iWay Designer, and additional information on using its capabilities, see the iWay Designer User's Guide.
You will complete the following high-level steps to define the route.
Note: A Validation Report is used to determine if your SWIFT message is compliant with SWIFT-defined standards. SWIFT tagging validation and network validation will be performed.
The Designer Project Information dialog box opens, prompting you for a project name and optional description.
In the Description field, type Defining a route for SWIFT inbound processing using iWay Designer to describe the project.
The Designer Project Bindings dialog box opens.
The iWay Process Configuration dialog box opens.
In the Description field, type Process flow for SWIFT inbound route processing channel.
The new SWIFTValidationProcess node appears under the Processes folder, and the workspace displays a Start object.
You are ready to build the SWIFTValidationProcess by adding objects to it and specifying their relationships.
The copy service redirects an output document to a destination.
The Service Name and Description dialog box opens.
The Service Type dialog box opens.
The Define Service dialog box opens.
Do not select the check box, since you do not want to use this service in other process flows.
The Properties dialog box opens.
The new CopyService object appears in the workspace.
Now you need to connect the Start object to the CopyService object.
The Line Configuration dialog box opens.
This option indicates that there are no conditions that affect the path, and that the path between the two objects will always be followed.
A line appears between the objects to indicate that a relationship has been established.
All processing paths must terminate with an End object.
The End Name and Description dialog box opens.
The End Name Schema dialog box opens.
The Properties dialog box opens.
The new End object appears in the workspace.
The Line Configuration dialog box opens.
This option indicates that there are no conditions that affect the path and that the path between the two objects will always be followed.
Your process flow will look similar to the following. The CopyService object is a unit of work that redirects the XML output to a defined destination through a custom emit. The End object terminates this single process.
You can reposition the objects as desired.
You will add a Validation Report service to execute a SWIFT validation report.
The Service Name and Description dialog box opens.
The Service Type dialog box opens.
The Define Service dialog box opens.
Do not select the check box, since you do not want to use this service in other process flows.
The Properties dialog box opens.
The new SWIFTValidationService object appears in the workspace. The process flow will look similar to the following.
The Line Configuration dialog box opens.
A line appears between the objects to indicate that a relationship has been established.
All processing paths must terminate with an End object.
The process flow is now complete. It will look similar to this.
Validating a process flow ensures that its structure is correct. Publishing a process flow makes it available in the Registry for use in channel configuration.
For instructions on validating and publishing the process flow, see the iWay Designer User's Guide.
Your next step is to add a new route to the Registry of the iWay Service Manager Administration Console and associate the process flow with it.
Parameter |
Value |
---|---|
Name * |
SWIFTtoXML_Route_PFlow |
Description |
Route for SWIFT to XML using process flow. |
You are prompted for the type of component to associate with the route.
The route, with its associated process flow, has been successfully defined.
An outlet defines how a message leaves a channel. An emitter is a transport protocol that sends a document to its recipient. In the sample configuration, we will use a File emitter. For details on supported protocols, see the iWay Service Manager Protocol Guide.
For the channel in this example, you will add two emitters to the Registry. Then you will define two outlets, associating one emitter with each outlet.
When you associate the outlets with the channel in later steps, you will apply a condition to each one to dynamically direct the flow of the output document based on its content.
In the example, you will add:
The configuration parameters pane opens.
Parameter |
Value |
---|---|
Destination * |
C:\File_out\SWIFT\_SREG(basename)_*.xml This value is the directory to which the XML output goes. Make sure that you have created this directory; otherwise, errors will occur during deployment. SREG(basename) is a special register reserved by iWay Service Manager, which uses a file name without an extension. For more information on how to configure a special register (SREG), see the iWay Service Manager User's Guide. On output, an asterisk (*) in the destination file name is replaced by a date and time stamp. |
Create Directory |
false |
Parameter |
Value |
---|---|
Name * |
XML_Out_Emitter |
Description |
Emitter for XML output for SWIFT. |
The configuration parameters pane opens.
Parameter |
Value |
---|---|
Destination * |
C:\File_out\Report\_SREG(basename)_*.xml This value is the directory to which the report validation output goes. You can use an extension other than .xml, for example, .SWIFT or .data. Make sure that you have created this directory; otherwise, errors will occur during deployment. On output, an asterisk (*) in the destination file name is replaced by a date and time stamp. For details on the special register (SREG) used in the preceding file name, see the iWay Service Manager User's Guide. |
Create Directory |
false |
Parameter |
Value |
---|---|
Name * |
Validation_Report_Emitter |
Description |
Emitter for Validation Report output for SWIFT. |
Now that you have added an XML and Validation Report emitter to the Registry, you are ready to add and define the outlets. You will associate the previously created emitters with the outlets (one emitter for each outlet).
Parameter |
Value |
---|---|
Name * |
SWIFT_XML_Outlet |
Description |
XML outlet for SWIFT. |
The next pane prompts you for the component type.
The next pane prompts you to select an emitter.
The XML emitter is associated with the outlet. Now you need to define the second outlet for the validation report output.
Parameter |
Value |
---|---|
Name * |
Validation_Report_Outlet |
Description |
Validation Report outlet for SWIFT. |
The next pane prompts you for the component type.
The next pane prompts you to select an emitter.
Now you have defined the two outlets.
Now that you have defined the inlet, route, and outlets for the channel, you are ready to add the channel to the Registry and associate the conduits with it.
Parameter |
Value |
---|---|
Name * |
SWIFTtoXML_Channel |
Description |
Channel for SWIFT to XML inbound processing. |
You are prompted to associate components with the channel.
The next pane prompts you to select an inlet.
The inlet is added to the channel.
Now you need to associate the route defined earlier with the channel.
The next pane prompts you for the component type.
On the next pane, you are prompted to select a route.
The Set Condition pane opens.
This condition tests the output data for SWIFT XML format. If it is in SWIFT XML format, it is routed to the destination specified when you added the emitter for XML output.
You will see that the Conditions plus sign icon has changed. You can click this icon to edit the condition.
For details on supported conditions, see the topic on using functions in the iWay Service Manager User's Guide.
The Set Condition pane opens.
This condition tests the output data for XML format. If the data is in XML format, it is routed to the destination specified when you added the emitter for validation report output.
The Channel Definitions pane opens.
The Add Ebix components pane opens.
The following pane opens.
Now that you have associated all the components with the channel, you are ready to build it.
The results of the build are displayed on the right pane.
If an error or errors are displayed in the Message column, take the appropriate action as instructed.
Deployment is the mechanism by which a channel moves from being stored in the Registry to becoming active in iWay Service Manager. For more information on deployment, see the iWay Service Manager User's Guide.
The Channel Management pane reopens.
The red X under Status changes to a green check mark to indicate that the channel has been started. If an error or errors are displayed, take the appropriate action as instructed.
To make sure that the channel is working as expected, perform the following steps:
The following table contains links to SWIFT files that are attached to this PDF and can be used to verify your channel.
SWIFT MT950 (Statement of Cash) |
SWIFT MT535 (Statement of Holding) |
SWIFT MT541 (Receive Against Payment) |
---|---|---|
. MT950.txt |
. MT535.txt |
. MT541.txt |
Note: For file association compatibility only, each SWIFT file that is attached to this PDF has been renamed to include a .txt extension. However, please note that the actual SWIFT output file that is placed in the C:\File_in directory will not carry a .txt extension.
For example, if you specified the destination file name for the XML emitter as _SREG(basename)_*.xml per the configuration example, a SWIFT input file named MT950.txt is named MT950_2009-03-03T19_33_26.684Z.xml on output.
The following table contains links to sample XML validation reports that are attached to this PDF and can be used to verify your output.
SWIFT MT950 |
SWIFT MT535 |
SWIFT MT541 |
---|---|---|
. MT950_rpt.xml |
. MT535_rpt.xml |
. MT541_rpt.xml |
The following table contains links to SWIFT FIN message report files that are attached to this PDF and can be used to verify your output.
SWIFT MT950 |
SWIFT MT535 |
SWIFT MT541 |
---|---|---|
. 950.xml |
. 535.xml |
. 541.xml |
Using the Archive Manager feature of iWay Service Manager, you can archive your channel configuration with its associated components and import them into another Registry. They will then be available from that Registry for modification or reuse.
For details on this feature, see the iWay Service Manager User's Guide.
iWay Software |