You are on page 1of 5

Cloudis Ltd

CMPIC Termination Import Utility
User Manual
Document No: UM/04005
Revision: 2
Name
Prepared by:

Signature

Date

Tony Mahaffey (Cloudis)

23-MAR-11

Verified by:
Approved by:
DOCUMENT REVISION HISTORY
Rev

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

Tony Mahaffey

Cloudis Ltd

Function
Author

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

which is easily reproducible from the majority of spreadsheet applications. 13. Spare cores require no other fields to be populated. 2 Data Requirements Termination data is presented in CSV (Comma Separated Values) format. 5. other than the mandatory fields highlighted. 2011 Page 2 of 5 . 9.09. to be loaded into the Terminations area of CMPIC. As from CMPIC R6.2. 15. 17. 7. 11. 16. 3. Document No: UM/04005 Last Updated: 23/03/2011 10:24 Revision: 2 Last Updated by: Tony Mahaffey © Cloudis Ltd. the functionality of the import facility has been extended to permit updating of termination information.CMPIC Termination Import Utility. 3 Spare cores can be identified by populating the signal field with the spare core identifier (defined within Project Defaults CMSF08). 18. which has been created/maintained outside of the CMPIC application. 2 This field must be a numeric value. 14. 10. 2. 12. The data must be supplied with the following field layout: 1. User Manual 1 Introduction The Termination Import Utility allows for termination data. 6. Cable ID1 NSN1 From device ID1 From end termination1 From end entry no From end entry type From end entry ID To device ID1 To end termination1 To end entry no To end entry type To end entry ID Core sequence number12 Core ID1 Line reference Signal ID3 Signal description Signal type Signal phase 1 These fields are mandatory. 4. where previously this was prevented if the termination information already existed. 19. 8.

• Qualifier – A Yes/No field to identify if fields have been enclosed by (single or double) quotes. control passes automatically to CMIF07. For CSV files. Once the data has been loaded. These details are stored when the import is initiated. • Import – When pressed. Any problems with access will be reported via a standard alert message. In the event that the delimiter is not listed. User Manual 3 Data Import Screen CMIF06 provides the facility to define the filename and path of the CSV file containing terminations data. although certain applications allow for alternatives to be used. as will information on number of records processed etc. and the delimiter entered in the field provided.CMPIC Termination Import Utility. • File Name . the “Other” option should be selected.The name of the CSV file. 2011 Page 3 of 5 . for use within screen CMIF07 (see next Section). so can be re-used for future import activities (Note: the stored values are relative to a specific project and may be changed by other users): The fields/items are: • File Path .The location of the file. Care should be taken when using this option. • Delimiter . Certain applications do not use qualifiers unless one or more fields contain the delimiter character. this is usually a comma. the file is accessed & the data contained within is loaded to a temporary holding area. Document No: UM/04005 Last Updated: 23/03/2011 10:24 Revision: 2 Last Updated by: Tony Mahaffey © Cloudis Ltd. as well as any specific configuration details of the file layout.The value used to identify a break between fields.

o Cable already has entry – an entry already exists for this cable at both ends. if the complete flag is set (i. along with a “traffic light” status indicator (showing red in the screen-shot above). this must prevent update. a value of Part or Yes) for any vessel (multi-vessel projects only) at both ends. 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 From/To Device cancelled – changes are not permitted if the cable is linked to a cancelled device. The “traffic light” has 3 possible values. Document No: UM/04005 Last Updated: 23/03/2011 10:24 Revision: 2 Last Updated by: Tony Mahaffey © Cloudis Ltd. and a field identifying the status of the record. and can also be called directly from the Navigator: The data loaded from the CSV file is presented.e. which can be used in conjunction with the record status to determine a possible action: • Red – Record cannot be loaded/processed. screen CMIF07 allows for this data to be manipulated (including deletion of records) & subsequently processed. o Cable status prevents update – the termination status of the cable prevents update.CMPIC Termination Import Utility. 2011 Page 4 of 5 . The screen is called via CMIF06 following a successful load of the data. User Manual 4 Process Data After the termination data has been transferred from the CSV file into CMPIC. Updates will only be processed for a cable end if its Complete flag is set to No for all vessels (multi-vessel projects only).

which means that end of the cable will not be processed. 4 The temporary directory is set using the Registry or environmental variable ICE_TEMP. and can be processed. CLAMP. but may load once the specific problem (highlighted in record status field) is corrected. o Device(s) differ – the cable from/to device does not match the Cable Schedule definition. and is usually set to be C:\TEMP or /tmp for Windows and Unix installations respectively. NOTE: The records loaded by screen CMIF06 are registered against the current CMPIC user. If the Trace checkbox is active. HOLE. a trace file of all activity will be created in the temporary directory4.CMPIC Termination Import Utility. the record status is reevaluated on save. or (c) the signal ID has been entered. and will be loaded/processed. however the status of the existing data in CMPIC means some portion of the record cannot be loaded/updated. Document No: UM/04005 Last Updated: 23/03/2011 10:24 Revision: 2 Last Updated by: Tony Mahaffey © Cloudis Ltd. 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 be processed. Green – Record is OK. or the Gland Entry value defined in Project Defaults (CMSF08). however the description given in the imported file does not match that stored. o Core is invalid – the core does not exist against the NSN/Pattern in the Cable Types screen. Amber –The second “state” is that the record is OK. pressing the Load Data button will process them. 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. but the entry type or entry id is missing. User Manual • • • Amber – This represents two possible “states” for the record. o OK (To Entry/terms will not load) – an entry already exists for this cable at the To End. SOCKET. This means the From End information will be ignored in the data load/update process. or (b) an entry no has been entered. and a suitable message detailing the count of records processed is shown. 2011 Page 5 of 5 . Once the user is happy that records are at a suitable status. or the same CMPIC user initiates a fresh import. In the latter case. They will be held until such time as they are processed. o NSN/Pattern differs – the NSN/Pattern defined against the cable in the Cable Schedule is not the same as the value loaded. a Complete flag is set to Yes/Part on one or more vessels (where applicable on multi-vessel projects). if set. and are not visible to other users within the system. but signal type is missing. The first possible “state” is that the record cannot be loaded in its current condition. Records that have been successfully processed are removed from the screen. Such corrections may either be carried out against the source file (and reloaded via CMIF06) or amended directly within this screen. Possible statuses are: o OK (From Entry/terms will not load) – an entry already exists for this cable at the From End. o Invalid entry type – the entry type can only be one of PLUG. o Signal descriptions differ – the signal exists within CMPIC.