TMW Systems, Inc. TMW 3GTMS Integration Service Installation Guide

Transcription

1 TMW Systems, Inc. TMW 3GTMS Integration Service Installation Guide

2 Contact Information TMW Systems, Inc Parkland Boulevard Mayfield Heights, Ohio U.S.A. Copyright and Trademarks 2017, TMW Systems, Inc. All rights reserved. This document is for informational purposes only. TMW Systems, Inc. makes no warranties, expressed or implied, in this document. TMW 3GTMS Integration Service 8/ TMW Systems, Inc. All Rights Reserved.

3 Installing the TMW 3GTMS Integration Service This guide provides installation instructions for the TMW 3GTMS Integration Service. The service allows TMW products to work with 3GTMS to provide rates and plan loads. In addition to the 3GTMS Integration Service, you will install the following components: Master Data Management Service This service sends updates made to carrier and customer data in your database to 3GTMS. Health Check Use this utility for troubleshooting issues with 3GTMS and TMW. Data Migration Utility Use this utility to migrate carrier and customer information from your database to 3GTMS. Quote rating process... 2 Planning order data flow... 3 Installation requirements... 4 Client machine requirements... 4 Server machine requirements... 4 Additional requirements... 4 Downloading the installation file... 7 Installing the TMW 3GTMS Integration Service... 8 Configuring the TMW 3GTMS Integration Service Applying SQL to your database Configuring client machines to allow access to 3GTMS TMW 3GTMS Integration Service 1 Revised: 8/2017

4 Quote rating process This illustration shows how rate quotes are processed through the TMW 3GTMS Integration Service. 1. Rate quote request sent from TMW Operations to the TMW 3GTMS Integration Service (with previously acquired authentication token) 2. TMW 3GTMS Integration Service sends the request to the TMW Operations Plug-in 3. TMW Operations Plug-in reformats the data as a 3GTMS rate quote request sent to the 3GTMS API 4. 3GTMS rate quote result sent to the TMW Operations Plug-in 5. TMW Operations Plug-in sends the returned quote to the TMW 3GTMS Integration Service 6. Reformatted TMW rate quote result sent to TMW Operations TMW 3GTMS Integration Service 2 Revised: 8/2017

5 Planning order data flow This diagram shows the flow of data when an optimization request is submitted. 1. User in TMW application identifies one or more orders to be optimized with the 3G-TM algorithm. These order numbers are sent to the Integration Service with a Set ID. 2. The Integration Service sends the request to the Data Sync plug-in. 3. The Data Sync plug-in returns the completed order object(s) to the Integration Service in the TMW Unified API format. 4. The integration service converts the TMW order(s) to a 3G-TMS order format and sends this to the 3G-TMS Web API. 5. Success/Failure is reported to the integration service. 6. Success/Failure is reported to the TMW application. 7. Selected order set is loaded in the 3G-TM embedded web page. 8. As loads (routes) are released, they are pushed to the Integration service. 9. Loads (routes) are converted to TMW format and forwarded to the Data Sync plug-in to update the database. 10. When all routes are processed, Integration Service sends Success/Failure to the TMW application. TMW 3GTMS Integration Service 3 Revised: 8/2017

6 Installation requirements The following are required to use the TMW 3GTMS Integration Service. Client machine requirements Each client machine must have the following installed: version _ or later For more information on installation requirements for, see Installing or upgrading your applications and database. TMW Operations version or later For more information on installation requirements for TMW Operations, see the TMW Operations Installation Guide. Internet access using one of the following: Google Chrome version 22 or later Microsoft Internet Explorer version 10 or later Apple Safari 5.1 or later Server machine requirements Your server must have the following installed: Microsoft Windows Server 2008 R2 or later Internet Information Services (IIS).NET Framework version 4.5 or later Copies of TTS50.ini and TTSLocal.ini Note: These files must be located in a folder to which the user profile (described in "Additional requirements" below) and/or the IIS application pool has access. If necessary, review your IIS security configuration. Additional requirements To complete the installation, you must also have the following: System administrator rights to the server machine The following licenses, both of which are provided by TMW Systems: INTERSERVICE_RATING CARRIERCONNECT The URL of the 3GTMS website used by your company, along with the organization ID You will provide this information during the installation process. This presumes that 3GTMS has been installed and configured. For more information, contact your 3GTMS implementation specialist. TMW 3GTMS Integration Service 4 Revised: 8/2017

7 Setting up the user profile You must create a user profile that will be used to synchronize data between the database and 3GTMS. You will provide this user ID and password during the installation process. For information on creating a user profile, see: Guide: System Administration Chapter: Establishing user profiles This user profile must have the following: Access to TMW Operations System administrator rights Note: 3GTMS users do not need to have system administrator rights to the database. TMW 3GTMS Integration Service 5 Revised: 8/2017

8 Access to 3GTMS To enter login credentials, follow these steps: 1. In the Edit User Profiles window, to the right of the Login Id field, click External User Cross Reference. The External User Cross Reference window opens. 2. Click Add. A new line appears in the grid. 3. In the ExternalSystem field, select 3GTMS Integration. If it does not appear in the list of choices, verify that the option in the ExternalUserXref label is not retired. For more information on viewing and editing labels, see: Guide: System Administration Chapter: Using the label file to customize fields If the 3GTMS Integration option does not exist for the label, contact your TMW Support representative. 4. In the External User ID field, enter the 3G user ID. 5. In the External Password field, enter the 3G user password. This password is casesensitive. 6. Click Save, and then click Close. 7. In the Edit User Profiles window, click Save, and then click Close. TMW 3GTMS Integration Service 6 Revised: 8/2017

9 Downloading the installation file You download the installation file from the Build Delivery section of TMW ClientCenter ( Note: The TMW 3GTMS Integration Service version should match your version of TMW Operations. For example, if you are running version of TMW Operations, you would install the version of TMW 3GTMS Integration Service. There may be times when your TMW Support representative will advise you to install a later version of TMW 3GTMS Integration Service. However, keeping the versions in sync is recommended. 1. In ClientCenter, you can use the Line of Business, Product, and Build lists to locate the build that you want to download. The build files appear at the bottom of the page. 2. Select the build you want and click View Details to open a page containing a list of files. 3. After you select the I have reviewed the notes above provided by TMW for this download check box, a Download link appears next to each file in the list. The installation file is an MSI contained in a ZIP file. Download the ZIP file to your server and extract the contents to a folder. TMW 3GTMS Integration Service 7 Revised: 8/2017

10 Installing the TMW 3GTMS Integration Service To install the TMW 3GTMS Integration Service, follow these steps. 1. Go to the folder where you saved the TMW Systems Integration Service installation file (*.MSI). 2. Double-click on the file. The Welcome to the TMW Integration Service Setup Wizard window opens. 3. Click Next. The Custom Setup window opens. A tree view in the middle of the window lists all available components. TMW 3GTMS Integration Service 8 Revised: 8/2017

11 4. For each option, click or and select Entire feature will be installed on local hard drive. After you do this, the tree should resemble the one shown in the following illustration. 5. Click Next. The Authentication Information window opens. 6. Make entries in the fields as indicated. TMW TMS User Password The ID of the user profile used to sync data between the database and 3GTMS The password for that user profile TMW 3GTMS Integration Service 9 Revised: 8/2017

12 Server Database The path to the server on which the database resides The name of the database 7. Click Next. The IIS Information window opens. 8. Make entries in the fields as indicated. Web Site Virtual Directory Application Pool Name The root-level web site in IIS Manager defaults to Default Web Site. Select the name of your web site from the drop-down list. The virtual directory receives queries and directs each query to the appropriate data source. The name for the TMW Integration Service virtual directory defaults to TMWIntegrationService. If you want, enter another name for the virtual directory. In IIS 7.0 and later, you group your web applications and services by assigning each to an application pool. Applications that call similar processes could be in the same application pool. The name defaults to TMWIntegrationServiceAppPool. If you want, enter another name for the application pool. TMW 3GTMS Integration Service 10 Revised: 8/2017

13 9. Click Next. The Additional Info window opens. 10. Make entries in the fields as indicated. 3G Web API URL 3G Organization ID House Carrier ID The path your company uses to access the 3GTMS website The ID of the 3GTMS organization to which your users are assigned Note: This value is case-sensitive. If you have a designated carrier to which you assign generic rates, enter its ID in this field. Note: This carrier should not exist in the database. 11. To verify the credentials, click Test Connection. If they are correct, the Successful connection! message appears. 12. Click Next. The INI File Locations window opens. TMW 3GTMS Integration Service 11 Revised: 8/2017

14 13. Make entries in the fields as indicated. TTS50.ini file TTSLocal.ini file Log File Location Minimum Log Level The path and name of the TTS50 file on the machine If you want, click Select to display a window from which you can locate and select the file. The path and name of the TTSLocal file on the machine If you want, click Select to display a window from which you can locate and select the file. The path and name of the log file created and updated by the service The type of information logged Options are: ALL All types of information DEBUG Detailed information designed to assist with debugging ERROR Error events that might allow the service to continue running INFO High-level information documenting service actions WARN Information about potentially harmful conditions TMW 3GTMS Integration Service 12 Revised: 8/2017

15 14. Click Next. The Master Data Management Service window opens. 15. The Master Data Management Service reviews the database for any changes made to carrier or customer data. If there are changes, it sends them to 3GTMS. In this window, enter a value that defines how often the service will run. Make your entry in seconds. For example, a value of 600 causes the service to run every 10 minutes. The value you enter depends on how often changes are made in your database. 16. Click Next. The Ready to install TMW Integration Service window opens. 17. Click Install. When the installation is complete, the Completed the TMW Integration Service Setup Wizard window opens. 18. Click Finish. By default, Master Data Management Service, Health Check, and Data Migration Utility files are stored in the following location: C:\Program Files (x86)\tmw Systems, Inc\TMW Integration Service [version number] TMW 3GTMS Integration Service 13 Revised: 8/2017

16 Configuring the TMW 3GTMS Integration Service Before your users can use 3GTMS functionality, you must do the following: 1. Apply the Integration Service SQL to your database. 2. Set up each client machine to allow access to 3GTMS. Applying SQL to your database As part of the installation, a SQL script was stored on your server's hard drive in this folder: C:\inetpub\IntegrationServicePlugin\TMWOperations\SQL Go to this folder and apply the SQL script to your database. For more information on applying SQL to a database, see the Microsoft SQL Server Management Studio online help. Warning: When the SQL file is applied to your database, you should see a message stating, "Query executed successfully." If you get a message saying the query executed with errors, do not move on to the next part of the installation process. Contact your TMW Support representative for assistance. Configuring client machines to allow access to 3GTMS For each user, you must do the following: Add 3GTMS login credentials to the user's profile. You do this in System Administration. Note: These users do not need to have system administrator rights to the database. Add settings to the user's TTS50. For more information, refer to the TMW Operations online help. TMW 3GTMS Integration Service 14 Revised: 8/2017