Cabsys Introduction Guide
Cabsys Introduction Guide
Introduction Guide
by Ementor ASA
This publication was created using Doc-To-Help® , from WexTech Systems, Inc.
CABSYS and its modules are developed on a Microsoft Windows ® user interface. The system is implemented
using Oracle ® Relational Data Base Management System (RDBMS) as the archiving tool.
Information in this document is subject to change without notice and does not represent a commitment on the
part of Ementor ASA. Companies, names and data used in examples herein are fictitious. No part of this
document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any
purpose, without the express written permission of Ementor ASA.
Pilestredet 27
Po. Box 6824, St. Olavs plass
N-0130 OSLO, NORWAY
Tlf. + 47 23 15 75 00
Fax. +47 23 15 75 01
Support:
Phone: +47 95 06 12 12
E-mail: [email protected]
http://www.ementor.no/
Contents
Preface 1
About this Guide ........................................................................................................................1
Audience......................................................................................................................................1
Conventions used in this Guide ...............................................................................................2
Comments are welcome ............................................................................................................2
Introduction 3
What is CABSYS and what can it do? ...................................................................................3
CABSYS work sequence (Main activities). ..........................................................................4
Getting started 6
Starting the CABSYS application ...........................................................................................6
Navigating ...................................................................................................................................8
How to Activate Menus ..........................................................................................12
How to Add New Data Records ............................................................................12
How to Delete Data Records..................................................................................12
How to do tasks 13
CABSYS Abstract....................................................................................................................13
Project codes module ...............................................................................................................14
How to enter Cable Segregation Levels ...............................................................14
How to enter Area Codes........................................................................................15
Equipment module ...................................................................................................................16
How to define Equipment Numbers / Equipment maintenance.......................16
Cable module ............................................................................................................................18
Work sequence for defining a cable ......................................................................18
How to enter Cable Types ......................................................................................20
Reference Card 59
What is…...................................................................................................................................59
Menu bar....................................................................................................................59
Icon bar.......................................................................................................................60
Status bar....................................................................................................................60
Title bar......................................................................................................................61
Function Menu..........................................................................................................61
This guide introduces you to the CABSYS System, a part of the Ementor Engineering
Information System (E2 IS), with which you can handle and deliver consistent and quality
checked data in a computerised format. It provides step-by-step exercises that explain how
to create a cable, and follow it through the system until it reach installed status. The guide
will not show all aspects of the system, but enough to get you started.
Audience
This guide is intended for the novice end user, which is using CABSYS for the first time.
The novice user needs no technical background, nor knowledge of the database structure at
his or her site, to complete the exercises. Although, to get full value of the description in
this manual, note the following assumptions:
The conventions used in this guide are described in the table below:
We encourage you to send to us with any suggestions, ideas or comments that you may
have regarding this guide. Your opinions are the most important input we receive as we
revise CABSYS documentation.
If you would like to contact us directly, you can do that by sending an E-mail to
[email protected] .
CABSYS is designed to take care of cable routing and general information about cables,
equipment and other associated production components. It will follow a project throughout
all it's phases from the early engineering into operation.
The system will be of use to several disciplines within a project. In pre-engineering it
serves as a valuable aid in dimensioning the cable racks. When the detailed engineering
starts it keeps track of all information needed to route cables on the cable way network and
calculates MTO estimates along with the routing. During the construction phase feedback
of progress is entered into CABSYS and gives the basis for project control calculations. In
the operational phase the system readily looks up maintenance information and ease the
work of keeping the information consistent when making changes and extensions to the
original design.
CABSYS is a user-friendly system developed on a MS Windows© user interface. Each
window is carefully designed by engineers, for engineers and is intuitive and easy to use.
All functions are accessible by pointing and clicking with the mouse, or by keyboard
strokes. This makes the system easy to learn as well as efficient in operation for the
experienced users. In addition it is possible to do multiple update of thousands of records
with minimal effort in a spreadsheet type of interface.
When entering data in CABSYS, it is important to enter the data in the right order. This is
because data in one form may rely on information entered in another form. For instance the
Cable Register, relies on information entered in Cable Library, Equipment Register,
Document Register, and more.
(1)
Define project codes
(5)
Cable
routing
(7) (6)
Cable Define
installation drums
If not:
2. Log on to CABSYS with correct username and password.
3. Select a project.
To quit CABSYS:
1. On the File menu, click Exit.
-or-
Click the Close button at the upper right of the CABSYS window.
Title bar
Menu bar
Icon bar
Function Menu
Status bar
Note!
The asterisk (*) is used as wildcard.
Most windows in the application has the same layout. They appear either as a grid window
or as a navigator window.
Grid windows act more or less like MS Excel where you can sort columns, change column
order, edit and replace etc.
Navigator windows are a lite more complex and used where there is a need to gather a lot
of information in one window.
Navigator Detail
Navigator
The left part is a grid with all your data. For more experienced users, the Edit Replace
menu is very useful.
Lookup
Type in the data you want to find in the Lookup box.
Master
This part shows the key data as well as some of the most important information pieces
assosiated with the key (e.g. Cable Number).
Detail
More details about the item will be shown on one or several tabs.
Split screen bar
Note!
Mandatory boxes are always marked with an asterisk (*) behind the box name.
Dimmed boxes are Read-only.
White boxes are boxes where you can type or select values.
CABSYS Abstract
This chapter will explain some typical procedures for each function, which have to be
performed when using CABSYS. The examples used in the procedures assume normal
working conditions; thus exceptions are not described. Moreover, all examples start from
the point where you have the function menu in front of you.
The CABSYS system is divided in several modules as follows:
Project codes module
Document module
Equipment module
Cable module
Network module
Drum module
Routing module
Termination module
Utilities module
Report module
System Administration module
This guide will introduce the users to some of the most essential procedures in CABSYS
System. It will not describe all the possibilities that the users have as they perform the
various procedures. The guide will show the most common use and procedures in a step-by-
step approach.
Prerequisites:
Mandatory:
None
Others:
The Segregation Levels with descriptions are usually described in your Engineering
Numbering Manual / Project Coding Manual.
Procedure:
1. On the Function Menu, choose Cable Segregation Levels .
2. Press F2 to retrieve any existing rows.
3. On the File menu, click New to add a new row.
4. In the Segrl box, type the segregation level.
5. In the Desc box, type the description
6. On the File menu, click Save
The purpose of entering Area Codes is to be able to place equipment, verify which area(s)
a cable is running through and where cabletrays are placed on your project.
Prerequisites:
Mandatory:
None
Others:
The Area Codes with descriptions are usually described in your Engineering Numbering
Manual / Project Coding Manual.
Procedure:
1. On the Function Menu, choose Area Codes.
2. Press F2 to retrieve any existing rows
3. On the File menu, click New to add a new row
4. In the Areaco box type the area code.
5. In the Desc box type the description.
6. On the File menu, click Save
In the Equipment Module we define all tagged equipment. An equipment resides in an area
(or module) in your project. All equipment must be defined here first before attaching
cables to an equipment in the Cable Register.
Prerequisites:
Mandatory:
None
Others:
Area Codes.
Cable Segregation Level and
Nodes in List of Nodes.
Document Numbers in Document References.
Procedure:
1. On the Function Menu, choose Equipment Maintenance.
2. In the Equipment Tag box , type a new Equipment Number. (described in your
Engineering Numbering- / Project Coding Manual)
Note: Nearest node links a nodepoint on the cabletray network to an equipment with a
distance (Tarelength). An equipment may have several nearest nodes on different
segregation levels.
Note!
The Cable Type in step 1 is later referenced in the Cable Library.
Prerequisites:
Mandatory:
None, if you follow steps 1 through 2.
Others:
None
Mandatory
boxes
Procedure:
1. On the Function Menu, choose Segment Register.
Procedure:
1. On the Function Menu, choose Cable Register.
Note! To get a list of valid nodenumbes , refer to List of Nodes in the network module
7. In the Main tab, type To information in the different boxes in the To group
box. Enter the to node
8. On the File menu, click Save.
The “from” and “to” Nodes must have unique nodes entered prior to
cablerouting.
9. Click the Route Cable button.
CABSYS will route the cable and find the shortest path. The cable will get status
routed (RO).
Tip!
If you get an error message when trying to route a cable, indicating that you have segment
overload, you can can handle this in the two ways described below.
Either:
Verify the Segment Code or Fill- and Weight factor in the Segment Register.
For more information about Segment Register see "How to register a segment".
Finally:
Retry to route cable.
8. Click the Status tab.
9. Press the F2 button on your keyboard.
This will retrieve the new status of the cable from the database.
10. Select the Routed or Attemped Routed check box, to reset the cablestatus
back to CR.
11. On the File menu, click Save.
12. Click the Route Cable button again.
13. On the Function Menu, choose either Route by Segments, or Route by
Node.
Tip!
You can also click the Related Functions menu to access Route by Segments or Route by
Node from the Cable register.
If the route is acceptable and the rest of information in the Cable Register is correct , then
Release the cable:
14. In the Cable Register, click the Status tab.
15. Press the F2 button on your keyboard.
16. Click the Released check box to release the cable.
The cable is now in released status (RE) and is ready to be issued to a Pulling Slip.
Procedure:
First you need to enter the terminal type. To do so, follow these steps:
1. On the Function Menu, choose Terminal Type Library.
Note!
In the Terminal Type Library you describe the different terminal types (type of
connections) that the various equipment can have. In the example above, it is defined a
Terminal Type called "PT-01". It has 5 terminals, numbered +, -, GND, X1 and X2.
If needed, modify the Terminal Name box and/or the Equipment Side box.
6. On the File menu, click Save.
Wire number
1,2 and 3 in
Wire/Conductor
Group 1
10. In all mandatory boxes (marked with *), type or select values.
The Group box is the numbering of set of wires/conductors that make a group.
The Id box is the wire/conductor identification. The colour codes are;
BL=Black, BU=Blue, WH=White, SC=Screen etc.
The Type box is the Type of Wire/Conductor for each Wire Number.
Note!
Before you can connect wires to equipment, you need to define which parts (e.g. terminal
strips) the equipment consists of. This is done in the Type Allocation to Tag window (see
procedure below).
14. On the Function Menu, choose Equipment Parts (Type Allocation to Tag).
Note!
The sequence must always start at the first (1).
Note!
Note the colon (:).
Tip!
To type large amounts of terminations, use Batch Termination.
To maintain connections, use Connection Register.
Procedure:
1. On the Function Menu, choose Batch Termination.
Procedure:
1. On the Function Menu, choose Batch Termination Flying Lead.
Standard Reports
There are many reports in the system. Starting, setting search criteria and printing follow
the same procedure.
Procedure:
1. On the Function Menu there is a Report entry under each module. Choose
the report you want to print.
Example:
5. Enter sort criteria if you don't want the default. A parameter with .sort value 1
will be the most significant sort item.
6. Click Preview. The report will be started, and a preview window will appear.
7. On the File menu, click Print.
Note!
To make a PDF file, simply select the PDF printer defined on your computer (requires
Adobe Acrobat)
Note!
This procedure will not delete any saved files from the file system, but they can no longer
be used for revision handling .
Note!
Click the Revisions… button to connect a revision to the document number.
Procedure:
1. On the Function Menu, choose Pulling Slip.
All available document numbers will be available in the drop down list, when
connected to a document.
3. In the Value box, type the Cable Number you want to make a pulling slip for
Note!
If no values are typed, the Pulling Slip report will include all cables with released status.
Note!
The database expands continuously during the progress of the project. As the database
increases in size the setting should be changed from 0 to 1 or 2, to lower the network traffic
and reducing window opening time.
Bubble Help
The bubble help setting will show help in the form of yellow stickers on some of the input
fields.
To change the setting:
1. On the Options menu, click Preferences.
2. Select Bubble Help in the Ini Item box.
3. In the Ini Value box, type YES if you want the feature on, else type NO.
4. On the File menu, click Save.
Search Criteria
Search criteria are used to limit the number of rows retrieved from the database. Use search
criteria to speed up the retrieval process and to limit the dataset to exactly your items.
To limit the set of data on the screen, the filter function is available from all screens in the
system. To set a filter or make a search, follow these steps:
1. On the View menu, click Filter/Search.
2. Enter a search expression.
3. Click the OK button.
Tip!
Use % or * as wildcards. There is an implicit AND between the fields in the window
However, in many cases you need to specify more complex search criteria. To do so, you
can use the advanced mode.
The dialog box window expands and a new area becomes visible.
In the new box, you can type the SQL where clause expression.
Tip!
Consult your local database administrator to get advice how to construct a valid SQL where
clause.
2. Type your SQL expression in the lower part of the dialog box.
3. Click OK
Tip!
On the Option menu, click Show DB Names to get the names of tables and columns to be
used in expressions. Every time you click a field, the table name and column will be listed
in the window
Wildcards
Use asterisk (*) and question mark (?) as wildcards. Those two characters will
automatically be translated to % and _ respectively before the expression is send to the SQL
database. Hence, you can als o use % and _ in your search criteria.
The asterisk (*): Zero or many occurrences of any character.
The question mark (?): Exactly one occurrence of any character.
Example
Find all tag numbers containing PSV:
Basic Filter
1. Right-click the mouse.
2. Point to Filter and click Basic.
3. In the Column box, select the column you want to filter on.
4. In the Operator box, select the operator you want to use.
5. In the Value box, type or select the value.
6. Click the OK button
Advanced filter
1. Right-click the mouse.
2. Point to Filter and click Advanced.
You will see a Visual Basic expression builder
Tip!
Always look in the Edit menu to see if there is a copy function. This function will help you
to clone an object. See Copy Tag from Tagged Equipment Window
What is…
Menu bar
Contains Consists of
File New, Open, Close, Save, Save As, Delete, Print, Print Preview,
Printer Setup,Exit
Edit Undo, Replace, Cut, Copy, Paste, Insert Row, Add Row, Copy Row,
Delete Row
View First Row, Previous Page/Row, Next Page/Row, Last Row,
Filter/Search, Retrieve All, Refresh, Sort
Related Functions Shortcuts to functions related to current function
Options Toolbar, Toolbar Text, Menu, Show DB Names, Preferences
Window Layer, Horizontal, Vertical, Cascade, Arrange Icons, (any opened
windows)
Help Contents, Search, How to Use Help, About
1 2 3 4 5 6 7 8 9 10 11 12 13 14
Button # Function
1 Icon for Save
2 Icon for Print (Default printer)
3 Icon for Print Preview
4 Icon for Insert
5 Icon for Copy
6 Icon for Delete
7 Icon for Retrieve All
8 Icon for Filter / Search
9 Icon for Refresh
10 Icon for Go to first row
11 Icon for Go to prior page/row
12 Icon for Go to next page/row
13 Icon for Go to last row
14 Icon for Help Topics
Status bar
The status bar is the lower line in the MDI frame See Finding your way in the Function
Menu.
Function Menu
The function menu contains the functions granted to you in the project. See Finding your
way in the Function Menu.
You may personalize your function menu from the Option menu and click Add to
Favorites. Next time you open the system the selected function will appear under Favorites
in the Function Menu.
Navigator
The navigator is the grid section in the left pane of the window. See Using a Function
Window.
Lookup
The lookup is the small box in the upper left corner where an entry can be typed in to move
directly to a line in the navigator. See Using a Function Window.
Split bar
The split bars are the grey lines in the window used to resize content within a window. See
Using a Function Window.
Related Functions
The Related functions is a menu item in the menu bar where you can directly access
windows and related data to the current window. See Finding your way in the Function
Menu.
Note!
Multiple selections:
To select nonadjacent cells, select a single cell, and hold down the CTRL key while you
simultaneously click other cells that you want to select.
To select adjacent cells, select a single cell, and hold down the SHIFT key while you
simultaneously click the other cell that limits the range of cells you want to select.
Edit / Replace
To perform a multi-update of values and/or text on several lines simultaneously without
changing anything else in these lines, follow these steps:
1. On the Edit menu, click Replace.
2. In the Find where box, type or select the parameter/column you want to
change.
3. In the Find what box, type what you want to change from.
4. In the Replace with box, type what you want to change to.
6.5. Clar the Match check box to set the new value regardless of the old value.
5.6. Select the Match Case check box to distinguish between upper and lower case
letters.
Copy Row
Use the copy row function to make a identical copy of the current row:
1. On the Edit menu, click Copy Row.
A copy of all the columns for the current row will be made. Make sure to
change key values before you save to avoid duplicates in the database.