97
ConSol Datamart Specification Version 5.1 Published 3 July 2017 Yarris Pty Ltd Copyright and Disclaimer Notice This document and any attachments/appendices are confidential and may contain legally privileged information and/or copyright material of Yarris Pty Ltd or third parties. Recipients of this document shall not copy, reproduce, distribute or commercialise any part of the material without explicit written consent from Yarris Pty Ltd.

ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

Embed Size (px)

Citation preview

Page 1: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

ConSol Datamart SpecificationVersion 5.1

Published 3 July 2017

Yarris Pty Ltd

Copyright and Disclaimer NoticeThis document and any attachments/appendices are confidential and may contain legally privileged information and/or copyright material of Yarris Pty Ltd or third parties. Recipients of this document shall not copy, reproduce, distribute or commercialise any part of the material without explicit written consent from Yarris Pty Ltd.

Page 2: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

Table of Contents1 INTRODUCTION................................................................................................................................ 1

1.1 Summary................................................................................................................................ 11.2 Scope..................................................................................................................................... 1

2 APPROACH....................................................................................................................................... 22.1 Extract Type........................................................................................................................... 22.2 Initial Load / Full Refresh........................................................................................................22.3 Timing..................................................................................................................................... 22.4 File Names and Locations......................................................................................................32.5 File Transfer Process.............................................................................................................42.6 Extract Load Order................................................................................................................. 42.7 File Structure.......................................................................................................................... 5

2.7.1 Entity Detail Extract Delta..................................................................................................62.7.2 Entity History Extract Delta................................................................................................62.7.3 Master Data Extract...........................................................................................................6

2.8 Monitoring............................................................................................................................... 62.9 Backups.................................................................................................................................. 7

3 DATA DICTIONARY............................................................................................................................ 83.1 Status Codes.......................................................................................................................... 9

3.1.1 Project................................................................................................................................ 93.1.2 Order.................................................................................................................................. 93.1.3 Supplier Quote................................................................................................................. 103.1.4 Invoice.............................................................................................................................. 103.1.5 Contract........................................................................................................................... 103.1.6 Order Invoice History – Status.........................................................................................113.1.7 Order History – Note Type...............................................................................................143.1.8 Milestone Status...............................................................................................................153.1.9 Compliance Document Status..........................................................................................153.1.10 Compliance Document Type............................................................................................163.1.11 Item Version Type............................................................................................................16

4 DATA EXTRACTS.............................................................................................................................. 164.1 Summary Extract.................................................................................................................. 16

4.1.1 Data Dictionary................................................................................................................164.1.2 Design Rules:...................................................................................................................17

4.2 Attribute Master Extract........................................................................................................174.2.1 Data Dictionary................................................................................................................174.2.2 Design Rules:...................................................................................................................20

4.3 Attribute List Master Extract..................................................................................................204.3.1 Data Dictionary................................................................................................................204.3.2 Design Rules....................................................................................................................21

4.4 WIP Master Extract...............................................................................................................214.4.1 Data Dictionary................................................................................................................214.4.2 Design Rules:...................................................................................................................22

4.5 Milestone Type Master Extract.............................................................................................224.5.1 Data Dictionary................................................................................................................224.5.2 Design Rules....................................................................................................................23

ConSol Datamart Specification

Page 3: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

4.6 Work Type Master Extract....................................................................................................234.6.1 Data Dictionary................................................................................................................244.6.2 Design Rules....................................................................................................................24

4.7 Compliance Document Master Extract.................................................................................244.7.1 Data Dictionary................................................................................................................244.7.2 Design Rules:...................................................................................................................25

4.8 Removed Orders Master Extract..........................................................................................254.8.1 Data Dictionary................................................................................................................264.8.2 Design Rules:...................................................................................................................26

4.9 Deleted Event Details Extract...............................................................................................264.9.1 Data Dictionary................................................................................................................264.9.2 Design Rules:...................................................................................................................27

4.10 Contract Details Extract Delta.........................................................................................274.10.1 Data Dictionary................................................................................................................274.10.2 Design Rules:...................................................................................................................29

4.11 SOR History Extract Delta...............................................................................................294.11.1 Data Dictionary................................................................................................................294.11.2 Design Rules:...................................................................................................................30

4.12 Contract History Extract Delta.........................................................................................314.12.1 Data Dictionary................................................................................................................314.12.2 Design Rules:...................................................................................................................31

4.13 Project Details Extract Delta............................................................................................324.13.1 Data Dictionary................................................................................................................324.13.2 Design Rules:...................................................................................................................33

4.14 Project History Delta Extract............................................................................................334.14.1 Data Dictionary................................................................................................................344.14.2 Design Rules:...................................................................................................................34

4.15 Order Details Extract Delta..............................................................................................344.15.1 Data Dictionary................................................................................................................344.15.2 Design Rules:...................................................................................................................40

4.16 Attribute Detail Extract Delta...........................................................................................404.16.1 Data Dictionary................................................................................................................404.16.2 Design Rules....................................................................................................................41

4.17 Milestone Details Delta Extract........................................................................................424.17.1 Data Dictionary................................................................................................................424.17.2 Design Rules:...................................................................................................................44

4.18 Metadata Extract Delta....................................................................................................444.18.1 Data Dictionary................................................................................................................444.18.2 Design Rules:...................................................................................................................45

4.19 App Survey Extract Delta................................................................................................454.19.1 Data Dictionary................................................................................................................454.19.2 Design Rules:...................................................................................................................46

4.20 Survey Actions Extract Delta...........................................................................................464.20.1 Data Dictionary................................................................................................................464.20.2 Design Rules:...................................................................................................................47

4.21 Invoice Details Extract Delta............................................................................................474.21.1 Data Dictionary................................................................................................................474.21.2 Design Rules:...................................................................................................................50

ConSol Datamart Specification

Page 4: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

4.22 Claim History Extract Delta..............................................................................................504.22.1 Data Dictionary................................................................................................................504.22.2 Design Rules:...................................................................................................................51

4.23 Order Invoice History Extract Delta.................................................................................514.23.1 Data Dictionary................................................................................................................514.23.2 Design Rules:...................................................................................................................53

4.24 Order Item Details Extract Delta......................................................................................534.24.1 Data Dictionary................................................................................................................534.24.2 Design Rules:...................................................................................................................54

4.25 Invoice Item Details Extract Delta....................................................................................544.25.1 Data Dictionary................................................................................................................544.25.2 Design Rules:...................................................................................................................55

4.26 Item History Extract Delta................................................................................................554.26.1 Data Dictionary................................................................................................................554.26.2 Design Rules:...................................................................................................................56

4.27 Item Variation Extract Delta.............................................................................................574.27.1 Data Dictionary................................................................................................................574.27.2 Design Rules:...................................................................................................................58

4.28 Attribute History Extract Delta..........................................................................................584.28.1 Data Dictionary................................................................................................................584.28.2 Design Rules....................................................................................................................59

4.29 Document Details Extract Delta.......................................................................................594.29.1 Data Dictionary................................................................................................................594.29.2 Design Rules....................................................................................................................61

4.30 Milestone History Delta Extract........................................................................................614.30.1 Data Dictionary................................................................................................................614.30.2 Design Rules....................................................................................................................62

ConSol Datamart Specification

Page 5: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

Document Control SheetThe purpose of these sections is to capture all changes made to the content of document.Document Title:Document Title ConSol Datamart specification

Document Revision 5.1

Document Date 3 July 2017

Document Creator Trish McIlwraith

Document Owner Trish McIlwraith

Revision History:Version No Version Date Nature of Change Author of Change

1.0 8th June, 2012 Initial Creation Satheesh Nunna

1.1 14th June, 2012 Updates to Extracts Satheesh Nunna

1.2 11th July, 2012 Updates to Extracts Satheesh Nunna

1.3 20th July, 2012 Updates as per customer feedback Satheesh Nunna

1.4 28th August, 2012 Updates to document Trish McIlwraith

1.5 10th September, 2012Redefinition of Order Details, Invoice Item Details and Order Items Details extracts

Trish McIlwraith

1.6 13th September, 2012 Minor Corrections and inclusions Trish McIlwraith

1.7 17th September, 2012 Addition of Invoice Item and Invoice Variation extracts Trish McIlwraith

1.8 18th September, 2012 Minor modifications Trish McIlwraith

1.9 15th October, 2012Column names changed for Invoice details Extract delta and Item Variation Extract Delta.

Srinivasa Parupalli

1.10 17th October 2012Updates to Section 2.4 and Changed column description for Contract Administrator

Srinivasa Parupalli

1.11 17th October 2012

Order Invoice History :COMMENT column length is changed.

New column added to the Item History Extract

Srinivasa Parupalli

1.12 23rd October 2012

Updated Data dictionary

Updated Attribute History > Attribute Value : Field length and Description changed.

Srinivasa Parupalli

1.13 24th October 2012Order Item Detail (4.9.1) – field length changed, Item History (4.11.2) – change to rules

Trish McIlwraith

ConSol Datamart Specification

Page 6: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

1.14 2nd November 2012Extend field length for Project_Ref_Id (4.4.1) and Reference_Nr (4.6.1) fields to accommodate imported characters

Trish McIlwraith

1.15 9nd November 2012Remove Project No from Other Customer Order in Order Detail extract

Trish McIlwraith

2.0 02nd January 2013

Extend to include Work type Master extract and Work Type in Project View and Order Details extracts. Review and tidy up of all extracts. Include Contract & Milestone extracts

Trish McIlwraith

2.1 08th January 2013 Inclusion of Metadata and App Survey extracts Trish McIlwraith

2.2 14h January 2013 Revision after feedback from Marcus & Ian Trish McIlwraith

2.3 30h January 2013Inclusion of Supplier Operations user into Order Details extract

Trish McIlwraith

2.4 13th February 2013 Inclusion of Attribute Detail extract Trish McIlwraith

2.5 21st February 2013 Inclusion of Refuse Order Master extract Trish McIlwraith

2.6 14th March 2013 Changes after review from the customer Trish McIlwraith

2.7 14th May 2013

Update – Include Docket Dates on Invoices, Compliance expiry date, Interface flag on Orders & PV, Document extract, Survey Action extract, column name changes

Trish McIlwraith

2.8 9th June 2013Include additional column in App Survey Extract. Rename ‘Refused Order Master’ to ‘Removed Order Master’. Clarify file creation and naming conventions

Trish McIlwraith

2.9 2nd July 2013Change SOR Master to SOR Detail extract, Modify Primary key definition in Compliance Document Master extract to ensure uniqueness

Trish McIlwraith

2.10 7th October 2013Minor changes to file naming convention, changes to mandatory nature of some fields, Extended code set for new PV status codes

Trish McIlwraith

3.0 28th February 2014

Update Code lists. Separate Address Location in Order Details extract into different fields. Update Milestone status table, Milestone Details extract and introduce Milestone History extract

Trish McIlwraith

3.1 18th March 2014Inclusion of GST & Auditable flags on SOR extract. Inclusion of ‘Deleted Records’ extract

Trish McIlwraith

3.2 25th March 2014Inclusion of Effective From and Effective To dates in SOR extract; supplier company number in invoice details extract

Trish McIlwraith

3.3 16th May 2014 Removed Batch Id from Milestone History extract Trish McIlwraith

ConSol Datamart Specification

Page 7: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

3.4 29th August 2014 Corrections to text Trish McIlwraith

3.5 25th September 2014Inclusion of IntegralPLUS related fields PMO_NR and OP_NR to extracts

Hamish Goddard

3.6 26th September 2014 Correction to PMO_NR label Hamish Goddard

3.7 24th February 2015Convert SOR to History extract and changes to SOR extract (p33).

Trish McIlwraith

3.8 24th March 2015Convert Deleted Events extract from Master to Delta (p 30)

Trish McIlwraith

3.9 15th July 2015Update to Datamart services and inclusion of SLAs – no change to extracts (p7)

Trish McIlwraith

4.0 24th September 2015

Inclusion of Geo-cordinates in Order Details extract and Order Invoice History extract.

Inclusion of Used Qty in the Order Item details extract.

Inclusion of new BASELINE_DATE field and change name of TARGET_DATE to FORECAST_DATE in Milestone Details delta extract.

Trish McIlwraith, Hamish Goddard

4.1 8 October 2015Removed section 2.10 Service Level Agreement (redundant). Changes to Milestone Details and Milestone Type extracts.

Hamish Goddard, Norval Hope

4.2 5 November 2015

Order Invoice History extract changes:

Removal of ‘Subtype’ field

GPS longitude and latitude field positions reordered

Hamish Goddard

4.3 28 February 2017Extension of document history extract field FORM_ID from 8 to 16 characters

Hamish Goddard

5.0 14 June 2017

Introduction of Claim History extract

Introduction of Batch Job extract.

Extended length of Attribute Name in Attribute Master extract

Extend length of Special Instructions in Order Details extract

Extend Contract Details extract to identify method of invoicing and contract category

Multiple changes to Document History extract

Apply filter to Datamart processor to remove non-standard characters

Introduce ‘Sequence’ column to Order Invoice History extract

Trish McIlwraith

ConSol Datamart Specification

Page 8: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

5.1 3 July 2017Changes to Batch Job extract – renamed to Summary. Change position of Data_Refresh_Date column in Item History extract & Order Invoice History extract

Norval Hope

Contacts for Enquires and Proposed Changes:If you have queries regarding this document, please contact:

Name Designation Phone Email AddressTrish McIlwraith Business Analysis Manager & Product

Owner0422 055 337 [email protected]

Hamish Goddard BA & Account Manager 0422 475 701 [email protected]

Norval Hope Solutions Architect & Development Manager

0405 527 884 [email protected]

Prasanna Konda Test Manager [email protected]

ConSol Datamart Specification

Page 9: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

1 INTRODUCTION

1.1 Summary

ConSol customers require the facility to extract key information from the application system so that they can report on it in their own BI environment.This approach will provide the following advantages:

1. Greater flexibility and agility in delivery of reports.2. Ability to report across whole of business using in-house data integration approaches.3. Protection from future technology changes in Yarris.

The extracted data, referred to as the Datamart, will be the single reporting entity that will be utilised by customers. This document details the scope and structure of the Datamart.

1.2 Scope

The extracts included within the Datamart correspond, to some extent, with the main ConSol entities. This presents a rationalised, business-oriented view of the application data.

Three types of extract files are created: Master Extracts – information/code sets: Removed Orders, Attributes, WIP Events, Compliance

Docs, Work Type and Milestone Type Detail Extracts – detail relating to the core reporting entities: Summary, Projects, Orders, Items,

Invoices, Contracts, Rates, Attributes and Milestones History Extracts – changes that have occurred within the processing window relating to core

reporting entities

Data Master Extracts:

∙ Attribute Master∙ Attribute List Master∙ WIP Master. Work Type Master. Milestone Type Master∙ Compliance Documents Master∙ Removed Orders Master

Entity Detail Extracts:

∙ _0_Summary∙ Project Details Delta∙ Order Details Delta∙ Order Item Details Delta∙ Attribute Details Delta∙ Invoice Details Delta∙ Invoice Item Details Delta. Item Variation Delta∙ Contract Details Delta. Milestone Details Delta. Metadata Details Delta

ConSol Datamart Specification Page 1

Page 10: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

. App Survey Details Delta∙ Deleted Event Details Delta∙ Document Detail Delta

Entity History Extracts:

∙ Project History Delta∙ Order Invoice History Delta∙ Item History Delta∙ Attribute History Delta∙ Contract History Delta∙ Survey Action Delta∙ Milestone History Delta∙ SOR History Delta∙ Claims History Delta

2 APPROACH

2.1 Extract Type

Each of the Detail and History extracts will be provided as a delta file. The delta processing will be based on a last extracted date and each delta file will contain only data that has changed since the last successful extraction. This approach allows us to set the last extracted date to a date prior to ‘ConSol Go Live’ to provide a full refresh in the event of problems.

2.2 Initial Load / Full Refresh

The extracts operate over a time window when providing delta extracts. This can be extended to the complete database history for the initial load. This mechanism can also be used to recover from a Datamart corruption, if required.

Delta datamarts are delivered in file names of the form {CUSTOMER}Datamart_{RUN_DATE}.zip (e.g. “SSCDatamart_20170629143500.zip”), whereas full datamarts have the same form except that they end in “_full.zip”).

2.3 Timing

Data extracts are generated between (and including) 05:00 and 21:00 daily, on a schedule agreed with the customer, and all files generated in the extract will be time-stamped and delivered in the same batch transfer. Delta files in the extract will contain details of any changes that have occurred since the last successful extraction. To reduce the risk of partially committed records being transferred, the process windows have a half hour off-set so that, for example, a delta processing at 11:00 will contain data from 08:30 to 10:30.

Where a full Datamart refresh is requested by the customer, this can generally be accommodated within 3 days of a request being submitted to the Yarris Customer Support Team. Four customer-initiated full Datamart refreshes can be accommodated each financial year with no additional charge. Subsequent requests will incur a charge for 1 day of effort.

ConSol Datamart Specification Page 2

Page 11: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

If a ConSol release includes changes that impact on the Datamart, a full Datamart refresh will be included as part of the release, at no additional charge to the customer. The specification for the change will be released to the customer no less than 4 weeks prior to the ConSol release date.

On occasion, Yarris may recommend a full refresh be undertaken by a customer. It is up to the customer to determine whether they comply with this recommendation.

2.4 File Names and Locations

For each Datamart, the thirty extracts will be named as follows (where YYMMDD_hhmmss is the time the file was written).

ZIP File Name Extract File Name

_0_Summary _0_summary_ YYMMDD_hhmmss_n.csvAttribute Master attribute_master_YYMMDD_hhmmss_n.csvAttribute List Master attribute_list_master_YYMMDD_hhmmss_n.csvWIP Master wip_master_YYMMDD_hhmmss_n.csvMilestone Type Master milestone_type_master_YYMMDD_hhmmss_n.csvWork Type Master work_type_master_YYMMDD_hhmmss_n.csvCompliance Documents Master compliance_doc_master_YYMMDD_hhmmss_n.csvSOR History Delta sor_history_YYMMDD_hhmmss_n.csvRemoved Orders Master removed_orders_master_YYMMDD_hhmmss_n.csvProject Details Delta project_details_YYMMDD_hhmmss_n.csvOrder Details Delta order_details_YYMMDD_hhmmss_n.csvOrder Item Details Delta order_item_details_YYMMDD_hhmmss_n.csvAttribute Detail Delta attribute_details_YYMMDD_hhmmss_n.csvInvoice Details Delta invoice_details_YYMMDD_hhmmss_n.csvInvoice Item Details Delta invoice_item_details_YYMMDD_hhmmss_n.csvItem Variation Delta item_variation_YYMMDD_hhmmss_n.csvContract Details Delta contract_details_YYMMDD_hhmmss_n.csvMilestone Details Delta milestone_details_YYMMDD_hhmmss_n.csv Metadata Details Delta metadata_details_YYMMDD_hhmmss_n.csvApp Survey Details Delta app_survey_details_YYMMDD_hhmmss_n.csvProject History Delta project_history_YYMMDD_hhmmss_n.csvOrder Invoice History Delta order_invoice_history_YYMMDD_hhmmss_n.csvAttribute History Delta attribute_history_YYMMDD_hhmmss_n.csvItem History Delta item_history_YYMMDD_hhmmss_n.csvContract History Delta contract_history_YYMMDD_hhmmss_n.csvDocument Detail Delta document_detail_YYMMDD_hhmmss_n.csvSurvey Action Delta survey_action_YYMMDD_hhmmss_n.csvMilestone History Delta milestone_history_YYMMDD_hhmmss_n.csvDeleted Events Delta deleted_events_YYMMDD_hhmmss_n.csvClaim History Delta claim_history_ YYMMDD_hhmmss_n.csv

ConSol Datamart Specification Page 3

Page 12: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

The extract will be compressed into a single zip file which will be named as follows:

{customer Id}Datamart_yymmdd_hhmmss.zipwhere ddmmyy_hhmmss corresponds to the time that the extract file was created.

All files within the extract will be named as:

<<filename>>_YYMMDD_hhmmss_0.csv,

For all extracts, if the number of rows in the extract exceeds 50,000 rows, the extract will be split into multiple files. This should only occur for Detail and History extracts in the case of a Full Refresh.

If an extract exceeds 50,000 rows and is split into multiple files, the second and subsequent extracts will be named as per

<<filename>>_YYMMDD_hhmmss_1.csv, <<filename>>_YYMMDD_hhmmss_2.csv, etc

The rules controlling the number of rows in extracts spanning multiple files is as follows:

For the first file, there are always 49,999 rows, including the header For the second and subsequent files, there are 50,000 rows, including the header

Empty files will not include a header row.

2.5 File Transfer Process

The Datamart zip file will be written to the Yarris S3 bucket and will be able to be retrieved by the customer.

2.6 Extract Load Order

Data dependencies exist between the thirty files comprising the Datamart extract. To ensure that no load conflicts arise because of these dependencies, the following file load order is suggested:

Table Order Primary Key Foreign Key Foreign Key Table_0_Summary 0 AttributeMaster 1 ATTRIBUTE_TYPE_NOContractDetails 1 CONTRACT_NO MilestoneTypeMaster 1 MILESTONE_TYPE_NO WipMaster 1 WIP_EVENT_NO WorkTypeMaster 1 WORK_TYPE_NO AttributeListMaster 2 ATTRIBUTE_LIST_NO ATTRIBUTE_TYPE_NO AttributeMasterComplianceDocumentMaster 2 COMPLIANCE_NO CONTRACT_NO ContractDetailsContractHistory 2 CONTRACT_NO ContractDetailsSorHistory 2 CONTRACT_NO ContractDetailsProjectDetails 2 PROJ_VIEW_NO WORK_TYPE_NO WorkTypeMaster

OrderDetails 3 ORDER_ID

PROJ_VIEW_NO ProjectDetailsCONTRACT_NO ContractDetailsWIP_EVENT_NO WipMasterWORK_TYPE_NO WorkTypeMaster

ConSol Datamart Specification Page 4

Page 13: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

ProjectHistory 3 PROJ_VIEW_NO ProjectDetails

AppSurveyDetails 4 RESPONSE_ITEM_NOPROJ_VIEW_NO ProjectDetailsORDER_ID OrderDetails

DocumentDetail4 DOC_NO

PROJ_VIEW_NO ProjectDetailsORDER_ID OrderDetailsINVOICE_NO InvcoiceDetails

InvoiceDetails 4 INVOICE_NO ORDER_ID OrderDetails

MetadataDetails 4 METADATA_NOPROJ_VIEW_NO ProjectDetailsORDER_ID OrderDetails

MilestoneDetails 4 MILESTONE_NO

MILESTONE_TYPE_NO MilestoneTypeMaster

PROJ_VIEW_NO ProjectDetailsORDER_ID OrderDetails

OrderItemDetails 4 ORDER_ITEM_NO ORDER_ID OrderDetailsRemovedOrdersMaster 4 ORDER_ID OrderDetails

AttributeDetails 5

PROJ_VIEW_NO ProjectDetailsORDER_ID OrderDetailsORDER_ITEM_NO OrderItemDetailsATTRIBUTE_TYPE_NO AttributeMasterATTRIBUTE_LIST_NO AttributeListMaster

AttributeHistory 5

PROJ_VIEW_NO ProjectDetailsORDER_ID OrderDetailsORDER_ITEM_NO OrderItemDetailsATTRIBUTE_TYPE_NO AttributeMaster

InvoiceItemDetails 5 INVOICE_ITEM_NOORDER_ITEM_NO OrderItemDetailsINVOICE_NO InvoiceDetails

ItemHistory 5 ORDER_ITEM_NO OrderItemDetailsORDER_ID OrderDetails

ItemVariations 5 ORDER_ITEM_VARIATION_NO ORDER_ITEM_NO OrderItemDetails

MilestoneHistory 5 AUDITING_NOMILESTONE_NO MilestoneDetailsORDER_ID OrderDetailsPROJ_VIEW_NO ProjectDetails

OrderInvoiceHistory 5 ORDER_ID OrderDetailsINVOICE_NO InvoiceDetails

DeletedEvents 5 DEL_AUDIT_NOMILESTONE_NO MilestoneDetailsORDER_ITEM_NO OrderItemDetailsINVOICE_NO InvoiceDetails

ClaimsHistory 5 ORDER_ID OrderDetailsORDER_ITEM_NO OrderItemDetails

SurveyAction 5 SURVEY_RESP_ACTION_NO RESPONSE_ITEM_NO AppSurveyDetails

2.7 File Structure

All files will be output in a CSV format (comma delimited with quote boundaries on non-null text fields and field padding (blank spaces) removed)

All records will be stamped with the extract date and time. This will allow customers to provide an accurate picture in their reports of the data age.

All date values in the Datamart reflect Australian Eastern Standard Time (AEST) or Australian Eastern Daylight Time (AEDT), where appropriate

Data in Master and Detail files will be provided ‘as at’ the extract date. That is to say that if a detail record changes value three times within the time window only the value ‘as at’ the extract date will be provided, not the previous/ intermediate values.

Primary keys and / or Foreign keys will be provided per record to assist customers in performing efficient loads/updates.

All files will be zipped before delivery. This will assist in speedy delivery and bandwidth reduction. This will be especially important when delivering a full refresh.

ConSol Datamart Specification Page 5

Page 14: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

The order of columns in each extract will match the specification below. If any additional information is required in any extract, it will be introduced as a new column at the end and will required a Full extract refresh.

All words within a multi-word column names in extracts will be separated with an underscore ( _ )

All extract file names will be in lower-case. If the number of rows in any extract exceeds 50,000 rows, the extract will be split into

multiple files Other than these common features the extracts will come in three basic classifications:

2.7.1 Entity Detail Extract Delta

An entity detail record provides the current details of an entity in a single record (eg. one row per order in the order detail extract). Generally, the Entity Detail records will contain a primary key, relevant information for reporting purposes and identification keys for linking to other extract files. The primary key will allow the determination of whether the record will update an existing or insert a new record.

2.7.2 Entity History Extract Delta

The history extracts provide history / change data focussed on a limited set of data elements. For example, the order invoice history extract provides a record of order and invoice workflow state changes (Transmitted, Work in Progress, Field Complete, Invoice Approved, etc) as well as changes to core order information and any comments or notes that have been added. Each row in a history extract will represent one state change or one note entry of the type being captured in the history log. If an entity undergoes multiple changes of the observed state or has multiple notes added during the window, then there will be multiple records in the extract. The history extracts do not contain a Primary key but may contain one or more foreign keys.

2.7.3 Master Data Extract

The master data extracts provide customers with the ability to manage Meta data changes – for example if a new WIP state is added to a WIP template or an attribute value is deactivated. This will allow customers to provide reporting against items which may not be currently active within the ConSol application.

2.8 Monitoring

All extracts are integrated with the Yarris batch monitoring system and will be monitored to identify errors relating to:

Creation of Extract file Transfer of extract file to S3 bucket

In the event of a failure, the Customer Technical Contact(s) will be notified via an automatically generated email. Customers will provide a group email address for relevant recipients of the automated notifications. The Application Support team will communicate with customers on the progress of the issue.

ConSol Datamart Specification Page 6

Page 15: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

2.9 Backups

All Datamart extracts are backed-up and stored by Yarris for 10 days to assist in investigation of reported issues relating to a specific Datamart delivery. Reissue of a previously delivered delta is not recommended as processing this information after a subsequent load may compromise data integrity. If processing of a delivered delta has been missed, a full Datamart refresh should be requested.

We strongly recommend that a Datamart backup process is also utilised by customers to enable a quick recovery to a previously loaded version, if an issue does occur. Yarris will be working to resolve the issue but this backup will ensure that any business reliance on the Datamart continues to be supported and we have a recent restore point to rollback to and resume Datamart deltas. Having a backup and restore process should significantly reduce the amount of work involved in restoring the Datamart to a valid working state (avoiding the costly full Datamart refresh process).

ConSol Datamart Specification Page 7

Page 16: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

3 DATA DICTIONARYThe following diagram shows the relationships between the extracted entities. This should be used as a reference to assist in constructing the Datamart on the customer’s side.

A full data dictionary for these entities is attached below, defining in business terms each data item.

ConSol Datamart Specification Page 8

Page 17: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

3.1 Status Codes

3.1.1 ProjectCODE DESCRIPTION CODE DESCRIPTIONACT Active Project View HOLD Project View On HoldAPP Approved Project View IN_ACT Inactive Project ViewCANC Cancelled Project View NEW New Project ViewCLO Closed Project View RAPP Project View Requiring ApprovalCOMPL All Orders Complete REJ Project View Not Approved

3.1.2 OrderCODE DESCRIPTION CODE DESCRIPTIONACVAR Refused unless Variations Agreed FRQVAR Request for Variation Not Yet SubmittedALLOC Work in Progress – Open INC Requires Items and QuantitiesASSGD Requires Attention INCOM Incomplete ReinstatementsAWI Awaiting Invoice INV Invoice SubmittedBIG Order Requires Manager Approval NAC Not Yet AcceptedBIGAP Manager Approved NTX Not Yet SentBIGC Claim Requires Manager Approval OVDUE Overdue AcceptanceBIGCRJ Claim Rejected by Manager QUOTE Order awaiting Quote outcomeBIGRJ Order Rejected by Manager RECVD Requires DispatchCANCL Cancelled REEOT Customer Response to Extension of Time RequestCOMPL Order Complete REFUS Requires Supplier ReselectionDISP Done – Claim Disputed REVAR Customer Response to Variation RequestDONE Done – Awaiting Claim RJRIN Reinstatement RejectedESCLM Manager Response to Escalated Docket RQEOT Request for Extension of TimeESORD Manager Response to Escalated Order RQVAR Request for VariationsFDISP Fax Claim Disputed STOP Order StoppedFIN Done – Claim Submitted UOR Requires Supplier Selection

ConSol Datamart Specification Page 9

Page 18: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

3.1.3 Supplier Quote

CODE DESCRIPTION CODE DESCRIPTIONQ_ACC Quote Submitted Q_ORDER Quote Converted to OrderQ_ALLOC Quote Allocated to Supplier Q_PASS Quote Passed-OverQ_CANCL Quote Cancelled Q_REJ Quote DeclinedQ_NTX Quote Not yet Transmitted

3.1.4 Invoice

CODE DESCRIPTION CODE DESCRIPTIONAER Account Code Errors DIS Draft Invoice – Claim DisputedAPP Invoice Approved EPR Draft Invoice – Escalated Claim awaiting Manager responseAWX Invoice Awaiting Extraction ESC Manager response to Escalated Invoice BGC Draft Invoice – Claim requires Manager approval EXT Invoice Extracted to Payment SystemBHL Invoice Held by Approval Manager GER General Errors BIG Invoice Requires Manager Approval HLD Invoice Held by Customer Finance user

BJCDraft Invoice – Claim rejected by Approval Manager NEW Draft Invoice – Created on Claim Submission

BRJ Invoice Rejected by Approval Manager NTX Invoice Not Yet Submitted to CustomerCAN Invoice Cancelled OUT Invoice Submitted for ApprovalCLO Invoice Paid and Closed REJ Invoice RejectedCON Invoice receipt Confirmed by Payment System VER Vendor Number Errors

3.1.5 ContractCODE DESCRIPTION CODE DESCRIPTIONACT Contract Active REV Contract ReviewedCON Contract Pending SUS Contract SuspendedEXP Contract Expired TER Contract Terminated

ConSol Datamart Specification Page 10

Page 19: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

3.1.6 Order Invoice History – StatusSTATUS DESCRIPTION STATUS DESCRIPTION STATUS DESCRIPTION

ACCEP Order Accepted by Supplier FRESB Resubmit Fax Claim PRESP Escalated Payment Claim Responded to by Manager

ACFIX Invoice Account Codes Fixed FRQVAR Request for Variation created PRESPR Payment Claim Response Re-escalated

ACVAROrder Refused unless Variations Accepted FX Successful Fax confirmation PRESPV Escalated Payment Claim Response

Viewed

ADD Order Created HLDIN Invoice Held PRJ Payment Claim Rejected by Manager

ADDB Added by Batch HRPAY Invoice Approved

PVERIF Payment Claim Verified

ADDE Order created from estimate (No longer used) IADD Invoice Submitted by Supplier

to Customer PVRCAL Payment Claim Verification Recalled

AKSTP Stop Order Request Acknowledged IADDEB Invoice Created Exceeds

Budget QCAN Supplier Quote Cancelled

APPRV Large Order Approved by Manager IADDUB Invoice Created Under Budget QDCHG Supplier Quote Date Changed

ASSGN Order Assigned to Supplier INAPP Invoice Submitted for Approval QPASS Supplier Quote Passed Over

ASSOR Order Assigned to Contract Administrator INCAN Invoice Cancelled QRESENT Supplier Quote Resent

AWI Customer has approved the Work Docket INCLO Invoice Closed (No longer

used) QSENT Supplier Quote Sent

BACK Order has been reversed (no longer used) INREC Invoice Recalled to Supplier

QUCRE Master Quote Created (No longer used)

ConSol Datamart Specification Page 11

Page 20: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

CANCL Order Cancelled INREJ Invoice Rejected QUOTE Quote requested for Order (No longer used)

CANCLM Disputed Claim Cancelled INV Invoice has been submitted (no longer used) REACT Invoice has been un-cancelled

CAT Order Categorised INVPA Invoice validated and marked for extract (No longer used) REEOT Customer Response to Extension of

Time Request

CHGUG Order moved from workgroup to another (no longer used) IRECEB Invoice Exceeding Budget

Recalled REEOTS Customer Response to Extension of Time Request Viewed by Supplier

CLMODF Claim Submission Overdue by 14 Days IRECUB Invoice Under Budget Recalled REESCL Re-Escalate Claim from Response

CLMODN Claim Submission Overdue by 90 Days IRECEB Invoice Exceeding Budget

Recalled REFUS Order Refused

CLMREC Final Claim Recalled from Approval Manager MODIF Order Details Modified (No

longer used) REINS New Reinstatement

CREQAP Final Claim Requires Manager Approval OIEC Invoiced Entity on Order

Changed REJEC Rejected Job

CLRESP Escalated FInal Claim Responded to by Manager OK

Fax Order Acceptance has been Acknowledged (No longer used)

RENOT Reinstatement Not Required

CRESPV Escalated Final Claim Response Viewed ORCLO Order Closed by Supplier REOPEN Order Reopened

CLMRJ Final Claim Rejected by Approval Manager ORDCM Order Closed (No longer used) REACT Invoice has been un-cancelled

CLONE Order Cloned (no longer used) ORDREC Order Reccalled from Approval Manager REQAP Order Requires Approval

ConSol Datamart Specification Page 12

Page 21: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

CLREC Claim Recalled ORDREJ Order Rejected by Approval Manager REREQ Reinstatement Required

CLSTP Claim Order Stopped ORESP Manager Respornse to Manually Escalated Order RESSUP Customer Response to Variation

Request Viewed by Supplier

CMPREC Completed Order Recalled ORESPV Escalated Order Response Viewed REVAR Customer Response to Variation

Request

COMPL Order Completed ORDVR Order Reopened (No longer used) REVREC Customer Response to Variation

Request Recalled

COPY Order Copied ORREC Order Recalled (No longer used) RINSB Reinstatement Submitted

CRQVAR Customer Requested Variation OVBGT Budget Exceeded RJREI Reinstatement Rejected

DISCON Design Order Discontinued (no longer used) OVDRLC Overdue Order Reallocated RQEOT Extension of Time Request Submitted

DISP Final Claim Disputed OVDUE Order Overdue RQVAR Variation Request Submitted

DONE Order Marked Done PAP Payment Claim Approved by Manager RSBCL Claim Resubmitted

EDOCER Order EDOC Error PAPREC Payment Claim Requiring Approval Recalled STOP Order Stopped

EDOCRX Order EDOC Received PCCAN Payment Claim Cancelled TRANS Order Transmitted to Supplier

EDOCTX Order EDOC Transmitted PCLREC Payment Claim Recalled UNACC Order Unaccepted

EOTREC Response to EOT Recalled PCSMT Payment Claim Submitted UNCAT Order Uncategorised

ConSol Datamart Specification Page 13

Page 22: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

EXVREC Export Variation Recalled PCLREC Payment Claim Recalled UNDONE Order marked Undone

FF Fax Failure confirmed (no longer used) PDSREC Dispute of Payment Claim

Recalled VERIF Claim Verified

FF/U Fax Failure updated (no longer used) PREITM Order Pre-Itemised VPRO Request for Variation Processed (No

longer used)

FIN Final Claim Submitted PREQAP Payment Claim Requires Manager Approval VRCAL Final Claim Verification Recalled

Order Codes Invoice Codes Quote Codes

3.1.7 Order History – Note Type

CODE DESCRIPTION CODE DESCRIPTIONACCP_RSN Supplier Acceptance KEYDATES Key DatesATT_NOTE Normal Note Attachment MAN_REJ Manager RejectionBIGHLD Invoice Held by Approval Manager MASTER From QuoteBIGINREJ Escalated Invoice Rejected MISC General – MiscellaneousCANCEL Cancel MOBILE From ConSol MobileCANNAT Invoice Cancelled – No further action MOD ModifiedCANRSB Invoice Cancelled – Resubmit Claim MODIFY ModifiedCLM_REJ Escalated Claim Rejected MSG MessageCNT_ORD Claim Status – Continuing Order OFORM Attachment – Order FormCOMMENT Commentary Note REJ_Q Quote Decline ReasonCOMPL Order Completed STOP Order StoppedCUST_REJ Customer Refusal SUPP_REF Supplier RefusalDISP_CLM Disputed Claim SYS System

ConSol Datamart Specification Page 14

Page 23: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

DOCMGMT Documents SYSTEM SystemESCL Escalated Event TOW Ticket of Work EXTN EOT Requested VAR Variations RequestedINVHC Invoice Held VARCHG VariationINV_REJ Invoice Rejected WIP WIP Event ChangeINV_RES Invoice Reset WRKFLOW Workflow ChangeIVR Interactive Voice Response WRNG_ASS Incorrect AssignmentJOBDOC Attachment – Job Document

3.1.8 Milestone StatusCODE DESCRIPTION CODE DESCRIPTIONAT RISK The milestone is at risk of being missed – the warning

date has been passed DISABLED The Milestone is no longer required

BLOCKED

Chained milestone(s) impacted by an earlier milestone and unable to be completed. The Milestone is unable to be completed at this time and has been deferred. ON_TARGET

All on track for achieving the milestone – warning and forecast dates are both in the future

BREACHEDForecast date is earlier than Actual milestone completion date OVERDUE

Forecast date is in the past and the milestone has not been completed

COMPLETED Milestone has been achieved PENDINGThe Milestone is part of a chain and the previous milestone has not been completed

3.1.9 Compliance Document StatusCODE DESCRIPTION CODE DESCRIPTIONNEW New Compliance Document loaded by Supplier REJ Compliance Document rejected by customerOK Compliance Document verified by customer

3.1.10 Compliance Document TypeCODE DESCRIPTION CODE DESCRIPTION

ConSol Datamart Specification Page 15

Page 24: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

CERTIFICATION Certification INSURANCE Insurance PolicyCONTDOC Contract Document

3.1.11 Item Version TypeCODE DESCRIPTION CODE DESCRIPTIONCIVAR Customer Initiated Variation PROSUB Submit Progress ClaimFINSUB Submit Final Claim PROVER Verify Progress ClaimFINVER Verify Final Claim PROVERREC Progress Claim Verification RecalledFINVERREC Final Claim Verification Recalled REVAR Verify VariationORDACC Order Acceptance RQVAR Request Variation

4 DATA EXTRACTS

4.1 Summary Extract

This file has information about the existing files in the extract as well as containing information about the last successful extraction.

4.1.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

RECORD_TYPE String 20 - Identifies what information is stored in each row. The four available record types are:

Last Good File – the file name of last successful Datamart extract

Window Start Date – The start date/time of the processing window for last successful extract

Window End Date– The end date/time of the processing window for last successful extract

Line Count – as separate line for each file contained in the

ConSol Datamart Specification Page 16

Page 25: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

current extractFILE_NAME String

50 -

For the Last_Good_File row, this field contains the Name of last successful Datamart extract (ie AppianDatamart_yymmdd_hhmmss.zip)For each Line Count row, this field contains the name of each data file in the current extract

PHYSICAL_LINE_COUNT Integer 10 0 Contains a physical row count of the number of rows in each extract file.

4.1.2 Design Rules:

A processor will be run on completion of extraction of all current Datamart extract files that will determine a row count for each file. The row count that is indicated in the control file against each file type will be the physical row count in the csv file, including the header row.

The record type Last_Good_File will contain the name of the last successful Datamart extract followed by the Window_Start_Date and Window_End_Date which defined the duration of the processing window for that file. After this, the names of each file contained in current extract will be listed against a Line_Count record type, sorted in ascending file name order. The time stamp of current extract will be shown against each current extract line, as will the row count of each file.

4.2 Attribute Master Extract

This is a table of all Attribute Types for attribute lookup purposes. Attributes are customer-definable fields that can be applied to project views, orders or items.

4.2.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

ATTRIBUTE_TYPE_NO Integer 10 0 Primary key. Unique identifier for each Attribute Type M / MATTRIBUTE_NAME String 64 - The name of the attribute as displayed in the application. O / MDESCRIPTION String 200 - A longer description of the attribute. O / O

ConSol Datamart Specification Page 17

Page 26: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

ATTRIBUTE_ORDER Integer 10 0 A number indicating the order in which the attribute is displayed on the screen within the application.

O / M

ACTIVE String 1 - Indicates whether the attribute is currently active (1) or inactive (0) within the application.

O / M

MANDATORY String 1 - Indicates whether population of the attribute is mandatory within the application.

O / M

RESTRICT_CONTRACTS String

1 -

Supplier Contracts can be configured to ensure that they only receive specific types of work, based on order attribute values. For example, a particular contractor may work in only 3 ESA's and the customer can specify these ESAs on the contract so that the contractor is only presented for selection on orders with the specified ESA attribute values. This flag indicates that the attribute is available to restrict work order allocation on contracts.

O / M

BUSINESS_OBJECT String

8 -

Attributes can be attached to different ConSol entities. This field indicates which entity the attribute applies to. The possible values are: 'PRV' - Project View attributes; 'SR' - Service Request attributes; 'ORD' - Order attributes; and 'ORDITEM' - Order Item attributes.

O / M

VIEW_BY String

8 -

Identifies who is allowed to view the attribute within the application. The possible values are: 'SUPPLIER' - only the supplier can view the attribute; 'CUSTOMER' - Only the customer can view the attribute; 'BOTH' – both customer and supplier can view the attribute

M / M

EDIT_BY String 8 - Identifies who is able to edit the attribute within the application. The possible values are: 'SUPPLIER' - only the supplier can edit the attribute; 'CUSTOMER' - Only the customer can

M / M

ConSol Datamart Specification Page 18

Page 27: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

edit the attribute; 'BOTH' – both customer and supplier can edit the attribute

DATA_TYPE String

15 -

ConSol currently supports five distinct data types for attributes. These are: 'text' – a string of text that accepts most character values; 'date' – a date in dd/mm/yyyy format; 'list' – a defined list of coded values and descriptions; 'currency' – numeric value in currency format ($9999.99); and 'number' – numeric value.

O / M

DISPLAY_LEVEL String

15 -

Attributes in the application can be marked with two distinct display levels: 'header' - displayed at the top of the form, 'body' - displayed lower down in forms. This may be useful in maintaining reporting consistency with the application.

O / M

BANNER Integer1 0

Indicates whether the attribute is displayed in the entity banner (1) or not (0). The banner is the section displayed above the tabs for each entity.

O / M

WRITE_ONCE String

1 -

Indicates whether the value recorded against this attribute can be updated by normal users once it has been saved. System Administrators are able to update ‘Write-once’ values.

O / O

NON_REVERSIBLE String 1 - Not currently in use O / ODIRECTION String 4 - Not currently in use O / OOWNED_BY String 5 - Customer Code for the Owner of the Attribute O / MDATA_REFRESH_DATE Date

23 -yyyy/mm/dd hh:mm:ss

Data propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

ConSol Datamart Specification Page 19

Page 28: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

4.2.2 Design Rules:

As a general rule, all attributes which are visible to the customer in the application should be available in the extracts (Attribute Master, Attribute List Master, Attribute Detail and Attribute History).

The extract should include any Attribute type records that are owned by the customer and those Attribute type records owned by the customer’s customer that are flagged as viewable by supplier

4.3 Attribute List Master Extract

This is a table of all Attribute List values for attribute value lookup purposes. These are coded values and descriptions for each ‘List’ type attribute.

4.3.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

ATTRIBUTE_LIST_NO Integer10 0

Primary key. Unique identifier for each Attribute List value

M / M

NAME String 20 - The name of the Attribute List item as displayed in the application.

O / M

DESCRIPTION String 200 - A longer description of the Attribute List item. O / OATTRIBUTE_TYPE_NO Integer 10 0 Foreign key. Used to identify the attribute type from the

Attribute Master table.O / M

ACTIVE String 1 - Indicates whether the attribute list item is currently active (1) or inactive(0) within the application.

O / M

DATA_REFRESH_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Data propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

ConSol Datamart Specification Page 20

Page 29: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

4.3.2 Design Rules

As a general rule, all attribute list values which are visible to the customer in the application should be available in the extract. This extract should include list values for all list type attributes in the Attribute Master extract.

4.4 WIP Master Extract

This is a table of WIP Events for WIP lookup purposes, identifying the WIP template that each event is associated to.

4.4.1 Data Dictionary

Field Name TypeLength

Precision Format Description MandatoryDB / App

WIP_EVENT_NO Integer 10 0 Primary key. Unique identifier for each WIP Event M / MWIP_EVENT_TEMPLATE_NO Integer 10 0 Identifies the WIP template to which this WIP event is

attached.M / M

WIP_EVENT_TEMPLATE_NAME

String 50 - The name of the WIP template to which this WIP event is attached.

O / M

WIP_EVENT_TEMPLATE_TYPE

String 20 - Identifies the type of WIP template. Possible values are: 'Customised', 'conSol%Completed', 'conSolDescriptive'

O / M

TEMPLATE_CREATE_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date the WIP Template was created O / M

TEMPLATE_ACTIVE String 1 - Flags if the WIP template is currently active (1) or inactive (0).

O / M

WIP_EVENT_NAME String 35 - The name of the current WIP event. This is the name displayed in the application

O / O

EVENT_ORDER Integer 1 0 An order passes through a number of WIP statuses before completion. This number represents the ordering of this WIP event in the sequence.

O / M

WIP_EVENT_ACTIVE String 1 - Flags if the WIP event is currently active (1) or inactive O / M

ConSol Datamart Specification Page 21

Page 30: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

(0). DATA_REFRESH_DATE Date 23 - yyyy/mm/dd

hh:mm:ssData propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.4.2 Design Rules:

Those WIP Events owned by the customer, or visible to the customer as a supplier, should be included in the extract. WIP Template information is only available for WIP events owned by the customer.

4.5 Milestone Type Master Extract

This is a table of all Milestone Types for milestone value lookup purposes.

4.5.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

MILESTONE_TYPE_NO Integer 10 0 Primary key. Unique identifier for each Milestone Type value.

M / M

NAME String 20 - The name of the Milestone Type item as displayed in the application.

M / M

DISPLAY_NAME String 40 - A display name of the Milestone Type M / MCONTEXT String 10 - Association context (ie. Project or Order) M / MENABLED String 1 - Indicates whether the milestone will be

applied to new instances M / M

FORECAST_OFFSET_RELATIVE_BASE String 10 - Base date from which Milestones are offset, such as start of the Order/Project or previous Milestone.

O / M

FORECAST_DATE_METHOD String 10 - Determines whether date changes are offset by calendar days or working days as

O / M

ConSol Datamart Specification Page 22

Page 31: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

determined by the National and local public holidays for the relevant postcode.

FORECAST_DATE_OFFSET Integer 5 0 Whole number representing change applied to Milestone forecast date.

O / M

RECIPIENT_VIEWABLE String 1 - Indicates whether the milestone is visible to the supplier (1) or not (0)

M / M

RECIPIENT_EDITABLE String 1 - Indicates whether the milestone is editable by the supplier(1) or not (0)

M / M

CHANGE_DATE Date 23 yyyy/mm/dd hh:mm:ss

Date that the last change was made to the milestone type

M / M

CHANGE_BY String 71 - The full name of the user who last changed the Milestone Type

M / M

OWNED_BY String 5 - Customer Code for the Owner of the Milestone M / MDATA_REFRESH_DATE Date 23 - yyyy/mm/dd

hh:mm:ssData propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.5.2 Design Rules

As a general rule, all milestone type values which are visible to the customer in the application should be available in the extract. Other customer milestones which are recipient viewable should be included in the extract.

4.6 Work Type Master Extract

This is a table of all Work Types for Work Type value lookup purposes

4.6.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

ConSol Datamart Specification Page 23

Page 32: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

WORK_TYPE_NO Integer 19 0 Primary key. Unique identifier for each Work Type value. M / MCODE String 10 The code associated with each Work Type M / MWORK_TYPE_NAME String 35 - The name of the Work Type item as displayed in the

application.M / M

DESCRIPTION String 200 - The description of the Work Type O / OBUSINESS_OBJECT String 20 - Association context (ie. PROJECTVIEW or ORDER) M / MACTIVE String 1 - Indicates whether the Work Type is active(1) or not (0) M / MOWNED_BY String 5 - Customer Code for the Owner of the Work Type M / MDATA_REFRESH_DATE Date 23 - yyyy/mm/dd

hh:mm:ssData propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.6.2 Design Rules

As a general rule, all work type values which are visible to the customer in the application should be available in the extract.

4.7 Compliance Document Master Extract

This is a table of all Compliance requirements for each contract visible to the customer, showing when compliance documents have been submitted, when they expire and what the current status is of the compliance requirement.

4.7.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

CONTRACT_NO Integer 10 0 Foreign key. Unique identifier for each Contract M / MCOMPLIANCE_NO String 20 - Primary key. Unique identifier for each Compliance

Document (concatenation of Insurance_Required_no + Insurance No + Document No for Insurance documents and Compliance No for Compliance documents.

M / M

DOCUMENT_NO String 10 - Unique Identifier for each document uploaded O / O

ConSol Datamart Specification Page 24

Page 33: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

DOC_NAME String 200 - The Insurance Policy Type or the Contract Document Name

M /M

DOC_TYPE String 25 - The Insurance Compliance Type or the Contract Document Type

M /M

UPDATE_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date and time at which the compliance document was loaded

O / M

UPDATE_USER String 71 - The full name of the user who uploaded the Compliance document

O / M

STATUS String 30 - The Status of the Compliance Document M / MCOMMENT String 2000 - If the Compliance document was rejected, the reason for

the rejectionO / O

DATA_REFRESH_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Data propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

EXPIRY_DATE Date 23 - The date and time at which the compliance document expires

O / O

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.7.2 Design Rules:

Extract includes details of compliance requirement and each compliance document upload. The extract doesn’t include document attachments.

4.8 Removed Orders Master Extract

This is a table of all Orders that had been issued to the customer that are no longer available to them as they were subsequently refused by the customer or recalled or cancelled after initial issue.

4.8.1 Data Dictionary

Field Name Type Length Precision Format Description Mandatory

ConSol Datamart Specification Page 25

Page 34: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

DB / AppORDER_ID String 8 - Foreign key. The unique ConSol order ID. M / MDATA_REFRESH_DATE Date 23 - yyyy/mm/

dd hh:mm:ss

Data propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.8.2 Design Rules:

Extract includes list of orders that had been issued to the customer but which are no longer available to them.

4.9 Deleted Event Details Extract

This is a table of all Events that have been removed from the ConSol database within the processing window. These events may have previously been included in a Datamart extract and should now be deleted from the relevant extract tables (ie Invoice Detail, OrderItem Detail and Milestone Detail). The deletions occurred as a result of a recalled event (ie recall of submitted claim).

4.9.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

DEL_AUDIT_NO Integer 10 0 Primary key. Unique identifier for each Deleted record M / MTARGET String 32 - The file that the record was deleted from. This will be

one of the following: Milestone, Order Item, InvoiceM / M

TARGET_KEY String 32 The name of the Foreign key. This will either be Milestone_no, Order_Item_no or Invoice No)

M / M

TARGET_VALUE String 128 - Foreign key. The ConSol value for the Target Key M / MCONTEXT String 32 - The entity that the deleted item related to – Either

Project View or OrderO / O

CONTEXT_ID String 32 - Foreign key. Either the Order Id or the Project View No that the deleted item related to

O / O

DELETED_DATE Date 23 - yyyy/mm/dd The date and time at which the deletion occurred M / M

ConSol Datamart Specification Page 26

Page 35: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

hh:mm:ssDELETED_BY String 71 - The full name of the user who undertook the action that

triggered the deletionM / M

DESCRIPTION String 1000 - Text Description of the action that occurred M / MDATA_REFRESH_DATE Date 23 - yyyy/mm/dd

hh:mm:ssData propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.9.2 Design Rules:

Extract includes list of deleted Invoices, Milestones & Items, where deletion occurred within the processing window. All deleted records can be associated to an Order or PV and if that Order or PV has either been issued to or Issued by the customer, the deleted

item would have been included in an extract and should be removed. Records in other extracts that reference the deleted event as a Foreign key should also be deleted

4.10 Contract Details Extract Delta

This is a table of all Contracts which have been added or changed within the processing window, as identified by having a contract update date or a History log record (contract or compliance) created in the processing window. A single entry will be created for each Contract – all details for the Contract will be current as at time of extraction (ie. If a Contract underwent multiple changes during the processing window, only the final outcome of these changes would be extracted to the Datamart in the Contract details extract).

4.10.1 Data Dictionary

Field Name Type Length Precision Format Description Mandatory

DB / AppCONTRACT_NO Integer 10 0 Primary key. The unique Invoice identifier for the

Contract.M / M

CONTRACT _REF String 14 - The Contract reference id of the contract. This is the on-screen contract identifier.

M / M

CONTRACT_STATUS String 10 The current status of the contract. (see Contract status M / M

ConSol Datamart Specification Page 27

Page 36: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

codes above)CONTRACT_TYPE String 10 - Determines whether the contract is ‘PREFERRED’ or

‘PENDING’O / M

CONTRACT_CATEGORY String 10 - Determines whether the contract category is ‘PRIMARY or ‘SECONDARY’

O / M

INVOICE_METHOD String 15 Determines whether the invoicing method is ‘TRADITIONAL’, ‘RCTI’ or ‘NONE’

O / M

REVENUE_COST String 10 - Contract classified as Revenue or Cost. The expected values are ‘NONE’, ‘REVENUE’ or ‘COST’.

O / O

CONTRACT_MGR String 71 - The full name of the user who is identified as the Contract Manager of the contract.

O / M

CM_WORKGROUP String 50 - The name of the workgroup/area that is responsible for managing the contract. The Contract Manager must be a member of this workgroup

O / M

COMPLIANCE_MGR String 71 - The full name of the user who is responsible for the checking all Compliance requirements

O / O

ISSUE_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date the contract was issued M / M

EXPIRY_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date the contract expires O / O

KPI_START_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date that KPI statistics start processing O / M

SCHEDULE String 10 - The id for the schedule of rates which apply to the order. O / MSUPPLIER String 70 - The name of the supplier company engaged under this

contract.M / M

VENDOR_NO String 20 - The Vendor number of the Supplier Company O / MPAYMENT_TERMS Number 2 - The payment terms applying to the contract O / MSUPPLIER_ABN String 11 The Supplier company ABN O / OSUPPLIER String 71 - The full name of the user who is identified as primary O / M

ConSol Datamart Specification Page 28

Page 37: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

_CONTACT_NAME Supplier ContactSTAR_RATING Number 1 - On a scale of 1-5, the calculated rating of supplier

performanceO / O

OVERRIDE_STAR_RATING Number 1 - On a scale of 1-5, the manual override rating of supplier performance

O / O

DATA_REFRESH_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Data propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.10.2 Design Rules:

Only the customer contracts will be included in the Extract – this includes contracts issued to the customer as well as contracts raised by the customer

The details of the Contract which are extracted to the Datamart are the latest values stored against the Contract at processing time.

4.11 SOR History Extract Delta

This is a table displaying contractually agreed rates for SOR items on contracts accessible by the customer that were added or changed during the processing window. These are identified by having an Update Date in the processing window.

4.11.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

CONTRACT_NO Integer 10 0 Foreign key. Unique identifier for each Contract O / MITEM_ID String 25 - The item id of the item, as displayed in the application. O / MITEM_DESCRIPTION String 100 - The description of the item O / MPRICE Integer 11 3 The price for the Item on the Contract M / MPRICE_TYPE String 1 The price type for the item V- variable, C- Capped, F- Fixed,

E-At Cost, A- AgreedM / M

UOM String 200 - Unit of measure O / MGST_FREE String 3 - Indicates whether the item is GST Free (Yes / No) O / M

ConSol Datamart Specification Page 29

Page 38: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

AUDITABLE String 3 - Indicates whether the item is auditable (Yes / No). An auditable item requires manual verification of its supply.

O / M

EFFECTIVE_FROM Date 23 - yyyy/mm/dd hh:mm:ss

Indicates the date from which the rates will apply. If there is no ‘Effective To’ date or the ‘Effective To’ date is in the future, this is the SOR rate that will be used.

M / M

EFFECTIVE_TO Date 23 - yyyy/mm/dd hh:mm:ss

Indicates the date from which the rate stop is being applied. If no SOR record exists for that item with an ‘Effective From’ date after the ‘Effective To’ date, the item is no longer in use.

O / O

UPDATE_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date the contact rates were last updated O / M

SERVICE_CATEGORY String 6 - The id of the service category of the work being undertaken on the order.

M / M

CATEGORY_DESCRIPTION String 60 - The description of the service category of the work being undertaken on the order.

O / M

ZONE String 4 - The zone (Patch) for which the rate is applicable. This corresponds to the zone on the order. The same item may have a different price in different zones.

M / M

DATA_REFRESH_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Data propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.11.2 Design Rules:

Each extract contains a list of all SOR items for every contract that the customer has access to that were added or changed in the processing window

Extract includes current, future and expired prices for each item. The extract includes items for all contracts viewable by the customer that have been added or changed in the processing window.

ConSol Datamart Specification Page 30

Page 39: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

4.12 Contract History Extract Delta

This is a table of all events written to the Contract History log during the processing window.

4.12.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

CONTRACT_NO Integer 10 0 Foreign key. Unique identifier for each Contract O / MHISTORY_DATE Date 23 - yyyy/mm/dd

hh:mm:ssThe date and time at which the History log record was created.

M / M

UPDATE_USER String 71 - The full name of the user who triggered the recording of the History log record.

O / M

COMMENT String 2000 - Details of the event that resulted in the creation of the History log record

O / O

DATA_REFRESH_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Data propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application

M / M

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.12.2 Design Rules:

Extract includes every line note written in ConSol application that is visible to the customer users. This includes details from the Contract Activity Log, Contract Log and Contract Notes tables.

For contracts where the customer is the supplier but not the customer, only those notes flagged as visible to the supplier are included. The extract doesn’t include document attachments.

4.13 Project Details Extract Delta

This is a table of Project Views which have been added or changed in the processing window, as identified by having a History log record created in the processing window. A single entry will be created for each Project View – all details for the Project View will be current as at time of extraction (ie. If a Project underwent multiple changes during the processing window, only the final outcome of these changes would be extracted to the Datamart in the Project details extract).

ConSol Datamart Specification Page 31

Page 40: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

4.13.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

PROJ_VIEW_NO Integer 10 0 Primary key. Unique identifier for each Project M / MPROJ_NAME String 100 - The Project Name of the Project. This is a unique

name associated to each Project.M / M

PROJ_DESC String 100 - The Project Description of the Project. This is a description of the Project.

O / O

PROJ_REF_ID String 35 - The Project reference id of the project. This is the on-screen project identifier.

O / M

PURCHASE_ORDER_NR String 20 - Purchase Orders recorded for the Project. O / OSTART_DATE Date 23 - yyyy/mm/dd

hh:mm:ssThe date that the Project is to start O / M

END_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date that the Project is to end O / M

STATUS String 10 - The current status of the Project. O / MPROJECT_MANAGER String 71 - The name of the person who is currently managing

the Project in ConSolO / O

WORKGROUP_NAME String 50 - The name of the workgroup/area that is responsible for the Project. The Project Manager must be a member of this workgroup

O / M

PROJ_ESTIMATE Number 12 2 The estimated total cost of the Project. This is a value entered by the Project Manager when the Project is created or updated by the Project Manager during the life of the Project.

O / O

CREATE_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date that the Project was created in ConSol O / M

INV_ENTITY_NAME String 60 - The Invoiced Entity responsible for the Project O / MDATA_REFRESH_DATE Date 23 - yyyy/mm/dd Data propagates from the application to the Datamart M / M

ConSol Datamart Specification Page 32

Page 41: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

hh:mm:ss at defined intervals. This field indicates the date at which this record was read from the application.

WORK_TYPE_NO Integer 10 0 Foreign key. Unique identifier for each Work Type (see the Work Type Master table)

O / M

WORK_TYPE_NAME String 35 - The Work Type Name O / MINTERFACED_PROJECT String 1 Identifies whether Project was created through a web

interface. 1 = Yes, null or 0 = NoO / O

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.13.2 Design Rules:

Only Project Views that the customer has access to will be included in the extract. If the Project View is owned by another customer, certain fields in the extract will not display information (ie. Work_type_no) however the Project View will be listed.

A Project View delta record will be included in the extract if there is a Project View History record created in the interval since the last delta extract. This file will contain one record for each Project View regardless of the number of history events created for that Project View within the processing

window. The details of the Project which are extracted to the Datamart are the latest values stored against the Project View at processing time. The project_ref_id field may contain some special characters populated from ‘cut and paste’ actions from external applications. These will appear

in the Datamart as they are presented in the ConSol application.

4.14 Project History Delta Extract

This is a table of all events written to the Project History log during the processing window.

4.14.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

PROJ_VIEW_NO Integer 10 0 Foreign key. Unique identifier for each Project M / MHISTORY_DATE Date 23 - yyyy/mm/dd

hh:mm:ssThe date and time at which the History log record was created.

M / M

UPDATE_USER String 71 - The full name of the user who triggered the recording O / M

ConSol Datamart Specification Page 33

Page 42: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

of the History log record.COMMENT String 2000 - Details of the event that resulted in the creation of

the History log recordO / M

DATA_REFRESH_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Data propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.14.2 Design Rules:

Extract includes every line note written in ConSol application that is visible to the customer. The extract doesn’t include document attachments. All the extract details for the field notes will be presented as raw text. Any formatting entered using the Rich Text Editor in ConSol will be removed.

4.15 Order Details Extract Delta

This is a table of Orders and Supplier Quotes which have been added or changed in the processing window, as identified by having a History log record created in the processing window. A single entry will be created for each Order – all details for the Order will be current as at time of extraction (ie. If an Order underwent multiple changes during the processing window, only the final outcomes would be extracted to the Datamart)

4.15.1 Data Dictionary

Field Name Type Length Precision Format Description Mandatory

DB / AppPROJECT_VIEW_NO Integer 10 0 Foreign key. Unique identifier for the Project View

which this order is attached to. This is the Project View number of the Project View associated to the order and not the project reference id.

O / O

ORDER_ID String 8 - Primary key. The unique ConSol order ID. M / MORDER_DESCRIPTION String 520 - Description of the Order O / OORDER_PRIORITY String 60 - The ConSol priority of the order – as displayed in the

application. This identifies the type of work being done M / M

ConSol Datamart Specification Page 34

Page 43: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

and/or the order acceptance period.ZONE String 4 - The zone (Patch) in which the order takes place. O / O$_INITIAL_ESTIMATE Number 12 2 The initially estimated dollar value of the order. This is

the value of the order calculated as the sum of the (quantity x rate) for each item at the time of order transmission.

O / O

$_CURRENT_VALUE Number 12 2 The current value of the order – incorporating agreed variations to scope. This is the sum of the current agreed (quantity x rate) for each item on the order. This is normally (ordered qty x rate).Note: changes to items and new items being requested during a variation request process or a claim for payment request are not included in current value until agreed by the customer.

O / O

$_VERIFIED Number 12 2 The amount of the order which has been verified in approved claims. This is calculated as the sum of the current verified and previously verified (quantity x rate) for each item on the order.

O / O

$_PAID_(ex_GST) Number 12 2 The amount which has been paid to the supplier, exclusive of GST. This is the sum of GST exclusive value of all closed invoices raised against the order.

O / O

$_GST Number 12 2 The amount of GST paid on the order. This is the sum of GST value on all closed invoices raised against the order.

O / O

$_TOTAL_PAID Number 12 2 $ Total paid = $ PAID (ex GST) + $ GST. This is the sum of GST inclusive value of all closed invoices raised against the order.

O / O

START_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date and time for the commencement of work, as recorded on the work order.

O / O

END_DATE Date 23 - yyyy/mm/dd The date and time for completion of work, as recorded O / O

ConSol Datamart Specification Page 35

Page 44: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

hh:mm:ss on the work order.CUSTOMER String 4 - The company id of the customer company who raised

the order.M / M

SUPPLIER String 70 - The name of the supplier company who is fulfilling the order.

O / O

CONTRACT_NO Integer 10 0 Foreign key. Unique identifier for the contract which the order was issued against.

O / O

SCHEDULE String 10 - The id for the schedule of rates which apply to the order.

O / O

SERVICE_CATEGORY String 6 - The id of the service category of the work being undertaken on the order.

O / O

CATEGORY_DESCRIPTION String 60 - The description of the service category of the work being undertaken on the order.

O / O

REQUESTED_BY String 71 - The full name of the user on whose behalf the work order was raised.

M / M

ORDERED_BY String 71 - The full name of the user who raised the work order. O / OCREATE_DATE Date 23 - yyyy/mm/dd

hh:mm:ssThe date on which the work order was created O / M

DAYS_OVERDUE Number 10 1 The number of days the order completion is overdue (ie difference between the end date and current date if complete date is null)

O / O

COMPLETE_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date and time that the order was marked as field complete.

O / O

CLAIM_SUBMITTED_DATE Date 23 - yyyy/mm/dd hh:mm:ss.fff

The last date and time that a claim was submitted on the order.

O / O

REFERENCE_NUMBER String 35 - Customer reference number on the order, as displayed in the application.

O / O

ORDER_STATUS String 10 - The current status of the order. (See Order and Quote status codes above)

O / M

INVOICE_STATUS String 3 - The current status of the most recent invoice raised O / O

ConSol Datamart Specification Page 36

Page 45: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

against the order (see status codes above). If the order status is Complete and there are no invoice records for the order (internal workforce orders), the invoice status will be set to Closed.

LOCATION_ADDRESS String 200 - The street address at which the work on the order is to be carried out This field should be populated for all non-cancelled orders

O / O

LOCATION_SUBURB String 40 The suburb at which the work on the order is to be carried out This field should be populated for all non-cancelled orders

O / O

LOCATION_POSTCODE String 4 The postcode at which the work on the order is to be carried out This field should be populated for all non-cancelled orders

O / O

LOCATION_STATE String 3 The state in which the work on the order is to be carried out This field should be populated for all non-cancelled orders

O / O

WIP_EVENT String 4000 - The current WIP status of the order O / OWIP_EVENT_NO Integer 10 0 Foreign key. Unique identifier for each WIP Event (see

the WIP Master table)O / O

DATA_REFRESH_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Data propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

ACCEPT_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The latest date and time that the order was accepted by the Supplier

O / O

TRANSMITTED_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The latest date and time that the order was transmitted to the Supplier

O / O

VERIFIED_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The latest date and time that the submitted claim was verified

O / O

INV_ENTITY_NAME String 60 - The name of the Invoiced Entity responsible for the Order

O / M

ConSol Datamart Specification Page 37

Page 46: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

SUPP_REF_NR String 30 - The Supplier Reference Number – input by the supplier on acceptance of the order and not visible to the customer

O / O

MASTER_QUOTE_ID String 8 - The Master Quote Number that the Supplier quote was issued from

O / O

QUOTE_CLOSE_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date that the quote has to be submitted by O / O

PARENT_ORDER_ID String 8 - The Id of the order that the current order was generated from – this could be as a copied order or as an on-forwarded order.

O / O

CONTRACT_ADMINISTRATOR

String 71 - The full name of the Contract Administrator on the work order. This field may be blank if a user has not acquired the order.

O / O

WORKGROUP_NAME String 50 - The name of the Contract Administrator workgroup/area that is responsible for the Order. The Contract Administrator must be a member of this workgroup.

O / O

SUPPLIER_OPS_USER String 71 - The full name of the Supplier Operations user on the work order. This field may be blank if a user has not acquired the order.

O / O

RESOURCE_NAME String 50 - The name of the Supplier Operations resource/area that is managing the Order. The Supplier Operations user must be a member of this resource.

O / O

WORK_TYPE String 35 - The Work Type Name O / MWORK_TYPE_NO Integer 10 0 Foreign key. Unique identifier for each Work Type (see

the Work Type Master table).O / M

ACCOUNTING_STYLE String 20 - Accounting: Style Description O / OCOST_CENTRE String 10 - Accounting: Cost Centre O / OPROJECT_NR String 10 - Accounting: Project Number O / ONETWORK String 12 - Accounting: Network Number O / O

ConSol Datamart Specification Page 38

Page 47: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

ACTIVITY String 4 - Accounting: Activity Number O / OWBS_ELEMENT String 24 - Accounting: WBS Element O / OINTERFACED_ORDER String 1 Identifies whether Order was created through a web

interface. 1 = Yes, null or 0 = NoO / O

CUSTOMER_NOTES String 2000 Customer notes - These are ‘In-House’ comments that are only visible to customer users. For orders issued by another customer, these comments will not be displayed.

O / O

SPECIAL INSTRUCTIONS String 2000 Special Instructions for the Supplier O / OPMO_NR String 12 - Accounting: Plant Maintenance Order O / OGPS_LONGITUDE Number 9 6 The Longitude co-ordinates for the Order location O / OGPS_LATITUDE Number 9 6 The Latitude co-ordinates for the Order location O / OGEOCODING_STATUS String 10 The status of the Geocode search to retrieve latitude

and longitude address co-ordinates. Values are ‘APPLIED’ and ‘UNKNOWN’

O / O

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.15.2 Design Rules:

To display the customer Orders in the extract, the order should be eligible with below conditionso Order customer should be the customer

To display Other Customer’s orders in the extract, the order should be eligible with below conditionso Order customer should not be the customero Order supplier should be the customer o Order has been allocated to a contract where the customer is the supplier

An Order Details delta record will be created for every order that has had an Order_activity_log , Field_note or Form (attachment) record created in the interval since the last delta extract.

The Order Details extract will contain one record for each Order regardless of the number of history records created for that Order within the processing window.

The details of the Order which are extracted to the Datamart are the latest values stored against the Order at processing time. The Order Details delta extract will contain records of type ‘B’ – normal order; ‘R’ – reinstatement order and ‘Q’ – supplier quote. The extract will

not include records of type ‘M’ – master quote, ‘L’ – master template order or ‘T’ – project view template order.

ConSol Datamart Specification Page 39

Page 48: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

Special characters populated from ‘cut and paste’ actions from external applications have been removed from the following fields: Order Description, Reference Number, Job Location, Special Instructions and Comments.

4.16 Attribute Detail Extract Delta

This is a table of all current attribute values for each entity. It displays current values for Project View, Order and Order Item attributes.

4.16.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

PROJ_VIEW_NO Integer 10 0 Foreign key. Unique identifier for the Project to which this attribute is attached if it is a project attribute, null otherwise.

O / O

ORDER_ID String 8 - Foreign key. The unique ConSol order ID to which this attribute is attached if it is a order attribute, null otherwise.

O / O

ORDER_ITEM_NO Integer 10 - Foreign key. A unique identifier for the order item to which this attribute is attached if it is an item attribute, null otherwise.

O / O

ATTRIBUTE_TYPE_NO Integer 10 0 Foreign key. Uniquely identifies the attribute type. O / MATTRIBUTE_LIST_NO Integer 10 0 Foreign key. Uniquely identifies the attribute list

value.O / O

ATTRIBUTE_NAME String 64 - The name of the attribute whose value was changed. O / MDATA_TYPE String 15 - ConSol currently supports five distinct data types for

attributes. These are: ‘text’ – a string of text that accepts most character values; ‘date’ – a date in dd-mm-yyyy format; ‘list’ – a defined list of coded values and descriptions; ‘currency’ – numeric value in currency format ($9999.99); and ‘number’ – numeric value.

O / M

ConSol Datamart Specification Page 40

Page 49: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

ATTRIBUTE_VALUE String 255 - The Attribute Value O / ODATA_REFRESH_DATE Date 23 - yyyy/mm/dd

hh:mm:ssData propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.16.2 Design Rules

Extract includes current attribute value for each entity Each record will only have one of Proj_View_No, Order_id or Order_item_no populated A composite Primary Key of Proj_View_No + Order_Id + Order_Item_No +Attribute_Type_No can be inferred. If this combination has been

previously extracted, then the current row is an update of that information, else it is a new (insert) record.

4.17 Milestone Details Delta Extract

This is a table of all milestones associated to Project Views or Orders. The table contains details of any milestone with a change date in the extract processing window.

4.17.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

MILESTONE_NO Integer 10 0 Primary key. The unique Milestone Event Identifier M / MMILESTONE_TYPE_NO Integer 10 0 Foreign key. The unique identifier for the milestone

typeM / M

PROJ_VIEW_NO Integer 10 0 Foreign key. Unique identifier for the Project to which this milestone is attached if it is a project-context milestone, null otherwise.

O / O

ORDER_ID String 8 - Foreign key. The unique ConSol order ID to which this milestone is attached if it is an order-context milestone, null otherwise.

O / O

ConSol Datamart Specification Page 41

Page 50: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

MILESTONE_STATUS String 10 - The current status of the milestone (see milestone status codes above)

M / M

RECIPIENT_VIEWABLE String 1 - Indicates whether the milestone is visible to the supplier

M / M

RECIPIENT_EDITABLE String 1 - Indicates whether the milestone is editable by the supplier

M / M

BASELINE_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The first value of the FORECAST_DATE field. Represents the expected completion date.

O / M

FORECAST_DATE_OFFSET Integer 5 - Whole number representing change applied to Milestone forecast date.

O/ M

FORECAST_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date the milestone is expected to done by O / M

WARNING_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date that breach warnings begin O / O

ACTUAL_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date the milestone was completed O / O

MILESTONE_GROUP_NAME String 20 The name of the milestone group that the milestone is associated to

O / O

CHAIN_SEQUENCE Integer 2 If the milestone is part of a chain, it will have a not null sequence number, where ‘0’ identifies the anchor event and chained dependencies are sequentially numbered. Milestones within a chain will have the same group name.

O / O

TRIGGER_TYPE String 12 This will be ‘MANUAL’ if the milestone had been manually added to the event. If the milestone was automatically instantiated, this will display the stage at which the milestone was triggered – the options are ‘TRANSMIT’, ’ACCEPT’, ‘COMPLETE’ AND ‘PV_CREATION’

O / M

CHANGE_DATE Date 23 yyyy/mm/dd Date that the last change was made to the M / M

ConSol Datamart Specification Page 42

Page 51: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

hh:mm:ss milestoneCHANGE_BY String 71 - The full name of the user who last updated the

order milestone. This field may be blank if a user has not acquired the invoice.

M / M

DATA_REFRESH_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Data propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.17.2 Design Rules:

Extract includes details of milestones with a change_date in the processing window. If Project View or Order belong to another customer, only those Milestone marked as viewable by the supplier will be included

4.18 Metadata Extract Delta

This is a table of all metadata associated to Project Views or Orders that the customer can view. Metadata is additional information recorded against Orders or Project Views via a data import, which can be viewed from a mobile device. The table contains details of any metadata with a change date in the extract processing window.

4.18.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

METADATA_NO Integer 10 0 Primary key. The unique Metadata Identifier M / MPROJ_VIEW_NO Integer 10 0 Foreign key. Unique identifier for the Project to which

this metadata is attached if it is project-context metadata, null otherwise.

O / O

ORDER_ID String 8 - Foreign key. The unique ConSol order ID to which this O / O

ConSol Datamart Specification Page 43

Page 52: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

metadata is attached if it is order-context metadata, null otherwise.

METADATA_GROUP String 100 The Group Label for the Metadata Group O / MMETADATA_KEY String 100 - The Type of metadata being collected M / MMETADATA_VALUE String 2000 - The metadata value O / OCHANGE_DATE Date 23 yyyy/mm/dd

hh:mm:ssDate that the last change was made to the metadata record

M / M

CHANGE_BY String 71 - The full name of the user who last updated the metadata

M / M

DATA_REFRESH_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Data propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.18.2 Design Rules:

Extract includes metadata details for every Order in the Order Details extract and every Project View in the Project Details extract that have metadata associated, with a Change Date in the processing window.

4.19 App Survey Extract Delta

This is a table of all survey responses recorded using the Survey App which are associated to Project Views or Orders that the customer can view. The table contains details of any survey response undertaken from a Mobile device with a submit date in the extract processing window. Individual Questions and Answers are associated to a Survey Response.

4.19.1 Data Dictionary

Field Name Type Length Precision Format Description Mandatory

DB / AppRESPONSE_ITEM_NO Integer 19 0 Primary key. The unique identifier for each survey

item responseM / M

PROJ_VIEW_NO Integer 10 0 Foreign key. Unique identifier for the Project to O / O

ConSol Datamart Specification Page 44

Page 53: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

which this survey is attached if it is project-context survey, null otherwise.

ORDER_ID String 8 - Foreign key. The unique ConSol order ID to which this survey is attached if it is order-context survey, null otherwise.

O / O

SURVEY_NAME String 500 - The Survey Description O / MRESPONDENT_TYPE String 100 - Identifies whether the survey was undertaken by

Supplier (SUPP) or Customer (CUST)O / M

SURVEY_RESPONSE_NO Integer 19 0 Unique identifier for each response M / MSURVEY_QUESTION_NO Integer 19 0 The survey Item question number M / MSURVEY_ITEM_QUESTION String 4000 - The survey item question M / MSURVEY_ITEM_RESPONSE String 4000 - The survey item response O / OSURVEY_ITEM_CONTEXT String 25 - The item id of the trigger item O / ORESPONSE_BY String 71 - The full name of the user who submitted the survey

response M / M

RESPONSE_CHANGE_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Date that the survey response was changed M / M

DATA_REFRESH_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Data propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.19.2 Design Rules:

Extract includes survey response details for every Order in the Order Details extract and every Project View in the Project Details extract for which surveys have been submitted, with a Submit Date in the processing window.

Only Surveys undertaken using the Survey App tool will be included in the Datamart

ConSol Datamart Specification Page 45

Page 54: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

4.20 Survey Actions Extract Delta

This is a table of all actions triggered by survey responses recorded using the Survey App. The table contains details of any survey action with a change date in the extract processing window. For the customer, the survey actions that will be populated into this table are the SOR mappings occurring in the Pit Surveys. These SOR mappings can be associated to a specific survey response.

4.20.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

SURVEY_RESP_ACTION_NO

Integer 10 0 Primary key. The unique identifier for each survey response action

M / M

SURVEY_RESPONSE_NO Integer 19 0 Foreign key. Unique identifier for each response M /MACTION_KEY String 500 - The type of action being triggered O / MACTION_VALUE String 4000 - The value of the action O / MCHANGE_BY String 71 - The full name of the user who recorded the survey

response action M / M

RESPONSE_CHANGE_DATE

Date 23 - yyyy/mm/dd hh:mm:ss

Date that the survey response action was added / changed

M / M

DATA_REFRESH_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Data propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.20.2 Design Rules:

Extract includes survey response action details for those surveys with responses that triggered other actions, with a Change Date in the processing window.

4.21 Invoice Details Extract Delta

This is a table of all Invoice details. The table contains details of invoices that were submitted, approved, extracted, confirmed for payment, paid or had any status change within the processing window.

ConSol Datamart Specification Page 46

Page 55: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

4.21.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

ORDER_ID String 8 - Foreign key. The unique ConSol order ID. M / MINVOICE_NO Integer 10 - Primary key. The unique Invoice identifier for the

invoice.M / M

INVOICE_STATUS String 3 - The current status of the invoice (see invoice status codes above)

O / M

INVOICE_REF String 25 - The invoice reference number, as displayed on the application.

O / O

INVOICE_ISSUE_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date the invoice was created (the submission date of the claim when the claim was approved).

O / M

INVOICE_APPROVAL_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date the invoice was approved. O / O

INVOICE_AP_CONFIRM_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date that payment confirmation was received from Integral

O / O

FINANCE_PERSON String 71 - The full name of the Finance Person on the invoice. This field may be blank if a user has not acquired the invoice.

O / O

FINANCE_WORKGROUP String 50 The name of the Finance workgroup/area that is responsible for the Invoice. The Finance Person must be a member of this resource. This may not be

O / O

PAYMENT_REF String 12 - The payment reference for confirmation of a paid invoice

O / O

VENDOR_NO String 20 - The vendor number that the invoice was issued to O / MSUPPLIER_COMPANY_NO Integer 10 - The unique identifier for the supplier who

submitted the invoice.M / M

PAYMENT_TERMS Integer 2 - The number of days in the Payment terms. O / M

ConSol Datamart Specification Page 47

Page 56: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

INVOICE_SENT_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date the Invoice was submitted by the supplier O / O

$_INVOICE_(ex GST) Number 12 2 The invoice amount exclusive of GST. O / M$_GST Number 12 2 The amount of GST on the invoice. O / O$_INVOICE_TOTAL Number 12 2 The total invoice amount - sum of $ INVOICE(ex

GST) + $ GST. O / M

INVOICE_PAYMENT_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date the invoice was marked ‘Paid and Closed’.

O / O

DATA_REFRESH_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Data propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

COST_CENTRE String 10 - Accounting: Cost Centre O / OPROJECT_NR String 10 - Accounting: Project Number O / ONETWORK String 12 - Accounting: Network Number O / OACTIVITY String 4 - Accounting: Activity Number O / OWBS_ELEMENT String 24 - Accounting: WBS Element O / OCLAIM_TYPE String 20 - The type of Claim being made – this distinguishes

between ‘Claim for Payment’ and ‘Final Claim’. The values in this column will be ‘paymentClaim’ and ‘completionClaim’

O / M

EFF_FROM_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Docket Start Date for invoice. This defines payment period on part payments

O / O

EFF_TO_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Docket End Date for invoice. This defines payment period on part payments

O / O

INVOICE_CONFIRM_DATE_2 Date 23 - yyyy/mm/dd hh:mm:ss

The date that payment confirmation was received from second payment system

O / O

PAYMENT_REF_2 String 12 - The payment reference for confirmation of a paid invoice from second payment system

O / O

INVOICE_PAYMENT_DATE_2 Date 23 - yyyy/mm/dd The date the invoice was marked ‘Paid and Closed’ O / O

ConSol Datamart Specification Page 48

Page 57: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

hh:mm:ss from second payment system INVOICE_STATUS_2 String 3 - The status of the invoice with regards to the

second payment system O / O

PMO_NR String 12 - Accounting: Plant Maintenance Order O / O (Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.21.2 Design Rules:

Extract includes details from ‘Invoice Submit’ onwards. Invoices at the following statuses are not included: NEW, BGC, BJC, DIS, EPR, NTX – see table above for descriptions.

4.22 Claim History Extract Delta

This is a list of all claimed items showing details of the supplier claim and customer’s response to the claim request.

4.22.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

ORDER_ID String 8 - Foreign key. The unique ConSol order ID. M / MORDER_ITEM_NO Integer 10 - Foreign key. The unique identifier for this item. M / MVERSION_NO Integer 10 The sequence in which the submissions and

verifications have occurredM / M

VERSION TYPE String 10 - The snapshot version (see item version codes above) O / MITEM_PRICE Number 13 3 - The price of the item per unit, exclusive of GST. O / MORDER_QTY Number 12 2 - The number of ordered units of the specified item. O / MCLAIM_QTY Number 12 2 - The number of claimed units of the specified item. O / M

DELIV_QTY Number 12 2 - The number of verified units of the specified item . O / MSAP_ACTIVITY String 10 - Accounting: SAP Activity Code O / OSAP_ACCOUNT String 38 - Accounting: SAP Account Number O / OSUB_PROJECT_NR String 10 - Accounting: Sub Project Number O / O

ConSol Datamart Specification Page 49

Page 58: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

WBS ELEMENT String 24 - Accounting: WBS Element O / OOP_NR String 4 - Accounting: Operation Code O / OIS_VARIATION Integer 2 - Flag to indicate whether the item has been varied O / MVARIATION_ACCEPTANCE

String 10 - - The variation status of the Item (n/a, New, Agreed, Partial or Rejected)

O / M

CREATE_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date the claim was submitted or verified O / M

DATA_REFRESH_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Data propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.22.2 Design Rules:

Extract includes every Order Item change within the processing windowwhere the change was related to a Claim for Payment request and . This includes all records with the following version type codes: FINSUB, FINVER, FINVERREC, PROSUB, PROVER, PROVERREC (see table above for descriptions)

4.23 Order Invoice History Extract Delta

This is a table of all events written to the Order History logs during the processing window. These records relate to Order, Quote, Claim and Invoice events.

4.23.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

ORDER_ID String 8 - Foreign key. The unique ConSol order ID. M / MHISTORY_DATE Date 23 - yyyy/mm/

dd hh:mm:ss

The date and time at which the history log record was added to the ConSol database

M / M

UPDATE_USER String 71 - The full name of the user who triggered the O / M

ConSol Datamart Specification Page 50

Page 59: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

recording of the History log record.COMMENT String 2000 - Details of the event that resulted in the creation

of the History log record or the Order History code defining the change event (see Order History Codes above). If the comment was recorded by the user from a mobile device, it will be prefixed by the date/time that the comment was updated to the mobile device to accommodate possible delays of information upload caused by off-line processing

O / M

INVOICE_NO Integer 10 0 Foreign key. The unique Invoice identifier. O / ORECORD_TYPE String 10 - Indicates whether the record is a status change

(STATUS) or a note (NOTE)O / M

NOTE_TYPE String 8 - If the Record type is note, this displays the type of note, else it is null

O / O

GPS_LONGITUDE Number 9 6 The Longitude co-ordinates from which the action from the mobile device was submitted that triggered the creation of the history event

O / O

GPS_LATITUDE Number 9 6 The Latitude co-ordinates from which the action from the mobile device was submitted that triggered the creation of the history event

O / O

GPS_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Date history note uploaded from mobile device O / O

ORIGINATOR_TYPE String 10 Where the action was triggered. ‘MOB’ if triggered from a mobile device, else blank

O / O

SORT_NO Number 19 0 Sequence number of all ConSol events, to assist with sorting

O / O

DATA_REFRESH_DATE Date 23 - yyyy/mm/dd

Data propagates from the application to the Datamart at defined intervals. This field indicates

M / M

ConSol Datamart Specification Page 51

Page 60: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

hh:mm:ss the date at which this record was read from the application.

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.23.2 Design Rules:

Extract includes every line note written in ConSol application for Orders, Quotes and Invoices that are viewable by the customer The extract doesn’t include document attachments. The extract does not include notes for orders where the customer is the supplier if the order has not yet been transmitted. All the extract details for the field notes (entered using the Rich Text Editor in ConSol) added by user will be removed for any formatting and

only raw text will be presented in the extract.

4.24 Order Item Details Extract Delta

This is a table of all order item details for items on all orders included in the Order Details extract.

4.24.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

ORDER_ID String 8 - - Foreign key. The unique ConSol order ID. M / MORDER_ITEM_NO Integer 10 0 - Primary key. A unique identifier for this item. M / MITEM_ID String 25 - The item id of the item, as displayed in the application. O / MINTIAL_ORDER_QTY Number 12 2 - The agreed number of units of the specified item at the

time of order transmission.O / M

ITEM_PRICE Number 13 3 - The price of the item per unit, exclusive of GST. O / OORDER_QTY Number 12 2 - The current agreed number of units of the specified

item.O / M

REQUESTED_QTY Number 12 2 - The requested number of units by the supplier. O / OCLAIM_QTY Number 12 2 - The claimed number of units by the supplier O / ODELIVERED_QTY Number 12 2 - The number of units delivered thus far. This refers to O / O

ConSol Datamart Specification Page 52

Page 61: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

approved claim quantities.ITEM_DETAIL String 500 - - The item description O / OITEM_COMMENTS String 500 - - Items may have comments entered against them

through the application. This field holds the current comment if any.

O / O

DATA_REFRESH_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Data propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

SAP_ACTIVITY String 10 - Accounting: SAP Activity Code O / OSAP_ACCOUNT String 38 - Accounting: SAP Account Number O / OSUB_PROJECT_NR String 10 - Accounting: Sub Project Number O / OWBS_ELEMENT String 24 - Accounting: WBS Element O / OOP_NR String 4 - Accounting: Operation Code O / OUSED_QTY Number 12 2 Quantity of the Item that has been recorded as ‘Used’

from the mobility app O / O

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.24.2 Design Rules:

Extract includes details of items for every order in the Order Details extract. This extract will always show the current values of the items with respect to the order in the Order Details extract.

4.25 Invoice Item Details Extract Delta

This is a table of all invoice item details for items on all invoices included in the Invoice Details extract.

4.25.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

INVOICE_ITEM_NO Integer 10 0 - Primary key. A unique identifier for this invoice item. M / MORDER_ITEM_NO Integer 10 0 - Foreign key. A unique identifier for this item. M / M

ConSol Datamart Specification Page 53

Page 62: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

INVOICE_NO Integer 10 0 Foreign key. The unique Invoice identifier. M / MITEM_PRICE Number 13 3 - The price of the item per unit, exclusive of GST. O / MITEM_QTY Number 12 2 - The number of units of the specified item being

invoiced.M / M

AMT_INVOICED Number 12 2 - The invoice amount exclusive of GST for this item. O / MGST_INVOICED Number 12 2 - The amount of GST on the invoice for this item. O / OTOTAL_INVOICED Number 12 2 - The total invoice amount for this item - sum of AMT

PAID + GST PAID. O / M

DATA_REFRESH_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Data propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

SAP_ACTIVITY String 10 - Accounting: SAP Activity Code O / OSAP_ACCOUNT String 38 - Accounting: SAP Account Number O / OSUB_PROJECT_NR String 10 - Accounting: Sub Project Number O / OWBS ELEMENT String 24 - Accounting: WBS Element O / OOP_NR String 4 - Accounting: Operation Code O / O

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.25.2 Design Rules:

Extract includes details of invoice items for every invoice in the Invoice Details extract. This extract will always show the current values of the items with respect to the invoice in the Invoice Details extract.

4.26 Item History Extract Delta

This is a table of all Item details for items on snapshots that were generated during the processing window.

4.26.1 Data Dictionary

Field Name Type Length Precision Format Description Mandatory

DB / AppORDER_ID String 8 - - Foreign key. The unique ConSol order ID. M / M

ConSol Datamart Specification Page 54

Page 63: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

ORDER_ITEM_NO Integer 10 0 - Foreign key. A unique identifier for this item. M / MITEM_PRICE Number 13 3 - The price of the item per unit, exclusive of GST. O / OORDER_QTY Number 12 2 - The current agreed number of units of the specified

item.O / M

REQUESTED_QTY Number 12 2 - The requested number of units by the supplier. O / OCLAIM_QTY Number 12 2 - The claimed number of units by the supplier O / ODELIVERED_QTY Number 12 2 - The number of units delivered thus far. This refers to

approved claim quantities.O / O

VARIATION_ACCEPTANCE String 10 - - The variation status of the Item (n/a, New, Agreed, Partial or Rejected)

O / M

SNAPSHOT_DETAIL String 2000 - - The snapshot type where the order item details can be viewed through the application

O / O

SNAPSHOT_CREATE_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Date and Time of Snapshot creation O / M

UPDATE_USER String 71 - - The full name of the user who triggered the recording of the History log record for respective item version record

O / M

VERSION TYPE String 10 - The Item Version type (see item version type codes above

O / M

DATA_REFRESH_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Data propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.Should this be last row as per other extracts?

M / M

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.26.2 Design Rules:

The extract will include duplicate lines for every Item that has one or more snapshots generated or invoice activity during the processing window

Item History records for items that no longer exist will be removed from this extract.

ConSol Datamart Specification Page 55

Page 64: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

4.27 Item Variation Extract Delta

This is a table of all Item details for items where an item variation occurred

4.27.1 Data Dictionary

Field Name Type Length Precision Format Description Mandatory

DB / AppORDER_ITEM_VARIATION_NO

Integer 10 0 - Primary key. A unique identifier for the variation being made.

M / M

ORDER_ITEM_NO Integer 10 0 - Foreign key. A unique identifier for this item. M / MORIG_ITEM_PRICE Number 13 3 The original price of the item per unit, exclusive of

GST.O / O

ORIG_QTY Number 12 2 The original number of units of the specified item O / MREQ_ITEM_PRICE Number 13 3 The requested price of the item per unit, exclusive of

GST.O / O

REQ_QTY Number 12 2 The requested number of units of the specified item O / ORESP_ITEM_PRICE Number 13 3 The response price of the item per unit, exclusive of

GST.O / O

RESP_QTY Number 12 2 The response number of units of the specified item O / OVARIATION_VERSION Number 10 - The order sequence for the variation that occur

against an itemM / M

VARIATION_STATUS String 10 - - The status of the variation acceptance (n/a, Yes, No, or Partial)

O / M

VARIATION_AMOUNT Number 13 3 - The amount of variation for current request O / OVARIATION_TYPE String 20 - - The variation type – distinguishes between

variations submitted through the request for variation process (RQVAR) or variations made when submitting a claim (CLAIM).

O / M

USER_TYPE String 8 - - Identifies whether the variation was made by the SUPPLIER or the customer.

O / M

ConSol Datamart Specification Page 56

Page 65: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

DATA_REFRESH_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Data propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.27.2 Design Rules:

The extract will include duplicate lines for every Item that has one or more variations generated during the processing window

4.28 Attribute History Extract Delta

This is a table of all attribute changes that occurred within the processing window

4.28.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

PROJ_VIEW_NO Integer 10 0 Foreign key. Unique identifier for the Project to which this attribute is attached, if it is a project attribute, null otherwise.

O / O

ORDER_ID String 8 - Foreign key. The unique ConSol order ID to which this attribute is attached, if it is an order attribute, null otherwise.

O / O

ORDER_ITEM_NO Integer 10 0 Foreign key. A unique identifier for the order item to which this attribute is attached if it is an item attribute, null otherwise.

O / O

HISTORY_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date and time at which the attribute value was updated.

M / M

UPDATE_USER String 71 - The full name of the user who made the attribute change

O / M

ConSol Datamart Specification Page 57

Page 66: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

ATTRIBUTE_NAME String 32 - The name of the attribute whose value was changed. M / MATTRIBUTE_VALUE String 4000 - The value that was set on the attribute. O / MDATA_REFRESH_DATE Date 23 - yyyy/mm/dd

hh:mm:ssData propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

ATTRIBUTE_TYPE_NO Integer 10 0 Foreign key. Uniquely identifies the attribute type. M / M (Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.28.2 Design Rules

Extract includes every line note written in ConSol application within the processing window. The ATTRIBUTE_NAME will be a truncated line note of the attribute whose value changed. The extract doesn’t include document attachments

4.29 Document Details Extract Delta

This is a table of all documents added to Project Views, Orders or Invoices within the processing window

4.29.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

DOC_NO Integer 15 Primary key. A unique identifier for attached Document.

M/M

ASSOC_ENTITY_TYPE String 20 Entity that document is associated with, e.g. PROJECTVIEW, ORDER, INVOICE

O / M

PROJ_VIEW_NO Integer 10 0 Foreign key. Unique identifier for the Project to which this document is attached or associated

O / O

ORDER_ID String 8 - Foreign key. The unique ConSol order ID to which this document is attached, if it was attached at Order level, null otherwise.

O / O

ConSol Datamart Specification Page 58

Page 67: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

INVOICE_NO Integer 10 - Foreign key. The unique ConSol Invoice No to which this document is attached, if it was attached at invoice level, null otherwise.

O / O

DOC_NAME String 255 - File name of the attached document O / MDESCRIPTION String 500 - Description of attached document O / OMODIFY_DATE Date 23 - yyyy/mm/

dd hh:mm:ss

The date and time the attachment was added or its content modified.

O / O

MODIFIER String 71 - The full name of the user who attached the document

O / O

STATUS String 20 - Document Review status O / ODOC_VERSION String 10 - Version of the attached document O / ODOC_SIZE Integer 12 - Size of the attached document (in bytes) O / ODOC_TYPE String 50 Name of associated user managed document

type, or internal types (ie Engagement, INVOICE, Mobile, Migrated, Batch,Field Completion Advice)

O / O

VIEW_BY String 32 - Whether the document is viewable by customer & supplier (SUPP), supplier only (SUPP_ONLY) or customer only (CUST)

O / O

SUPPLIER_UPLOADED Number 1 - Whether the document was uploaded by a supplier

O / O

GPS_LONGITUDE Number 9 6 The Longitude co-ordinates from which the document was attached from the mobile device

O / O

GPS_LATITUDE Number 9 6 The Latitude co-ordinates from which the document was attached from the mobile device

O / O

GPS_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date that the document was uploaded from the mobile device.

M / M

DATA_REFRESH_DATE Date 23 - yyyy/mm/dd

Data propagates from the application to the Datamart at defined intervals. This field indicates

M / M

ConSol Datamart Specification Page 59

Page 68: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

hh:mm:ss the date at which this record was read from the application.

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.29.2 Design Rules

Extract includes document attachment id for documents added to Project Views, Orders or Invoices in ConSol application within the processing window that is visible to the customer.

The extract doesn’t include document attachment files

4.30 Milestone History Delta Extract

This is a table of all history records written as a result of additions and modifications of Milestones.

4.30.1 Data Dictionary

Field Name Type Length Precision Format Description MandatoryDB / App

AUDITING_NO Integer 10 0 Primary key. Unique identifier for each Milestone History record.

M / M

MILESTONE_NO Integer 10 0 Foreign key. The unique identifier for the Milestone that the history record relates to.

M / M

ORDER_ID String 8 - Foreign key. The unique ConSol order ID to which the milestone is attached, if it is an order milestone, null otherwise.

O / O

PROJ_VIEW_NO Integer 10 0 Foreign key. Unique identifier for the Project to which the milestone is attached, if it is a project attribute, null otherwise.

O / O

DESCRIPTION String 1000 - Brief Description of the change that triggered the history record creation

M / M

INFO String 4000 Keys and codes associated to the milestone O / O

ConSol Datamart Specification Page 60

Page 69: ConSol Datamart specification - help. Web viewAll words within a multi-word column names in extracts will be separated with an ... Response to EOT Recalled. PCSMT. Payment Claim

OWNED_BY String 5 - Customer Code for the Owner of the Milestone History record

M / M

UPDATE_DATE Date 23 - yyyy/mm/dd hh:mm:ss

The date and time of the change resulting in the history record being written

M / M

UPDATE_USER String 71 - The full name of the user who initiated the changed. M / MVIEW_BY String 32 - Whether the history record is viewable by customer &

supplier (SUPP) or customer only (CUST)M / M

DATA_REFRESH_DATE Date 23 - yyyy/mm/dd hh:mm:ss

Data propagates from the application to the Datamart at defined intervals. This field indicates the date at which this record was read from the application.

M / M

(Mandatory column indicates whether the field is mandatory or optional at the database and application levels)

4.30.2 Design Rules

Extract includes history records created in the processing window for Milestones updated in the processing window.

ConSol Datamart Specification Page 61