32
STW Dealer Technical Information DBS Upload Utility Validations and Uploads Prepared for Marketing & Product Support Division Caterpillar Inc.

UploadUtility_Validations

  • Upload
    lisahun

  • View
    19

  • Download
    0

Embed Size (px)

DESCRIPTION

utility for maintenance man using service code and upload validation over

Citation preview

Page 1: UploadUtility_Validations

STWDealer Technical Information

DBS Upload Utility Validations and Uploads

Prepared forMarketing & Product Support Division

Caterpillar Inc.

Page 2: UploadUtility_Validations

Documentation Information and Revision History

File Name UploadUtility_Validations.docOriginal Author Caterpillar Inc.

Version Date Author Revision Notes1.0 7/16/07 Daniel Gabrielse Initial Version

Certain parts of this document and the information herein are the property of Caterpillar Inc. and may not be reproduced,

Disclosed, revealed or used except in accordance with the executed license agreement with Caterpillar or its authorized

Sub licensor. This document may contain materials and information that were not prepared or reviewed by Caterpillar.

2

Page 3: UploadUtility_Validations

Table of contentsTABLE OF CONTENTS.......................................................................................................................3

1 INTRODUCTION..................................................................................................................5

1.1 PURPOSE..........................................................................................................................51.2 SCOPE...............................................................................................................................5

2 XML FIELD DESCRIPTIONS............................................................................................6

2.1 HEADER...........................................................................................................................62.2 SEGMENT FIELDS.............................................................................................................62.3 OPERATION FIELDS..........................................................................................................72.4 REPAIR NOTES.................................................................................................................82.5 SIMS / PART CAUSING FAILURE FIELDS.........................................................................82.6 LABOR FIELDS.................................................................................................................92.7 MISCELLANEOUS COSTS FIELDS....................................................................................102.8 MILEAGE FIELDS............................................................................................................112.9 PARTS FIELDS................................................................................................................12

3 UPLOAD ACTIONS............................................................................................................13

3.1 HEADER – STANDARD ACTIONS....................................................................................133.1.1 Format Validations....................................................................................133.1.2 DBS Validations........................................................................................13

3.2 SERVICE METER VALUES..............................................................................................143.2.1 Format Validations....................................................................................143.2.2 DBS Validations........................................................................................14

3.3 REPAIR NOTES / COMMENTS.........................................................................................143.3.1 Format Validations....................................................................................143.3.2 DBS Validations........................................................................................153.3.3 DBS Upload Actions.................................................................................15

3.4 SIMS / PART CAUSING FAILURE...................................................................................163.4.1 Format Validations....................................................................................163.4.2 DBS Validations........................................................................................163.4.3 DBS Upload Actions.................................................................................16

3.5 LABOR............................................................................................................................173.5.1 Format Validations....................................................................................173.5.2 DBS Validations........................................................................................173.5.3 DBS Upload Actions.................................................................................18

3.6 MISCELLANEOUS COST..................................................................................................183.6.1 Format Validations....................................................................................183.6.2 DBS Validations........................................................................................193.6.3 DBS Upload Actions.................................................................................19

3.7 MILEAGE........................................................................................................................203.7.1 Format Validations....................................................................................203.7.2 DBS Validations........................................................................................203.7.3 DBS Upload Actions.................................................................................21

4 DOWNLOAD ACTIONS....................................................................................................22

3

Page 4: UploadUtility_Validations

4.1 FORMAT VALIDATIONS..................................................................................................224.2 DBS VALIDATIONS........................................................................................................224.3 DBS Download Values.................................................................................................22

4

Page 5: UploadUtility_Validations

1 Introduction

1.1 PurposeThe purpose of this document is to communicate technical information relating to the functionality in DBS Upload Utility, specifically relating to any validations performed as well as DBS fields updated by the tool. This document may be communicated to all dealerships with special interest to Information Technology staff.

1.2 ScopeThis document contains information relating to the DBS Upload Utility, STW Service Report, as well as DBS/DBSi. It is assumed that DBS is at the most recent version, with supported versions including 2.3.4, 3.1, and 5.0.

5

Page 6: UploadUtility_Validations

2 XML Field DescriptionsThe following lists all node information specific to the upload and download functions of the DBS Upload Utility. This is not an exhaustive list of all portions of the Service Report content.

2.1 Header

XML Section: Service Report HeaderField Name XML Location

Version Number STWSERVICEREPORT version=""Upload Status STWSERVICEREPORT DBSUploaded=""Work Order Number STWSERVICEREPORT/REPHEADER/WORKORDERService Date STWSERVICEREPORT/REPHEADER/SERVICEDATEEmployee ID STWSERVICEREPORT/REPHEADER/EMPLOYEEIDSMU Unit STWSERVICEREPORT/REPHEADER/SMUUNITSMU Value STWSERVICEREPORT/REPHEADER/SMUSpecial Instructions STWSERVICEREPORT/REPHEADER/INSTRUCTIONSCustomer STWSERVICEREPORT/REPHEADER/CUSTOMERManufacturer STWSERVICEREPORT/REPHEADER/MANUFACTURERModel STWSERVICEREPORT/REPHEADER/MODELSerial Number STWSERVICEREPORT/REPHEADER/SERIALNUMBER

2.2 Segment Fields

XML Section: Segment NodesField Name XML Location

Segment Number STWSERVICEREPORT/SEGMENTS/SEGMENT SEGMENTNO=""Segment Description STWSERVICEREPORT/SEGMENTS/SEGMENT SEGMENTDESC=""

6

Page 7: UploadUtility_Validations

Segment Operations STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONSSegment SIMS Records STWSERVICEREPORT/SEGMENTS/SEGMENT/PARTFAILEDSegment Labor Records STWSERVICEREPORT/SEGMENTS/SEGMENT/LABORDETAILSSegment Cost Records STWSERVICEREPORT/SEGMENTS/SEGMENT/MISCCOSTSegment Mileage Records STWSERVICEREPORT/SEGMENTS/SEGMENT/MILEAGESegment Notes STWSERVICEREPORT/SEGMENTS/SEGMENT/REPAIRBKGSegment Job Code STWSERVICEREPORT/SEGMENTS/SEGMENT/SEGMENTINFO/JOBCODESegment Job Code Description

STWSERVICEREPORT/SEGMENTS/SEGMENT/SEGMENTINFO/JOBDESC

Segment Component Code STWSERVICEREPORT/SEGMENTS/SEGMENT/SEGMENTINFO/COMPONENTCODESegment Component Description

STWSERVICEREPORT/SEGMENTS/SEGMENT/SEGMENTINFO/COMPONENTDESC

Special Instructions STWSERVICEREPORT/SEGMENTS/SEGMENT/SEGMENTINFO/INSTRUCTION

2.3 Operation FieldsXML Section: Segment Nodes

Field Name XML LocationOperation Number STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION OPERATIONNO=""Operation Description STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION OPERATIONDESC=""Operation Labor Records STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/LABORDETAILSOperation Cost Records STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/MISCCOSTOperation Mileage Records STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/MILEAGEOperation Notes STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/REPAIRBKGOperation Job Code STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/OPERATIONINFO/

JOBCODEOperation Job Code Description

STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/OPERATIONINFO/JOBDESC

Operation Component Code

STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/OPERATIONINFO/COMPONENTCODE

Operation Component STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/OPERATIONINFO/COMPONENTDESC

7

Page 8: UploadUtility_Validations

DescriptionSpecial Instructions STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/OPERATIONINFO/

INSTRUCTION

2.4 Repair NotesXML Section: Segment Repair Notes

Field Name XML LocationSegment Customer Complaint

STWSERVICEREPORT/SEGMENTS/SEGMENT/REPAIRBKG/CUSTOMERCOMPLAINT

Segment Cause of Failure STWSERVICEREPORT/SEGMENTS/SEGMENT/REPAIRBKG/FAILURECAUSESegment Resulting Damage

STWSERVICEREPORT/SEGMENTS/SEGMENT/REPAIRBKG/DAMAGE

Segment Comments STWSERVICEREPORT/SEGMENTS/SEGMENT/REPAIRBKG/COMMENTS

XML Section: Operation Repair NotesField Name XML Location

Operation Customer Complaint

STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/REPAIRBKG/CUSTOMERCOMPLAINT

Operation Cause of Failure STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/REPAIRBKG/FAILURECAUSE

Operation Resulting Damage

STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/REPAIRBKG/DAMAGE

Operation Comments STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/REPAIRBKG/COMMENTS

2.5 SIMS / Part Causing Failure FieldsXML Section: SIMS / Part Causing Failure

Field Name XML LocationSIMS Part Number STWSERVICEREPORT/SEGMENTS/SEGMENT/PARTFAILED/PARTFAILEDREC/PARTNUMBERSIMS Quantity STWSERVICEREPORT/SEGMENTS/SEGMENT/PARTFAILED/PARTFAILEDREC/QTYSIMS Primary Value

STWSERVICEREPORT/SEGMENTS/SEGMENT/PARTFAILED/PARTFAILEDREC/PRIMARY

8

Page 9: UploadUtility_Validations

SIMS Secondary Value

STWSERVICEREPORT/SEGMENTS/SEGMENT/PARTFAILED/PARTFAILEDREC/SECONDARY

SIMS Group Number

STWSERVICEREPORT/SEGMENTS/SEGMENT/PARTFAILED/PARTFAILEDREC/GROUPNUMBER

SIMS Product Inoperable

STWSERVICEREPORT/SEGMENTS/SEGMENT/PARTFAILED/PARTFAILEDREC/PRODUCTINOPERABLE

SIMS Repair Comments

STWSERVICEREPORT/SEGMENTS/SEGMENT/PARTFAILED/PARTFAILEDREC/PARTFAILURECOMMENTS

2.6 Labor FieldsXML Section: Segment Level Labor Records

Field Name XML LocationLabor Employee ID STWSERVICEREPORT/SEGMENTS/SEGMENT/LABORDETAILS/LABORDETAILREC/EMPLOYEEIDLabor Date STWSERVICEREPORT/SEGMENTS/SEGMENT/LABORDETAILS/LABORDETAILREC/DATEOvertime Indicator STWSERVICEREPORT/SEGMENTS/SEGMENT/LABORDETAILS/LABORDETAILREC/OVERTIMEINDICATORLabor Code STWSERVICEREPORT/SEGMENTS/SEGMENT/LABORDETAILS/LABORDETAILREC/LABORCODEStart Time STWSERVICEREPORT/SEGMENTS/SEGMENT/LABORDETAILS/LABORDETAILREC/STARTTIMEEnd Time STWSERVICEREPORT/SEGMENTS/SEGMENT/LABORDETAILS/LABORDETAILREC/ENDTIMEMan Hour Amount STWSERVICEREPORT/SEGMENTS/SEGMENT/LABORDETAILS/LABORDETAILREC/MANHOURSLabor Shift STWSERVICEREPORT/SEGMENTS/SEGMENT/LABORDETAILS/LABORDETAILREC/SHIFT

XML Section: Operation Level Labor RecordsField Name XML Location

Employee ID STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/LABORDETAILS/LABORDETAILREC/EMPLOYEEID

Labor Date STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/LABORDETAILS/LABORDETAILREC/DATE

Overtime Indicator STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/LABORDETAILS/LABORDETAILREC/OVERTIMEINDICATOR

Labor Code STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/LABORDETAILS/

9

Page 10: UploadUtility_Validations

LABORDETAILREC/LABORCODEStart Time STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/LABORDETAILS/

LABORDETAILREC/STARTTIMEEnd Time STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/LABORDETAILS/

LABORDETAILREC/ENDTIMEMan Hour Amount STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/LABORDETAILS/

LABORDETAILREC/MANHOURSLabor Shift STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/LABORDETAILS/

LABORDETAILREC/SHIFT

2.7 Miscellaneous Costs Fields XML Section: Segment Level Miscellaneous Costs Records

Field Name XML LocationCost Employee ID STWSERVICEREPORT/SEGMENTS/SEGMENT/MISCCOST/MISCCOSTSREC/EMPLOYEEIDCost Date STWSERVICEREPORT/SEGMENTS/SEGMENT/MISCCOST/MISCCOSTSREC/DATECost Charge Code STWSERVICEREPORT/SEGMENTS/SEGMENT/MISCCOST/MISCCOSTSREC/CHARGECODECost Quantity STWSERVICEREPORT/SEGMENTS/SEGMENT/MISCCOST/MISCCOSTSREC/QTYCost Description STWSERVICEREPORT/SEGMENTS/SEGMENT/MISCCOST/MISCCOSTSREC/DESCRIPTIONCost Amount STWSERVICEREPORT/SEGMENTS/SEGMENT/MISCCOST/MISCCOSTSREC/COSTCost Comment STWSERVICEREPORT/SEGMENTS/SEGMENT/MISCCOST/MISCCOSTSREC/COMMENTS

XML Section: Operation Level Miscellaneous Costs RecordsField Name XML Location

Cost Employee ID STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/MISCCOST/MISCCOSTSREC/EMPLOYEEID

Cost Date STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/MISCCOST/MISCCOSTSREC/DATE

Cost Charge Code STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/MISCCOST/MISCCOSTSREC/CHARGECODE

Cost Quantity STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/MISCCOST/MISCCOSTSREC/QTYCost Description STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/MISCCOST/MISCCOSTSREC/

10

Page 11: UploadUtility_Validations

DESCRIPTIONCost Amount STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/MISCCOST/MISCCOSTSREC/

COSTCost Comment STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/MISCCOST/MISCCOSTSREC/

COMMENTS

2.8 Mileage Fields XML Section: Segment Level Mileage Records

Field Name XML LocationMileage Employee ID

STWSERVICEREPORT/SEGMENTS/SEGMENT/MISCCOST/MISCCOSTSREC/EMPLOYEEID

Mileage Vehicle STWSERVICEREPORT/SEGMENTS/SEGMENT/MISCCOST/MISCCOSTSREC/VEHICLEMileage Date STWSERVICEREPORT/SEGMENTS/SEGMENT/MISCCOST/MISCCOSTSREC/DATEMileage Code STWSERVICEREPORT/SEGMENTS/SEGMENT/MISCCOST/MISCCOSTSREC/CHARGECODEMileage Quantity STWSERVICEREPORT/SEGMENTS/SEGMENT/MISCCOST/MISCCOSTSREC/QTY

XML Section: Operation Level Mileage RecordsField Name XML Location

Mileage Employee ID

STWSERVICEREPORT/SEGMENTS/SEGMENT/MISCCOST/MISCCOSTSREC/EMPLOYEEID

Mileage Vehicle STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/MISCCOST/MISCCOSTSREC/VEHICLE

Mileage Date STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/MISCCOST/MISCCOSTSREC/DATE

Mileage Code STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/MISCCOST/MISCCOSTSREC/CHARGECODE

Mileage Quantity STWSERVICEREPORT/SEGMENTS/SEGMENT/OPERATIONS/OPERATION/MISCCOST/MISCCOSTSREC/QTY

2.9 Parts Fields XML Section: Segment Level Parts Records

Field Name XML Location

11

Page 12: UploadUtility_Validations

Order ID STWSERVICEREPORT/SEGMENTS/SEGMENT/PARTORDERRECS/PARTORDERREC/ORDERIDPart Work Order STWSERVICEREPORT/SEGMENTS/SEGMENT/PARTORDERRECS/PARTORDERREC/WORKORDERPart Operation STWSERVICEREPORT/SEGMENTS/SEGMENT/PARTORDERRECS/PARTORDERREC/OPERATIONPart Order Notes STWSERVICEREPORT/SEGMENTS/SEGMENT/PARTORDERRECS/PARTORDERREC/ADDNOTES

XML Section: Operation Level Mileage RecordsField Name XML Location

Part Number STWSERVICEREPORT/SEGMENTS/SEGMENT/PARTORDERRECS/PARTORDERREC/PART/PARTNUMBERPart Quantity STWSERVICEREPORT/SEGMENTS/SEGMENT/PARTORDERRECS/PARTORDERREC/PART/QUANTITYPart SMCS STWSERVICEREPORT/SEGMENTS/SEGMENT/PARTORDERRECS/PARTORDERREC/PART/SMCSPart Note STWSERVICEREPORT/SEGMENTS/SEGMENT/PARTORDERRECS/PARTORDERREC/PART/NOTEPart Name STWSERVICEREPORT/SEGMENTS/SEGMENT/PARTORDERRECS/PARTORDERREC/PART/NAMEPart Group STWSERVICEREPORT/SEGMENTS/SEGMENT/PARTORDERRECS/PARTORDERREC/PART/GROUPIDPart Group Name STWSERVICEREPORT/SEGMENTS/SEGMENT/PARTORDERRECS/PARTORDERREC/PARTGROUPNAME

12

Page 13: UploadUtility_Validations

3 Upload ActionsThe following sections describe the various validations and processes for each uploadable area of the Service Report. There are two steps in the validation process. Local validations are those that are performed without being connected to DBS. Local validations allow the utility to determine issues with file formatting prior to establishing a connection to DBS. DBS Validations are those that require a connection to DBS. DBS Validations corroborate the data in the report with the values in DBS.

There are two advantages to this setup. First, performance is greatly improved, as there is no local connection to DBS required at this point. Second, we are able to validate all file information prior to connecting to DBS. The result is being able to show all issues to the user at one time, rather than repeating the process over and over.

3.1 Header – Standard ActionsThese validations are performed regardless of the user-selected areas being uploaded.

3.1.1 Format Validations

Validation Name: Standard Header ValidationField Validation

Version Number Value > 2004AUpload Status Value = FALSE or blankWork Order Number Length >0, <11Date Validation Year Value > 1969Employee ID Validation Length > 0, < 5Segment Number Length > 0, <3Operation Number Length > 0, <3

3.1.2 DBS Validations

DBS Validation Work Order DBS ValidationDescription Field Validation

Work Order Exists XML Field: Work Order Number

Exists in Work Order file: [WOPHDRS0].[WONO]

Work Order State [WOPHDRS0].[ACTI] Value = “O”Employee ID exists XML Field: EmployeeID Exists in employee file:

[WOPLEMP0].[EPIDNO]All segments exist Segment Number Exists in Segment file:

[WOPSEGS0]All operations exist Operation Number Exists in Operation file:

[WOPOPER0]

13

Page 14: UploadUtility_Validations

3.2 Service Meter ValuesThese validations will only be performed in the case that the user has selected SMU to be uploaded into DBS.

3.2.1 Format Validations

Validation Name: SMU ValidationField Validation

SMU Unit Value in {HOURS, MILES, KILOMETERS}SMU Value Value > 0

3.2.2 DBS Validations

DBS Validation SMU DBS ValidationDescription Field Validation

Equipment Validation

[WOPHDRS0].[EQMFSN], [WOPHDRS0].[EQMFCD]

Combination exists in equipment data file: [EMPEQPD0]

If no matching record is found, the upload continues and assumes the unit measure is correct

SMU Unit validation

XML Field: SMU Unit Equipment SMU Unit [EMPEQPD0].[USGCDE] matches

3.3 Repair Notes / CommentsThese validations will only be performed in the case that the user has selected repair comments to be uploaded into DBS.

3.3.1 Format Validations

Validation Name: Notes ValidationPlease be aware that blank fields will be skipped and not cause an error

Field ValidationSegment Customer Complaint Length > 0Segment Cause of Failure Length > 0Segment Resulting Damage Length > 0Segment Comments Length > 0Operation Customer Complaint Length > 0Operation Cause of Failure Length > 0Operation Resulting Damage Length > 0Operation Comments Length > 0

14

Page 15: UploadUtility_Validations

3.3.2 DBS Validations

DBS Validation SMU DBS ValidationDescription Field Validation

Segment Note count

[WOPNOTE0] Count of note record (with [NTLNO1] being a value between 000 and 999) is < 999 for the segment

Operation Note count

[WOPNOTE0] Count of note record (with [NTLNO1] being a value between 000 and 999) is < 999 for the operation

3.3.3 DBS Upload Actions

DBS Table: WOPNOTE0Table Action: Insert

Description: Record created by the utility. Note that a record is created for every 50 characters of text.

DBS Field Source Value[WONO] XML Field XML Field: Work Order Number[WOSEGNO] XML Field XML Field: Segment Number[WOOPNO] XML Field XML Field: Operation Number[NTLNO1] Calculated Field Calculated Field: Incremented line number[NTDA] XML Field XML Field: Segment / Operation Note[MASTRI] Preference

ValuePreference Value: Internal, External, Both {I, E, B}

DBS Table: WOPHDRS0Table Action: Update

Description: Header table is updated with the latest record totalsDBS Field Source Value

[NONOTE] Calculated Incremented record count

DBS Table: WOPSEGSS0Table Action: Update

Description: Update segment totals to account for new recordsDBS Field Source Value

[NONOTE] Calculated Incremented record count

DBS Table: WOPOPERS0

15

Page 16: UploadUtility_Validations

Table Action: UpdateDescription: Update operation totals to account for new records

DBS Field Source Value[NONOTE] Calculated Incremented record count

3.4 SIMS / Part Causing FailureThese validations will only be performed in the case that the user has selected SIMS / Part Causing Failure to be uploaded into DBS.

3.4.1 Format Validations

Validation Name: SIMSValidationIf count = 0, the section is skippedEither a PRIMARY or SECONDARY value is required

Field ValidationCount of records Count > 0SIMS Part Number Length > 0, <21SIMS Quantity Value > 0SIMS Primary Length > 0, or SECONDARYSIMS Secondary Length > 0, or PRIMARYSIMS Group Number Length > 0, <21SIMS Product Inoperable Value in {n, N, y, Y}SIMS Comment Length < 21

3.4.2 DBS Validations

DBS Validation SIMS DBS ValidationDescription Field Validation

Record Count by Segment

[WOPSIMS0].[WONO],[WOPSIMS0].[WOSGNO]

Count of existing records (by work order and segment) should not exceed 9

3.4.3 DBS Upload Actions

DBS Table: WOPSIMS0Table Action: Insert

Description: SIMS record is inserted into the SIMS tableDBS Field Source Value

[WONO] XML Field Work Order Number[WOSGNO] XML Field Segment Number[RCDCD] Calculated Incremented record index[DLCMCD] Static Value Space (literally: “ “)[EPIDNO] XML Field Employee ID

16

Page 17: UploadUtility_Validations

[PIPDHR] XML Field SMU value (if unit is “Hours”)[PIPDMI] XML Field SMU value (if unit is “Miles”)[DOCDT8] XML Field Service Date[RPTYP] Static Value “1”[PANO20] XML Field SIMS Part Number (specially formatted)[QTY4] XML Field SIMS Quantity[PPDC] XML Field SIMS Primary or SIMS Secondary[GPAN20] XML Field SIMS Group Number[IOPI] XML Field SIMS Product Inoperable[CMNT] XML Field SIMS Comment (padded to the right)[LSMN8] XML Field Current Date[PCSSUI] Static Value Space (literally: “ “)

DBS Table: WOPSEGS0Table Action: Update

Description: Update segment totals to account for new SIMS recordDBS Field Source Value

[SMSSUI] Calculated Incremented record count

3.5 Labor3.5.1 Format Validations

Validation Name: Local Labor ValidationsIf count = 0, the section is skippedAll validation apply to the segment-level as well as operation-level records

Field ValidationCount of records Count > 0Labor Employee ID Length = 4Labor Code Length > 0, < 4Overtime Indicator Length = 1Man Hour Amount Value < 99.99

3.5.2 DBS Validations

DBS Validation Labor DBS Validation – StoreDescription Field Validation

Store associated to work order exists

[WOPSTPR0].[STNO] Query on store returns a valid store.

Labor Approval value set

[WOPSTPR0].[LBRAPV] Value must equal a “Y” in order to continue with the upload

Employee associated to labor record is valid

[WOPLEMP0].[EMPID] Value from Labor Employee ID is found

17

Page 18: UploadUtility_Validations

Labor code is valid [WOPLSL10].[CGCD] Value from Labor Code is found in labor code table

3.5.3 DBS Upload Actions

DBS Table: WOPSIMS0Table Action: Insert

Description: SIMS record is inserted into the SIMS tableDBS Field Source Value

[LABWO] XML Field Work Order Number[LABSEG] XML Field Segment Number[LABOP] XML Field Operation Number[LABCC] XML Field Labor Charge Code[LABSEQ] Calculated Index number[LABEMP] XML Field Labor Employee ID[LABBAD] DBS Field Employee Badge [WOPLEMP0].[EMPBAD][LABBRN] DBS Field Employee Branch [WOPLEMP0].

[EMPBRN][LABAGP] DBS Field Employee Approval Group [WOPLEMP0].

[EMPAGP][LABSHF] XML Field Labor Shift[LABOTI] XML Field Labor Overtime Indicator[LABDA8] XML Field Labor Date[LABST] XML Field Labor Start[LABSTP] XML Field Labor Stop[LABELT] Calculated Calculated from Labor Start and Labor Stop[LABRS] Calculated Rounded decimal from Labor Start[LABRSP] Calculated Rounded decimal from Labor Stop[LABCLK] Static Value “STW”[LABCHGI] Static Value Space (literally: “ “)[EMPRNR] Static Value “W”[EMPNM] DBS Field Employee Badge [WOPLEMP0].[EMPNM]

3.6 Miscellaneous Cost3.6.1 Format Validations

Validation Name: Local Misc Cost ValidationsIf count = 0, the section is skippedAll validation apply to the segment-level as well as operation-level records

Field ValidationCount of records Count > 0Cost Employee ID Length = 4Cost Charge Code Length = 3

18

Page 19: UploadUtility_Validations

Cost Quantity Value > 0Cost Amount Value > 0

3.6.2 DBS Validations

DBS Validation Misc Cost DBS Validation

We validate for wildcard values in the table. As an example, store “1*” includes stores 10, 11, 12, etc. This validation is done for Store, Cost Center, and Customer Class in the Misc Cost Code table

Description Field ValidationCost code is valid [WOPMSL20].[CGCD] Value from Cost Code is found

cost code tableCost Code is valid for Cost Center, Store, and Customer Class

[WOPMSL20].[CGCD],[WOPMSL20].[CSCC], [WOPMSL20].[STN1], [WOPMSL20].[MCCC]

A cost code record with the combination of Cost Center ([CSCC]), Store Number ([STN1]), and Customer class ([MCCC]) is found.

3.6.3 DBS Upload Actions

DBS Table: WOPMISC0Table Action: Insert

Description: SIMS record is inserted into the SIMS tableDBS Field Source Value

[WONO] XML Field Work Order Number[WOSGNO] XML Field Segment Number[WOOPNO] XML Field Operation Number[CGCD] XML Field Cost Charge Code[SQNO1] Calculated Sequence Number (Iterated)[UNCS] XML Field Cost Amount[PROVI] Calculated If Cost > 0, value = “C”, else space (“ “)[CUNO] DBS Field [WOPHDRS0].[CUNO][EPIDNO] XML Field Cost Employee ID[QTY5] XML Field Cost Quantity[PONO] DBS Field [WOPHDRS0].[CUPONO][VHNO] Static Value Space (literally “ “)[CSCC] DBS Field [WOPSEGS0].[CSCC][STN1] DBS Field [WOPSEGS0].[STN1][TRXCD] Static Value “74”[DOCDT8] XML Field Cost Date[LSMN8] XML Field Cost Date

DBS Table: WOPSEGS0

19

Page 20: UploadUtility_Validations

Table Action: UpdateDescription: Update segment totals to account for new cost record

DBS Field Source Value[MCRCCT] Calculated Incremented record count

DBS Table: WOPOPERS0Table Action: Update

Description: Update operation totals to account for new cost recordDBS Field Source Value

[MCRCCT] Calculated Incremented record count

3.7 Mileage3.7.1 Format Validations

Validation Name: Local Mileage Cost ValidationsIf count = 0, the section is skippedAll validation apply to the segment-level as well as operation-level records

Field ValidationCount of records Count > 0Employee ID Length = 4Charge Code Length = 3Quantity Value > 0Vehicle Length >0, <5

3.7.2 DBS Validations

DBS Validation Mileage DBS Validation

We validate for wildcard values in the table. As an example, store “1*” includes stores 10, 11, 12, etc. This validation is done for Store, Cost Center, and Customer Class in the Misc Cost Code table

Description Field ValidationCost code is valid [WOPMSL20].[CGCD] Value from Cost Code is found

cost code tableCost Code is valid for Cost Center, Store, and Customer Class

[WOPMSL20].[CGCD],[WOPMSL20].[CSCC], [WOPMSL20].[STN1], [WOPMSL20].[MCCC]

A cost code record with the combination of Cost Center ([CSCC]), Store Number ([STN1]), and Customer class ([MCCC]) is found.

20

Page 21: UploadUtility_Validations

3.7.3 DBS Upload Actions

DBS Table: WOPMISC0Table Action: Insert

Description: Mileage record is inserted into the Misc tableDBS Field Source Value

[WONO] XML Field Work Order Number[WOSGNO] XML Field Segment Number[WOOPNO] XML Field Operation Number[CGCD] XML Field Cost Charge Code[SQNO1] Calculated Sequence Number (Iterated)[UNCS] Static Value 0[PROVI] Calculated Space (literally “ “)[CUNO] DBS Field [WOPHDRS0].[CUNO][EPIDNO] XML Field Mileage Employee ID[QTY5] XML Field Mileage Quantity[PONO] DBS Field [WOPHDRS0].[CUPONO][VHNO] Static Value Mileage Vehicle[CSCC] DBS Field [WOPSEGS0].[CSCC][STN1] DBS Field [WOPSEGS0].[STN1][TRXCD] Static Value “74”[DOCDT8] XML Field Cost Date[LSMN8] XML Field Cost Date

DBS Table: WOPSEGS0Table Action: Update

Description: Update segment totals to account for new mileage recordDBS Field Source Value

[MCRCCT] Calculated Incremented record count

DBS Table: WOPOPERS0Table Action: Update

Description: Update operation totals to account for new mileage recordDBS Field Source Value

[MCRCCT] Calculated Incremented record count

21

Page 22: UploadUtility_Validations

4 Download Actions

4.1 Format Validations

Validation Name: Work Order NumberField Validation

Work Order Length > 0, <11

4.2 DBS Validations

DBS Validation Work Order ValidationsDescription Field Validation

Work Order existsWork Order is open [WOPHDRS0].[ACTI] Value = “O”Store number setAt least one Segment exists

4.3 DBS Download Values

DBS Table: WOPHDRS0Table Action: Read

Description: Values read from header fileXML Location Value Type Value

Work Order Number DBS File [WOPHDRS0].[WONO]Truck Cab Type DBS File [WOPHDRS0].[CABTY1]Customer Name DBS File [WOPHDRS0].[CUNM]Promise Date DBS File [WOPHDRS0].[PRMDT8]Customer equipment number

DBS File [WOPHDRS0].[CUEQNO]

Manufacturer Computed If “AA”, Manufacturer set to “Caterpillar Inc.” - [WOPHDRS0].[EQMFCD]

Serial Number DBS File [WOPHDRS0].[EQMFSN]Model DBS File [WOPHDRS0].[EQMFMD]In Date DBS File [WOPHDRS0].[PRMDT8]Out Date DBS File [WOPHDRS0].[PRMDT8]Service Date DBS File [WOPHDRS0].[PRMDT8]

DBS Table: WOPSEGS0

22

Page 23: UploadUtility_Validations

Table Action: ReadDescription: Values read from segment file for each segment

XML Location Value Type ValueSegment Number DBS File [WOPSEGS0].[WOSGNO]Segment Job Code DBS File [JBCD]Segment Job Desc. DBS File [JBCDDS]Segment Component Code

DBS File [CPTCD]

Segment Component Code Description

DBS File [CPTCDD]

DBS Table: WOPOPER0Table Action: Read

Description: Values read from operation file for each operationXML Location Value Type Value

Operation Number DBS File [WOPOPER0].[WOOPNO]Operation Job Code DBS File [JBCD]Operation Job Desc. DBS File [JBCDDS]Operation Component Code

DBS File [CPTCD]

Operation Component Code Description

DBS File [CPTCDD]

DBS Table: WOPNOTE0Table Action: Read

Description: Values read from note record for header, segments and operations

XML Location Value Type ValueHeader Instructions DBS File, where sequence

number in {“WWW”, “XXX”, “YYY”, “ZZZ”)

[WOPNOTE0].[NTDA]

Segment Instructions DBS File, where sequence number in {“WWW”, “XXX”, “YYY”, “ZZZ”)

[WOPNOTE0].[NTDA]

Operation Instructions DBS File, where sequence number in {“WWW”, “XXX”, “YYY”, “ZZZ”)

[WOPNOTE0].[NTDA]

DBS Table: WOPSTDL0Table Action: Read

Description: Values read from store fileXML Location Value Type Value

Dealer Code DBS File [WOPSTDL0].[STNO]

23

Page 24: UploadUtility_Validations

DBS Table: WOPPART0Table Action: Read

Description: Values read from segment file for each segmentXML Location Value Type Value

Order ID DBS File [RFDCNO]Part Number DBS File [PANO20]Part Quantity DBS File [ORQY]Part Name DBS File [DS18]

24