Universal Interface Service Installation - WebTMA 7

To set up the Universal Interface module, the following actions are taken in the order listed below.

  • Install the service (Service Installation)

  • Establish records in WebTMA to set up the database connection (UI Database Connection Setup)

  • Configure the Service (Service Configuration)

  • Setup and Test File Transfer (Setup for File Transfer)

Service Installation

The first step is to Install the Universal Interface Service. The installer is the client-side Universal Interface (UI) service which can be run on a server or local machine. If you want to use a database UI process, you only need to install on a server and let the service run. If you are set up for file transfer and want to use a server-based solution, make sure that the service can access the folders you have set up to drop the files. If you use a local install for file transfers and there are multiple users, ensure that the users do not use the same file paths. Use UNC paths rather than file structure paths.

To get started, download from www.tmasystems.net.

How to Install the Service

  1. Right click on WebTMA 7 UI.exe to run as Administrator.

  2. Click Next to start the install process.

  3. Confirm or change path of installation files.

  4. Click Next.

  5. Click Install to install the service

  6. Accept the prompts about system changes if they appear.

  7. Click Finish to complete the install

UI Database Connection Setup

Once Universal Interface Setup is installed, the next step is to create Universal Interface Setup records for the modules you plan to configure before you configure the service.

How to Create UI Setup Records in the Application

After you have launched the WebTMA application:

  1. Go to Admin > Universal Interface Setup.

  2. Click Add on the Toolbar

  3. Select the Transaction Type first.

  4. Select the proper Connection Type and set the Code and Description. *

  5. Click the Repair Center Tab.

  6. Click the Add Repair Center link to open the Repair Center Entry flyout.

  7. Check all Repair Centers that will use this setup.

  8. Click the Add Selected button.

  9. Click Save on the WebTMA toolbar.

* Reminder: Only the default required fields are needed at this time.

Create as many different records as needed for the modules you plan to use following the steps listed above.

Service Configuration

The service is configured outside the application and involves a number of different steps outlined in the following topics.

How to Start the Service Configuration

  1. Click the Windows Icon in the Taskbar.

  2. Click the WebTMA 7 UI Service folder in the application list.

  3. Right-click on WebTMA 7 UI Config Tool.

  4. Select More.

  5. Run as an Administrator.

  6. Allow the Application to run.

  7. Select the Config file by clicking Browse, then go to C:\Program Files\TMA Systems LLC\WebTMA 7\Services\UI Service or the path designated during installation.

  8. Select the file called appsettings.json

Go to the next topic, How to Complete the Client Service Configuration Window to continue the setup.

How to Complete the Client Service Configuration Window

UI_WebTMAIntegrationClientServiceConfigurationNew.png

  1. Select a WebTMA user account to process the data jobs. This account should have rights to add or edit data for the UI being used. NOTE: The User Login ID and Password are required.

  2. Enter the WebTMA Client name.

  3. Set the UI WebService URL (path = https://WebTMAServer/UIservice).

  4. Click the Test Connection button to make sure the Config tool can access WebTMA. If you get a “Successfully connected to UI WebService” notice at the lower left, the service was able to communicate with the server.

  5. Click Save at the lower right to save the settings.

Go to the next topic, How to Set Up the UI Database Connection to continue the setup.

How to Set Up the UI Database Connection

Use the instructions found in How to Start the Service Configuration to reopen the Configuration Tool.

  1. Click the Test Connection button to validate the connection and to update the grid with the UI records that were created in WebTMA.

  2. Double-click on the UI you wish to configure. This opens the DetailForm window.

  3. Verify or adjust the Connection Type.

  4. Enter the Server name.

  5. Enter the transition Database, User ID, and Password.

  6. Click the Test Connection button to make sure the system can access that database.

Complete the window using the steps in How to Complete the DetailForm Integration Table Fields

How to Complete the Detail Form Integration Table Fields

UI_ConfigurationDetailForm.png

WebTMA requires three additional column fields be completed for the integration:

  • Key Column. Used with a seeded value that is used as the unique identifier

  • Processed Column. A bit with a default as NULL

  • Error Column. A nvarchar 100 to store the error if something goes wrong

  1. Enter the Table Name. This is the table that you will integrate with.

  2. Enter names of the transition database columns described above (Key, Processed, and Error).

  3. Click the Load Columns button to pass those columns into WebTMA so you can map them.

  4. Click Save on the DetailForm window

  5. Click Save on the WebTMA Integration Client Service Configuration window.

How to Use Connection Settings

After you have completed all the steps in How to Complete the Client Service Configuration Window, How to Set Up the UI Database Connection, and How to Complete the DetailForm Integration Table Fields, launch the WebTMA application to establish mapping.

  1. Go to Admin > Universal Interface Setup.

  2. Open a record you created earlier.
  3. Click Edit.

  4. Click the pencil icon for each required column in the Mappings Grid Section.

  5. Select the field for the transition database from the Remote Column list to map it. NOTE: If no data exists in the Remote Column, verify you clicked the Load Columns button in How to Complete the DetailForm Integration Table Fields.

  6. Select the Add Column link to add any optional data to be mapped and follow the directions in step 5.

  7. Repeat until all of the optional data is added.

  8. Click Save on the WebTMA toolbar when all columns have been mapped.

The final step is to pass some test lines to validate the data is passing. See Setup for File Transfer for instructions.

Setup for File Transfer

In the WebTMA application:

  1. Make sure the data aligns with the UI Setup Transaction Type.

  2. Ensure the columns are mapped appropriately.

  3. Enter the UNC path where you want the system to store your information. Each Universal Interface Setup record should have a unique File Path.

  4. Place transfer file(s) into the folder.

Based on the Polling Interval set on the Config Tool, the service will pick up the file and process it/them.

An Archive and ErrorLog folder is automatically created when the fields are processed, and a copy goes to the Archive folder showing what was processed. If there are any errors, they are listed in an ErrorLog Folder.

Reminder: If you want to use a server-based solution when setting up for file transfer, make sure that the service can access the folders you have set up to drop the files. If you use a local install for file transfers and there are multiple users, ensure that the users do not use the same file paths. Use UNC paths rather than file structure paths.

 

Want to Learn More?

Visit the WebTMA Help Page

Was this article helpful?
0 out of 0 found this helpful

Articles in this section

2024 Client Training Schedule
See the full list of web training events.