You are on page 1of 20

Cloudis Ltd

CMPIC Data Import Wizard


User Manual
Document No: UM/05015
Revision: 6
Name
Prepared by:

Signature

Date

Tony Mahaffey (CLOUDIS)

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

Include Cable Types, new logging function,


general cosmetic changes.

29-JUN-06

Tony Mahaffey

ISSUED

Include Appendix with input data formats.

05-OCT-06

Tony Mahaffey

ISSUED

Extend functionality to include Node and


Segment import.

21-MAY-09

Tony Mahaffey

ISSUED

Cable Usage no longer mandatory.

24-DEC-09

Tony Mahaffey

29-NOV-10

Tony Mahaffey

Cable Estimated Length column added.


Scope increased to include additional library
data, also merged cable/device data.
New optional update/delete functionality.
6

ISSUED

Option Sets retained between sessions


Preview option.
Device Near Nodes.
Cable Free-format fields x 3.
Bundle fields (Cable and Cable Type)

CMPIC Data Import Wizard, User Manual

DISTRIBUTION LIST
Name

Company and Role

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

Import Progress providing information on the progress of the import

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

Cloudis Ltd, 2010

Last Updated by: Tony Mahaffey


Page 2 of 20

CMPIC Data Import Wizard, User Manual


2.1 Import Detail

Press the button to


access the standard
file selection dialog.

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.

Document No: UM/05015

Last Updated: 29/11/2010 17:26

Revision: 6

Last Updated by: Tony Mahaffey

Cloudis Ltd, 2010

Page 3 of 20

CMPIC Data Import Wizard, User Manual


NB. When run initially, the fields shown are blank or set to the default value. Subsequent visits will
automatically populate these values with those last used.

2.2 Column Definition

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

Document No: UM/05015

Last Updated: 29/11/2010 17:26

Revision: 6

Last Updated by: Tony Mahaffey

Cloudis Ltd, 2010

Page 4 of 21

CMPIC Data Import Wizard, User Manual


Option Sets are a means of storing multiple sets of column definitions for the same data type; they are used in
much the same way as report parameters within CMPIC report parameter forms.
To create a new Option Set, enter an Option Set name in the field provided, and press the Add Set button. This
will duplicate the contents of the Standard Option Set into a new Option Set, which is then immediately
available for modification. Alternatively, the Standard Option Set can be modified as required.
NOTE: The Option Set used is retained between sessions; if you load device data with a specific Option Set, a
subsequent load of device data will show that Option Set as pre-selected automatically.

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.

Document No: UM/05015

Last Updated: 29/11/2010 17:26

Revision: 6

Last Updated by: Tony Mahaffey

Cloudis Ltd, 2010

Page 5 of 21

CMPIC Data Import Wizard, User Manual


2.3 Import Progress

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.

Document No: UM/05015

Last Updated: 29/11/2010 17:26

Revision: 6

Last Updated by: Tony Mahaffey

Cloudis Ltd, 2010

Page 6 of 20

CMPIC Data Import Wizard, User Manual


2.3.1

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.

Document No: UM/05015

Last Updated: 29/11/2010 17:26

Revision: 6

Last Updated by: Tony Mahaffey

Cloudis Ltd, 2010

Page 7 of 20

CMPIC Data Import Wizard, User Manual

3 Appendix
3.1 Device Data Column Specification
Column Descriptor

Data Format /
Maximum Size

Mandatory?

Additional Information

Device Applicability

Alphanumeric (21)

Yes

The applicability for the device, represented in binary form. Column


will not be available on single-vessel projects.

Device ID

Alphanumeric (20)

Yes

Unique Device identifier.

Description

Alphanumeric (60)

Yes

Free-text description of the device.

System Code

Alphanumeric (6)

Yes

The system that the device forms a part of.

Group

Alphanumeric (6)

No

The type of device.

Module

Alphanumeric (6)

No

[also referenced as Unit]

Area/Compartment

Alphanumeric (6)

No

The location of the device within the build.

Corporate No

Alphanumeric (20)

No

Remarks

Alphanumeric (60)

No

ECD Drawing

Alphanumeric (30)

No

No. of Terminals

Pos. Integer (7)

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

The X-coordinate of the device, usually only of relevance in CAD


environments.

Y Co-ordinate

Numeric

No

The Y-coordinate of the device, usually only of relevance in CAD


environments.

Z Co-ordinate

Numeric

No

The Z-coordinate of the device, usually only of relevance in CAD


environments.

2D Part ID

Alphanumeric (30)

No

3D Part ID

Alphanumeric (30)

No

Event ID

Alphanumeric (20)

No

Installation event this device should be linked to.

Checkwire Reqd?

Alphanumeric (1)

No

Installation marker to identify if a "checkwire" should be performed.


Values of "Y" or "N" only permitted.

X Co-ordinate

Free-text additional comments regarding this device.

The number of terminals (relevant terminal records are auto-created).

The Hazardous Area Code for the device, if required. Permissible values
dependant on project reference data.

Document No: UM/05015

Last Updated: 29/11/2010 17:26

Revision: 6

Last Updated by: Tony Mahaffey

Cloudis Ltd, 2010

Page 8 of 20

CMPIC Data Import Wizard, User Manual


Column Descriptor

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

Near node definitions see Appendix.

Document No: UM/05015

Last Updated: 29/11/2010 17:26

Revision: 6

Last Updated by: Tony Mahaffey

Cloudis Ltd, 2010

Page 9 of 20

CMPIC Data Import Wizard, User Manual


3.2 Cable Data Column Specification
Column Descriptor

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

Unique Cable identifier.

System Code

Alphanumeric (6)

Yes

The system which the cable forms a part of.

NSN/Pattern No.

Alphanumeric (20)

No

The Cable Type this cable uses

Segregation

Alphanumeric (6)

No

The Segregation/EMC Class of the cable.

Function Code

Alphanumeric (6)

No

From Device ID

Alphanumeric (20)

Yes

The device this cable runs from.

To Device ID

Alphanumeric (20)

Yes

The device this cable runs to.

Usage Code

Alphanumeric (1)

No

The usage category. Permissible values dependant on project library


data.

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

Free-text additional comments regarding this cable.

From Device
Alignment

Alphanumeric (1)

No

The alignment of the cable at the From Device. Values of "C"


(Clockwise) or "A" (Anti-Clockwise) only permitted.

To Device Alignment

Alphanumeric (1)

No

The alignment of the cable at the To Device. Values of "C" (Clockwise)


or "A" (Anti-Clockwise) only permitted.

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. Only available when Free-format fields are


active for the project.

Free-format Field 2

Alphanumeric (50)

No

Free-format field. Only available when Free-format fields are


active for the project.

Free-format Field 3

Alphanumeric (50)

No

Free-format field. Only available when Free-format fields are


active for the project.

Document No: UM/05015

Last Updated: 29/11/2010 17:26

Revision: 6

Last Updated by: Tony Mahaffey

Cloudis Ltd, 2010

Page 10 of 20

CMPIC Data Import Wizard, User Manual


Column Descriptor

Data Format /
Maximum Size

Mandatory?

Additional Information

Bundle

Pos. Integer (2)

No

Bundle definition. Permissible values of 0, 1, 2, 3, 4, 5, 6, 12. Only


available when Cable Bundling in Fill Calculations is active for
the project (and if so will replace Formation field).

Document No: UM/05015

Last Updated: 29/11/2010 17:26

Revision: 6

Last Updated by: Tony Mahaffey

Cloudis Ltd, 2010

Page 11 of 20

CMPIC Data Import Wizard, User Manual


3.3 Cable and Device Data Column Specification
Column Descriptor

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

Unique Cable identifier.

System Code

Alphanumeric (6)

Yes

The System which the cable forms a part of.

NSN/Pattern No.

Alphanumeric (20)

No

The Cable Type this cable uses

Segregation

Alphanumeric (6)

No

The Segregation/EMC Class of the cable.

Function Code

Alphanumeric (6)

No

From Device ID

Alphanumeric (20)

Yes

The device this cable runs from.

From Device
Applicability

Alphanumeric (21)

Yes

The applicability for the From Device, represented in binary form.


Column will not be available on single-vessel projects.

From Device
Description

Alphanumeric (60)

Yes

Free-text description of the From Device.

From Device System

Alphanumeric (6)

Yes

The System which the From Device forms a part of.

From Device Area

Alphanumeric (6)

No

The location of the From Device within the build.

From Device Group

Alphanumeric (6)

No

The From Device type.

From Device Near


Node(s)

Alphanumeric (500)

No

Near Node items for From Device. See Appendix for detailed formatting
information.

To Device ID

Alphanumeric (20)

Yes

The device this cable runs to.

To Device
Applicability

Alphanumeric (21)

Yes

The applicability for the To Device, represented in binary form. Column


will not be available on single-vessel projects.

To Device
Description

Alphanumeric (60)

Yes

Free-text description of the To Device.

To Device System

Alphanumeric (6)

Yes

The System which the To Device forms a part of.

To Device Area

Alphanumeric (6)

No

The location of the To Device within the build.

To Device Group

Alphanumeric (6)

No

The To Device type.

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

The usage category. Permissible values dependant on project library


data.

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

Free-text additional comments regarding this cable.

Document No: UM/05015

Last Updated: 29/11/2010 17:26

Revision: 6

Last Updated by: Tony Mahaffey

Cloudis Ltd, 2010

Page 12 of 20

CMPIC Data Import Wizard, User Manual


Column Descriptor

Data Format /
Maximum Size

Mandatory?

Additional Information

From Device
Alignment

Alphanumeric (1)

No

The alignment of the cable at the From Device. Values of "C"


(Clockwise) or "A" (Anti-Clockwise) only permitted.

To Device Alignment

Alphanumeric (1)

No

The alignment of the cable at the To Device. Values of "C" (Clockwise)


or "A" (Anti-Clockwise) only permitted.

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. Only available when Free-format fields are


active for the project.

Free-format Field 2

Alphanumeric (50)

No

Free-format field. Only available when Free-format fields are


active for the project.

Free-format Field 3

Alphanumeric (50)

No

Free-format field. Only available when Free-format fields are


active for the project.

Formation/Bundle

Pos. Integer (2)

No

Bundle definition. Permissible values of 0, 1, 2, 3, 4, 5, 6, 12. Only


available when Cable Bundling in Fill Calculations is active for
the project (and if so will replace Formation field).

Document No: UM/05015

Last Updated: 29/11/2010 17:26

Revision: 6

Last Updated by: Tony Mahaffey

Cloudis Ltd, 2010

Page 13 of 20

CMPIC Data Import Wizard, User Manual


3.4 Node Data Column Specification
Column Descriptor

Data Format /
Maximum Size

Mandatory?

Additional Information

Node ID

Alphanumeric (12)

Yes

Unique Node identifier.

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

Flag to indicate if Node should be identified as Major. Values of "Y" or


"N" only permitted.

X Co-ordinate

Numeric (20)

No

The X-coordinate of the Node, usually only of relevance in CAD


environments.

Y Co-ordinate

Numeric (20)

No

The Y-coordinate of the Node, usually only of relevance in CAD


environments.

Z Co-ordinate

Numeric (20)

No

The Z-coordinate of the Node, usually only of relevance in CAD


environments.

Comments

Alphanumeric (60)

No

Free-text additional comments regarding this Node.

Principal/Secondary
flag

Alphanumeric (1)

No

Flag to indicate if Node is Principal or Secondary. Values of "P" or "S"


only permitted. Only relevant when Allow Principal/Secondary
Nodes is active for the project.

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.

Document No: UM/05015

Last Updated: 29/11/2010 17:26

Revision: 6

Last Updated by: Tony Mahaffey

Cloudis Ltd, 2010

Page 14 of 20

CMPIC Data Import Wizard, User Manual


3.5 Segment Data Column Specification
Column Descriptor

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

A valid Segment Type, representing the construction of the Segment,


e.g. tray, ladder rack, penetration.

Segment Length

Numeric (20)

Yes

The length of the Segment.

Segment Applicability

Alphanumeric (21)

Yes

The applicability for the Segment, represented in binary form. Column


will not be available on single-vessel projects.

Span

Numeric (20)

No

The distance between supports, used to determine %weight fill. A value


of 0 (zero) is permissible where weight does not require calculation.

Segment ID

Alphanumeric (20)

No

The unique identifier of the Segment. If not supplied, a value will be


auto-generated.

Useable Area

Numeric (20)

No

The available area (overriding Segment Type dimensions) available for


cables. Only available when "Allow Non-Standard Penetrations"
is active for the project.

Raceway ID

Alphanumeric (20)

No

The Raceway ID of which this Segment is a part. Only available when


"Raceways" is active for the project.

Allowable
Segregations

Alphanumeric (200)

No

Allowable Segregations or Segregation Groups for this Segment.


Commas must separate multiple values.

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.

Document No: UM/05015

Last Updated: 29/11/2010 17:26

Revision: 6

Last Updated by: Tony Mahaffey

Cloudis Ltd, 2010

Page 15 of 20

CMPIC Data Import Wizard, User Manual


3.6 Cable Type Data Column Specification
Column Descriptor

Data Format /
Maximum Size

Mandatory?

Additional Information

MUN/NSN/Pattern

Alphanumeric (20)

Yes

The unique identifier for this Cable Type

Description

Alphanumeric (60)

Yes

Free-text description of the Cable Type

Conductor CSA

Numeric

Yes

Conductor Stranding

Alphanumeric (10)

No

Conductor Diameter

Numeric

Yes

Number of Cores

Pos. Integer (5)

Yes

Core Insulating
Material

Alphanumeric (30)

No

Diameter over Ins.


Core

Numeric

No

Diameter over Group

Numeric

No

Cable Weight (in


Kg/Km)

Numeric

Yes

Diameter over Laid-up


Cable

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

Flag to indicate armoured status of Cable Type; allowable values are Y


(Yes) & N (No)

Cable Usage

Alphanumeric (1)

Yes

The usage category. Permissible values dependant on project library


data.

No of cores within the cable, excluding screen information

Weight of cable, used to determine % weight fill against containing


network items

Document No: UM/05015

Last Updated: 29/11/2010 17:26

Revision: 6

Last Updated by: Tony Mahaffey

Cloudis Ltd, 2010

Page 16 of 20

CMPIC Data Import Wizard, User Manual


Column Descriptor

Data Format /
Maximum Size

Mandatory?

Additional Information

Minimum Bending
Radius

Numeric

No

Type of Cable

Alphanumeric (6)

No

The Cable Type category. Permissible values dependant on project


library data.

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

The classification of heat resistance for the Cable Type. Permissible


values dependant on project reference data.

Standard Classification

Alphanumeric (1)

No

The classification for this equipment; allowable values are C


(Catalogued), N (Non-preferred), P (Preferred) and S (Non-Standard)

Formation/Bundle

Pos. Integer (2)

No

Bundle definition. Permissible values of 0, 1, 2, 3, 4, 5, 6, 12. Only


available when Cable Bundling in Fill Calculations is active for
the project (and if so will replace Formation field).

Document No: UM/05015

Last Updated: 29/11/2010 17:26

Revision: 6

Last Updated by: Tony Mahaffey

Cloudis Ltd, 2010

Page 17 of 20

CMPIC Data Import Wizard, User Manual


3.7 Area / Compartment Data Column Specification
Column Descriptor

Data Format /
Maximum Size

Mandatory?

Additional Information

Area Code

Alphanumeric (6)

Yes

The unique identifier of the area/compartment.

Area Applicability

Alphanumeric (21)

Yes

The applicability for the area/compartment, represented in binary form.


Column will not be available on single-vessel projects.

Area Description

Alphanumeric (60)

Yes

A descriptive name for the area/compartment.

Hot Code

Alphanumeric (6)

No

The Hot Code for the area/compartment, if required. Permissible values


dependant on project reference data.

Parent Area

Alphanumeric (6)

No

Parent area, to permit loading of hierarchical area structures, providing


this parent area is not the "base level" area. Only available when
"Allow Area Hierarchy" is active for the project.

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.

Document No: UM/05015

Last Updated: 29/11/2010 17:26

Revision: 6

Last Updated by: Tony Mahaffey

Cloudis Ltd, 2010

Page 18 of 20

CMPIC Data Import Wizard, User Manual


3.8 System Code Data Column Specification
Column Descriptor

Data Format /
Maximum Size

Mandatory?

Additional Information

System Code

Alphanumeric (6)

Yes

The unique identifier of the system.

System Applicability

Alphanumeric (21)

Yes

The applicability for the system, represented in binary form. Column


will not be available on single-vessel projects.

System Description

Alphanumeric (80)

Yes

A descriptive name for the system.

Estimated Cables

Pos. Integer (20)

No

Estimate of number of cables for this system.

Estimated Devices

Pos. Integer (20)

No

Estimate of number of devices for this system.

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.

Document No: UM/05015

Last Updated: 29/11/2010 17:26

Revision: 6

Last Updated by: Tony Mahaffey

Cloudis Ltd, 2010

Page 19 of 20

CMPIC Data Import Wizard, User Manual


3.9 Near Node Definitions
Node definitions must be passed to the Wizard in a specific format in order that the data is translated into
suitable instructions for loading into CMPIC. Nodes are constructed of the following components:

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.

Document No: UM/05015

Last Updated: 29/11/2010 17:26

Revision: 6

Last Updated by: Tony Mahaffey

Cloudis Ltd, 2010

Page 20 of 20

You might also like