CMPIC 6 Termination Import Utility

8/10/2019 CMPIC 6 Termination Import Utility

1/5

Cloudis Ltd

CMPIC Termination Import Utility

User Manual

Document No: UM/04005

Revision: 2

Name Signature Date

Prepared by: Tony Mahaffey (Cloudis) 23-MAR-11

Verified by:

Approved by:

DOCUMENT REVISION HISTORYRev Status Amendment/Reason Date Author

1 ISSUED Initial Creation 22-NOV-04 Tony Mahaffey

2 ISSUED Provide functionality to permit updates. 23-MAR-11 Tony Mahaffey

DISTRIBUTION LIST

Name Company and Role Function

Tony Mahaffey Cloudis Ltd Author

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.


2/5

CMPIC Termination Import Utility, User Manual

1 Introduction

The Termination Import Utility allows for termination data, which has been created/maintained outside of theCMPIC application, to be loaded into the Terminations area of CMPIC.

As from CMPIC R6.09.2, the functionality of the import facility has been extended to permit updating of

termination information, where previously this was prevented if the termination information already existed.

2 Data Requirements

Termination data is presented in CSV (Comma Separated Values) format, which is easily reproducible from themajority of spreadsheet applications. The data must be supplied with the following field layout:

1. Cable ID12. NSN13. From device ID14. From end termination1

5. From end entry no6. From end entry type7. From end entry ID8. To device ID19. To end termination110. To end entry no11. To end entry type12. To end entry ID13. Core sequence number1214. Core ID115. Line reference16. Signal ID3

17. Signal description18. Signal type19. Signal phase

1These fields are mandatory.

2This field mustbe a numeric value.

3Spare cores can be identified by populating the signal field with the spare core identifier (defined within

Project Defaults CMSF08). Spare cores require no other fields to be populated, other than the mandatory fieldshighlighted.

Document No: UM/04005 Last Updated: 23/03/2011 10:24

Revision: 2 Last Updated by: Tony Mahaffey

Cloudis Ltd, 2011 Page 2 of 5


3/5


3 Data Import

Screen CMIF06 provides the facility to define the filename and path of the CSV file containing terminationsdata, as well as any specific configuration details of the file layout. These details are stored when the import isinitiated, so can be re-used for future import activities (Note: the stored values are relative to a specific projectand may be changed by other users):

The fields/items are:

File Path- The location of the file.

File Name- The name of the CSV file.

Delimiter- The value used to identify a break between fields. For CSV files, this is usually a comma,although certain applications allow for alternatives to be used. In the event that the delimiter is notlisted, the Other option should be selected, and the delimiter entered in the field provided. Careshould be taken when using this option.

Qualifier A Yes/No field to identify if fields have been enclosed by (single or double) quotes. Certainapplications do not use qualifiers unless one or more fields contain the delimiter character.

Import When pressed, the file is accessed & the data contained within is loaded to a temporaryholding area, for use within screen CMIF07 (see next Section). Any problems with access will bereported via a standard alert message, as will information on number of records processed etc. Oncethe data has been loaded, control passes automatically to CMIF07.





4/5


4 Process Data

After the termination data has been transferred from the CSV file into CMPIC, screen CMIF07 allows for thisdata to be manipulated (including deletion of records) & subsequently processed. The screen is called viaCMIF06 following a successful load of the data, and can also be called directly from the Navigator:

The data loaded from the CSV file is presented, along with a traffic light status indicator (showing red in thescreen-shot above), and a field identifying the status of the record. The traffic light has 3 possible values,which can be used in conjunction with the record status to determine a possible action:

Red Record cannot be loaded/processed. The record status may be one of the following:

o Cable does not exist the Cable ID does not correspond to a record in the Cable Schedule.

o Cable status prevents update the termination status of the cable prevents update; if thecomplete flag is set (i.e. a value of Part or Yes) for any vessel (multi-vessel projects only) atboth ends, this must prevent update. Updates will only be processed for a cable end if itsComplete flag is set to No for all vessels (multi-vessel projects only).

o Cable already has entry an entry already exists for this cable at both ends.

o From/To Device cancelled changes are not permitted if the cable is linked to a cancelleddevice.





5/5


Amber This represents two possible states for the record. The first possible state is that therecord cannot be loaded in its current condition, but may load once the specific problem (highlighted inrecord status field) is corrected. Such corrections may either be carried out against the source file (andreloaded via CMIF06) or amended directly within this screen. In the latter case, the record status is re-evaluated on save. The record status may be one of the following:

o Mandatory fields empty either (a) one of the mandatory fields (as defined in Section 2)has not been set, or (b) an entry no has been entered, but the entry type or entry id ismissing, or (c) the signal ID has been entered, but signal type is missing.

o NSN/Pattern differs the NSN/Pattern defined against the cable in the Cable Schedule isnot the same as the value loaded.

o Core is invalid the core does not exist against the NSN/Pattern in the Cable Types screen.

o Device(s) differ the cable from/to device does not match the Cable Schedule definition.

o Invalid entry type the entry type can only be one of PLUG, SOCKET, CLAMP, HOLE, or theGland Entry value defined in Project Defaults (CMSF08), if set.

o Signal descriptions differ the signal exists within CMPIC, however the description given in

the imported file does not match that stored.

AmberThe second state is that the record is OK, and can be processed, however the status of theexisting data in CMPIC means some portion of the record cannot be loaded/updated. Possible statusesare:

o OK (From Entry/terms will not load) an entry already exists for this cable at the FromEnd. This means the From End information will be ignored in the data load/update process.

o OK (To Entry/terms will not load) an entry already exists for this cable at the To End.This means the To End information will be ignored in the data load/update process.

o OK (status may prevent changes) the status of the cable means some data will not beprocessed; a Complete flag is set to Yes/Part on one or more vessels (where applicable on

multi-vessel projects), which means that end of the cable will not be processed.

Green Record is OK, and will be loaded/processed.

Once the user is happy that records are at a suitable status, pressing the Load Databutton will process them.If the Tracecheckbox is active, a trace file of all activity will be created in the temporary directory4.

Records that have been successfully processed are removed from the screen, and a suitable message detailingthe count of records processed is shown.

NOTE: The records loaded by screen CMIF06 are registered against the current CMPIC user, and are not visible

to other users within the system. They will be held until such time as they are processed, or the same CMPICuser initiates a fresh import.

4The temporary directory is set using the Registry or environmental variable ICE_TEMP, and is usually set to beC:\TEMP or /tmp for Windows and Unix installations respectively.




Documents

CMPIC 6 Termination Import Utility