Channel Structure

Each message that is processed by iSM passes through a channel, and in many applications through multiple channels. Messages can be XML or non-XML, based on the demands and requirements of the application. Channels are developed using the Channel Builder in iWay Integration Tools (iIT) and organized into meaningful groups. One or more channels constitute an application, which can be configured and deployed as a single entity.

Each channel contains the following components that must be configured and associated with a specific channel:

  • Inlet. Defines the initial point at which a message enters the channel, and optionally, some preliminary steps in the message processing to prepare for subsequent stages. Each channel must contain an inlet. In the inlet, the message is received by a supported protocol (for example, FTP, HTTP, and so on), may be decrypted and/or pre-parsed, and then assigned to an appropriate route for further processing. Inlets can contain listeners, decryptors, and preparsers. Generally, decryption using standard security algorithms are simply configured, and decryption is built into iSM.
  • Route. Defines the path a message takes through a channel. Each channel must contain a reference to one or more routes. Along each route, transformations and other forms of business logic are applied to the message. Routes can contain transforms and processes (defined process flows). Conditional logic, expressed using iWay Functional Language (iFL) is used to select the appropriate route for each message. For more information on using iFL, see the iWay Functional Language Reference Guide.
  • Outlet. Defines how a message leaves a channel at the end of the process. Each channel must contain one or more outlets. In the outlet, the message may be transformed further and/or encrypted, and finally emitted by the system. Each message may be sent to multiple outlets of a channel. Outlets can contain preemitters, encryptors, and emitters. Selecting (associating) specific outlets for a channel can also be handled by using iFL expressions.

The following diagram provides a visual representation of the message path through channel. In this diagram, subchannel refers to multiple threads (workers) processing data on a single defined channel.

For more information on threading and thread management, see Understanding Thread Management.

Channels are developed for specific applications using the Channel Builder in iIT, as shown in the following image.

For more information on designing and configuring channels in iIT, see the iWay Integration Tools User’s Guide.

2.1 Understanding Channels

A channel assists in the construction of message flows in iWay Service Manager (iSM). It is a container for your components that simplifies the application integration design process and improves organization, versioning, and troubleshooting.

This section includes the following topics:

 

Registration Help

If you do not receive your license file email within five business days, verify that you provided the correct site code and email address (either by registering from the machine on which iWay resides or sending it in the alternate registration method). If you are sure you provided accurate information, contact iWay Customer Support and provide the following information:

  • Site Code
  • Host name
  • Email address used to register the software

If you have licensing issues after receiving your license file, contact iWay Customer Support and provide them with the following information:

  • License file you received
  • The install.xml file located in the iWay8\bin directory
  • Any license error messages found in the iWay Service Manager Administration Console

How to Register Software

There are three methods available to register iWay 8.0 SM. If you have email or Internet access from the machine where the iWay software resides, then you can use the iWay Service Manager Administration Console to register through either email or the Internet. If you do not have email or Internet access from the machine where the iWay software resides, we provide an alternate method of registration.

This section explains how to register your software using the three methods.

How to Register iWay Using the iWay Service Manager Administration Console

To register iWay using the iWay Service Manager Administration Console:

  1. Start iWay Service Manager and log on to the iWay Service Manager Administration Console if you have not already done so.
     
  2. At the top-right of the iWay Service Manager Administration Console, click Licenses.

    A page appears with information about your current licenses.

  3. Click the register the software hyperlink.

    A registration form is displayed.

  4. Provide the requested information.
     
  5. Click either Web or EMail.
    • Web sends the form using HTTP.
    • EMail opens your default email client and creates an email with the form contents in the message body. Use the email client Send button to submit the registration form.

    Once the registration request is processed, you will receive an email with a license file (license.xml) within 72 hours containing the license key(s) for your site and details on how to install the file.

  6. Copy the license file onto your computer and place it in the root directory of your iWay 8.0 SM installation.

    Note: iWay Service Manager must be stopped at this stage.

  7. Start iWay Service Manager to activate the registration.

How to Register iWay Using an Alternate Method

If you do not have email or Internet service on the machine where iWay is installed, use the following steps to register the iWay software.

  1. Send the install.xml file, located in the iWay8\bin directory, to feedback@iwaysoftware.com with the following information in the body of the email:
    • Company Name
    • Your Full Name
    • Email Address
    • City, Province, Postal Code, and Country
    • Phone Number

    Once the registration request is processed, you will receive an email at the address you provided within 72 hours that contains the license file (license.xml) and details on how to install the file.

  2. Stop iWay Service Manager.
     
  3. Copy the license file onto your computer and place it in the root directory of your iWay 8.0 SM installation.
     
  4. Start iWay Service Manager to activate the registration.

Why Should You Register iWay Software

You must register iWay software for each machine on which iWay is installed. The registration process will generate a separate license file for each specific machine.

You must re-register iWay software when you:

  • Install a new major release of iWay.
  • Install iWay in a new directory on the same machine.
  • Upgrade or replace the computer where iWay resides.
  • Replace the operating system of the computer where iWay resides.

1.1 Installing iWay 8.0 Service Manager

The initial iWay installation procedure installs all iWay components and a set of adapters. These components and adapters are available for a 90-day trial. To receive a permanent license after you have installed iWay 8.0 SM, register the software using the instructions found in Registering iWay Software.

After you have successfully installed iWay 8.0 Service Manager, it is recommended to review 1.2 Post-Installation Topics and Tasks and 1.3 Registering iWay Software.

Follow the procedure for your platform.

 

1.3 Registering iWay Software

A default license file, provided when you install iWay 8.0 SM, allows you to use all features of iWay, including adapters, for 90 days. In order to receive a permanent license file that allows you to use the iWay features you purchased beyond this trial period, you must register your software.

Note: Once you receive your permanent license, you will also receive a 90-day trial extension for all non-purchased iWay features.

Tip: To view the features you have purchased, log onto the iWay Service Manager Administration Console and click Licenses in the top-right corner. The features that are currently in effect are displayed.

An iWay software license is associated with a specific site and a specific machine. When you register your software, your license file is generated based on information provided during the installation (Site Code) and registration (email address). Therefore, the site code you provide during installation must be accurate. The license files are sent to you through email. The process validates the email address supplied during registration and matches it to the domain name associated with the site code. License files cannot be sent to other domain names.

iWay 8.0 SM uses a software-based license management technology that verifies that the site code is valid and that the software has been activated on the eligible machine(s).

The license file (license.xml) contains one or more license keys required to activate specific features of iWay 8.0 SM. Do not attempt to edit this file.

 

How to Install iWay 8.0 Service Manager on Windows Platforms

You must be an administrator for the local machine to run the installation.

  1. Start the installation by executing the iway80.exe installation program.

    The installation begins by temporarily copying files and analyzing your environment. This may take some time. When this process completes, the Welcome window opens, as shown in the following image.

    Note: If you receive an error, ensure you are installing as an administrator and there is at least 2 GB of free space on your operating system drive.

  2. Click Next.

    The License Agreement window opens, as shown in the following image.

  3. Review the information, and select I accept the terms of the license agreement if you agree to the terms.

    The Customer Information window opens, as shown in the following image.

  4. Provide your User Name, Company Name, and Site Code.

    Important: The site code is a unique company identifier associated with a specific machine. Be sure to enter a valid and accurate site code in this step because this entry is used when generating your permanent license during the registration process. If you need assistance with the site code, contact your iWay Software sales representative.

  5. Click Next.

    The Setup Type window opens, as shown in the following image.

  6. Select the setup type (Typical, Runtime, or Custom) according to your requirements.
     
  7. Click Next.

    The Choose Destination Location window opens, as shown in the following image.

  8. Accept the default location, which is C:\Program Files (x86)\iway8\, or click Browse to specify a new location.
     
  9. Click Next.

    The Adapter Selection window opens, as shown in the following image, where you can select the specific iWay adapters that you want to install. Ensure that you expand all of the categories to view the available adapters.

  10. Select the adapters you want to install.
     
  11. Click Next.

    The Feature Selection window, as shown in the following image, opens where you can select the specific iSM features that you want to install. Ensure that you expand all of the categories to view the available features.

  12. Select the features you want to install.
  13. Click Next.

    The iWay Service Manager Configuration options window opens, as shown in the following image.

    You are prompted to specify the ports that iWay Service Manager uses, as listed and described in the following table.

    Name

    Default Port

    Purpose

    Console

    9999

    HTTP listener for the iWay Service Manager Administration Console.

    SOAP

    9000

    SOAP listener for iBSP and iWay Explorers.

    Envoy

    (optional)

    9001

    Designated port for Envoy to allow Sentinel monitoring.

    The Envoy port option is displayed only if Envoy is selected in the Feature Selection window.

  14. Accept the default port values or specify new values and then click Next.

    Note: Be sure to specify ports that are not being used by other programs or by another instance of iWay. If necessary, contact your system administrator for assistance in identifying available TCP ports.

    If you selected Envoy to be installed from the Feature Selection window in step 11, then the Sentinel Registration window opens, as shown in the following image.

  15. Accept the default Host and Port values or specify new values along with the correct User ID and Password, and then click Next.

    The Start Copying Files window opens, as shown in the following image.

  16. Review the settings and then click Next to start the installation.

    The Setup Status window opens, as shown in the following image.

    Files are copied to your system in the directory you specified.

    You have the option to start the Service Manager when installation completes, as shown in the following image.

    If you choose this option, the iWay Service Manager Administration Console launches in your default web browser. You can log on to the iWay Service Manager Administration Console using the default user name, admin, and password, admin.

  17. Click Finish to complete the installation Wizard.

How to Install iWay 8.0 Service Manager on UNIX, OS/400, and z/OS Platforms

On UNIX/Linux, installing as root is not recommended. Creating a dedicated iWay user ID and group with appropriate rights is preferable.

On OS/400, your user ID must have *ALLOBJ, *JOBCTL, and *SAVSYS authority.

On z/OS, the iway80.jar file must be placed in the USS file system.

The new unified iWay installer can enable silent, unattended installation. Contact iWay Customer Support for more information.

  1. Use FTP in binary mode to transfer the installation file to your UNIX or OS/400 machine. For OS/400, place the file in a directory under QSH.
     
  2. Navigate to the directory containing the installation file. On OS/400, you must be running under QSH.
     
  3. Ensure the installation file is executable, for example:
    chmod 755 iway80.jar
  4. Start the installation by executing:
    java -jar iway80.jar

    The installation initializes, which may take some time. When initialization is complete, a Welcome prompt appears:

    Welcome to the iWay 8.0.2.101 Service Manager Setup Wizard. This setup program installs iWay 8.0.2.101 Service Manager on this system.
    8.0.2.101
    Setup is using Windows 10 10.0 amd64 Settings
    File encoding is Cp1252, XML encoding is UTF-8
    Copyright (C) 2003-2018, iWay Software/Information Builders, Inc. All Rights Reserved.
    Press 1 for Next, 2 to Cancel [1]

    Note: If the installation does not launch, ensure that /JAVA_HOME/bin is in your $PATH variable. See Java Requirements for information on setting up your Java environment.

  5. Press Enter to continue.

    A license agreement appears.

  6. Review the agreement and press Enter until you see the following prompt:
    Please choose from the following options:
    [ ] 1 - I accept the terms of the license agreement.
    [X] 2 - I do not accept the terms of the license agreement.
    To select an item enter its number, or 0 when you are finished: [0]
  7. If you accept the terms, type 1 and press Enter.

    The prompt repeats showing the new value.

    [X] 1 - I accept the terms of the license agreement.
    [ ] 2 - I do not accept the terms of the license agreement.
    To select an item enter its number, or 0 when you are finished: [0]
  8. Type 0, then press Enter to continue.

    The Customer Information prompts appear:

    Customer Information
    Please enter your information.
    User Name: [unknown]
  9. Enter a user name for the product registration and then press Enter. This user name does not affect product operations.
    Company Name: [unknown]
  10. Enter your company name for the product registration and then press Enter.
    Site Code: [nnnx.nn] or q to quit: [unknown]
  11. Enter your site code or press q to quit, and then press Enter.

    Important: The site code is a unique company identifier associated with a specific machine. Be sure to enter a valid and accurate site code in this step because this entry is used when generating your permanent license during the registration process. If you need assistance with the site code, contact your Information Builders sales representative.

    The Navigation prompt appears:

    Press 1 for Next, 2 for Previous, 3 to Cancel or 4 to Redisplay [1]
  12. Press Enter to continue.

    The installation directory prompt appears:

    Destination Location
    Setup will install iWay 8.0.2.101 Service Manager in the following location. Setup allows users to enter a different location.
    Directory: [/iway/install/iWay8]

    Note: On Linux systems, you may need to change the default directory that appears. The default directory normally should be named iWay8, but some Linux environments do not follow this default.

  13. Specify where to install iWay on your system and then press Enter. Ensure this is a directory to which you have write access.

    The navigation prompt appears.

    Press 1 for Next, 2 for Previous, 3 to Cancel or 4 to Redisplay [1]
  14. Press Enter.

    The following prompt for iWay adapter selection appears.

    iWay Adapters
    iWay 8.0.2.101 Service Manager is packaged with a subset of iWay adapters.
    From the list below select the adapter(s) you want to install with your
    configuration.
    [ ] 1 - Technology Adapters
    [ ] 2 - Application Adapters
    [ ] 3 - eBusiness Adapters
    [ ] 4 - Legacy Adapters
    [ ] 5 - Queuing Adapters
    [ ] 6 - Protocol Adapters
    [ ] 7 - IOT Protocols
    Enter a number, (a)ll, (n)one or 0 to finish: [0]

    Note: An X next to an adapter category indicates one or more adapters are selected.

  15. Type the number of the adapter you want to install and press Enter.

    Note: You can only enter one adapter number at a time.

  16. When you are finished with your selections, type 0 and press Enter.

    You are returned to the iWay Adapters selection prompt.
    iWay Adapters
    iWay 8.0.2.101 Service Manager is packaged with a subset of iWay adapters.
    From the list below, select the adapter(s) you want to install with your
    configuration.
    [ ] 1 - Technology Adapters
    [ ] 2 - Application Adapters
    [ ] 3 - eBusiness Adapters
    [ ] 4 - Legacy Adapters
    [ ] 5 - Queuing Adapters
    [ ] 6 - Protocol Adapters
    [ ] 7 - IOT Protocols
    Enter a number, (a)ll, (n)one or 0 to finish: [0]
  17. Type 0 and press Enter.

    The navigation prompt appears.

    Press 1 for Next, 2 for Previous, 3 to Cancel or 4 to Redisplay [1]
  18. Type 1 and press Enter to continue.

    The Extensions menu appears.

    Extensions
    iWay 8.0.2.101 Service Manager comes with a set of additional components that can be used to extend standard functionality. 
    From the list below, select the extension(s) you want to install.
    [ ] 1 - Gateway (RVI)
    [ ] 2 - Enterprise Index
    [ ] 3 - LDAP High Water Mark Listener
    [ ] 4 - RDBMS High Water Mark Listener
    [ ] 5 - Hot backup
    [ ] 6 - Compatibility Services
    [ ] 7 - PGP Encryption Components
    [ ] 8 - Security Developers Tools
    [ ] 9 - Data Quality Service
    [ ] 10 - Real-Time Data Replication
    [ ] 11 - XQuery
    [ ] 12 - MongoDB Connector
    [ ] 13 - Simple Network Management Protocol Agent (SNMP)
    [ ] 14 - Command Scheduler
    [ ] 15 - Java Scripting Engine
    [ ] 16 - Schema Validation Services
    [ ] 17 - Advanced XML Digital Signature
    [ ] 18 - De-identification Services
    [ ] 19 - Envoy
    [ ] 20 - Open Rules Decision Management Integration
    [ ] 21 - PDF Services
    [ ] 22 - Twilio based messaging, voice, and video cloud services
    [ ] 23 - WebFOCUS support
    [ ] 24 - Twitter
    Enter a number, (a)ll, (n)one or 0 to finish: [0]
  19. Type the number of the extension you want to install and press Enter.

    Note: You can only enter one extension number at a time. When you press Enter, the Extensions menu reappears with your selection checked.

  20. When you are finished with your selections, type 0 and press Enter.

    The navigation prompt appears.

    Press 1 for Next, 2 for Previous, 3 to Cancel or 4 to Redisplay [1]
  21. Type 1 and press Enter to continue.

    You are prompted for the iWay port assignments. You can accept the default value listed with each prompt or type a new value appropriate for your installation, and press Enter.

    Resource Assignments
    Setup allows users to customize the default port numbers used within 
    the installed iWay 8.0.2.101 Service Manager configuration.
    Console Port [9999]
    SOAP Port [9000]
    Envoy Port [9001]
    Press 1 for Next, 2 for Previous, 3 to Cancel or 4 to Redisplay [1]

    Note: The Envoy Port option is displayed only if Envoy is selected in the Extensions menu.

  22. Type 1 and press Enter to continue.

    If you selected Envoy in the Extensions menu, then you are prompted for Sentinel Registration. You can accept the default value listed with each prompt or type a new value appropriate for your installation, and press Enter.

    Sentinel Registration
    This version of Service Manager can be remotely managed by iWay Sentinel. Enter the following to enable self-registration with Sentinel.
    Host: [localhost]
    Port: [8080]
    Userid: [admin]
    Password: [admin]
    Press 1 for Next, 2 for Previous, 3 to Cancel or 4 to Redisplay [1]
  23. Type 1 and press Enter to continue.

    A notice and summary are displayed to inform you that you have provided enough information to start copying files.

    Start Copying Files
    Setup has enough information to start copying the program files. If you
    want to review or change any settings, now is the time to do so.
    iWay 8.0.2.101 Service Manager will be installed in the following location:
    /opt/iway/iWay8
    The base configuration will be installed with the following settings:
       Default console userid is set to iway
       Default console password is set to iway
       Default console port is set to 9999
       Default SOAP port is set to 9000
       Default ENVOY port is set to 9001
       Register with Sentinel as admin,admin@localhost:8080
       Site Code is 9999
    Press 1 for Next, 2 for Previous, 3 to Cancel or 4 to Redisplay [1]
  24. Press Enter to start the installation.

    The Setup Status information is displayed.

    Setup Status
    Setup is configuring your new software installation.
     |----------|----------|----------|----------|
    0%        25%        50%        75%      100%
    ||||||||||||||||||||||||||||||||||

    Once installation has finished, a message appears indicating that the setup is complete.

    Setup Completes
    Setup has finished installing iWay 8.0.2.101 Service Manager on your system.
    Press 1 to Finish Setup [1]