The Universal Interface for WR (Work Request) enables organizations to import Work Requests and export Request Status.

The Universal Interface for WR bundles two types of request records.

• WR - Request Import
• WR - Request Status Export

WR - Request Import

Path: Admin > Universal Interface > Universal Interface Setup

The WR – Request Import allows you to import work Requests. If desired, you can also use WR - Request Import with the optional Auto Attendant to automatically convert requests into work orders.

When you select the Transaction Type, WebTMA automatically loads the required fields in the mapping grid. These lines display a red sphere in the left column until the row is mapped to the remote columns in the third-party database.

WebTMA filters the column field selection to prevent duplicate selection. For example, Requestor Name is not available for selection when you click the Add Column link because it is already selected. Reminder: The lines that auto-populate the grid are required. Please do not delete these lines.

Remember to add at least one Repair Center to the Repair Center Tab.

How to Link Universal Interface Fields for WR - Request Import

In order to import Request lines, you must link WebTMA fields with fields within your Universal Interface table. By default, all required fields should already have line entries.

From your Universal Interface Setup window in Add/Edit mode:

1. Complete the required fields.

2. Click the Add Column link on the grid to open the Entry flyout.

3. Choose your WebTMA Column.

4. Select the Remote Column.

5. Click Save & Add (or Save).

6. Repeat until required fields and selected elective fields in your Universal Interface table have been matched up.

7. Add the applicable Repair Center(s) to the Repair Center Tab.

8. Click Save on the WebTMA toolbar.

WR - Request Import Required Columns

The following fields must be present in your outside database to accomplish a successful import of work Request information to WebTMA. When you add a new Universal Interface template, these required fields are automatically added to the TMA Column. At this point, all you need to do is map them. You can also add any WR - Request Import Elective Columns.

Action Requested – Validated field (text field)

Request Date – Validated field (text field)

Request Type Code – Validated field (text field)

Requestor Name – Validated field (text field)

For Validated fields, the data must exist in the WebTMA database in order for the record to import with the field completed.

WR - Request Status Export

Path: Admin > Universal Interface > Universal Interface Setup

Select the WR - Request Status Export Transaction Type to export records using the Universal Interface framework. You have a choice of three export Connection Types: Comma Delimited Text File, Tab Delimited Text File, or Microsoft SQL Server.

The Export Query is used only to determine the records to be exported. Select an existing Browse Query to serve as the Export Query. The selected Export Query has no impact on the data columns that are used in the export process.

The WebTMA Integration Client Service Configuration (Stand-alone windows application) Service includes fields to support exporting records.

Remember to add at least one Repair Center to the Repair Center Tab.

The Server fields are auto-populated using the entries made to the Detail window during Universal Interface Client Service Installation.

WARNING: The Server-related fields can be edited in WebTMA; however, this should only be done by highly qualified personnel. Changes saved here overwrite the contents of the Detail setup windows. It is preferable to make changes to the Detail setup window where you can test your connection.

How to Link Universal Interface Fields for WR - Request Status Export

In order to export your Request Status records, you must link WebTMA fields with fields within your Universal Interface table. By default, all required fields should already have line entries. Edit those records and then add elective fields.

From the Universal Interface Setup window in Add/Edit mode:

1. Complete the required fields.

2. Click the Add Column link on the grid to open the Column Mapping popup window.

3. Choose your WebTMA Column.

4. Select the Remote Column.

5. Click Save & Add (or Save & Close).

6. Repeat until all fields in your Universal Interface table have been matched up.

7. Add the applicable Repair Center(s) to the Repair Center Tab.

8. Click Save on the WebTMA toolbar.

WR - Request Status Export Columns

The following columns are available for export:

Completion Date – DateTime

Primary Key – INT

Request # – Nvarchar

Status – Nvarchar

Work Order # – Nvarchar

UI WR Request Status Export Web Service

The service uses JSON-formatted request and response messages to exchange data. Please note that the order of the JSON elements in request messages should match the examples below, but optional elements may be omitted.

The following documentation assumes you know the existing rules for UI. This is merely a new source / destination for the data. Otherwise all existing UI rules apply.

Authenticate Method

This service method is used to generate an authentication token for use with the other service methods. The POST request must include a Content-Type header of “application/json”.

POST URL:

https://[WebTMAdomain]/webservice/RequestInterface.svc/Authenticate

REQUEST FORMAT:

{

"Username":"dev",

"Password":"dev",

"Client":"abc corporation"

}

RESPONSE Format:

{

<Success>true</Success>

<Message>User Authenticated.</Message>

<Token> fEKG8PMWoIWgeJ27Oi4xUpq6dzffxOvdPdJVRwqKiC%2b41S5gnuf5nHS1i%2fY5qL%2bG9JcZHsufRz7BZzBRcYTNNgrpXUeRaW%2bN</Token>

<ExpDate>2020-11-10T17:55:14.4457027Z</ExpDate>

}

WRRequestStatusExport

This service method is used to retrieve the status of a work request. The POST request must include a TMAAuth HTTP header with a valid authentication token from the Authenticate method.

POST URL:

https://[WebTMAdomain]/webservice/RequestInterface.svc/WRRequestStatusExport

REQUEST FORMAT:

{"UISetupCode":"WR-StatusExp"}

RESPONSE FORMAT:

{

"Success": true,

“RequestList”: [

{

"CompletionDate": null,

"PrimaryKey": 574578,

"RequestNumber": 78982

“Status”: "Pending Request",

"WorkOrderNumber": null

}

{

"CompletionDate": null,

"PrimaryKey": 574580,

"RequestNumber": "78984",

“Status”: "Pending Request",

"WorkOrderNumber": null

}

{

"CompletionDate": null,

"PrimaryKey": 574581,

"RequestNumber": "78985",

“Status”: "Pending Request",

"WorkOrderNumber": null

}

{

"CompletionDate": null,

"PrimaryKey": 574602,

"RequestNumber": "79006",

“Status”: "Pending Request",

"WorkOrderNumber": null

}

]

}

Want to Learn More?

Visit the WebTMA Help Page