Sample Configuration for Inbound Processing: EDIFACT to XML

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 UN/EDIFACT. The message flow represents the movement and tasks in the conversion of a message from Electronic Data Interchange (EDIFACT) format to XML format and acknowledgement of the message.


Top of page

x
Accessing the iWay Service Manager Administration Console

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.



x
Procedure: How to Access the iWay Service Manager Administration Console on Windows
  1. From the Windows desktop, select Start, All Programs, iWay 6.1 Service Manager, and Console

    or

    from a browser such as Microsoft Internet Explorer, enter the following URL:

    http://host:port

    where:

    host
    Is the host machine on which iWay Service Manager is installed. The default value is localhost.
    port
    Is the port number on which iWay Service Manager is listening. The default value is 9999.

    The following image shows the URL with the default values.

  2. When prompted, enter your user name and password, and click OK.

    Note: The default user name and password is iway.

    The iWay Service Manager Administration Console opens, as shown in the following image.


Top of page

x
Adding an Ebix to the Registry

The iWay e-Business Information Exchange (Ebix) framework supplies several Ebix files for the iWay Integration Solution for UN/EDIFACT.

An Ebix file for EDIFACT is named EDIFACT_transaction_set.ebx, where transaction_set is the transaction set number. For example, the Ebix file for EDIFACT transaction set D01B is named EDIFACT_D01B.ebx.

For details on the supported EDIFACT transaction sets, see EDIFACT Supported Versions.

This topic describes how to add an Ebix to the Registry on Windows and UNIX.



x
Procedure: How to Add an Ebix to the Registry on Windows
  1. To access the Registry, select the Registry option in the top pane.
  2. Under Components in the left pane of the Registry, select Ebix.

    The Ebix pane opens, as shown in the following image.

  3. Click Add to add a new Ebix. The New Ebix pane opens.

    New Ebix pane

  4. Browse to the directory in which the Ebix is located and select the name of the file, for example, EDIFACT_D01B.ebx.
  5. Once you have selected the Ebix, click Next.

    You are prompted for the name of the Ebix and an optional description.

  6. Enter a name for the Ebix, for example, EDIFACT_D01B_EBIX, and an optional description, such as EDIFACT D01B EBIX.

    Note: This step must be repeated for each Ebix message set that is added to the Registry.

  7. Click Finish.

    On the Ebix pane, you will see that the Ebix was successfully added. Later you will associate it with the channel for inbound processing.



x
Procedure: How to Add an Ebix to the Registry on UNIX

Depending on your system configuration, there are two methods that you can use to add an Ebix to the Registry on UNIX.


Top of page

x
Adding Special Register Sets

In iWay Service Manager, a special register is a name-value pair that defines a variable that is carried throughout the system. Once defined, this variable is available to all components of the system. Within the EDIFACT components, a Best Practice is to use special registers to define inputs and outputs. When packages containing channels are migrated between systems, the only changes required to deploy in the new location is to modify these special registers and build the channel. Channels may have many locations and this practice will minimize the effort required to migrate. For a complete list of system special registers that are provided, see the iWay Service Manager Programmer's Guide. For more information on defining a special register of your own, see the iWay Service Manager User's Guide.

The sample inbound channel uses a set of special registers. For example:



x
Procedure: How to Add a Special Register Set to Your Channel

To add a special register set to your channel:

  1. In the left console pane of the Registry menu, select Channels.

    The Channels pane opens.

  2. In the row for your channel, click Regs for the channel you want to modify.

    The Assign register pane opens.

  3. Select a register and click Finish.
  4. Click Back to return to the Channels pane.

Top of page

x
Defining an Inlet

An inlet defines how a message enters a channel. It typically contains a:



x
Procedure: How to Add a Listener
  1. From the Registry menu options on the left pane, select Listeners under Components.
  2. On the Listeners pane on the right, click Add to add a new listener.
  3. For the purpose of this example, we will show the configuration with a File listener. For details on supported protocols, see the iWay Service Manager Protocol Guide.

    Select File from the Type drop-down list and click Next.

    The configuration parameters pane opens.

  4. Supply configuration parameters for the new File listener as follows. An asterisk indicates that a parameter is required. For parameters not listed in the following table, accept the default value.

    Parameter

    Value

    Input Path *

    sreg(EDIFACT.Input)

    This value is a special register that uses a defined directory in which input messages are received.

    Make sure that you have created this directory; otherwise, errors will occur during deployment.

    Destination *

    sreg(EDIFACT.GoodOutput)

    This value is a special register that uses a defined 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

    sreg(EDIFACT.Archive)

    This value is a special register that uses a defined 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.

  5. Click Next.

    You are prompted for the name of the listener and an optional description.

  6. On the Listeners pane, enter the name of the new listener, EDIFACTtoXML_Listener, and an optional description. Then click Finish to add the listener. In a later step, you will associate this listener with the inlet.


x
Procedure: How to Add a Batch Splitter Preparser
  1. From the Registry menu options, select Preparsers under Components.
  2. On the Preparsers pane, click Add to add a new preparser. You are prompted for the type of preparser.

  3. Select EDIFACTBatchSplitter (com.ibi.preparsers.XDEDIFACTBatchSplitter) from the Type drop-down list.

    The EDIFACTBatchSplitter internally splits EDIFACT input files into multiple individual EDIFACT transactions. The file will then be processed into one XML output when passed to the EDIFACT Preparser. You can also use the EDIFACTBatchSplitter if there is only one EDIFACT transaction.

    For details on the supported EDIFACT transaction sets, see EDIFACT Supported Versions.

  4. Click Next.

    The Preparsers configuration parameters pane opens.

    Disabled by default, the Timestamp option writes a timestamp to the log file. When enabled, the log file will display the start and end time of the file transformation and the input file name that is used. This feature is useful in development or debugging environments when processing batches of files. When the transaction log is not in use (for example, in a production mode) then this information is available in the Activity Log.

  5. Click Next.

    You are prompted for a name and optional description for the new preparser.

  6. Enter a name for the new preparser, for example, EDIFACTBatchSplitter_Preparser, and an optional description.
  7. Click Finish to add the preparser. In the next procedure, you will associate this preparser with an inlet.


x
Procedure: How to Add a Preparser
  1. From the Registry menu options, select Preparsers under Components.
  2. On the Preparsers pane, click Add to add a new preparser. You are prompted for the type of preparser.

  3. Select EDIFACTPreParser (com.ibi.preparsers.XDEDIFACTPreParser) from the Type drop-down list.

    The EDIFACTPreparser is used with the EDIFACTBatchSplitter. It processes an EDIFACT input file which has been split by the BatchSplitter into multiple XML output files. One XML output file is produced for each EDIFACT transaction. EDIFACTPreparser should be used when there is only one EDIFACT transaction being processed.

    For details on the supported EDIFACT transaction sets, see EDIFACT Supported Versions.

  4. Click Next.

    The Preparsers configuration parameters pane opens.

    The Template field is used to locate the template in the Ebix, which is used during the transformation from EDIFACT format to XML format.

    Disabled by default, the Timestamp option writes a timestamp to the log file. When enabled, the log file will display the start and end time of the file transformation and the input file name that is used. This feature is useful in development or debugging environments when processing batches of files. When the transaction log is not in use (for example, in a production mode) then this information is available in the Activity Log.

    The InsertGroupLoop parameter inserts a group loop node in the generated XML document. By default, this parameter is set to true.

  5. In the Template field, enter FACT_%_^toXML.xch.

    The preparser obtains the message type and version information from the EDIFACT input document. In the parameter, the character "%" represents the message type, and the character "^" represents the version.

    For example, if the message type for the EDIFACT document is INVOIC and the version is D01B, the constructed template name is FACT_INVOIC_D01BtoXML.xch.

  6. Click Next.

    You are prompted for a name and optional description for the new preparser.

  7. Enter a name for the new preparser, for example, EDIFACT_Preparser, and an optional description.
  8. Click Finish to add the preparser. In the next procedure, you will associate this preparser with an inlet.


x
Procedure: How to Define an Inlet

Now that you have added a File listener and splitter 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.

  1. From the Registry menu options, select Inlets under Conduits.
  2. On the Inlet Definitions pane, click Add to add an inlet.
  3. On the New Inlet Definition pane, enter the name of the new inlet and an optional description, as shown in the following table. Then click Finish to add the inlet.

    Parameter

    Value

    Name *

    EDIFACTtoXML_Inlet

    Description

    Inlet for EDIFACT to XML.

  4. On the Construct Inlet pane, click Add to associate the listener and preparser with the inlet. The next pane prompts you for the component type.
  5. Select Listener and click Next.

    The next pane prompts you to select a listener.

  6. Select EDIFACTtoXML_Listener, which is the listener you added earlier, and click Finish.

    The listener is associated with the inlet. Now you need to associate the preparser created earlier with the inlet.



x
Defining a Route

For this sample channel configuration, you will define a route that will invoke the EDIFACT to XML validation process flow. The outcome of the validation process flow will place valid XML data in a defined output folder. Invalid EDIFACT data will be routed to an errors folder. A validation report will also be sent to the appropriate folder.

This section describes how to create a validation process flow using iWay Designer and bind it to a sample outbound channel as a route.



x
Procedure: How to Create a New Project and Start the Process Flow

To create a new project and start the process flow using iWay Designer:

  1. From the Windows Start menu select Programs, iWay 6.1 Service Manager, tools, and then iWay Designer.
  2. Connect to the repository from which you want to work, for example, iWay.
  3. Right-click the iWay node and select New Project from the drop-down list.

    The Designer Project Information dialog box opens, prompting you for a project name and optional description.

  4. In the Name field, type a project name, for example, Test.

    In the Description field, type a brief description (optional) to describe the project.

  5. Click Next.

    The Designer Project Bindings dialog box opens.

  6. To create the project in the iWay Registry, select iWay Registry and click Finish. The choice of project association depends on where you intend to publish (deploy) your process flow. If you are developing a process flow for use as part of a channel, you must publish it to the iWay Registry for subsequent deployment.
  7. The Test project node appears under the repository in which it was created (in this example, it appears under iWay).
  8. To save the project to the repository, right-click the project node and select Save from the context menu.
  9. Expand the Test project node to expose the project elements (Processes, Services, Transforms, and so on).
  10. Right-click the Processes folder and select New Process from the drop-down list.

    The iWay Process Configuration dialog box opens.

  11. In the Name field, type EDIFACTToXML as the process flow name.

    In the Description field, type a brief description (optional).

  12. Click Finish.

    The new EDIFACTToXML node appears under the Processes folder, and the workspace displays a Start object.

    You are ready to build the EDIFACTToXML validation process flow by configuring objects to it and specifying their relationships.



x
Procedure: How to Configure Objects for the Process Flow

To configure objects for the process flow using iWay Designer:

  1. Drag and drop the Service object from the toolbar to the workspace.

    The New Service Object dialog box opens.

  2. In the Name field, type XDEDIFACTAckAgent, and a brief description (optional) in the Description field.
  3. Click Next.

    The Service Type dialog box opens.

  4. Select Class Name and enter com.ibi.agents.XDEDIFACTAckAgent.
  5. Click Next.

    The Define Service dialog box opens.

  6. Click Next.

    The Properties dialog box opens.

  7. For the Acknowledgment type parameter, select CONTRL from the drop-down list.
  8. Click Finish.

    The new Service object (XDEDIFACTAckAgent) appears in the workspace.

  9. Select the Start object, right-click the XDEDIFACTAckAgent object, and select Relation from the context menu.

    The Line Configuration dialog box opens.

  10. From the Event drop-down list, select OnCompletion and click OK.

    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.

  11. Drag and drop the File object from the toolbar to the workspace.

    The New File Object dialog box opens.

  12. In the Name field, type File Output Acknowledgement, and a brief description (optional) in the Description field.
  13. Click Next.

    The Define File Type dialog box opens.

  14. Select File Write from the Type drop-down list and click Next.

    The Properties dialog box opens.

  15. For the Target Directory parameter, enter the following location where the data will be written:
    Sreg(EDIFACT.Ack)
  16. For the File pattern parameter, enter the following:
    Sreg(basename)__*.edifact
  17. For the Respect Transactionality parameter, select true from the drop-down list.
  18. Click Finish.

    The new File object, File Output Acknowledgement, is added to the workspace area.

  19. Select the XDEDIFACTAckAgent object, right-click the File Output Acknowledgement object, and select Relation from the context menu.

    The Line Configuration dialog box opens.

  20. From the Event drop-down list, select OnCompletion and click OK.

    A line appears between the objects to indicate that a relationship has been established.

  21. Drag and drop the End object from the toolbar to the workspace.

    The End Name and Description dialog box opens.

  22. In the Name field, type End, and a brief description (optional) in the Description field.
  23. Click Next.

    The End Name Schema dialog box opens.

  24. Since no schemas are used in this processing path (that is, the process flow will not be exposed as a web service), from the Schema drop-down list, select None.
  25. Click Next.

    The Properties dialog box opens.

  26. Click Finish to accept the default values and close the dialog box.

    The new End object appears in the workspace.

  27. Select the File Output Acknowledgement object, right-click the End object, and select Relation from the context menu.

    The Line Configuration dialog box opens.

  28. From the Event drop-down list, select OnCompletion and click OK.

    A line appears between the objects to indicate that a relationship has been established.

  29. Drag and drop the End object from the toolbar to the workspace.

    The End Name and Description dialog box opens.

  30. In the Name field, type End1, and a brief description (optional) in the Description field.
  31. Click Next.

    The End Name Schema dialog box opens.

  32. Since no schemas are used in this processing path (that is, the process flow will not be exposed as a web service), from the Schema drop-down list, select None.
  33. Click Next.

    The Properties dialog box opens.

  34. Click Finish to accept the default values and close the dialog box.

    The new End1 object appears in the workspace.

  35. Select the Start object, right-click the End1 object, and select Relation from the context menu.

    The Line Configuration dialog box opens.

  36. From the Event drop-down list, select OnCompletion and click OK.

    A line appears between the objects to indicate that a relationship has been established.

  37. Drag and drop the Service object from the toolbar to the workspace.

    The New Service Object dialog box opens.

  38. In the Name field, type Validation Report, and a brief description (optional) in the Description field.
  39. Click Next.

    The Service Type dialog box opens.

  40. Select Class Name and enter com.ibi.agents.XDEDIFACTValidationReportAgent.
  41. Click Next.

    The Define Service dialog box opens.

  42. Click Next.

    The Validation Report object appears in the workspace.

  43. Select the Start object, right-click the Validation Report object, and select Relation from the context menu.

    The Line Configuration dialog box opens.

  44. From the Event drop-down list, select OnCompletion and click OK.

    A line appears between the objects to indicate that a relationship has been established.

  45. Drag and drop the File object from the toolbar to the workspace.

    The New File Object dialog box opens.

  46. In the Name field, type File Output Validation Report, and a brief description (optional) in the Description field.
  47. Click Next.

    The Define File Type dialog box opens.

  48. Select File Write from the Type drop-down list and click Next.

    The Properties dialog box opens.

  49. For the Target Directory parameter, enter the following location where the data will be written:
    sreg(EDIFACT.ValidRpt)
  50. For the File pattern parameter, enter the following:
    sreg(basename)_*.xml
  51. For the Respect Transactionality parameter, select true from the drop-down list.
  52. Click Finish.

    The new File object, File Output Validation Report, is added to the workspace area.

  53. Select the Validation Report object, right-click the File Output Validation Report object, and select Relation from the context menu.

    The Line Configuration dialog box opens.

  54. From the Event drop-down list, select OnCompletion and click OK.

    A line appears between the objects to indicate that a relationship has been established.

  55. Select the File Output Validation Report object, right-click the End1 object, and select Relation from the context menu.

    The Line Configuration dialog box opens.

  56. From the Event drop-down list, select OnCompletion and click OK.

    Note: If you do not want to create APERAK or CONTROL, but need to monitor accept or reject rules validation status, a validation report can be substituted for the acknowledgement agent to update the SREG.

    A line appears between the objects to indicate that a relationship has been established.

  57. Drag and drop the Decision Test object from the toolbar to the workspace.

    The New Test Object dialog box opens.

  58. In the Name field, type Test Validation Report, and a brief description (optional) in the Description field.
  59. Click Next.

    The Test Operands dialog box opens.

  60. In the Operand One field, enter the following:
    XPATH(/documents/ValidationReport/Report/Errors/error)
  61. From the Operation drop-down list, select Is Not Null.
  62. Click Next.

    The Value Occurrences dialog box opens.

  63. Ensure that Unique is selected from the available options.
  64. Click Finish.

    The new Decision Test object appears in the workspace.

  65. Select the Validation Report object, right-click the Test Validation Report object, and select Relation from the context menu.

    The Line Configuration dialog box opens.

  66. From the Event drop-down list, select OnCompletion and click OK.

    A line appears between the objects to indicate that a relationship has been established.

  67. From the Tools menu, select Property Manager.

    The Property Manager dialog box opens.

  68. Click the Run Time tab.
  69. In the Name column, click on an empty row.

    SREG1 appears in the Name column.

  70. In the Value column, enter the value N.
  71. In the Usage column, select Header from the drop-down list.
  72. In the Scope column, select Message from the drop-down list.
  73. Click OK.
  74. Drag and drop the Set object from the toolbar to the workspace.

    The Set Name and Description dialog box opens.

  75. In the Name field, type Good Validation, and a brief description (optional) in the Description field.
  76. Click Next.

    The Define Events dialog box opens.

  77. Click the first row in the Name column and enter SREG1.
  78. In the first row of the Value column, type G.
  79. Select header from the drop-down list in the Usage column.
  80. Click Finish.

    The new Set object (Good Validation) appears in the workspace.

  81. Drag and drop the Set object from the toolbar to the workspace.

    The Set Name and Description dialog box opens.

  82. In the Name field, type Bad Validation, and a brief description (optional) in the Description field.
  83. Click Next.

    The Define Events dialog box opens.

  84. Click the first row in the Name column and enter SREG1.
  85. In the first row of the Value column, type B.
  86. Select header from the drop-down list in the Usage column.
  87. Click Finish.

    The new Set object (Bad Validation) appears in the workspace.

  88. Select the Test Validation Report object, right-click the Good Validation Set object, and select Relation from the context menu.

    The Line Configuration dialog box opens.

  89. From the Event drop-down list, select OnCustom.

  90. In the Case of section, select false.
  91. Click OK.

    A line appears between the objects to indicate that a relationship has been established.

  92. Select the Test Validation Report object, right-click the Bad Validation object, and select Relation from the context menu.

    The Line Configuration dialog box opens.

  93. From the Event drop-down list, select OnCustom.

  94. In the Case of section, select true.
  95. Click OK.

    A line appears between the objects to indicate that a relationship has been established.

  96. Select the Good Validation set object, right click the End1 object, and select Build Relation from the context menu.

    The Line Configuration dialog box opens.

  97. From the Event drop-down list, select OnCompletion and click OK.

    A line appears between the objects to indicate that a relationship has been established.

  98. Select the Bad Validation set object, right click the End1 object, and select Build Relation from the context menu.

    The Line Configuration dialog box opens.

  99. From the Event drop-down list, select OnCompletion and click OK.

    A line appears between the objects to indicate that a relationship has been established.

    The process flow is now complete.

  100. To save the process flow, right-click the EDIFACTtoXML node in the left pane and select Save from the context menu.

    Now you need to validate the process flow and publish it to the Registry of the iWay Service Manager Administration Console for use in the route of a channel for outbound processing.

    Validating a process flow ensures that its structure is correct. Publishing a process flow makes it available in the Registry for use in a channel configuration. For instructions on validating and publishing the process flow, see the iWay Designer User's Guide.

  101. Close iWay Designer.

    Your next step is to add a new route to the Registry using the iWay Service Manager Administration Console and associate the process flow with it.



x
Procedure: How to Define a Route and Associate the Process Flow With It

To define a route and associate the process flow with It:

  1. From the Registry menu options in the iWay Service Manager Administration Console, click Routes.
  2. On the Route Definitions pane, click Add to add a route.
  3. On the New Route Definition pane, enter a name for the route and an optional description, as shown in the following table.

    Parameter

    Value

    Name *

    EDIFACTToXML_Route

    Description

    This route will invoke the EDIFACT to XML process. The outcome of the process will place valid EDIFACT XML data in your Good File folder. Invalid EDIFACT XML data will be routed to your Bad File folder.

  4. Click Finish.
  5. On the Construct Route pane, click Add.

    You are prompted for the type of component to associate with the route.

  6. Select Process and click Next.
  7. The next pane prompts you to select a process. Select the process flow you created earlier with iWay Designer, EDIFACTToXML, and click Finish.

    The route, with its associated process flow, has been successfully defined.



x
Defining the Outlets

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 an emitter for the transformed EDIFACT input data. Two emitters will be defined. The purpose is to separate EDIFACT data that passes validation and those that failed. You will set a condition statement to ensure that the data is emitted to their corresponding folders. The condition settings will be as follows:

Good Output Emitter:

Cond(_sreg(Sreg1),EQ, 'G') and _isXML() and _Cond(_root(),ne,'documents')

This condition is checking the special register SREG1 for a value of 'G' (this was set in the process flow). It is also checking to see if the data is formatted in XML. The last statement is allowing only XML documents where the root tag is not equal to documents. An XML with a root tag of documents is the validation report. In this Emitter we are interested in the transformed XML document only.

Bad Output Emitter:

Cond(_sreg(Sreg1),EQ, 'B') and _isXML() and _Cond(_root(),ne,'documents')

This condition is checking the special register SREG1 for a value of 'B' (this was set in the process flow). It is also checking to see if the data is formatted in XML. The last statement is allowing only XML documents where the root tag is not equal to documents. An XML with a root tag of documents is the validation report. In this Emitter we are interested in the transformed XML document only.



x
Procedure: How to Add an Emitter for Good EDIFACT Output

This procedure describes how to configure an emitter for transformed EDIFACT input data that passes validation.

  1. On the Emitters pane, click Add to add an emitter. The next pane prompts you for the emitter type.
  2. For this example, select File from the drop-down list and click Next.

    The configuration parameters pane opens.

  3. Supply configuration parameters for the File emitter as follows, then click Next.

    Parameter

    Value

    Destination *

    sreg(EDIFACT.GoodOutput)\sreg(basename)__*.xml

    This value is the directory where the transformed XML will be placed for any EDIFACT input data that has passed validation.

    sreg(EDIFACT.GoodOutput) is a special register value that uses a defined directory in which output files are stored after transformation. For more information, see Adding Special Register Sets.

    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

  4. On the Emitters pane, enter the name of the new emitter and an optional description, as shown in the following table. Then click Finish to add the emitter.

    Parameter

    Value

    Name *

    Good_Output_Emitter

    Description

    Emitter for EDIFACT XML output that passes Report Validation.



x
Procedure: How to Define an Outlet for Good EDIFACT Output
  1. From the Registry menu options, select Outlets.
  2. On the Outlet Definitions pane, click Add to add an outlet.
  3. On the New Outlet Definition pane, enter the name of the new outlet and an optional description, as shown in the following table. Then click Finish to add the outlet.

    Parameter

    Value

    Name *

    Good_Output_Outlet

    Description

    Good File Outlet for EDIFACT

  4. On the Construct Outlet pane, click Add to associate the created emitter with its outlet. The next pane prompts you for the component type.
  5. Select Emitter and click Next.

    The next pane prompts you to select an emitter.

  6. Select Good_Output_Emitter, which is the emitter you added earlier, and click Finish.


x
Procedure: How to Add an Emitter for Bad EDIFACT Output

This procedure describes how to configure an emitter for transformed EDIFACT input data that fails validation.

  1. On the Emitters pane, click Add to add an emitter. The next pane prompts you for the emitter type.
  2. For this example, select File from the drop-down list and click Next.

    The configuration parameters pane opens.

  3. Supply configuration parameters for the File emitter as follows, then click Next.

    Parameter

    Value

    Destination *

    sreg(EDIFACT.BadOutput)\sreg(basename)__*.xml

    This value is the directory where the transformed XML will be placed for any EDIFACT input data that has failed validation.

    sreg(EDIFACT.BadOutput) is a special register value that uses a defined directory in which output files are stored after transformation. For more information, see Adding Special Register Sets.

    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

  4. On the Emitters pane, enter the name of the new emitter and an optional description, as shown in the following table. Then click Finish to add the emitter.

    Parameter

    Value

    Name *

    Bad_Output_Emitter

    Description

    Emitter for EDIFACT XML output that failed Report Validation.



x
Procedure: How to Define an Outlet for Bad EDIFACT Output
  1. From the Registry menu options, select Outlets.
  2. On the Outlet Definitions pane, click Add to add an outlet.
  3. On the New Outlet Definition pane, enter the name of the new outlet and an optional description, as shown in the following table. Then click Finish to add the outlet.

    Parameter

    Value

    Name *

    Bad_Output_Outlet

    Description

    Bad File Outlet for EDIFACT

  4. On the Construct Outlet pane, click Add to associate the created emitter with its outlet. The next pane prompts you for the component type.
  5. Select Emitter and click Next.

    The next pane prompts you to select an emitter.

  6. Select Bad_Output_Emitter, which is the emitter you added earlier, and click Finish.


x
Defining a Channel

This section describes how to define a channel.



x
Procedure: How to Define a Channel
  1. From the Registry menu options, select Channels under Conduits.
  2. On the Channel Definitions pane, click Add to add a channel.
  3. On the New Channel Definition pane, enter the name of the new channel and an optional description, as shown in the following table. Then click Finish to add the channel.

    Parameter

    Value

    Name *

    EDIFACTtoXML_Channel

    Description

    Channel for EDIFACT to XML inbound processing.

  4. On the Construct Channel pane, click Add to associate the inlet, route, and outlets defined previously with the channel.

    You are prompted to associate components with the channel.

  5. Select Inlet and click Next. The next pane prompts you to select an inlet.
  6. Select EDIFACTtoXML, which is the inlet you defined earlier, and click Finish.

    The inlet is added to the channel. Now you need to associate the route defined earlier with the channel.

  7. On the Construct Channel pane, click Add.

    The next pane prompts you for the component type.

  8. Select Route and click Next.

    On the next pane, you are prompted to select a route.

  9. Select EDIFACTtoXML_Route, which is the route created earlier, and click Finish.
  10. On the Construct Channel pane, click the minus sign (-)under Conditions next to the name of the route to set it as the default.

  11. On the Construct Channel pane, click Add to add the outlets.
  12. On the next pane, select Outlet and click Next.
  13. Select the outlet you defined earlier, Good_Output_Outlet, and click Finish.
  14. To set a condition for the Good_Output_Outlet, on the Construct Channel pane, click the plus sign (+) under Conditions for the Good_Output_Outlet.

    The Set Condition pane opens.

  15. In the Condition input field, enter the following:
    COND(_sreg(SREG1), EQ, 'G') and _isXML() and _COND(_root(),ne,'documents')
  16. Click Update.
  17. On the Construct Channel pane, click Add to add the outlets.
  18. On the next pane, select Outlet and click Next.
  19. Select the outlet you defined earlier, Bad_Output_Outlet, and click Finish.
  20. To set a condition for the Bad_Output_Outlet, on the Construct Channel pane, click the plus sign(+) under conditions for the Bad_Output_Outlet.

    The Set Condition pane opens.

  21. In the Condition input field, enter the following:
    COND(_sreg(SREG1), EQ, 'B') and _isXML() and _COND(_root(),ne,'documents')
  22. Click Update.


x
Procedure: How to Add the Ebix to the Channel
  1. From the Registry menu options, select Channels.

    The Channel Definitions pane opens.

  2. Click the link in the Ebix column for the EDIFACTtoXML_Channel.
  3. On the next pane, which prompts you to add Ebix components, click Add to add the Ebix to the channel.
  4. On the next pane, select EDIFACT_D01B_Ebix, which is the name of the Ebix you added previously, and click Finish.

    Now that you have associated all the components with the channel, you are ready to build it.



x
Procedure: How to Add the Register to the Channel
  1. From the registry menu options, select Channels.

    The Channel Definitions pane opens.

  2. Click the link in the Regs column for the EDIFACTtoXML_Channel.
  3. On the next pane, which prompts you to add register sets, click Add.
  4. On the next pane, select EDIFACT, which is the register set you created previously.

    For more information on creating register sets, see Adding Special Register Sets.

    Now that you have associated all the components with the channel you are ready to build it.



x
Procedure: How to Build the Channel
  1. From the Registry menu options on the left pane, select Channels under Conduits.
  2. On the Channel Definitions pane, select the channel defined previously, EDIFACTtoXML_Channel, and click Build.

    The results of the build are displayed on the right pane.

  3. Review the results of your build and then click Back.

    If an error or errors are displayed in the Message column, take the appropriate action as instructed.



x
Procedure: How to Deploy the Channel

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.

  1. Select the Deployments option in the top pane.
  2. On the Channel Management pane, click Deploy.
  3. On the Available Channels pane, select the channel you defined previously, EDIFACTtoXML_Channel, and click Deploy.

    The Channel Management pane reopens.

  4. Select EDIFACTtoXML_Channel and click Start.

    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.


Top of page

x
Reusing Your Channel Configuration

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