Professional Documents
Culture Documents
Signature
Date
29-NOV-10
Verified by:
Approved by:
DOCUMENT REVISION HISTORY
Rev
Status
Amendment/Reason
Date
Author
ISSUED
Initial Creation
22-SEP-05
Tony Mahaffey
ISSUED
29-JUN-06
Tony Mahaffey
ISSUED
05-OCT-06
Tony Mahaffey
ISSUED
21-MAY-09
Tony Mahaffey
ISSUED
24-DEC-09
Tony Mahaffey
29-NOV-10
Tony Mahaffey
ISSUED
DISTRIBUTION LIST
Name
Tony Mahaffey
Cloudis Ltd
Function
Author
1 Introduction
The Data Import Wizard has been introduced as a means of simplifying the population of CMPIC data from
external sources. This functionality is especially useful when migrating legacy data to CMPIC.
The Wizard was originally designed for the import of new data only. As the functionality within this screen is
stacked on top of our API, this has been further extended to permit the update and deletion of data (cable
types excluded), subject to existing API rules. This is managed via a separate, and optional, "action" column; if
this is not used, or a value of "-" is passed, the "action" (insert or update) is determined, based on the
existence (or not) of the record in CMPIC. Deletions may only be attempted by providing the appropriate value
for the action of "D".
2 The Wizard
The Data Import Wizard is divided into 3 views:
Import Detail allows selection of import files & log file location, as well as other complementary
settings
Column Definition allows definition of the ordering of fields contained within the import file
This document has been prepared specifically for Confidential Use. It remains the property of Cloudis Ltd and
Last Updated: 29/11/2010 17:26
be disclosed to any third party without prior consent.
Document
No: UM/05015
its contents
may not
Revision: 6
The initial step in the import process is to define the type of information to import, as well as its location and
destination project.
Type of data
The data available to load. Currently this is restricted to the following data sets (but
may be extended to cover other types of data in a future revision):
Device Data
Cable Data *or* Cable and Device Data1
Node Data
Segment (Network) Data
Library Data/Cable Types
Library Data/Areas and Compartments
Library Data/System Codes
Import file
This is the full directory/file path for the import file currently the import file must
be in CSV (Comma Separated Values) format
Header records
The first records in the import file may contain header information. Rather than have
them produce errors, they can be ignored/skipped (up to a maximum of 100
records)
Destination project
The available destination projects are determined by the permissions provided to the
current user. Apart from certain items of library data, loading of data to the ADMIN
project is not permitted, and a destination cabling project must be selected
Log file
This is the full directory path for the log file, which will be generated as the data is
imported from the import file
Ignore Successful?
If active, the log file will exclude successfully-loaded records. Only those records
which the Wizard was unable to load will be shown.
Pressing Next > validates the information provided and transfers control to the Column Definition view.
Subject to Project Default "Process Cables/Devices Simultaneously in Wizard". If OFF, only cables may be
loaded; if ON, Cables and Device may be combined in one record, and loaded collectively.
Revision: 6
Page 3 of 20
The Column Definition view allows for the structure of the input file to be defined. Whilst the column definitions
(name, size, type, etc) are static, the ordering and inclusion of these columns can be defined here. To make
correlation between a spreadsheet and these definitions easier, the columns are identified in the same
alphabetic fashion as used in most popular spreadsheet programs. Subject to the type of data being loaded &
project-specific settings, certain columns may or may not be shown; these are detailed in the Appendix.
Initially, certain columns will automatically be flagged for inclusion in the input. Unless it relates to a mandatory
value, the inclusion flag can be activated/deactivated at any point.
The inclusion flag only signifies that the data contained within the column should be loaded, it does not relate
to the column's existence in the input file. You should make use of the column id (the left-most field) to ensure
the column definitions correlate directly to the placement of data in the input spreadsheet.
E.g. In the screen-shot above, columns A through to J are visible, although only A-D and F-G are to be used by
the Wizard. As such, the input file must contain at least columns A-G, although the contents of column E will be
ignored (columns after the last included column will also be ignored).
The position of data columns can be managed by means of the Move Up and Move Down buttons, which
alter the position of the currently selected field. Additionally, all selected columns can be grouped together via
the Group Selected button.
NB. All modifications to column definitions are instantaneous. There is no requirement to save changes.
2.2.1
Fillers
In addition to the standard column definitions (which cannot be removed), it is possible to insert/delete socalled filler columns via the Insert Filler and Remove Filler buttons, respectively. These are useful when
extra information is contained within the input file, but not necessarily relevant within CMPIC. Filler columns are
ignored during the import process, regardless of the inclusion flag.
2.2.2
Option Sets
Revision: 6
Page 4 of 21
NB. Option Sets are project-specific; the Data Import Wizard does not retain these between projects.
Pressing Preview or Finish moves control to the Import Progress view. The Preview option permits a dryrun of the import to be performed, without any data in CMPIC being altered or impacted, whilst still providing
a full report of any success/failure.
Revision: 6
Page 5 of 21
At this point, the data provided in the import file is read and each field is:
a) Checked against the field definitions provided, and
b) Validated against any existing data in the destination project.
For each record read & processed, a suitable entry is added to the log file and the relevant status counter
updated. A progress bar also provides a visible clue to the current state of the import. The generated log file
will be named data_import_{PROJECT}.log (where {PROJECT} relates to the destination project specified
in the Import Detail view), and stored in the log file location specified previously. If this file already exists, any
logging is appended to existing log data.
Once complete, the progress bar will have reached 100%, and two options will now be available:
Another? Return to the Import Detail view, to select another file for import
End Exit the Data Import Wizard
In addition, it will be possible to view the log file for the import just run (ignoring any data from previous
imports) via the Show Results button.
NOTE: Blank lines within the import file (if not ignored as part of the header definition) will be treated as
malformed data and shown in the totals and log file as such.
Revision: 6
Page 6 of 20
Preview
If the import had been run in preview mode, the same status counters are shown, as is the button to permit
access to the import log file. As the data has not actually been loaded, this option is now made available, as
well as the option to begin the process again.
Revision: 6
Page 7 of 20
3 Appendix
3.1 Device Data Column Specification
Column Descriptor
Data Format /
Maximum Size
Mandatory?
Additional Information
Device Applicability
Alphanumeric (21)
Yes
Device ID
Alphanumeric (20)
Yes
Description
Alphanumeric (60)
Yes
System Code
Alphanumeric (6)
Yes
Group
Alphanumeric (6)
No
Module
Alphanumeric (6)
No
Area/Compartment
Alphanumeric (6)
No
Corporate No
Alphanumeric (20)
No
Remarks
Alphanumeric (60)
No
ECD Drawing
Alphanumeric (30)
No
No. of Terminals
No
Location
Alphanumeric (17)
No
Level Code
Alphanumeric (6)
No
Location drawing
Alphanumeric (30)
No
Hazardous Area
Code
Alphanumeric (6)
No
Special Features
Alphanumeric (6)
No
Numeric
No
Y Co-ordinate
Numeric
No
Z Co-ordinate
Numeric
No
2D Part ID
Alphanumeric (30)
No
3D Part ID
Alphanumeric (30)
No
Event ID
Alphanumeric (20)
No
Checkwire Reqd?
Alphanumeric (1)
No
X Co-ordinate
The Hazardous Area Code for the device, if required. Permissible values
dependant on project reference data.
Revision: 6
Page 8 of 20
Data Format /
Maximum Size
Mandatory?
Additional Information
Insert/Update/Delete
Alphanumeric (1)
No
Flag to indicate action required. Values of "I" (Insert), "U" (Update), "D"
(Delete) and "-" (Determine based on existence of data) only permitted.
Non-population of field will result in determination based on data, by
default.
Near Node(s)
Alphanumeric (500)
No
Revision: 6
Page 9 of 20
Data Format /
Maximum Size
Mandatory?
Additional Information
Cable Applicability
Alphanumeric (21)
Yes
The applicability for the cable, represented in binary form. Column will
not be available on single-vessel projects.
Cable ID
Alphanumeric (40)
Yes
System Code
Alphanumeric (6)
Yes
NSN/Pattern No.
Alphanumeric (20)
No
Segregation
Alphanumeric (6)
No
Function Code
Alphanumeric (6)
No
From Device ID
Alphanumeric (20)
Yes
To Device ID
Alphanumeric (20)
Yes
Usage Code
Alphanumeric (1)
No
Formation Code
Alphanumeric (1)
No
The cable formation. Values of "F" (Flat) and "T" (Trefoil) only
permitted. Replaced by Bundle if Cable Bundling in Fill
Calculations is active for the project
Remarks/Comments
Alphanumeric
(1000)
No
From Device
Alignment
Alphanumeric (1)
No
To Device Alignment
Alphanumeric (1)
No
Module
Alphanumeric (6)
No
Fit Code
Alphanumeric (1)
No
Corporate Number
Alphanumeric (25)
No
Alphanumeric (12)
No
Link Reference
Installation Fit Code. Permissible values are "L" (Local), "M" (Main), "S"
(Special) and "D" (Degaussing).
Estimated Length
Numeric
Insert/Update/Delete
Alphanumeric (1)
No
Flag to indicate action required. Values of "I" (Insert), "U" (Update), "D"
(Delete) and "-" (Determine based on existence of data) only permitted.
Non-population of field will result in determination based on data, by
default.
Free-format Field 1
Alphanumeric (50)
No
Free-format Field 2
Alphanumeric (50)
No
Free-format Field 3
Alphanumeric (50)
No
Revision: 6
Page 10 of 20
Data Format /
Maximum Size
Mandatory?
Additional Information
Bundle
No
Revision: 6
Page 11 of 20
Data Format /
Maximum Size
Mandatory?
Additional Information
Cable Applicability
Alphanumeric (21)
Yes
The applicability for the cable, represented in binary form. Column will
not be available on single-vessel projects.
Cable ID
Alphanumeric (40)
Yes
System Code
Alphanumeric (6)
Yes
NSN/Pattern No.
Alphanumeric (20)
No
Segregation
Alphanumeric (6)
No
Function Code
Alphanumeric (6)
No
From Device ID
Alphanumeric (20)
Yes
From Device
Applicability
Alphanumeric (21)
Yes
From Device
Description
Alphanumeric (60)
Yes
Alphanumeric (6)
Yes
Alphanumeric (6)
No
Alphanumeric (6)
No
Alphanumeric (500)
No
Near Node items for From Device. See Appendix for detailed formatting
information.
To Device ID
Alphanumeric (20)
Yes
To Device
Applicability
Alphanumeric (21)
Yes
To Device
Description
Alphanumeric (60)
Yes
To Device System
Alphanumeric (6)
Yes
To Device Area
Alphanumeric (6)
No
To Device Group
Alphanumeric (6)
No
To Device Near
Node(s)
Alphanumeric (500)
No
Near Node items for To Device. See Appendix for detailed formatting
information.
Usage Code
Alphanumeric (1)
No
Formation Code
Alphanumeric (1)
No
The cable formation. Values of "F" (Flat) and "T" (Trefoil) only
permitted. Replaced by Bundle if Cable Bundling in Fill
Calculations is active for the project
Remarks/Comments
Alphanumeric
(1000)
No
Revision: 6
Page 12 of 20
Data Format /
Maximum Size
Mandatory?
Additional Information
From Device
Alignment
Alphanumeric (1)
No
To Device Alignment
Alphanumeric (1)
No
Module
Alphanumeric (6)
No
Fit Code
Alphanumeric (1)
No
Corporate Number
Alphanumeric (25)
No
Alphanumeric (12)
No
Link Reference
Installation Fit Code. Permissible values are "L" (Local), "M" (Main), "S"
(Special) and "D" (Degaussing).
Estimated Length
Numeric
Insert/Update/Delete
Alphanumeric (1)
No
Flag to indicate action required. Values of "I" (Insert), "U" (Update), "D"
(Delete) and "-" (Determine based on existence of data) only permitted.
Non-population of field will result in determination based on data, by
default.
Free-format Field 1
Alphanumeric (50)
No
Free-format Field 2
Alphanumeric (50)
No
Free-format Field 3
Alphanumeric (50)
No
Formation/Bundle
No
Revision: 6
Page 13 of 20
Data Format /
Maximum Size
Mandatory?
Additional Information
Node ID
Alphanumeric (12)
Yes
Node Applicability
Alphanumeric (21)
Yes
The applicability for the Node, represented in binary form. Column will
not be available on single-vessel projects.
Node Location
Alphanumeric (6)
Yes
The location of the Node within the build (also referred to as Area or
Compartment).
Major Node?
Alphanumeric (1)
No
X Co-ordinate
Numeric (20)
No
Y Co-ordinate
Numeric (20)
No
Z Co-ordinate
Numeric (20)
No
Comments
Alphanumeric (60)
No
Principal/Secondary
flag
Alphanumeric (1)
No
Insert/Update/Delete
Alphanumeric (1)
No
Flag to indicate action required. Values of "I" (Insert), "U" (Update), "D"
(Delete) and "-" (Determine based on existence of data) only permitted.
Non-population of field will result in determination based on data, by
default.
Revision: 6
Page 14 of 20
Data Format /
Maximum Size
Mandatory?
Additional Information
From Node
Alphanumeric (12)
Yes
The identifier of an existing Node, used as the starting point for the
Segment.
To Node
Alphanumeric (12)
Yes
The identifier of an existing Node, used as the end point for the
Segment.
Segment Type
Alphanumeric (30)
Yes
Segment Length
Numeric (20)
Yes
Segment Applicability
Alphanumeric (21)
Yes
Span
Numeric (20)
No
Segment ID
Alphanumeric (20)
No
Useable Area
Numeric (20)
No
Raceway ID
Alphanumeric (20)
No
Allowable
Segregations
Alphanumeric (200)
No
Insert/Update/Delete
Alphanumeric (1)
No
Flag to indicate action required. Values of "I" (Insert), "U" (Update), "D"
(Delete) and "-" (Determine based on existence of data) only permitted.
Non-population of field will result in determination based on data, by
default.
Revision: 6
Page 15 of 20
Data Format /
Maximum Size
Mandatory?
Additional Information
MUN/NSN/Pattern
Alphanumeric (20)
Yes
Description
Alphanumeric (60)
Yes
Conductor CSA
Numeric
Yes
Conductor Stranding
Alphanumeric (10)
No
Conductor Diameter
Numeric
Yes
Number of Cores
Yes
Core Insulating
Material
Alphanumeric (30)
No
Numeric
No
Numeric
No
Numeric
Yes
Numeric
No
Cable Layering
Alphanumeric (50)
No
Group Screen/Braid
Alphanumeric (10)
No
Diameter of Group
Scr/Br Wire
Numeric
No
Overall Screen
Alphanumeric (10)
No
Diameter of Overall
Screen Wire
Numeric
No
Diameter of Overall
Screen
Numeric
No
Overall Diameter
Numeric
Yes
Resistance
Numeric
No
Voltage Rating
Alphanumeric (10)
No
Non-metallic content
Numeric
No
Is Cable Armoured?
Alphanumeric (1)
No
Cable Usage
Alphanumeric (1)
Yes
Revision: 6
Page 16 of 20
Data Format /
Maximum Size
Mandatory?
Additional Information
Minimum Bending
Radius
Numeric
No
Type of Cable
Alphanumeric (6)
No
Cable Configuration
Alphanumeric (6)
No
The configuration of the Cable Type cores & screens. Permissible values
dependant on project library data.
Hot Code
Alphanumeric (6)
No
Standard Classification
Alphanumeric (1)
No
Formation/Bundle
No
Revision: 6
Page 17 of 20
Data Format /
Maximum Size
Mandatory?
Additional Information
Area Code
Alphanumeric (6)
Yes
Area Applicability
Alphanumeric (21)
Yes
Area Description
Alphanumeric (60)
Yes
Hot Code
Alphanumeric (6)
No
Parent Area
Alphanumeric (6)
No
Insert/Update/Delete
Alphanumeric (1)
No
Flag to indicate action required. Values of "I" (Insert), "U" (Update), "D"
(Delete) and "-" (Determine based on existence of data) only permitted.
Non-population of field will result in determination based on data, by
default.
Revision: 6
Page 18 of 20
Data Format /
Maximum Size
Mandatory?
Additional Information
System Code
Alphanumeric (6)
Yes
System Applicability
Alphanumeric (21)
Yes
System Description
Alphanumeric (80)
Yes
Estimated Cables
No
Estimated Devices
No
Insert/Update/Delete
Alphanumeric (1)
No
Flag to indicate action required. Values of "I" (Insert), "U" (Update), "D"
(Delete) and "-" (Determine based on existence of data) only permitted.
Non-population of field will result in determination based on data, by
default.
Revision: 6
Page 19 of 20
Example
Open
bracket
Node ID
Off
Route*
On
Route*
Default?*
Close bracket
NODE33
In the above example, the node would be represented in the import file as (NODE33,0,0,N)
Items marked * are optional, which allows for the same data to be represented in many possible ways, such as
(NODE33,0,0,N) or (NODE33,0,0) or (NODE33,0) or (NODE33). The Off Route and On Route length
values default to a value of 0 (zero) and the Default Node value defaults to N (No).
Multiple near nodes may be concatenated within the same instruction, up to the limit of 500 characters,
resulting in a possible chain of near node information such as (NODE33,10)(NODE34,5,,Y).
NB. Currently, the On Route value is an expected component, regardless of whether the project setting
prevents its use or not. If in doubt, this field should remain unused, or with a zero value.
Revision: 6
Page 20 of 20