Universal Interface Service Installation - WebTMA 5

Before you set up the service, log in to WebTMA and create a Universal Interface Setup record for the module you plan to configure. You do not have to provide any details, simply the Code, Description, and Transaction Type.

Once you have set up the Universal Interface in WebTMA, unzip the Universal Interface-[ModuleName]Client.zip file and run the setup.exe file. The [ModuleName] selections include Other Charges, Department, Facility, Building, Floor, Area, Area/Department Link, and Fuel & Oil.

If you use several of the Space Management import modules, the order of operation for the transactions is:

  1. Department Import
  2. Facility Import
  3. Building Import
  4. Floor Import
  5. Area Import
  6. Area/Department Link Import

Running the .exe file installs the Universal Interface Client Service. The PC or server where this is installed must have access to the WebTMA Login Page and Application.

Once installation is completed, browse to the C:\Program Files\TMA Systems LLC\WebTMA UI2 Client Service directory and launch the WebTMA[ModuleName]Configuration.exe file, or go to Start > Programs > WebTMA Universal Interface Client Services > Service Configuration.

Z_UI_ClientSvcConfig.png

The fields on this window are defined as follows:

Login ID – WebTMA Application User Login

Password – WebTMA Application Login Password

Client – WebTMA Client Name

WebTMA Login URL – The URL to your WebTMA Login Page

Polling Interval (Minutes) – How frequently you want the service to check for new records

After you have completed the fields:

Click the Load Setups button at the lower left to load your Universal Interface Setup.
Note: This will give you a list of Universal Interface Setup (Modules) you have configured.

Double-click on the appropriate Universal Interface module setup line to view the Detail window (shown in the related topics).

The read-only WebTMA Service URL field populates when you click the Test Connection button to test your connection settings.

Setup Detail for MSSQL Server Transfer

Z_UI_SetupDetailMSSQL.png

The entries made on this window automatically populate server-related fields on the Universal Interface Setup window in WebTMA. While those fields can be added or edited in WebTMA, the preferred way to manage this information is from the Detail window where you can test your connection. The Test Connection button is unavailable in WebTMA.

To complete the Detail Setup for MSSQL Server transfer:

  1. Configure this window to link to your source database.
  2. Select the Connection Type – Microsoft SQL Server.
  3. Type the Server – Server name.
  4. Enter the Database – Database Name.
  5. Enter the User ID – user a user ID for the person that can access the data. This account only requires read access.
  6. Type the Password – Password of the user accessing the data.
  7. Click the Test Connection button to make sure your connection works.

Next, configure the Import/Export Settings. This section is used to link primary data fields and tables between the databases.

  1. Type the Table Name - Sources table.
  2. Enter the Key Column - Primary key for the source table.
  3. Designate Processed Column - Field used to store the processed flag once the service processes the line.
  4. Type the name of the Error Column - Field used to store the error message if an issue arises during the import process.
  5. Click the Load Columns button at the lower left.
  6. Click the Save button on the Detail window to save the detail information.

To complete the Setup process:

  1. Click Save once more on the Configuration This saves the information to the configuration file.

Once this is completed, you can start the service from Windows Services (WebTMA Integration2 Client Service).

Setup Detail for Oracle Transfer

Z_UI_SetupDetailOracle.png

The entries made on this window automatically populate server-related fields on the Universal Interface Setup window in WebTMA. While those fields can be added or edited in WebTMA, the preferred way to manage this information is from the Detail window where you can test your connection. The Test Connection button is unavailable in WebTMA.

To complete the Detail Setup:

  1. Configure this window to link to your source database.
  2. Select the Connection Type – Oracle.
  3. Type the Host – Host name.
  4. Enter the Port – Port number.
  5. Enter the SID – SID name.
  6. Enter the User ID – use a user ID for the person that can access the data. This account only requires read access.
  7. Type the Password – Password of the user accessing the data.
  8. Click the Test Connection button to make sure your connection works.

Next, configure the Import/Export Settings. This section is used to link primary data fields and tables between the databases.

  1. Type the Table Name - Sources table.
  2. Enter the Key Column - Primary key for the source table.
  3. Designate Processed Column - Field used to store the processed flag once the service processes the line.
  4. Type the name of the Error Column - Field used to store the error message if an issue arises during the import process.
  5. Click the Load Columns button at the lower left.
  6. Click the Save button on the Detail window to save the detail information.

To complete the Setup process:

  1. Click Save once more on the Configuration This saves the information to the configuration file.

Once this is completed, you can start the service from Windows Services (WebTMA Integration2 Client Service).

Setup Detail for Tab or Comma Delimited Transfer

Z_UI_SetupDetailCommaTab.png

The entries made on this window automatically populate server-related fields on the Universal Interface Setup window in WebTMA. While those fields can be added or edited in WebTMA, the preferred way to manage this information is from the Detail window.

To complete the Detail Setup for tab or comma delimited transfer:

  1. Configure this window to link to your destination file folder.
  2. Select the flat file format Tab or Comma Delimited.
  3. Select a file path by using the Browse option
  4. Click the Load Positions button at the lower left.
  5. Click the Save button on the Detail window to save the detail information.

To complete the Setup process:

  1. Click Save once more on the Configuration This saves the information to the configuration file.

Once this is completed, you can start the service from Windows Services (WebTMA Integration2 Client Service).

Universal Interface Service Operation

When the first polling interval has elapsed, the service checks the database/table or the flat file in the Universal Interface Setup. For database processing, the service will look for any records where the Processed Column is False. Any lines will be imported if they meet these conditions: The Processed field is set to False and all the required and validated data fields are complete.

If a required field is incomplete or a validated field does not match WebTMA, the Processed field is set to False with a description of the problem in the Error column. There is one exception to this rule: If the field has a Default 1st Record option that is checked and data is passed in that field that does not match WebTMA, the service will set the Processed field to True but provide an error indicating the mismatch.

You can correct the problem and mark the Processed column to False and Error Column to NULL to try the transaction again. Note: The Processed column must be set to False as a default for all Universal Interface tables. See each individual module topic for additional setup requirements specific to that module

If the Universal Interface Service is configured for Flat File transfer, the service will process the file and all content.

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.