Integrations

CloudLink Integrator Agent

How to set up the CloudLink Integrator Agent for Texada iMACS.

In This Article

Overview

The CloudLink Integrator is a backend service facilitating the communication between the CloudLink applications and dealer on-premise systems. It is currently required for the iMACS application and integration with the DBS ERP.

Minimum Requirements

  • Server: bare-metal or virtual machine
  • CPU: 4 cores
  • Memory: 8 GB RAM
  • Disk: 500 MB
  • Operating System: Windows Server 2016
  • Count: 2 servers minimum
  • Firewall: no ports are required to be open
  • Outbound connectivity: the Integrator connects to CloudLink Gateway servers using SSL/TLS on port TCP 443. It is recommended to whitelist the following domains:
    • *.texada.com
    • *.texadasoftware.com

Prerequisites

  • Download the CloudLink Integrator .msi file using the link provided by Texada
  • Connectivity:
    • From the Integrator servers to the ERP database servers
    • From the Integrator servers to the iMACS file share
  • For DBS ERP:
    • If you are using ServiceLink with Parts and Service Quoter, you do not need to setup IBM ODBC driver and DBS accounts.
    • 1 DBS account with access to DBS databases (Test & Production)
    • IBM drivers for ODBC installed
    • On each server 2 System DSN ODBC connections to the Test and Production DBS databases
  • For iMACS files:
    • If you are not using iMACS application, you do not need to setup the service account for iMACS.
    • 1 service account with full access to the iMACS file share
    • iMACS Template Folder structure - When a project is created, project related files are stored on a common shared folder. The desired default/template structure for the folder directory must be created under "{iMACS file share}\Template".

    Installation

    1. Download the CloudLink Integrator .msi file on the server using the URL provided by Texada.
    2. Double-click the downloaded integrator .msi file to begin installation and follow the prompts:
      1. Click “Next” on the Welcome page.
      2. Accept the End-User License Agreement.
      3. Select the location on disk for the installation.
      4. Provide approval for administrator-level access required by User Account Control (where applicable).
      5. Wait for the Setup Wizard to install CloudLink Integrator, then click “Finish”.

        CloudLink Integrator - Completed SHADOW

    At the end of the installation process, a web browser window is opened with the CloudLink Integrator Admin application. The setup package installs two windows services:

    • CloudLinkIntegratorAdmin: the configuration application is hosted on URL http://localhost:8159/ therefore accessible only from the server itself. This service is started after installation.
    • CloudLinkIntegrator: the Agent service that provides connectivity to the CloudLink servers. Upon installation, this service is stopped. It is started once the configuration is completed.

    Open Windows services using services.msc from Start→Programs and note that CloudLinkIntegratorAdmin service is started upon installation. 

    Proceed to the configuration of the CloudLink Integrator. See the Configuration section of this document for more information.

    Configuration

    Open CloudLink Integrator using the following url: 

    http://localhost:8159

    There are three sections for configuration: General, iMACS, and DBS Connection.

    General

    The General section is to configure the integrator connection with CloudLink Integrator Gateway Server. 

    CloudLink support will provide you a set of Connection URLs and Client Keys for two integrators that you can install and configure on separate servers.

    Enter the following configuration values, then click “Save Settings”:

    • Connection URL: Internet address for the Integrator Gateway server 
    • Client Key: Integrator identifier key

    iMACS

    The iMACS section is to configure the security settings for access to the iMACS file share.

    If you are not using iMACS application, you do not need to configure the iMACS section of the integrator.

    Enter the following information, then click on Save Settings:

    • Account: Service account that you have created for accessing the iMACS file share. This service account must have full read/write access granted to the iMACS file share. 
    • Password: Service account password. Integrator encrypts and stores the password only on this server.

    DBS Connection

    The DBS Connection section is to configure the security settings for access to the ERP.

    If you are using ServiceLink with Parts and Service Quoter, you do not need to configure the DBS Connection section of the integrator.

    • Test DBS:
      • ODBC DSN: the name of the ODBC System DSN connection using the IBM DB2 driver
      • Account: the DBS account with write access to Test DBS DB2
      • Password: the password for the DBS account with access to Test DBS
      • DBS Library: the library name for Test DBS
      • DBS Version: either version 2 or version 5 of Test DBS
    • Production DBS:
      • ODBC DSN: the name of the ODBC System DSN connection using the IBM DB2 driver
      • Account: the DBS account with write access to Production DBS DB2
      • Password: the password for the DBS account with access to Production DBS
      • DBS Library: the library name for Production DBS
      • DBS Version: either version 2 or version 5 of Production DBS
    • Click on Save Settings

    Testing

    When the configuration is finished and saved, the CloudLinkIntegrator service is started or restarted and the Test section can be used to verify connectivity to iMACS and ERP.

    There are two sections for testing the configuration: iMACS and DBS Connection.

    iMACS

    This section is to test the access to the iMACS file share.

    If you are not using the iMACS application, you don’t need to run this test.

    1. Click the “Test” button on the top right corner in the Configuration page.
    2. Click the iMACS tab.
    3. Enter the UNC path of the iMACS shared folder in the Folder text box.
    4. Click the “Test File Share” button.
    5. Expected result: The service account configured in the iMACS section is able to connect to the shared folder.
    6. If there is an error, check the permissions on the iMACS shared folder to resolve.

    DBS Connection

    This section is to test the access to the DBS/ERP.

    If you are using ServiceLink with Parts and Service Quoter, you do not need to run this step.

    1. Click the “Test” button in the top-right corner in the Configuration page.
    2. Click the “DBS Connection” tab.
    3. Click the “Test” button under Test DBS.
    4. Expected result: Returns the list of schema table.
    5. If there is an error, check the permissions for the DBS account configured for DBS.
    6. Click the “Test” button under Production DBS.
    7. Expected result: Returns the list of schema table.
    8. If there is an error, check the permissions for the DBS account configured for DBS.

    CloudLink Integrator connectivity with CloudLink Gateway server

    1. Contact your support person at Texada.
    2. CloudLink support will validate and confirm the CloudLink Integrator connectivity with the CloudLink Gateway server.