CMPIC 5 Data Import Wizard

8/10/2019 CMPIC 5 Data Import Wizard

1/20

Cloudis LtdCMPIC Data Import Wizard

User Manual

Document No: UM/05015

Revision: 6

Name Signature Date

Prepared by: Tony Mahaffey (CLOUDIS) 29-NOV-10

Verified by:

Approved by:

DOCUMENT REVISION HISTORY

Rev Status Amendment/Reason Date Author

1 ISSUED Initial Creation 22-SEP-05 Tony Mahaffey

2 ISSUED Include Cable Types, new logging function,general cosmetic changes.

29-JUN-06 Tony Mahaffey

3 ISSUED Include Appendix with input data formats. 05-OCT-06 Tony Mahaffey

4 ISSUED Extend functionality to include Node andSegment import.

21-MAY-09 Tony Mahaffey

5 ISSUED Cable Usage no longer mandatory.

Cable Estimated Length column added.

Scope increased to include additional librarydata, also merged cable/device data.

New optional update/delete functionality.

24-DEC-09 Tony Mahaffey

6 ISSUED Option Sets retained between sessions

Preview option.

Device Near Nodes.

Cable Free-format fields x 3.

Bundle fields (Cable and Cable Type)

29-NOV-10 Tony Mahaffey


2/20

CMPIC Data Import Wizard, User Manual

DISTRIBUTION LIST

Name Company and Role Function

Tony Mahaffey Cloudis Ltd Author

1 IntroductionThe Data Import Wizard has been introduced as a means of simplifying the population of CMPIC data fromexternal 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 isstacked on top of our API, this has been further extended to permit the update and deletion of data (cabletypes excluded), subject to existing API rules. This is managed via a separate, and optional, "action" column; ifthis is not used, or a value of "-" is passed, the "action" (insert or update) is determined, based on theexistence (or not) of the record in CMPIC. Deletions may only be attempted by providing the appropriate valuefor the action of "D".

2 The WizardThe Data Import Wizard is divided into 3 views:

Import Detail allows selection of import files & log file location, as well as other complementarysettings

Column Definition allows definition of the ordering of fields contained within the import file

Import Progress providing information on the progress of the import

Document No: UM/05015 Last Updated: 29/11/2010 17:26

Revision: 6 Last Updated by: Tony Mahaffey

Cloudis Ltd, 2010 Page 2 of 20

This document has been prepared specifically for Confidential Use . It remains the property of Cloudis Ltd andits contents may not be disclosed to any third party without prior consent.


3/20


2.1 Import Detail

Press the button toaccess the standardfile selection dialog.

The initial step in the import process is to define the type of information to import, as well as its location anddestination project.

Type of data The data available to load. Currently this is restricted to the following data sets (butmay be extended to cover other types of data in a future revision):

Device Data Cable Data *or* Cable and Device Data 1 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 mustbe in CSV (Comma Separated Values) format

Header records The first records in the import file may contain header information. Rather than havethem produce errors, they can be ignored/skipped (up to a maximum of 100records)

Destination project The available destination projects are determined by the permissions provided to thecurrent user. Apart from certain items of library data, loading of data to the ADMINproject 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 isimported from the import file

Ignore Successful? If active, the log file will exclude successfully-loaded records. Only those recordswhich the Wizard was unable to load will be shown.

Pressing Next > validates the information provided and transfers control to the Column Definition view.

1 Subject to Project Default "Process Cables/Devices Simultaneously in Wizard". If OFF, only cables may beloaded; 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




4/20


NB. When run initially, the fields shown are blank or set to the default value. Subsequent visits willautomatically 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 makecorrelation between a spreadsheet and these definitions easier, the columns are identified in the samealphabetic 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 mandatoryvalue, 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 relateto the column's existence in the input file. You should make use of the column id (the left-most field) to ensurethe 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 bythe Wizard. As such, the input file must contain at least columns A-G, although the contents of column E will beignored (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, whichalter the position of the currently selected field. Additionally, all selected columns can be grouped together viathe 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 so-called filler columns via the Insert Filler and Remove Filler buttons, respectively. These are useful whenextra information is contained within the input file, but not necessarily relevant within CMPIC. Filler columns areignored during the import process, regardless of the inclusion flag.

2.2.2 Option Sets





5/20


Option Sets are a means of storing multiple sets of column definitions for the same data type; they are used inmuch 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. Thiswill 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, asubsequent 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 dry-run of the import to be performed, without any data in CMPIC being altered or impacted, whilst still providinga full report of any success/failure.





6/20


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, andb) 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 counterupdated. A progress bar also provides a visible clue to the current state of the import. The generated log filewill be named dat a_i mpor t _{PROJ ECT}. l og (where {PROJ ECT} relates to the destination project specifiedin the Import Detail view), and stored in the log file location specified previously. If this file already exists, anylogging 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 previousimports) via the Show Results button.

NOTE: Blank lines within the import file (if not ignored as part of the header definition) will be treated asmalformed data and shown in the totals and log file as such.





7/20


2.3.1 Preview

If the import had been run in preview mode, the same status counters are shown, as is the button to permitaccess to the import log file. As the data has not actually been loaded, this option is now made available, aswell as the option to begin the process again.





8/20


3 Appendix3.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. Columnwill 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 Free-text additional comments regarding this device.

ECD Drawing Alphanumeric (30) No

No. of Terminals Pos. Integer (7) No The number of terminals (relevant terminal records are auto-created).

Location Alphanumeric (17) No

Level Code Alphanumeric (6) No

Location drawing Alphanumeric (30) No

Hazardous AreaCode

Alphanumeric (6) No The Hazardous Area Code for the device, if required. Permissible valuesdependant on project reference data.

Special Features Alphanumeric (6) No

X Co-ordinate Numeric No The X-coordinate of the device, usually only of relevance in CADenvironments.

Y Co-ordinate Numeric No The Y-coordinate of the device, usually only of relevance in CADenvironments.

Z Co-ordinate Numeric No The Z-coordinate of the device, usually only of relevance in CADenvironments.

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.





9/20




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 .





10/20


3.2 Cable Data Column Specification



Cable Applicability Alphanumeric (21) Yes The applicability for the cable, represented in binary form. Column willnot 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 librarydata.

Formation Code Alphanumeric (1) No The cable formation. Values of "F" (Flat) and "T" (Trefoil) onlypermitted. Replaced by Bundle if Cable Bundling in FillCalculations 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 Installation Fit Code. Permissible values are "L" (Local), "M" (Main), "S"(Special) and "D" (Degaussing).

Corporate Number Alphanumeric (25) No

Link Reference Alphanumeric (12) No

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, bydefault.

Free-format Field 1 Alphanumeric (50) No Free-format field. Only available when Free-format fields areactive for the project.







11/20




Bundle Pos. Integer (2) No Bundle definition. Permissible values of 0, 1, 2, 3, 4, 5, 6, 12. Onlyavailable when Cable Bundling in Fill Calculations is active forthe project (and if so will replace Formation field).





12/20


3.3 Cable and Device Data Column Specification



Cable Applicability Alphanumeric (21) Yes The applicability for the cable, represented in binary form. Column willnot 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 DeviceDescription

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 NearNode(s)

Alphanumeric (500) No Near Node items for From Device. See Appendix for detailed formattinginformation.

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. Columnwill not be available on single-vessel projects.

To DeviceDescription

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 NearNode(s)

Alphanumeric (500) No Near Node items for To Device. See Appendix for detailed formattinginformation.

Usage Code Alphanumeric (1) No The usage category. Permissible values dependant on project librarydata.

Formation Code Alphanumeric (1) No The cable formation. Values of "F" (Flat) and "T" (Trefoil) onlypermitted. Replaced by Bundle if Cable Bundling in FillCalculations is active for the project

Remarks/Comments Alphanumeric(1000)

No Free-text additional comments regarding this cable.





13/20




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 Installation Fit Code. Permissible values are "L" (Local), "M" (Main), "S"(Special) and "D" (Degaussing).

Corporate Number Alphanumeric (25) No

Link Reference Alphanumeric (12) No

Estimated Length Numeric





Formation/Bundle Pos. Integer (2) No Bundle definition. Permissible values of 0, 1, 2, 3, 4, 5, 6, 12. Onlyavailable when Cable Bundling in Fill Calculations is active forthe project (and if so will replace Formation field).





14/20


3.4 Node Data Column Specification



Node ID Alphanumeric (12) Yes Unique Node identifier.

Node Applicability Alphanumeric (21) Yes The applicability for the Node, represented in binary form. Column willnot be available on single-vessel projects.

Node Location Alphanumeric (6) Yes The location of the Node within the build (also referred to as Area orCompartment).

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 CADenvironments.

Y Co-ordinate Numeric (20) No The Y-coordinate of the Node, usually only of relevance in CADenvironments.

Z Co-ordinate Numeric (20) No The Z-coordinate of the Node, usually only of relevance in CADenvironments.

Comments Alphanumeric (60) No Free-text additional comments regarding this Node.

Principal/Secondaryflag

Alphanumeric (1) No Flag to indicate if Node is Principal or Secondary. Values of "P" or "S"only permitted. Only relevant when Allow Principal/SecondaryNodes is active for the project.






15/20


3.5 Segment Data Column Specification



From Node Alphanumeric (12) Yes The identifier of an existing Node, used as the starting point for theSegment.

To Node Alphanumeric (12) Yes The identifier of an existing Node, used as the end point for theSegment.

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. Columnwill not be available on single-vessel projects.

Span Numeric (20) No The distance between supports, used to determine %weight fill. A valueof 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 beauto-generated.

Useable Area Numeric (20) No The available area (overriding Segment Type dimensions) available forcables. 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.

AllowableSegregations

Alphanumeric (200) No Allowable Segregations or Segregation Groups for this Segment.Commas must separate multiple values.






16/20


3.6 Cable Type Data Column Specification



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 No of cores within the cable, excluding screen information

Core Insulating

Material

Alphanumeric (30) No

Diameter over Ins.Core

Numeric No

Diameter over Group Numeric No

Cable Weight (inKg/Km)

Numeric Yes Weight of cable, used to determine % weight fill against containingnetwork items

Diameter over Laid-upCable

Numeric No

Cable Layering Alphanumeric (50) No

Group Screen/Braid Alphanumeric (10) No

Diameter of GroupScr/Br Wire

Numeric No

Overall Screen Alphanumeric (10) No

Diameter of OverallScreen Wire

Numeric No

Diameter of OverallScreen

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 librarydata.





17/20




Minimum BendingRadius

Numeric No

Type of Cable Alphanumeric (6) No The Cable Type category. Permissible values dependant on projectlibrary data.

Cable Configuration Alphanumeric (6) No The configuration of the Cable Type cores & screens. Permissible valuesdependant on project library data.

Hot Code Alphanumeric (6) No The classification of heat resistance for the Cable Type. Permissiblevalues 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. Onlyavailable when Cable Bundling in Fill Calculations is active for

the project (and if so will replace Formation field).





18/20


3.7 Area / Compartment Data Column Specification



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 valuesdependant on project reference data.

Parent Area Alphanumeric (6) No Parent area, to permit loading of hierarchical area structures, providingthis parent area is not the "base level" area. Only available when"Allow Area Hierarchy" is active for the project.






19/20


3.8 System Code Data Column Specification



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. Columnwill 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.






20/20


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

Openbracket

Node ID OffRoute*

OnRoute*

Default?* Close bracket

Example ( NODE33 0 0 N )

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 lengthvalues 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 settingprevents its use or not. If in doubt, this field should remain unused, or with a zero value.



Date post:	02-Jun-2018
Category:	Documents
Upload:	buturcas
View:	229 times
Download:	0 times

CMPIC 5 Data Import Wizard

Documents