Confirm - GIS Mapping | Pitney Bowesreference1.mapinfo.com/software/Confirm/Specification -...
Transcript of Confirm - GIS Mapping | Pitney Bowesreference1.mapinfo.com/software/Confirm/Specification -...
Location IntelligenceInfrastructure Asset Management
Confirm®
Import Anything Specification
Version v18.10b.AM
Information in this document is subject to change without notice and does not represent a commitmenton the part of the vendor or its representatives. No part of this document may be reproduced ortransmitted in any form or by any means, electronic or mechanical, including photocopying, withoutthe written permission of Pitney Bowes Inc., One Global View, Troy, New York 12180-8399.
© 2018 Pitney Bowes. All rights reserved. MapInfo, the MapInfo logo and Confirm are trademarks ofPitney Bowes and/or its affiliates.
Corporate Headquarters:Phone: 518 285 6000Fax: 518 285 6070Sales: 800 327 8627Government Sales: 800 619 2333Technical Support: 518 285 7283http://www.pitneybowes.com/us
UK and EMEA Headquarters:Phone: 1 800 840 0001Technical Support (UK): 1 800 840 0001Technical Support (International): 44 1634 880141http://www.pitneybowes.com/uk
Asia Pacific Headquarters:Phone: 61 2 9437 6255Fax: 61 2 9439 1773Technical Support: 1 800 648 899www.pitneybowes.com.au/software
Contact information for all Pitney Bowes offices is located at: http://www.pitneybowes.com/uk/contact-us.
Products named herein may be trademarks of their respective manufacturers and are hereby recognized.Trademarked names are used editorially, to the benefit of the trademark owner, with no intent to infringeon the trademark.
Open Source Attribution NoticeThe Confirm suite of products contain the following open source software:
• Feature Data Objects v 3.5.0, which is licensed under GNU Lesser General Public License, Version2.1, February 1999 with the unRAR restriction. The license can be downloaded from: http://fdo.os-geo.org/licenceAndGovernance.html. The source code for this software is available from ht-tp://fdo.osgeo.org/content/fdo-350-downloads
• MrSID software (specifically the mrsid32.dll) is used under license and is Copyright © 1995-2002,LizardTech, Inc., 1008 Western Ave., Suite 200, Seattle, WA 98104. All rights reserved. MrSID isprotected by U.S. Patent No. 5,710,835. Foreign patents are pending. Unauthorized use or duplicationprohibited.
Patented technology in the Software was developed in part through a project at the Los AlamosNational Laboratory, funded by the U.S. Government and managed by the University of California.The U.S. Government has reserved rights in the technology, including a non-exclusive, nontransfer-able, irrevocable, paid-up license to practice or have practiced throughout the world, for or on behalfof the United States, inventions covered by the patent, and has other rights under 35 U.S.C. § 200-212 and applicable implementing regulations.
For further information, contact Lizardtech.
• NodaTime, version number 1.3.10, which is licensed under the Apache license, version number 2.0.The license can be downloaded from http://www.apache.org/licenses/LICENSE-2.0 . The sourcecode for this software is available from http://nodatime.org/.
• Chromium Embedded Framework, version 3, which is licensed under the New BSD License. The li-cense can be downloaded from http://opensource.org/licenses/BSD-3-Clause. The source code forthis software is available from http://code.google.com/p/chromiumembedded/downloads/list.
• Xilium.CefGlue, version 3, which is licensed under the MIT License (with portions licensed underthe New BSD License). The licenses can be downloaded from http://opensource.org/licenses/MITand http://opensource.org/licenses/BSD-3-Clause. The source code for this software is availablefrom http://xilium.bitbucket.org/cefglue/.
• D3 Data Driven Documentation, version 3.4.1, which is licensed under the New BSD License. Thelicense can be downloaded from from https://github.com/mbostock/d3/blob/master/LICENSE. Thesource code for this software is available from http://d3js.org/.
• OpenLayers, version 2.12, which is licensed under the Modified BSD License. The license can bedownloaded from http://svn.openlayers.org/trunk/openlayers/license.txt. The source code for thissoftware is available from http://trac.osgeo.org/openlayers/browser.
• OpenLayers, version 3, which is licensed under the BSD 2-Clause Licence. The license which canbe downloaded from https://github.com/openlayers/ol3/blob/master/LICENSE.md. The source codefor this software is available from https://github.com/openlayers/ol3.
• Proj4js, version 1+, which is licensed under the Apache License, Version 2, January 2004.The licensecan be downloaded from http://www.apache.org/licenses/LICENSE-2.0.html. The source code forthis software is available from http://trac.osgeo.org/proj4js/.
• requireJS, version 2.1.2, which is licensed under the MIT License or the New BSD License.The licensecan be downloaded from https://github.com/jrburke/requirejs/blob/master/LICENSE. The sourcecode for this software is available from http://requirejs.org/.
• Apache Cordova, version 4.2.0, which is licensed under the Apache License, Version 2, January2004. The license can be downloaded from http://www.apache.org/licenses/LICENSE-2.0.html. Thesource code for this software is available from http://phonegap.com/download/.
May 08, 2018
Table of Contents
Specifications
Import Anything Specification(LJM-59-129) 6
Sites 7
Highway Dedication 8
Features and Feature Attributes 9
Inventory and InventoryAttributes 12
Surveys 14
Asset Valuation Logs 16
Jobs and Job Items 18
Inspection Features andConditions 20
Defects and Defect Attributes 21
Defect Updates 23
Inspection Routes 24
Monitoring Item 25
Traffic Survey 26
Document Links 28
File Format 29
SpecificationsThe following sections outline all the Specifications that exist within theConfirm functionality.
In this section
Import Anything Specification (LJM-59-129) 6
Import Anything Specification (LJM-59-129)
IntroductionThis document is an import file specification for the Import Data utility in the Confirm client software,and for the Import Anything Agent.
This document should be used in conjunction with training/consultancy in the use of the system’s dataimport facilities.
The types of record that can be imported are listed in the table below, along with the Module(s) requiredto be able to import them.
Module(s) requiredRecords to be imported
SG - Gazetteer Import Agent (3020)Sites
SG - Level 3 Compiler (3010) ORHighway Dedication
Map (0425)
AR – Import Agent (0195)Features and Feature Attributes
AR – Import Agent (0195)Inventory and Inventory Attributes
AR – Inventory (0112)
PMS - Observation Data (4010)Surveys
Asset Valuation and Depreciation (1500)Asset Valuation Logs
Condition Survey (0500)Inspection Routes
Condition Survey – Import Agent (0610)Jobs and Job Items
Condition Survey – Import Agent (0610)Inspection Features and Conditions
Condition Survey – Import Agent (0610)Defects and Defect Attributes
Defect Attributes (0510)
Condition Survey (0500)Defect Update
PM – Import Agent (1110)Monitoring Items
Traffic Count Data (4500)Traffic Count Surveys
Asset Valuation Logs can be imported via the Import Data utility without an Import AgentModule. However, the Module ‘Asset Valuation – Import Agent’ (1530) is required to load them
Note:
via the Import Anything Agent. For details on importing files formatted for the previous AssetValue Log Import Utility see Asset Valuation Log Import Transformation.
6 of 30Pitney Bowes
Specifications
Sites
Confirm module 3020 is required to import Site records.
Multiple instances of a Site record can be imported in a single file, with the last instance being con-sidered the most current version. Therefore the first instance is updated with any changes found insubsequent instances in the order in which they appear in the import file.
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Central Site'--Record Type
MandatoryCharacter10Code
MandatoryCharacter40Name
Site records onlyCharacter15Plan number
Defaults from SystemSetting
Character4Category
Defaults from SystemSetting
Character4Area
Defaults from SystemSetting
Character4Ward
Numeric10 (8.2)Extent 1 Easting
Numeric10 (8.2)Extent 1 Northing
Numeric10 (8.2)Extent 1 Altitude
Numeric10 (8.2)Extent 2 Easting
Numeric10 (8.2)Extent 2 Northing
Numeric10 (8.2)Extent 2 Altitude
Numeric10 (8.2)Centroid Easting
Numeric10 (8.2)Centroid Northing
Numeric10 (8.2)Centroid Altitude
Defaults from SystemSetting
Character8Organisation
Mandatory If Street Typefound in Confirm then
Numeric1 (1.0)Street Type
use record. Else if StreetType found in Confirmas External Referencethen use the matchingrecord with the lowestStreet Type Code. Elseuse System Default IfStreet Type Alias Flag ='N' then a Site record iscreated.
If any of the localityfields contains data then
Char35Locality
all are considered tocontain data.
(see Locality)Char35Town
7 of 30Pitney Bowes
Specifications
CommentTypeSizeField
(see Locality)Char35County
Defaults from SystemSetting
Numeric4 (4.0)Version
Default to current dateDateStart Date
Default to EOTDateEnd Date
Character2000Central Notes
Character2000Address
Character4Customer
Character4Contract Area
Character4Classification
Character15Cost code
Character2000Notes
Character10Site External Ref
Defaults to 0Numeric3 (3.0)Site Tolerance
Default to current dateDateModified Date
Default to NULLDatePublished Date
Default to NCACharacter4Site State Code
Set to current date if SiteState Code is supplied
DateSite State Date
and Site State Date isblank.
Default to NCACharacter4Site Surface Code
System Settings - The following Import Anything System Settings should be set if they are not con-tained within the imported Site record.
Category, Area, Ward, Street Type, Classification, Contract Area, Customer and Cost Code
Highway Dedication
Confirm module 3010 and 0425 is required to import Highway Dedication records.
The ESU (Elementary Street Units) against which Highway Dedications are being imported must existin the Map Workspace in the NSG Manager screen.
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Esu Dedication'--Record Type
MandatoryCharacter14ESU Id
MandatoryNumeric2(2,0)ESU Dedication Number
Mandatory (Lookup)Character4Highway DedicationCode
Defaults to current dateif not supplied
DateRecord Entry Date
8 of 30Pitney Bowes
Specifications
CommentTypeSizeField
Defaults to current dateif not supplied
DateLast Updated Date
DateRecord End Date
MandatoryDateHd Start Date
OptionalDateHd End Date
Optional (e.g. '11:15','22:45')
CharacterHd Start Time
Optional (e.g. '11:15','22:45')
CharacterHd End Time
'0' or '1'. If not specifiedthen will default to '0'.
Character1Hd Prow
'0' or '1'. If not specifiedthen will default to '0'.
Character1Hd Ncr
'0' or '1'. If not specifiedthen will default to '0'.
Character1Hd Quiet Route
'0' or '1'. If not specifiedthen will default to '0'.
Character1Hd Obstruction
'0' or '1'. If not specifiedthen will default to '0'.
Character1Hd Planning Order
'0' or '1'. If not specifiedthen will default to '0'.
Character1Hd Works Prohibited
OptionalDateHd Seasonal Start Date
OptionalDateHd Seasonal End Date
Note - Highway Dedication record are deleted and then Inserted when records are imported from NSGImport 8.1.
Highway Dedication record are inserted and updated when records are imported from Import Anything.
Sample FileThe following sample file creates a new Highway Dedication against an existing Esu:1,Esu Dedication,Esu Id,Esu Dedication Number,Highway Dedication Code,RecordEntry Date,Last Updated Date,Record End Date,Hd Start Date,Hd End Date,HdStart Time,Hd End Time,Hd Prow,Hd Ncr,Hd Quiet Route,Hd Obstruction,HdPlanning Order,Hd Works Prohibited,Hd Seasonal Start Date,Hd Seasonal EndDate2,Esu Dedica-tion,267823209184,4,HD09,05/09/2015,05/09/2015,05/10/2015,05/09/2015,05/10/2015,11:12,11:23,0,0,0,0,,1,05/09/2015,05/10/2015
Features and Feature Attributes
FeatureConfirm module 0195 is required to import Feature records.
The Sites against which Features are being imported must exist in Confirm or be present in the importfile.
9 of 30Pitney Bowes
Specifications
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Feature'--Record Type
Mandatory if new Invent-ory is to be imported
Character50Record Id
Mandatory for a newFeature. See Discard
Character10Site Code
Blank Site Records foran exception.
Can be auto-generatedfor a new Feature
Numeric10 (8.2)Plot Number
Character20Central Asset ID
Mandatory for a newFeature
Character15Feature ID
DateStart Date
DateEnd Date
Character4 or 30Feature Type
Defaults from the Site ifnot supplied.
Character4 or 30Site Classification
Defaults from the Site ifnot supplied.
Character4 or 30Customer
Defaults from the Site ifnot supplied.
Character15 or 30Cost Code
Defaults from the Site ifnot supplied.
Character4 or 30Area
Defaults from the Site ifnot supplied.
Character4 or 30Ward
Defaults from the Site ifnot supplied.
Character4 or 30Contract Area
Numeric10 (8.2)Extent 1 Easting
Numeric10 (8.2)Extent 1 Northing
Numeric10 (8.2)Extent 1 Altitude
Numeric10 (8.2)Extent 2 Easting
Numeric10 (8.2)Extent 2 Northing
Numeric10 (8.2)Extent 2 Altitude
Numeric10 (8.2)Centroid Easting
Numeric10 (8.2)Centroid Northing
Numeric10 (8.2)Centroid Altitude
Character20External Asset Ref
Character2000Feature location
Character2000Feature notes
DateSurvey date
Numeric2 (2.0)Hierarchy Level Code
10 of 30Pitney Bowes
Specifications
CommentTypeSizeField
Character20Property ID
Character4 or 30Asset Category
Character4 or 30Asset Control Type
Character4 or 30Function
DateActive from date
DateActive to date
Reverse(R),For-ward(F),Normal(F), N (F)
Character1 or 7Direct Flag
Full (F) or Partial (P) orFull by Inventory Type
Character1Inventory Flag
(I). Defaults to Full ByInventory Type.
The External Asset Ref. allows cross-referencing to another Asset register that is not able to use thesame Asset identification technique used by Confirm. If the Central Asset ID is not supplied, thenConfirm will assign a unique ID to the asset on import.
The hierarchy level determines the level of the asset in the hierarchical data model (1 being the top,99 the bottom). Steps of 10 are recommended.
Features are identified through the following methods in the specified order. The absence of any formof identification will result in an error.
1) Site and Plot Number
2) Central Asset ID
3) Feature ID and Start Date. Start date in this instance is used as an effective date.
Features cannot be modified so that the Feature itself or any of its Inventory has a start date greaterthan the end date
Versioning of a Feature can only occur if the unique Feature ID system setting is set to true. Whenversioning a Feature the Feature ID must be the same as the existing Feature but with a differentCentral Asset ID. The existing Feature with the greatest start date is always selected as the Featureto version.
Feature Type - For new Features where Feature Type is not supplied the Import System Settingscreen should have the default Feature Type set.
Discard Blank Site Records - This check box on the Import Anything System Setting screen shouldbe set in order to discard those Feature records with a blank Site Code. This prevents these recordsfrom being imported without raising an error and thus the import file being rejected.
Direct Flag - For importing Inventory. Specifies whether the Inventory data in the file is in the Forwardor Reverse direction relative to the Feature.
Inventory Flag - For importing Inventory. Determines how existing Inventory on the Feature will bedealt with, as follows:
• Partial - This will check whether there is any overlap between Inventory Items in the import file andthose in the database, and if so an error message will be displayed and it will not be possible to savethe data.
• Full - This will End Date all existing Inventory Items on the Features to which new Inventory Itemsare being imported.
• Full by Inventory Type - This will also End Date existing Inventory Items, however for each Featureonly existing Inventory of an Inventory Type being imported to that Feature will be End Dated. Forexample if the import file only contains Footway Items for a particular Feature, then existing Footwayon that Feature will be End Dated but all other Inventory will remain Live.
11 of 30Pitney Bowes
Specifications
When a feature being imported is a point feature the spatial geometry will be updated, provided thatgeometry is also a point.
Feature AttributeConfirm module 0195 is required to import Feature Attribute records.
Note that as on the 'Attributes' tab of the Feature screen, Feature Attributes here covers Feature TextAttributes, Feature Measurements, and Feature Dates. Each record will be interpreted as follows:
If 'Date' is supplied, the record is treated as a Feature Date. The supplied Attribute Type Code mustcorrespond to a Date Type in Confirm.
If 'Value' is supplied, the record is treated as a Feature Measurement. The supplied Attribute TypeCode must correspond to a Measurement Type in Confirm.
If 'Option' or 'Text' is supplied, the record is treated as a Feature Text Attribute. The supplied AttributeType Code must correspond to an Attribute Type in Confirm.
If none of these is supplied, the record is rejected.
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Feature Attribute'--Record Type
MandatoryCharacter50Parent Id
MandatoryCharacter4Attribute Type Code
Character4Option
Numeric12(10.2)Value
DateTimeDate
Character2000Text
Loaded Date - a Date Type to act as the Loaded Date can be specified in the Import Anything Settingsscreen.This will be set to the current date for all Features created via this import, including new versionsof existing Features. The Loaded Date does not get set for existing Features that are being updated.If a value for this Date Type is supplied as a Feature Attribute in the file, it will be ignored.
Feature/ Asset ID update is not supported.Note:
Inventory and Inventory Attributes
Inventory ItemConfirm modules 0112 and 0195 are required to import Inventory records.
Inventory items can only be imported against a Feature that exists in the same import file. Inventorycan be imported while adding a new Feature, updating an existing Feature, or creating a new versionof an existing Feature. For details of the treatment of existing Inventory in the latter cases, refer to thedescription of the Inventory Flag in the Feature section above.
When Inventory is imported to a Feature that has been End Dated (including via a Split or Merge) thenthe imported Items will be carried forward to any subsequent versions of the Feature. In the case ofa 'Full' or 'Full by Inventory Type' import, this will result in Items on those subsequent versions of theFeature being deleted.
12 of 30Pitney Bowes
Specifications
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Inventory Item'--Record Type
MandatoryCharacter50Record Id
Mandatory - must identi-fy a Feature record inthe import file
Character50Parent Id
Character4 or 30Customer
Character4 or 30Feature Type
If supplied cannot beearlier than FeatureStart Date
Date TimeStart Date
Date TimeEnd Date
Date TimeSurvey Date
Character1Reversed
Numeric10 (8.2)Start Width
Numeric10 (8.2)End Width
Character12 (10.2)Quantity
Identifies an existingFeature to which this In-
Character50Link Parent Id
ventory Item links. Seebelow
Defaults from FeatureCharacter4 or 30Site Classification
Describes Cross SectionPosition of inventoryitem
Character6 or 30XSP
Only with Module 4050.If supplied, Start Dis-
ASCII30Start Node
tance is interpreted asan offset from the identi-fied Node
Numeric10 (8.2)Start Distance
Only with Module 4050.If supplied, End Dis-
ASCII30End Node
tance is interpreted asan offset from the identi-fied Node
Numeric10 (8.2)End Distance
The Link Parent Id should be the Central Asset Id or Feature Id (case sensitive) of an existing Featurethat is live at the Start Date of the Inventory Item. The Feature must be of the appropriate FeatureGroup otherwise the import will be rejected.
Inventory AttributeConfirm modules 0112 and 0195 are required to import Inventory Attribute records.
13 of 30Pitney Bowes
Specifications
Attribute type code must already exist in Confirm and be associated with the parent record, otherwisethe file will be rejected.
CommentTypeSizeField
1 for the header row, 2 for datarows
--Row Type
'Inventory Attribute'--Record Type
MandatoryCharacter50Parent Id
MandatoryCharacter4Attribute Type Code
Character4Option
Numeric15 (9.6)Value
DateTimeDate
Character2000Text
Character2000Notes
Surveys
SurveyConfirm module 4010 is required to import Survey records. Multiple Surveys can be imported fromone import file.
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Survey'--Record Type
Character50Record Id
Character30Name
Mandatory - must beunique.
Character20External Reference
Mandatory.Character6 or 30Type
If not supplied then Typemust uniquely identify avalid Live Survey Type.
Numeric4Version
'A'/'Accepted into Data-base' or 'L'/'Loaded intoEdit Area' (default).
Character1 or 30Survey Status
Character2000Notes
Survey SectionConfirm module 4010 is required to import Survey Section records.
All relevant lookups like Feature Id must already exist in database for all the records to be successfullyimported.
14 of 30Pitney Bowes
Specifications
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Survey Section'--Record Type
Mandatory - must identi-fy a Survey record in theimport file.
Character50Parent Id
Character50Record Id
To identify a Feature.Character10Site Code
To identify a Feature.Numeric10 (8.2)Plot Number
To identify a Feature.Character15Feature Id
To identify a Feature.Character20Central Asset Id
Defaults to End Date ortoday.
DateTimeStart Date
Defaults to Start Date ortoday.
DateTimeEnd Date
Reverse (R), Forward(F), Normal (F), N (F).
Character1 or 7Direction
Character4 or 30Action Officer
Numeric8.2Length
Character2000Notes
• Survey Section will be identified based on the combination of Feature Id and Start Date, or SiteCode and Plot Number, or Central Asset Id.• The Feature must be Live at the Survey Section’s Start Date.• While importing Survey data for existing Section(s), the measured length does not always exactlymatch the recorded length of a Section. If the Section length is different but within a tolerance (refersto Tolerance mentioned in Survey Type screen for each Survey Type), data in the import file willbe stretched/squashed/trim to fit.• If a Survey has been recorded in the reverse direction to the Section's direction in the database,it will be reversed as part of the import process.• Surveys can be imported where the Survey Type is configured with Child Observation Types, sothat some values are stored in additional columns in a single Observation record.• Additional Survey Features and Observations can be imported to an existing Survey only withstatus as ‘Loaded into Edit Area’.• Surveys can be imported to End Dated Features and Survey data is carried forward to all laterversion(s) of Features created via End Date, Split and Merge.
Survey Observation
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Survey Observation'--Record Type
Mandatory - must identi-fy a Survey Section re-cord in the import file.
Character50Parent Id
Character6Observation Type
15 of 30Pitney Bowes
Specifications
CommentTypeSizeField
Character4 or 30Feature Group
Defaults to System Set-ting.
Character6 or 30XSP
Only with module 4050.If supplied, Start Dis-
Character30Start Node
tance is interpreted asan offset from the identi-fied Node.
Numeric8.2Start Distance
Only with module 4050.If supplied, End Dis-
Character30End Node
tance is interpreted asan offset from the identi-fied Node.
Numeric8.2End Distance
Numeric8.4Value
Character4Option
Denotes whether anObservation has been
Character1Recording Type
recorded as percentageor value (defaults to V).
Character2000Notes
Asset Valuation Logs
Confirm module 1530 is required to import Asset Valuation Log records via the Import Anything Agent.Importing them via the ‘Import Data’ utility on the Confirm menu requires either module 1500 or module1530.
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Valuation Log'--Record Type
Mandatory unless ‘cent-ral asset id’ or ‘featureid’ provided
Character10SITECODE
Mandatory unless ‘cent-ral asset id’ or ‘featureid’ provided
Numeric12(10.2)PLOTNUMBER
Mandatory unless ‘site-code/plotnumber’ or‘feature id’ provided
Character20CENTRAL ASSET ID
Mandatory unless ‘cent-ral asset id’ or ‘site-
Character15FEATURE ID
code/plotnumber’provided
Optional – defaults tocurrent date/time
DateTimeVALLOGTIME
16 of 30Pitney Bowes
Specifications
CommentTypeSizeField
MandatoryDateTimeLOGEFFECTIVEFROM-DATE
Optional – defaults tocurrent user
Character10LOGGEDBY
Optional – defaults fromlast Log if present, other-
Character4 or 30METHOD
wise from Feature. Ifneither set then resultsin an error
MandatoryCharacter4 or 30REASONCODE
Optional – defaults fromlast Log if present, other-
DateTimeACTIVEFROMDATE
wise from Feature. Ifneither set then resultsin an error
Optional – defaults tocalculation based on
DateTimeACTIVETODATE
Active From date andUseful Life (if supplied),otherwise uses valuefrom last Log, otherwisefrom Feature. Finally,results in error.
OptionalNumeric8USEFULLIFE
Optional – defaults fromlast Log if present, other-wise from Feature
Numeric14(12.2)VALUEQUANTITY
Optional – defaults fromlast Log if present, other-wise from Feature
Numeric14(10.4)REPLACEUNITCOST
Optional – calculatedfrom quantity and unitcost if not supplied
Numeric14(12.2)REPLACEVALUE
Optional – defaults fromlast Log if present, other-wise from Feature
Numeric14(10.4)RESIDUALUNITCOST
Optional – calculatedfrom quantity and unitcost if not supplied
Numeric14(12.2)RESIDUALVALUE
OptionalNumeric14(12.2)ASSETEXPENDVALUE
OptionalNumeric14(12.2)CURRENTVALUE
OptionalCharacter4 or 30VALUER
OptionalCharacter2000VALUENOTES
The Asset Category used for calculations is taken from that of the Feature if it has one, otherwise usesthe Feature Type’s Asset Category. If neither is set, an error is reported.
17 of 30Pitney Bowes
Specifications
Jobs and Job Items
JobConfirm module 0610 is required to import Job records.
All relevant Lookups, plus the Features you are importing Work against, must already exist in Confirm,otherwise the file will be rejected.
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Job'--Record Type
MandatoryCharacter50Job Id
Mandatory - unless Fea-ture Id specified
Character10Site Code
Mandatory - unless Fea-ture Id specified
Numeric10 (8.2)Plot Number
Mandatory - unless bothSite Code and PlotNumber specified
Character15Feature Id
Optional, Will default ifnot specified
Character2000Job Notes
Character2000Job Location
Default to the DefaultJob Type system setting
Character4Job Type Code
if not specified. Job willinherit the Defect Type’sJob Type if Job is linkedto a Defect in the importfile.
LookupCharacter15Cost Code
Mandatory LookupCharacter4Priority Code
Mandatory LookupCharacter4Price Factor Code
Character20Customer Reference
Mandatory LookupCharacter4Customer Code
LookupCharacter6Contract Code
MandatoryDateTimeJob Entry Date
DateTimeJob Start Date
DateTimeActual Start Date
DateTimeJob Complete Date
DateTimeActual Comp Date
DateTimeLiability Date
Numeric10 (8.2)Job Easting
Numeric10 (8.2)Job Northing
Numeric10 (8.2)Job Altitude
LookupNumeric8External System
18 of 30Pitney Bowes
Specifications
CommentTypeSizeField
Character50External Order Refer-ence
Character50External Job Reference
Numeric8 (6.2)Survey Obs Start
Numeric8 (6.2)Survey Obs End
LookupCharacter6XSP Code
"Y" or "N". If not spe-cified then will default to
Character1Part Payment Flag
the system setting valueor “N”
Mandatory LookupCharacter4Status Code
Mandatory LookupCharacter10Login Name
LookupCharacter4Allocated Officer
Defaults to current dateif not supplied
DateTimeLog Effective Date
LookupCharacter4Follow Up Code
DateTimeFollow Up Date
Character2000Log Text
Job Id - This must uniquely identify the job record within the file.
Job ItemConfirm module 0610 is required to import Job records.
All relevant Lookups must already exist in Confirm, otherwise the file will be rejected.
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Job Item'--Record Type
MandatoryCharacter50Job Id
Mandatory must beunique. Usually incre-
Numeric4 (4.0)Job Item Number
mented in tens. 9999 isreserved
Mandatory LookupCharacter8SOR Item Code
Mandatory LookupCharacter15Cost Code
Defaults to 0Numeric10 (8.2)Job Item Quantity
Will default if not spe-cified
Character2000Job Item Notes
Defaults to 0Numeric8 (6.2)Job Item Width
Defaults to 0Numeric8 (6.2)Job Item Length
Defaults to 0Numeric8 (6.2)Job Item Depth
Job Id - This must equate to the job id on a Job record.
19 of 30Pitney Bowes
Specifications
Inspection Features and Conditions
Inspection FeatureConfirm module 0610 is required to import Inspection Feature records.
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Inspection Feature'--Record Type
MandatoryCharacter50Record Id
Mandatory - unless Fea-ture Id or both Site Code
Character50Parent Id
and Plot Number spe-cified. This must corres-pond to the Record Id ofa Feature record presentin the import file
Mandatory - unless Par-ent Id or Feature Id spe-cified
Character10Site Code
Mandatory - unless Par-ent Id or Feature Id spe-cified
Numeric10 (8.2)Plot Number
Mandatory - unless Par-ent Id or both Site Code
Character15Feature Id
and Plot Number spe-cified
Mandatory LookupCharacter4Officer Code
Character4Inspection Route Code
Character40Inspection Batch Name
DateTimeInspection Date
Inspection Batch Number -
•A new Inspection Batch will be created for every combination of Inspection Route Code, InspectionBatch Name and Officer for which Inspection Features are being imported.•If no Inspection Route Code is specified, the Adhoc Route will be set as the Route on the InspectionBatch.•If no Inspection Batch Name is specified, the Inspection Route Name will be used. This meansthat if no Inspection Route Code and no Inspection Route Name are specified, the Inspection BatchName will be set to the Adhoc Route Name.•The Inspection Batch created, will immediately be set to be complete.•The Inspection Batch creation date is set to the Inspection Batch’s earliest Inspection FeatureDate.•The Inspection Batch completion date is set to the Inspection Batch’s latest Inspection FeatureDate.
Inspection ConditionConfirm module 0610 is required to import Inspection Feature records.
20 of 30Pitney Bowes
Specifications
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Inspection Condition'--Record Type
Mandatory. Mustuniquely identify an In-spection Feature
Character50Parent Id
Mandatory LookupCharacter6Observation Type
Character4Grade
Character2000Notes
Numeric12 (8.4)Score
If the Observation Type is a Pick List then a Grade must be supplied. A Score may also be suppliedprovided it is within the valid range for the Grade.
If the Observation Type is a Numerical Value then a Score must be supplied, and the Grade will beautomatically derived from the Score.
Defects and Defect Attributes
DefectConfirm module 0610 is required to import Defect records.
All relevant Lookups must already exist in Confirm, otherwise the file will be rejected
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Defect'--Record Type
Optional. Unique identifi-er for this defect record
Character50Record Id
id must be present if im-porting defect attributesor document links.
Mandatory - unless Fea-ture Id specified
Character10Site Code
Mandatory - unless Fea-ture Id specified
Numeric10 (8.2)Plot Number
Mandatory - unless bothSite Code and PlotNumber specified
Character15Feature Id
MandatoryDateTimeDefect Date
DateTimeTarget Date
Character2000Defect Description
Character2000Defect Location
Character20Customer Reference
Numeric14 (12.2)Estimated Cost
MandatoryCharacter4Officer Code
21 of 30Pitney Bowes
Specifications
CommentTypeSizeField
Character6 or 30Observation Type
MandatoryCharacter4Defect Type
Will default if not spe-cified
Character2000Defect Notes
Defaults to 0Numeric10 (8.2)Defect Easting
Defaults to 0Numeric10 (8.2)Defect Northing
Defaults to 0Numeric10 (8.2)Defect Altitude
MandatoryCharacter1Defect Status Flag
Character8Organise Code
Numeric8 (6.2)Survey Obs Start
Numeric8 (6.2)Survey Obs End
Numeric12 (8.4)Survey Obs Value
Character6XSP Code
If supplied the Defectwill be linked to the spe-
Character50Job ID
cified Job, which mustalso exist in the file.
Intended for when im-porting Defects without
Character4Priority Code
Jobs and therefore JobStatuses are not af-fected by the importedPriority, if a Job ID issupplied.
Inspection Batch Number -
• If Defects are being imported without Inspection Features, then a completed Inspection Batchwith associated Inspection Features will be created for every Officer for whom Defects are beingimported.• Where a number of Defects for the same Officer are being imported, the Inspection Batch creationdate will be updated and set to the earliest Defect date and its Completion date will be set to thelatest Defect date.
Defect AttributeConfirm modules 0510 and 0610 are required to import Defect Attribute records.
Attribute type code must already exist in Confirm and the parent Id must be associated with the parentdefect record, otherwise the file will be rejected.
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Defect Attribute'--Record Type
Mandatory. Uniquelyidentifies the parent De-fect record.
Character50Parent Id
MandatoryCharacter4Type Code
22 of 30Pitney Bowes
Specifications
CommentTypeSizeField
Character4Option
Numeric12 (10.2)Value
DateTimeDate
Character2000Text
Defect Updates
Defect UpdateConfirm module 0500 is required to import Defect Update records.
Defect Update can be used to link existing Defects to existing Jobs, in this scenario any Defect Statuspresent will not be used.
Defect Update can also be used to update the Status of an existing Defect to "No Actioned Required"without linking it to a Job.
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Defect Update'--Record Type
Mandatory. Identifier forthe Defect to be up-dated.
Numeric8 (8.0)Defect Number
Optional.Character2000Defect Notes
Optional. Updates theStatus. "Y" sets the
Character1Defect Status
status to 'No Action Re-quired' and "N" sets it to'Action Required'
Optional. Supplying thisfield will link the Defect
Numeric8 (8.0)Job Number
to the Job specified. Ifthis is supplied any De-fect Status Flag will beignored for the updated.
If a status is supplied together with a link to a Job the imported status will be ignored and awarning is displayed. The status will be set according to the rules.
Note:
Sample FileThe following sample file links a Defect (number 1005) to an existing Job, at the same time marking3 other Defects as 'No Action Required' since they have been found to no longer be present.1,Defect Update,Defect Number,Defect Status,Job Number,Defect Notes2,Defect Update,1005,,2007,Linking Defect 1005 to Job 20072,Defect Update,1006,Y,,Historical Defect - no longer observed2,Defect Update,1007,Y,,Historical Defect - no longer observed2,Defect Update,1008,Y,,Historical Defect - no longer observed
23 of 30Pitney Bowes
Specifications
Inspection Routes
Inspection RouteConfirm module 0500 is required to import Inspection Route records.
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Inspection Route'--Record Type
MandatoryCharacter50Record Id
MandatoryCharacter4Code
Mandatory for a new In-spection Route
Character30Name
Defaults to User's WorkGroup
Character4 or 30Work Group
Mandatory for a new In-spection Route
Character4 or 30Inspection Type
Visual (V) or Machine(M). Defaults to Visual
Character1 or 7Inspection Mode
Character2000Notes
Defaults to Y. VisualRoutes only
Character1Actioned Works Incom-plete
Inspection Mode cannot be changed for existing Routes.Note:
If the combination of Code and Work Group identifies an existing Inspection Route, then a warningwill be shown and that Inspection Route will be updated rather than a new one being created.
Inspection Route FeatureConfirm module 0500 is required to import Inspection Route Feature records.
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Inspection Route Fea-ture'
--Record Type
Mandatory. Uniquelyidentifies the parent In-spection Route record
Character50Parent Id
To identify FeatureCharacter10Site Code
To identify FeatureNumeric10 (8.2)Plot Number
To identify FeatureCharacter15Feature Id
To identify FeatureCharacter20Central Asset Id
Numeric8 (6.2)Order
24 of 30Pitney Bowes
Specifications
CommentTypeSizeField
DateNext Inspection DueDate
Character2000Notes
Machine Routes onlyCharacter6 or 30XSP
Machine Routes onlyNumeric10 (8.2)Start Distance
Machine Routes onlyNumeric10 (8.2)End Distance
Machine Routes onlyCharacter50Start Label
Machine Routes onlyCharacter50End Label
Yes (Y) to delete theFeature. Defaults to No(N)
Character1Delete
Sample FileThe following sample file creates a new Inspection Route containing 3 Features, at the same time re-moving those Features from an existing Inspection Route.1,Inspection Route,Record Id,Code,Name,Work Group,Inspection Type,Notes2,Inspection Route,NewRoute,IR06,New Route,ALL,TYPE,New Inspection Route2,Inspection Route,OldRoute,IR02,Old Route,ALL,TYPE,Updated to remove 3Features1,Inspection Route Feature,Parent Id,Central Asset Id,Order,Delete,Notes2,Inspection Route Feature,NewRoute,00010023,10,N2,Inspection Route Feature,NewRoute,00010026,20,N2,Inspection Route Feature,NewRoute,00010027,30,N2,Inspection Route Feature,OldRoute,00010023,,Y2,Inspection Route Feature,OldRoute,00010026,,Y2,Inspection Route Feature,OldRoute,00010027,,Y
Monitoring Item
Confirm module 1110 is required to import Monitoring Item records.
All relevant Lookups, plus the Order information, must already exist in Confirm, otherwise the file willbe rejected.
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Monitoring Item'--Record Type
Mandatory if no JobNumber or Feature ID
Character6Contract Code
Mandatory if no JobNumber or Feature ID
Numeric8 (8.0)Batch Number
Mandatory if no JobNumber or Feature ID
Numeric6 (6.0)Item Number
Character2000Notes
25 of 30Pitney Bowes
Specifications
CommentTypeSizeField
Mandatory if no JobNumber or MonitoringItem
Character15Feature ID
Mandatory if no FeatureID or Monitoring Item
Numeric8 (8.0)Job Number
Will default to date ofimport if not specified.
DateTimeInspection Time
Character4Failure Code
Character2000Failure Notes
Failure Code -If the Failure Code is populated, a failure item is raised
Traffic Survey
Traffic SurveyConfirm module 4500 is required to import Traffic Count Survey records.
All relevant lookups like Survey Type must already exist in the database for all the records to be suc-cessfully imported.
Multiple Traffic Count Surveys can be imported from one import file.
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Traffic Survey'--Record Type
Mandatory. Uniqueidentifier for this Traffic
Character50Record Id
Count Survey record id,is used when importingTraffic Count SurveyFeatures and TrafficCount Data.
Mandatory.Character30Survey Name
Mandatory.Character6Survey Type Code
Optional.Character2000Survey Notes
The Survey Type must have the following details:
• Source Type – Traffic Count.• Attribute Type – Must be blank.• Dead tick box is unticked.
Survey FeatureConfirm module 4500 is required to import Traffic Count Survey Feature records.
All relevant lookups like Feature Id must already exist in database for all the records to be successfullyimported.
26 of 30Pitney Bowes
Specifications
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Survey Feature'--Record Type
Mandatory – Uniquelyidentifies a Traffic CountSurvey.
Character50Parent Id
Optional – Uniquelyidentifies a Traffic Count
Character50Record Id
Survey Feature. Must besupplied when importingTraffic Count Data.
Mandatory – Unless SiteCode and Plot Numberare specified.
Character15Feature Id
Mandatory - UnlessFeature Id is specified.
Character10Site Code
Mandatory - UnlessFeature Id is specified.
Numeric10 (8.2)Plot Number
Mandatory. The StartDate of the Survey.
DateTimeStart Date
Where Feature Id isspecified this Date isalso used to identify theFeature.
Mandatory. The EndDate of the Survey.
DateTimeEnd Date
• Survey Feature will be identified based on the combination of Feature Id and Start Date, or SiteCode and Plot Number.• The Feature must be Live at the Survey Feature’s Start Date.• A Traffic Count Survey Feature cannot be imported if there is an existing Traffic Count Surveywhich has the same Survey Type and the Date range of the Surveys overlap.• A warning will be displayed if a Traffic Count Survey Feature exists with a different Survey Typeand the Date range of the Surveys overlap.
Survey CountConfirm module 4500 is required to import Traffic Count Data records.
The Time Slot lookup must already exist in database for all the records to be successfully imported.
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Survey Count'--Record Type
Mandatory – Uniquelyidentifies a Traffic CountSurvey Feature.
Character50Parent Id
Mandatory.Character40Time Slot Name
Mandatory.DateTimeDate
27 of 30Pitney Bowes
Specifications
CommentTypeSizeField
Mandatory if SurveyType of Survey does
Character4Attribute Value Code
have an Attribute Typespecified.
Optional.Numeric12(8.4)Value
Optional.Character2000Notes
• The Date of the Traffic Count Data must be within the Date range of the related Traffic CountSurvey Feature.• The Time Slot Name is matched against the Time Slot Level which is identified by the SurveyType Code on the Traffic Count Survey.• The Time Slot Name must not be marked as Dead.• Attribute Value Code is required if the Survey's Survey Type has an Attribute Type specified. IfAttribute Value Code is supplied for a Survey whose Survey Type does not have an Attribute Typespecified, then the field is ignored.• Attribute Value Code is matched against the Attribute Values for the Survey Type's Attribute Type.
Document Links
Document Links can be imported on Features, Inventory Items, Surveys, Defects and Jobs. They canonly only be imported on records supplied in the same import file.
CommentTypeSizeField
1 for the header row, 2for data rows
--Row Type
'Document Link'--Record Type
Mandatory. Must be setto one of FEATURE, IN-
Character10Entity Type
VITEM, SURVEY, DE-FECT, or JOB.
Mandatory. Uniquelyidentifies the parent re-
Character50Parent Id
cord in the file using itsRecord Id, except in thecase of JOB where theJob Id is used.
Mandatory. The full doc-ument link file path. No
Character2000Document Name
validation is applied tothis path.
Character2000Document Notes
Set to current date andtime if not supplied.
DateDocument Date
28 of 30Pitney Bowes
Specifications
File Format
Composite Delimited FilesEach row contains several delimited items. The first is a number (1, 2 or 9) identifying the row typeand the second is the name of the Record Type. The file can contain any or all of the Record Typesmentioned in the Record Type Descriptions section of this document.The Record Type name suppliedin the file should match the section name in the Record Type Descriptions section (the match is notcase sensitive).
The different row types are described here.
The Header Definition row (type 1) contains the field names of all data being supplied, in the order inwhich it is supplied. There should be one and only one header for each Record Type. The field namesshould match those defined in the Record Type Descriptions section (the match is not case sensitive).
A Data row (type 2) contains the actual values to go into the fields. The data should be in the orderdefined by the header record. If the file contains any data before the header record, an error will bereported.
The Record Count row (type 9) is optional. If supplied, this will contain a single numeric item, whichis checked against the number of rows of this Record Type in the file. If there is a mismatch, it is as-sumed that the file is incomplete or otherwise invalid, and an error is reported. There should be nomore than one record count for each Record Type.
An example of a Composite Delimited File is shown below:1,monitoring item,contract code,batch number,item number,inspectiontime,failure code,failure notes2,monitoring item,C1,150,50,24/11/2003 11:29,FL1,Sub-standard reinstatementat intersection with Delph Street2,monitoring item,C1,125,110,24/11/2003 12:29 2,monitoringitem,C1,155,10,24/11/2003 14:09,FL39,monitoring item,31,job,record id,site code,plot number,priority2,job,1,DENPLAY,2.00,12,job,2,CENPARK,100.00,39,job,21,job item,parent id,sor item code,quantity2,job item,1,1001,100.002,job item,1,1002,50.002,job item,2,1001,200.002,job item,2,1002,80.002,job item,2,1003,19.002,job item,2,1004,45.009,job item,6
Key FieldsKey fields must be unique where specified or the whole file will be rejected and an error generated.Generally alpha key fields will be capitalised.
Lookup FieldsWhere fields in a file being imported reference the database as lookups, the appropriate lookup recordmust exist to maintain database integrity. These can usually be supplied as a code or as a name (thetables below will say “4 or 30” where something can be supplied as a 4 character code or a 30 char-acter name).
29 of 30Pitney Bowes
Specifications
Where a lookup is referenced which does not already exist an error will be reported and the file rejected.
Field DetailsAll fields are optional unless stated otherwise.
• Numeric fields are specified in the format 6 (4.2), meaning 6 digits in total, 4 to the left of thedecimal point, 2 digits to the right. e.g. 1234.56.
• To prevent problems when files are imported on a different system to the one where the files wereprepared, fields specified as date should be supplied in the format DDMMYYYY or DD/MM/YYYY,except when importing XML files.
• All fields specified as time should be supplied in the format HH:MM, e.g. 18:30.• The field lengths need not be as shown in the definition tables but any characters in excess of those
specified will be truncated. A warning will be given if this happens.
Importing Related RecordsThere is no hierarchy in the file structure; where related records are to be imported each child rowcontains the data identifying its parent. This is done via temporary Record Id, Parent Id and FeatureId fields, which are used during the import process but not saved to the database.
If a record has children, a unique Record Id should be supplied for it. This can be any text up to 50characters. Each child record should have a Parent Id that must exactly match the Record Id of itsparent in the same file.
Document LinksIf a Document Links Directory has been specified for a particular Import Transformation, then the filebeing imported will be copied to this directory and attached as a Document Link to any InspectionBatch, Defect or Job created by the import. The Record ID field for the Defect import is mandatorywhen creating document links.
30 of 30Pitney Bowes
Specifications