qualcomm edvir setup instructions · see the example transmission record master below: figure 5 ....

TMW Asset Maintenance

TMT Fleet Maintenance – IBM i Qualcomm VIR Setup Instructions

Copyright © 2015 TMW Systems, Inc. 1 Revised: 08/2015 A Business Confidential Document.

Table of Contents

Overview ..................................................................................................................... 2

Features ...................................................................................................................... 3

Omnitracs eDVIR – lifecycle........................................................................................ 4 eDVIR - electronic Driver Vehicle Inspection Report ..................................................................................... 4

Omnitracs Portal - Create Driver Profile(s) ................................................................. 5 Omnitracs Implementation Setup ..................................................................................................................... 5 Omnitracs Portal - Create Subscriber(s) ........................................................................................................... 8 Configure Omnitracs Digital Certificate on IBM i ........................................................................................ 10

Overview - Configure TMT Import/Export Master .............................................................................. 10

Qualcomm Import - VIR Messages ........................................................................... 11 Import Setup....................................................................................................................................................... 11 Import Testing Procedures ............................................................................................................................... 19 Verify the Import ............................................................................................................................................... 21

Qualcomm VIR Import Reports ................................................................................. 22

Sample Reports generated by VIR Import ............................................................................................................ 23 Qualcomm VIR Import Listing Report TMT991QCIR ................................................................................. 23 Inspection Report (VIR) Transfer Program Report 991-IR TMT991IR ....................................................... 24

Inspection Tickets Created from Import ................................................................... 26 Inspection Tickets for Units with defects ....................................................................................................... 26 Inspection Tickets for Units without defects ................................................................................................. 26 Inspection Fields Master ................................................................................................................................... 27 Inspection Fields Mapping ............................................................................................................................... 28

Qualcomm eDVIR Import Flow (TMT991QCIR) ................................................................................................. 30

Qualcomm Export – VIR Mechanic Ack ..................................................................... 32 Export Setup ....................................................................................................................................................... 32 Export Testing Procedures ............................................................................................................................... 36 Verify the Export ............................................................................................................................................... 37

Qualcomm Import - VIR Mechanic Acknowledgment Reports .................................. 38

Sample Reports generated by VIR Export ............................................................................................................. 38 Qualcomm VIR Export Listing Report TMT991QCMA ............................................................................... 38

Qualcomm Export Flow (TMT992QCMA) ............................................................................................................ 39

Qualcomm eDVIR Setup Instructions

Qualcomm eDVIR Setup Instructions 2 Revised: 08/2015 Mobile Communication – Qualcomm Module

Overview

Omnitracs VIR – sends a Web Service request to Omnitracs and returns Vehicle Inspection Reports (VIR’s) that have been queued since the last request. This program is part of the Mobile Comm Module and requires your IBM i to be at or above release V6R1M0. Also requires Omnitracs MCP50, MCP100, MCP110 or MCP200 in-cab devices and the Omnitracs VIR (Vehicle Inspection Reporting) application enabled for the device. Not available for previous Omnitracs products such as OmniTRACS or OmniExpress in-cab devices.

Electronic Driver Vehicle Inspection Reports, (eDVIR’s), are created by a driver using the Omnitracs Mobile Communication device mounted in a vehicle (tractor, truck, or other power unit). TMT Fleet Maintenance™ is integrated with the Omnitracs host system and provides the functionality to generate Inspection Tickets.

Inspection Tickets are automatically generated in TMT from the eDVIR Import when defects reported by the driver are collected and processed.

Repair Orders can then be created from the Inspection Tickets and assigned to Employees to perform the repairs.

When the repairs are completed, and the Repair Order sections are closed, the VIR Mechanic Acknowledgment Export will send a return message to the Omnitracs Mobile Communication device mounted in the vehicle for the drivers review.

The conversion program included with this Module or Version Upgrade will automatically create the basic Import/Export Profile records needed in Menu Selection 847 - Import/Export Master. Some additional setup will be required, including the Mobile Comm - Qualcomm Module Security Code.



Features

The initial module configuration will automatically create the basic Import/Export Profile records needed to run the "eDVIR Messages" Import and the "eDVIR Mechanic Ack" explained below.

An Import Type record will be created named "Qualcomm".

An Import Profile record will be created named "VIR Messages", used to import the VIR from the Qualcomm console in the Unit.

An Export Profile record will be created named "VIR Mechanic Ack", used to export the VIR from TMT back to the Omnitracs console in the Unit.

The initial configuration will also automatically create all required TMT Codes;

A new TMTCODE - "INSP TYPE" will be added to the TMT Codes Listing.

Two new "INSP TYPE" codes will be added, "STANDARD" and "QUALCOMM".

The "STANDARD" code will automatically be assigned to any existing Inspection Fields and Inspection Fields Maps you may have.

The new default "QUALCOMM" fields will be added to the Inspection Fields Definition list during the installation of this module.

The new "QUALCOMM" Inspection Type code will be added to the Inspection Fields Mapping List, and two new 'Equipment Type' codes will also be added;

"TRACTOR" and "TRAILER".

A Module Security Code is required for the Mobile Comm - Qualcomm Module.



Omnitracs eDVIR – lifecycle

eDVIR - electronic Driver Vehicle Inspection Report

Driver creates and sends VIR using Omnitracs’s Vehicle Inspection application on the in-cab unit.

VIR transactions are published to the ESS (Event Subscription Service) server and remain queued until all subscribers (back office applications) have retrieved and acknowledged them.

When the TMT Qualcomm Import requests new VIR transactions from the ESS server via a dequeueing Web Service request, any previously dequeued transactions are acknowledged so they can be deleted from the ESS server.

The TMT Qualcomm Import can be setup to run automatically using the Import/Export Scheduler, or it may be run manually.

TMT Inspection Tickets are automatically created from any new imported VIR transactions that exist since the last export ran.

Repair Orders can then be created from the Inspection Tickets that were imported.

Repair Orders sections are closed as the repairs are completed.

o All Repair Order sections must be closed, (including any sections added for repairs unrelated to the eDVIR), before the Mechanic Acknowledgement will be sent back to Omnitracs.

The TMT Qualcomm Export processes the closed Repair Order sections that originated from the Omnitracs VIR since the last export ran. Repair Order information such as work completion status and mechanic acknowledgements are transmitted back to in-cab unit via Omnitracs Web Service calls.

The TMT Qualcomm Export can be setup to run automatically using the Import/Export Scheduler, or it may be run manually.

Omnitracs’s VIR application on the in-cab unit will require a driver acknowledgement including the mechanic’s response and verification that the truck is safe to operate before allowing another VIR to be created for the truck.



Omnitracs Portal - Create Driver Profile(s)

Omnitracs Implementation Setup

Omnitracs driver profiles are required that you create and maintain. The driver profiles allow the driver to log into the in-cab unit via the Omnitracs Portal.

Each driver should have their own unique profile to identify the driver that created the VIR.

1. Using your web browser, navigate to the Omnitracs Services Portal: https://services.omnitracs.com

2. Enter the Login information and click the Log In button.

Company ID:

User ID:

Password:

3. Click on the QTRACS link on the sidebar.

4. Click on the Drivers tab at the top of the page.

5. Click on Add new driver link.

https://services.omnitracs.com/



6. Fill in the New Driver form.

a. See the example below

Figure 1



7. After you have entered the required information, click the save link in the upper right hand corner, (see Figure 1), to create and save the Driver Profile.

Figure 2



Omnitracs Portal - Create Subscriber(s)

You will need to create a Subscriber representing the TMT Import/Export application that needs to receive transactions. They are called Subscribers because they subscribe to certain transactions.

1. Using your web browser, navigate to Omnitracs Services Portal: https://services.omnitracs.com

2. Enter the Login information and click the Log In button.

Company ID:

User ID:

Password:

3. Create the subscriber.

a. Select the Administration link in the upper right hand corner.

b. Select the Integration tab.

c. Click the Create Subscriber… button in the center of the screen.

d. On the Create Subscriber page:

i. Enter subscriber name in the Name field.

ii. Page down and find the "Vehicle Inspection Report Events" section, (displayed below)

a. Check the Subscribe? box for each of the Vehicle Inspection Report Events transaction types.

Figure 3

iii. Click the Save button at the bottom right corner of the page to create the Subscriber and save the preferences selected.

https://services.omnitracs.com/



e. You will be returned to the Subscribers page. i. Verify the Feed Status for your newly created subscriber shows Enabled.

Figure 4



Configure Omnitracs Digital Certificate on IBM i

Overview - Configure TMT Import/Export Master

The required Qualcomm VIR Import/Export Master records will be included with Version 2012.30. The Version and Release Upgrade conversion process will add the following required default records:

Qualcomm VIR import profile

Qualcomm VIR Mechanic Ack export profile.

Qualcomm Inspection Fields/Map

NOTE: Your IBM i OS must be at or above Version V6R1M0 before proceeding.

The Qualcomm modules and programs are required to be compiled at or above Version V6R1M0.

The links below are related to setting up the digital certificate on the client's IBM i.

Omnitracs Importing Portal's Certificate to your IBM i : https://intinfo.myqualcomm.com/display/iWebInt/Importing+Portal%27s+Certificate+to+your+iSeries\

IBM Digital Certificate Manager Links: http://pic.dhe.ibm.com/infocenter/tivihelp/v15r1/index.jsp?topic=/com.ibm.itm.doc/main_os40031.htm

https://intinfo.myqualcomm.com/display/iWebInt/Importing+Portal%27s+Certificate+to+your+iSeries/

https://intinfo.myqualcomm.com/display/iWebInt/Importing+Portal%27s+Certificate+to+your+iSeries/

http://pic.dhe.ibm.com/infocenter/tivihelp/v15r1/index.jsp?topic=/com.ibm.itm.doc/main_os40031.htm

http://pic.dhe.ibm.com/infocenter/tivihelp/v15r1/index.jsp?topic=/com.ibm.itm.doc/main_os40031.htm



Qualcomm Import - VIR Messages

Import Setup

The initial upgrade to TMT Version 2012.30 or above will create the required Qualcomm Import Profile – “VIR Messages”.

A Security Code is required to implement the “Mobile Comm – Qualcomm” Module.

Obtain the Module Security Code from TMT Support.

1. Activate the Qualcomm Import/Export Master Listing.

a. Use Menu Selection 847 - Import/Export Master.

b. Use Command Key F8=Show All to display all profiles.

c. Position the cursor to “Qualcomm” and use Option 6 to activate the Import/Export type “Qualcomm” if it is Inactive.

2. Activate the VIR Messages Profile.

a. Use Option 2=Work With for the Import/Export type: Qualcomm.


c. Use Option 2=Work With to update the VIR Messages profile.

d. Change "Status" to ‘A’ to activate. Press ENTER.

e. Press ENTER and F6 to Update the profile.

f. Use Command Key F8=Show All to display all Active profiles.



3. Use Option 4=Transmission to display the Transmission screen for the VIR Messages Profile.

a. Change the Archive value to ‘Y’.

b. Press ENTER and F6 to Update the profile.

See the example Transmission Record Master below:

Figure 5



4. Use Option 5=Scheduler to update the Scheduler screen.

a. Set the Schedule Days by placing an ‘X’ under each day of the week you want the Scheduler to Import the Omnitracs VIR’s.

b. Enter a Start and End Time for each day.

c. Enter the Delay Interval.

i. Minimum = 5 minutes

d. The Scheduled User – Enter a UserID that has security to run this job.

e. Job Name – Enter: “QCEDVIR”.

f. Job Message Queue/Library – Enter: “*USRPRF”/”*LIBL”.

g. Program to Call – Enter: “TMT991QCIR”.

h. Job Description/Library - Enter: “FLEETDEV” / “TMTDATA”.

i. These are TMT default values – if you have used other naming conventions, use your Job Description and/or Library name.

ii. After making changes to the Scheduler Record Master, press ENTER and F6 to Update the profile.

See the example Scheduler Record Master below:

Figure 6



5. Use Option 6=Fields to display the Field Maintenance screen.

Not required for Omnitracs VIR.

You may choose to setup default values for these fields that are displayed on an Inspection Ticket created from an Omnitracs VIR.

a. Use Command Key F8 to show all.

Company Unit - Default is ‘Y’.

Only company units are supported at this time.

Status - Default is "OP".

Symptom Code - Default is ‘01’.

Customer activated fields:

Inspected By User - use this field to assign a default user for all inspections.

Recommendation: setup a Default Employee (QC – Omnitracs VIR)

Inspection Status - use this field to assign a default status for all inspections.

Recommendation: setup a Default User Inspection Status (Omnitracs)

Opened By User - use this field to assign a default user (mechanic) for all inspections.

Inspection Shop – use this field to assign a default Shop for Inspection Tickets.

This value is used to define the Inspection Ticket Shop Number. The Inspection Ticket Shop can be controlled by the Cross-Reference value.

Recommendation: setup a Cross-Reference by Equipment Type for the Inspection Shop Number

TRACTORS (Any Unit with a Omnitracs in-cab unit)

Check for Inspection Shop Cross-Reference Value

Cross-Reference Value = Equipment Type

TMT Value = Inspection Ticket Shop Number

X-Ref Not Found = ‘C’

If the Cross-Reference Value is not defined, use the Default Value.

If the Cross-Reference Value is not defined and the Default Value is blank, use the Unit Domicile from the Unit Master.



TRAILERS (Attachments – any Unit that does not have a Omnitracs in-cab unit)

Check for Inspection Shop Cross-Reference Value

Cross-Reference Value = Equipment Type

TMT Value = Inspection Ticket Shop Number

X-Ref Not Found = ‘C’

If the Cross-Reference Value is not defined, use the Default Value.

If the Cross-Reference Value is not defined and the Default Value is blank, use the Unit Domicile from the Unit Master.

The logic flow used to determine the Inspection Ticket Shop Number from Inspection Shop Field setting is explained below:

If Field Property “Use Power Equipment Domicile for Attachments” = 'Yes' - then use the value from the Unit Domicile in the Unit Master for the TRACTOR.

If Field Property “Use Power Equipment Domicile for Attachments” = 'No' - then use the value from the Unit Domicile from the Unit Master.

You may Setup a Cross-Reference value for each Equipment Type used in the Unit Master, and a matching TMT Value for the Inspection Ticket Shop.

Example: if the TMT Value = Shop 100, and the Cross-Reference Value = "TRACTOR", then all VIR's imported for units with an Equipment Type of "TRACTOR" will default to Shop 100 as the Inspection Ticket Shop.

The Cross-Reference Value will represent the Equipment Type from the VHCLMSTR. The TMT Value will represent the Inspection Ticket Shop Number.

If the Cross-Reference value is not found, and "X-Ref Not Found" is set to 'D', then use the Default Value.

If the Default Value is blank, use the VEHDOM value from the VHCLMSTR.

If Field Property "Use Power Equipment Domicile for Attachments" = 'Yes' - then use the Domicile value for the Power Unit from VHCLMSTR/VEHDOM for the Attachments only.

If Field Property "Use Power Equipment Domicile for Attachments" = 'No' - then use the Domicile value from the Attachment Unit VHCLMSTR/VEHDOM for the Attachments only.



If the Cross-Reference value is not found, and "X-Ref Not Found" is set to 'C', and if Field Property "Use Power Equipment Domicile for Attachments" = 'Yes' - then use the Power Unit Domicile value from VHCLMSTR/VEHDOM.

If the Cross-Reference value is not found, and "X-Ref Not Found" is set to 'C', and if Field Property "Use Power Equipment Domicile for Attachments" = 'No' - then use the value for the Attachment VHCLMSTR/VEHDOM.

Note: When "X-Ref Not Found" is set to 'C', the "Default Value", (if one has been setup) will not be used. The "Default Value" is only used when "X-Ref Not Found" is set to 'D'.



6. Use Option 8=Properties to update the Properties.

a. User = Enter your Omnitracs assigned User ID.

Example Format is: (User@CompanyID).

b. Password = Enter your Omnitracs User ID password.

c. Transaction ID = the last VIR transaction ID received and processed.

This value updates as transactions are received.

d. Subscriber ID – the transaction subscriber ID setup in Omnitracs Services Portal integration with TMT.

e. Inspection Type - this value indicates the inspection map used and should always be 'QUALCOMM'.

f. Use Power Equipment Domicile for Attachments;.

Yes - If set to 'Yes', the Shop Number written on the Inspection Ticket for Trailers will use the Tractor Domicile Shop.

No - If set to 'No', the Shop Number written on the Inspection Ticket for Trailers will use the Trailer Unit Domicile from the Unit Master.

g. HTTP: Debug Log (Y=Yes; N=No; B=Both).

Y = Debug log is produced when Web Service is requested AND Web Service XML file returned is not processed.

N = No log is produced when Web Service is requested and XML file is processed (default).

B = Debug log is produced when Web Service is requested AND Web Service XML file returned is processed.



See the example Field Properties Master below:

Figure 7



Import Testing Procedures

1. Create an electronic vehicle inspection report via the Omnitracs in-cab unit.

These messages are generally transmitted to the Omnitracs Operation Center immediately and available to TMT within seconds.

2. To Import VIR messages:


b. Use Option 2=Work With for the Import/Export Type: Qualcomm.

c. Use Option R=Run Immediately for profile: VIR Messages.

If successful, the Web Service XML file will be returned and saved to the IFS folder specified in the Transmission record.

VIR remarks are then loaded into the Inspection Comments file (INSPCMTS). These include the following tags/info:

'eDVIR #TS = the Import/Export Type Sequence (15)

'eDVIR #OR = the Invoice Transfer Origin (T.7.01.0)

'eDVIR #ID = the Invoice Transfer Record Id (ITFRHEAD/THID#)

'eDVIR #MN = Vendor Message Id (VIR ID)

'eDVIR #DN = Driver Name logged into the Omnitracs in-cab unit

3. Each of these tests are designed to allow you to choose which HTTP Debug Log property setting will be desired and work best for your needs.

Recommendation: set the HTTP Debug Log property to ‘B’ to begin using the Qualcomm VIR Messages import.

TEST: when HTTP Debug Log property equal to "Y".

Create VIR on Omnitracs in-cab unit.

Run TMT Qualcomm import for VIR Messages.

Check TMT report & debug log in IFS to verify that debug log ran AND no VIR's were imported.

TEST: when HTTP Debug Log property equal to "N".



Check the TMT reports.

Check ITFRHEAD & ITFRBODY records were created.

Use Menu Selection 165 - Inspection Tickets – Verify inspections for imported VIR transactions were created.

TEST: when HTTP Debug Log property equal to "B".





Check TMT reports and verify Http Debug Log created in IFS.

Check ITFRHEAD & ITFRBODY records were created.

Use Menu Selection 165 - Inspection Tickets – Verify inspections for imported VIR transactions were created.



Verify the Import

Inspection(s) imported in TMT can be displayed using Menu Selection 165 – Inspection Tickets.

The XML file returned from running the VIR Messages Import is located in the IFS folder defined in the Transmission record.

The default location is:

/TMT/WebServices/Qualcomm/VIR/Logs.

Look for file: "HTTP_Debug_Log_eDVIR_Driver_Msg.txt"

If the archive option is activated in the Transmission record of the Import profile, the default location is:

/TMT/WebServices/Qualcomm/VIR/Archive

All in-cab message communications can also be viewed, and may be verified, from the Omnitracs Fleet Manager.



Qualcomm VIR Import Reports

Two reports (spooled files) will be produced after the Qualcomm VIR Messages import runs:

The “Qualcomm VIR Import Listing” report

This report displays a summary list of all the VIR transactions that have been queued since the previous VIR import from Omnitracs.

The report includes the Omnitracs VIR Message ID, the Date/Time Received, Unit ID, and Defects.

The "Inspection Report (VIR) Transfer Program" report

This report displays a detail list of all VIRs imported, listing the reported defects and the Inspection Tickets created.

The report includes the unit Number, Unit Description, Equipment Type, VIR ID, Inspection Ticket Number, Defective Component Sequence Map Number, Defective System Code, System Code Description, Defect Remarks or Error Message.



Sample Reports generated by VIR Import

Qualcomm VIR Import Listing Report TMT991QCIR

Figure 8

Transaction ID - Qualcomm Message ID

VIR ID – Omnitracs Message ID

Report Time – This represents the Date and Time the VIR was created on the Omnitracs in-cab unit

Unit ID – The Unit Number reported on the VIR

Defects – The VIR comments entered by the driver



Inspection Report (VIR) Transfer Program Report 991-IR TMT991IR

Figure 9


Description – Unit Description in Unit Master

Type – Equipment Type from the Unit Master for Unit

VIR ID - Omnitracs Message ID

Insp# - TMT Inspection Ticket Number that was created from the Import

Seq# - Inspection Defect sequence from the Map Master for the Unit

System – System Code associated with the reported defect

Description – System Code Description



Remarks/Errors –

Remarks represent the driver comments for a reported defect

If System and Remarks are blank, no defects were reported

Error messages are also displayed in this column:

Unable to determine inspection map

Unit Equipment Type blank in Unit Master – update the Unit Master with the correct Equipment Type Code, and run the Import again to create an Inspection Ticket.

Component NOT found on map

Assign the missing Component to the Map for the unit, and run the Import again to create the Inspection Ticket.

Invalid unit number – VHCLMSTR

Invalid Unit Number sent in by driver or the Unit needs to be added to the Unit Master.

Meter exceeds TMTFIRMW limits

Meter provided in eDVIR is too large.

Web Service failure

Multi-Util not set up for unit

eDVIRs Processed – Total number of eDVIRs processed from this import

Notice this report indicates 6 eDVIRs were processed

Inspections Created – Total number of Inspection Tickets created from this import

Notice this report indicates 4 Inspection Tickets were created

The first two eDVIRs have errors, and Inspection Tickets will not be created until the errors are corrected

o The errors in the example are “***Component NOT found on map”, see the corrective action above for this error



Inspection Tickets Created from Import

Inspection Tickets are created when a valid VIR without errors is imported using the Qualcomm VIR Messages Import.

After the Inspection Tickets are generated from an Import, you are ready to create a Repair Order or Work Pending from the Inspection Ticket using your standard process to perform these steps for Inspection Tickets.

Inspection Tickets for Units with defects

An Inspection Ticket will be created in 'OP' status.

Inspection Tickets for Units without defects

If a PM is Due and Firmware "Inspect - Auto Create PMs" is set to 'Yes', then an Inspection Ticket will be created in 'OP' status.

If a PM is not Due, then an Inspection Ticket will be created in 'CL' status.

If a PM is Due and Firmware "Inspect - Auto Create PMs" is set to 'No', then an Inspection Ticket will be created in 'CL' status.

If a PM is not Due, then an Inspection Ticket will be created in 'CL' status.



Inspection Fields Master

A default set of Inspection Fields are provided with the Qualcomm Module.

The initial module configuration will automatically create the basic Component defect and Inspection Fields available for use when you create the Inspection Field Maps.

A "Vital" field is provided to indicate Inspection Fields that you choose to define as critical and may be used to indicate VIR component defects that are required to be corrected and repaired prior to placing the unit back in service.

The "Vital" field may be used to indicate an Inspection Field is D.O.T. critical.

You should have a process in place for Inspection issues reported for a component marked “Vital”, that will ensure the issue has been addressed and the resolution recorded.

The “Vital” flag is only an indicator, and the software does not have any provisions to enforce or require the repairs have been completed.

The listing is ordered by Component.

You may change the status from ‘A’ to ‘I’ to inactivate Fields you will not include in any Map Masters.

The number of inspection fields is unlimited.

Command Keys

F8=Toggle definition, allows the user to toggle the display to include Active Fields, Inactive Fields, or All Fields.

F20=Create SYSKEY allows the user to create a default Symptom Code for a System Code defined as an Inspection Field, when the System Code does not have any Symptom Codes defined.

Note: F20=Create SYSKEY is only displayed when a Component exists in the list, and does not have any Symptoms defined.



Inspection Fields Mapping

A default set of Inspection Fields are provided with the Qualcomm Module. One for Equipment Type “TRACTORS”, and one for Equipment Type “TRAILERS”. The Inspection Fields provided on these Inspection Maps match the Omnitracs VIR Forms.

Recommendation: Create a Field Map for Equipment Type – TRACTORS and TRAILERS, or any other Equipment Type Codes you have defined.

You may create other Inspection Maps using any of the Mapping options. The hierarchy used by the program to determine the correct Inspection Map to use is listed below. Beginning at the top of the list below, the program stops at the first match for the unit, and uses the Inspection Field Map associated with the Unit, Fleet, Activity, or Equipment Type you have defined.

Individual Unit

*ALL Units

Individual Fleet

*ALL Fleets

Individual Activity

*ALL Activities

Individual Equipment Type

*ALL Equipment Types

Command Keys

F4=Prompt - Allows the new Inspection Type to be prompted to select STANDARD or QUALCOMM.

F7=Create - Allows the user to display the Inspection Fields Mapping Master to create a new Map Master.

The initial configuration will also automatically create all required TMT Codes;

A new TMTCODE - "INSP TYPE" will be added to the TMT Codes Listing.

Two new "INSP TYPE" codes will be added, "STANDARD" and "QUALCOMM".

The "STANDARD" code will automatically be assigned to any existing Inspection Fields and Inspection Fields Maps you may have.

The default "QUALCOMM" fields will be added to the Inspection Fields Definition list during the installation of this Module.

The new Inspection Fields list can be displayed in the Inspection Tickets Menu Fields Master, Menu Selection 165, F7=Fields Master, then select 'Inspection Type' - "QUALCOMM".

The "QUALCOMM" Inspection Type code will be added to the Inspection Fields Mapping List, and two new 'Equipment Type' codes will also be added;

"TRACTOR" and "TRAILER".



The new Inspection Fields Map can be displayed in the Inspection Tickets Menu Fields Map Master, Menu Selection 165, F8=Maps Master, then select 'Inspection Type' - "QUALCOMM".

Both Equipment Types are initially created with the same list of Omnitracs default Inspection fields. You need to review the list and change the status to 'Inactive' for any of the fields that do not apply for each Equipment Type list, (TRACTOR and TRAILER), before you begin using the Qualcomm VIR interface. The Inspection fields defined in the Inspection Fields Map must exactly match the Omnitracs form you use for eDVIR Inspections provided by Omnitracs.

The Inspection Ticket will not be created if an Inspection Field Maps does not exist for the Equipment Type/Activity Code/Fleet Code/Unit.

The Inspection Ticket will not be created if the Inspection Fields Map does not match the Omnitracs form.



Qualcomm eDVIR Import Flow (TMT991QCIR)

1. TMTSECCK: Check user security.

2. TMT990WS: Get Property & Transmission record information.

3. Check for blank IFS folder or IFS file names.

4. Set HTTP debug log based on user preference.

5. Verify IFS path(s) exist and create them if they don't.

6. Check for active Profile FIELDS.

7. Check for Profile PROPERTIES.

8. Run Omnitracs Web Service request.

9. Check for HTTP and communication errors. If errors occurred, print error on report and end program.

10. Create archive of eDVIR XML file (based on user preference).

11. Scrub XML file with powerEXT.

12. Parse XML and create ITFRHEAD and ITFRBODY records. ***Defect-free inspections only create ITFRHEAD record.

13. Create and populate the values for the ITFRHEAD record:

a. THUNIT = Unit#

b. THORIG = T.7.01.0

c. THDNDT = Date message was created by the driver. Represented as yyyy/dd/mm.

d. THDNTM = Time message was created by the driver. Represented in 24-hour format.

e. THUPDT = Date message was sent from the vehicle to the Omnitracs.

Represented as yyyy/dd/mm.

f. THUPTM = Date message was sent from the vehicle to the Omnitracs.

Represented in 24-hour format.

g. THSTAT = Inspection Ticket Status.

h. THCPYV = Default value of Company Unit from FIELDS record if active else cleared.

i. THOPBY = Default value of Opened By from FIELDS record if active else cleared.

j. THOPER = Driver name (from Omnitracs).

k. THSHOP = Default value of Unit Domicile from FIELDS record if active.



l. THROPO = Blank for tractor record. Otherwise, it will contain the attached unit.

E.G. - If this Inspection is for the tractor record, THROPO will be blank.

If this inspection is for the trailer record, THROPO represents the tractor number.

m. THMETR = Unit mileage. Values come from: tractorMiles or trailerHub.

n. THID# = getRecordID('ITFRHEAD').

o. THRO = TMT Inspection Ticket ID

If this value is zero, a TMT Inspection Ticket was not created – and may be due to an invalid UnitID or other error.

14. Create and populate the values for the ITFRBODY record:

a. TBSYM = Default value of Symptom Code from FIELDS record if active else cleared.

b. TBSECT = Incremented by 1 for each defect reported.

c. TBCMT = Defect Type in bytes 1-100 & Driver's Remarks in bytes 101-4196.

d. THID# = Same as THID# from corresponding ITFRHEAD record.



Qualcomm Export – VIR Mechanic Ack

Export Setup

The initial configuration will create the required Qualcomm Export Profile – “VIR Mechanic Ack”.

An Export Profile record will be created named "VIR Mechanic Ack", used to export the VIR from TMT back to the Omnitracs console in the Unit.

A Security Code is required to implement the “Mobile Comm – Qualcomm” Module.

The Module Security Code obtained from TMT Support for the initial setup performed at the beginning of this document will also enable the VIR Mechanic Acknowledgment Export.

1. Activate the Qualcomm Import/Export Master.



c. Use Option 6 to activate the Import/Export type: Qualcomm if it is Inactive.

2. Activate the VIR Mechanic Ack Profile.

a. Use Option 2=Work With for the Import/Export type: Qualcomm.


c. Use Option 2=Work With to update the VIR Mechanic Ack profile.

d. Change "Status" to "A" to activate. Press ENTER.

e. Press ENTER and F6 to Update the profile.



3. Use Option 4=Transmission to display the Transmission screen.

a. The Module Installation program will set the default values for the Transmission record.

b. Change the Archive value to ‘Y’.

c. Press ENTER and F6 to Update the profile.

See the example Transmission Record Master below:

Figure 10



4. Use Option 5=Scheduler to update the Scheduler screen.

a. Set the Schedule Days by placing an ‘X’ under each day of the week you want the Scheduler to Export the Qualcomm VIR Mechanic Acknowledgment.

b. Enter a Start and End Time for each day.

c. Enter the Delay Interval.

i. Minimum = 5 minutes

d. The Scheduled User – Enter a UserID that has security to run this job.

e. Job Name – Enter: “QCEDVIRMA”.

f. Job Message Queue/Library – Enter: “*USRPRF”/”*LIBL”.

g. Program to Call – Enter: “TMT991QCMA”.

h. Job Description/Library - Enter: “FLEETDEV” / “TMTDATA”.

ii. These are TMT default values – if you have used other naming conventions, use your Job Description and/or Library name.

iii. After making changes to the Scheduler Record Master, press ENTER and F6 to Update the profile.

See the example Scheduler Record Master below:

Figure 11



5. Option 6=Fields is not used with the Mechanic Ack Profile.

6. Use Option 8=Properties to update the Properties. (Requires initial configuration):

a. HTTP Debug Log (N=No; B=Both).

N = No log is produced when Web Service is requested (default).

B = Debug log is produced when Web Service is requested.

b. User = Enter your Omnitracs customer user id.

c. Password = Enter your Omnitracs customer user password.

See the example Field Properties Master below:

Figure 12



Export Testing Procedures

1. Several tasks need to be performed before testing of VIR Mechanic Ack can begin:

a. VIR(s) have been created via the Omnitracs in-cab unit.

b. TMT import for VIR Messages has been successfully run.

c. Repair Orders have been created from Inspection Tickets and ALL sections on those Repair Orders have been closed, (including any sections added for repairs unrelated to the eDVIR).

a. Note: The Repair Order is not required to be closed.

2. To export VIR Mechanic Acknowledgement messages:

d. Use Menu Selection 847 - Import/Export Master.

e. Use Option 2=Work With for the Import/Export Type: Qualcomm.

f. Use Option R=Run Immediately for Profile: VIR Mechanic Ack

g. If successful, Omnitracs Web Service response will be saved as an XML file on the IFS located at:

/TMT/WebServices/Qualcomm/VIR/VIR_Mechanic_Ack.xml

h. Report(spooled file) will be produced:

i. Inspection Report.

ii. A message will be posted to Omnitracs Web Service listing any errors encountered.

Possible error messages that can appear on report include:

No VIR transactions available to process.

**ERROR: Error occured during updateReport for the maintenance package: Cannot update a VIR that is closed.

Missing Export Transmission address.

*Warning: Mechanic name is missing.

Error - Tractor# is required.

Trailer# is required.

Driver name is missing.

Error - Ref. Inspection#: 18010 Invalid Form Type:

Web Service Failure. Reason: check form avail error:"Incorrect syntax near ','" query:"open_check_form_availability 1972,"

Export Profile Property: User ID is blank.

o **Program Stopped Before Webservice Requested**



Verify the Export

XML response file representing the last message posted from running the VIR Mechanic Ack export is located in the IFS:

/TMT/WebServices/Qualcomm/VIR/VIR_Mechanic_Ack.xml

If the archive option is chosen in the Transmission record of the Import profile, the archived file(s) should be located at:

/TMT/WebServices/Qualcomm/VIR/Archive/VIR_Mechanic_Ack_(user name)_(date)_(time)_(import type sequence#)_(import profile sequence#).xml

Values displayed in ( ) represent the values used to create the Archive file name.

Omnitracs in-cab unit received the Mechanic Acknowledgement message.

All in-cab message communications can also be viewed, and may be verified, from Omnitracs Fleet Manager.

URL: https://services.omnitracs.com/portalWeb/

Confirm your Company User ID

Confirm your Password

Click on "Messages" tab

Click on "Search" tab

Upon successful completion of repairs, (all Repair Order sections are in “Closed” status, a record will be created in the Order Export file, (ORDREXPT). Program TMT164MA is called when a Repair Order with eDVIR sections, (and all sections are “Closed”), to create the Order Export file record.

The ORDREXPT/OEORIGIN Id will be ‘IT’ for Inspection Tickets.

The ORDREXPT/OEDATE and ORDREXPT/OETIME will be blank.

The ORDREXPT/OENUMB will represent the Inspection Ticket Number.

If the Order Export file record exists for the Repair Order, when the VIR Mechanic Acknowledgment scheduled job runs, the return message is sent to the Omnitracs console in the truck.

Export failures:

The Export will fail when the Security Code for Module: Mobile Comm - Qualcomm not enabled.

Export failure when User profile supplied in the Scheduling record doesn’t have adequate authority.

https://services.omnitracs.com/portalWeb/



Qualcomm Import - VIR Mechanic Acknowledgment Reports

Sample Reports generated by VIR Export

Qualcomm VIR Export Listing Report TMT991QCMA

Figure 13


VIR ID – Omnitracs Message ID

Mechanic – Mechanic ID and Name of Employee performing repairs

Resolution – Indicates the resolution for the repairs performed or not performed

Message – Message Status relevant to the Unit and VIR



Qualcomm Export Flow (TMT992QCMA)

1. Prototype: Profile Sequence, Type Sequence, Retries.

2. TMTSECCK: Check user security.

3. TMT990WS: Get Property & Transmission record information.

4. Check for Profile PROPERTIES.

5. Check for blank IFS folder or IFS file names.

6. Set HTTP debug log based on user preference.

7. Verify IFS path(s) exist and create them if they don't.

8. Retrieve VIR mechanic inspection confirmation records with a blank processing date from Order Export file.

9. Process each ORDREXPT record returned:

a. Call TMT992QC passing oenumb & ordate to return the VIR mechanic acknowledgement.

10. Validate values.

11. Build URL by combining webservice address from the transmission record and the message data in an xml string.

12. Use URL Encoding procedures to encode the XML data.

13. Post url encoded xml data to Omnitracs Web Service.

14. If program TMT990WS finds the Archive option on the Transmission record set to ‘Y’, then the xml response from the Web Service will be saved in the IFS location:

/TMT/WebServices/Qualcomm/VIR/Archive/VIR_Driver_Msg_(user name)_(date)_(time)_(import type sequence#)_(import profile sequence#).xml

Values displayed in ( ) represent the values used to create the Archive file name.

15. Scrub xml response file with powerEXT.

16. Process xml response file:

a. If unsuccessful, print error message to report.

b. If successful, update the OEDATE & OETIME fields in the Order Export file:

ORDREXPT and print message# successfully sent.

qualcomm edvir setup instructions · see the example transmission record master below: figure 5 ....

Documents