RTI – Real-Time Integration (for Gateway and Data Exchange)

NOTE: The following article is provided for informational purposes only. Please consult with your CMiC representative and implementation staff before proceeding with the following steps.

Standard path: CMiC Field > File Maintenance > Real-Time Integration

This section details the configuration steps involved in setting up your CMiC System to communicate with the Gateway/Data Exchange System.  These steps are carried out on the RTI Maintenance screen (standard Treeview path: CMiC Field > File Maintenance > Real-Time Integration > RTI Maintenance).

RTI Maintenance – Configuring RTI for Enterprise

Step 1: Internal Site – Tab

Standard path: CMiC Field > File Maintenance > Real-Time Integration – Internal Site tab

The Internal Site tab is used to set up a site name to use for your environment.  This site name will be shared with the other RTI Users, which they will be entering as their External Site information.

The GCS RTI adapters will be linked to the Internal Site.

  1. Enter your Internal Site Name.

  2. Select the Internal Site Version from the drop-down menu.

  3. Click on [Save].

Use the icon to create multiple Internal Sites, if required.  Multiple Internal Sites may be required if your company has multiple locations and you would like to create a unique Internal Site for each location.

NOTE: The Transmit Url field is not used for Gateway/Data Exchange.

Step 2: Internal Adapter – Tab

Standard path: CMiC Field > File Maintenance > Real-Time Integration – Internal Adapter tab

The Internal Adapter tab is used to set up your Gateway and Exchange internal adapters.  Gateway uses GCS adapters and Data Exchange uses DX adapters. After you have selected the adapters, you can provide user-defined Adapter Names and IDs to be used to identify them within your Internal Site environment.

This setup is also used to show the System/Message Type and Adapter protocols for the Adapters you have selected to be used with your site.

  1. Select your Internal Site from the drop-down menu, located in the upper left-hand corner of the screen. This is the site you defined in Step 1. The version number of the Internal Site will default in the Version field.

  2. For Gateway, select the following two internal adapters from the drop-down menu (framed in green in the above screenshot):

    1. Http Receive Adapter for GCS
    2. Http Transmit Adapter for GCS

    For each of these Gateway adapters, enter an Adapter Name and Adapter ID. These names will be used to reference your adapters within your environment. These Names and IDs will be shared with other RTI Users, who will be entering them as their External Adapter information.

  3. For Data Exchange, select the following two internal adapters from the drop-down menu (framed in red in the above screenshot):

    1. Http Receive Adapter for DX
    2. Http Transmit Adapter for DX

    For each of these Data Exchange adapters, enter an Adapter Name and Adapter ID. Like Gateway, these Names and IDs will be used to reference your adapters within your environment and will be shared with other RTI Users, who will be entering them as their External Adapter information.

  4. The Adapter Protocol, Message Type, and System fields are display-only fields and provide additional information about the Adapters you have selected to be used with your site.

  5. Click on [Save].

NOTE: The fields JMS Queue Connection Factory and JMS Queue Name are not used in Gateway/Data Exchange.  These fields are used in Generic RTI.

Step 3: External Site – Tab

Standard path: CMiC Field> File Maintenance > Real-Time Integration – External Site tab

The External Site tab is used to define an External Site. The External Site is the reference to the other user system with which you will be utilizing the RTI Transmissions.  There will be a separate External Site for each ‘other’ Environment with which you may be connecting.

Create an External Site Name for GCS. This name is user-defined and can be anything you choose. In this example, we have chosen to name our External site ‘GCS’, as shown in the screenshot above.

Step 4: External Adapters – Tab

Standard path: CMiC Field > File Maintenance > Real-Time Integration – External Adapter tab

The setup for External Adapters is similar to the setup for Internal Adapters, however, the values entered here are based on the other user site Internal Adapter configuration.  (What you create as Internal is their External and vice-versa.)

A drop-down list of External Sites is provided.  Ensure you have selected the correct Site prior to entering the Adapter information you have received from them.

As mentioned in Step 2, Gateway uses GCS adapters and Data Exchange uses DX adapters.

  1. Select the External Site from the drop-down menu, located in the upper left-hand corner of the screen. This is the site you defined in Step 3. The version number of the External Site will default in the Version field.

  2. For Gateway, select the following two external adapters from the drop-down menu (framed in green in the above screenshot):

    1. Http Receive Adapter for GCS
    2. Http Transmit Adapter for GCS

  3. For Data Exchange, select the following two external adapters from the drop-down menu (framed in red in the above screenshot):

    1. Http Receive Adapter for DX
    2. Http Transmit Adapter for DX

  4. The Adapter Protocol, Message Type, and System fields are display-only fields and provide additional information about the Adapters you have selected to be used with your site.

  5. Click on [Save].

NOTE: The following fields are not used in Gateway/Data Exchange: External Client ID, External Username, External Password, Confirm Password. 

Step 5: External IP Address – Tab

Standard path: CMiC Field > File Maintenance > Real-Time Integration – External IP Address tab

The External Site IP tab is used to configure the mapping for the internet travel of RTI data to the other site.  Use of either the FQDN Name or the Site IP (recommended) is used, and then specification of which sites Transmit/Receive or both, as well as the Port to use, J2EE Server name and whether the communication is Secure (HTTPS) or non-secured (HTTP).

NOTE: When specifying a server’s URL, do not include the “http://” or “https://” portion of the URL, as that is done in the backend and will cause errors if specified.

  1. Select the External Site from the drop-down menu, located in the upper left-hand corner of the screen. This is the site you defined in Step 3.

  2. Complete the fields on this tab as follows:

    1. Site FQDN – enter ‘cmiccollaborate.com’

    2. Site IP – leave blank

    3. Transmit Flag – select ‘YES’

    4. Receive Flag – select ‘YES’

    5. Transmit IP Port – leave blank

    6. Transmit JEE Server – enter ‘cmicprod/WsRti/receive/v1’

    7. Transmit Use SSL – select ‘YES’

  1. Click on [Save].

Step 6: Communication Links – Tab

The Communication Links tab is used to link the Internal Site to the External Site.

  1. Select the Gateway Software (GCS) from the Software System drop-down menu, located in the upper left-hand corner of the screen. This is the External Site you defined in Step 3.

  2. For the Gateway Software system (GCS), complete the fields (framed in green) as shown in the screenshot below and click on [Save].

Standard path: CMiC Field > File Maintenance > Real-Time Integration – Communication Links tab, Gateway – Software system: GCS

  1. Select the Data Exchange Software (DX) from the Software System drop-down menu, located in the upper left-hand corner of the screen.

  2. For the Data Exchange Software system (DX), complete the fields (framed in red) as shown in the screenshot below and click on [Save].

Standard path: CMiC Field > File Maintenance > Real-Time Integration – Communication Links tab, Data Exchange – Software system: DX