Guide to Tech CMS

Embed Size (px)

Citation preview

  • 7/29/2019 Guide to Tech CMS

    1/19

    CML INTERNATIONAL

    A GUIDE TO USING CML TECHNIQUES

    A GUIDE TOUSING CMS

    Volume

    1

  • 7/29/2019 Guide to Tech CMS

    2/19

    C M L I N T E R N T A I O N A L

    Techniques CMS Guide

    Callum King (Web-System Manager)CML International

    Office 309-311, IT PlazaSilicon Oasis DubaiPO BOX - 341169

    Phone +971 (0)4 326 1116 Fax +971 (0)4 326 1117

  • 7/29/2019 Guide to Tech CMS

    3/19

    Table of Contents

    Introduction to the Commissioning Management System ......... 2Commissioning Activity Schedule (CAS) Module ..................... 4

    The CAS Sheet Entry ...................................................................... 6

  • 7/29/2019 Guide to Tech CMS

    4/19

    C M L T E C H N I Q U E S

    1

    Chapter

    1

  • 7/29/2019 Guide to Tech CMS

    5/19

    C M L T E C H N I Q U E S

    2

    Introduction to the

    Commissioning

    Management System

    CMS is an online hub of all Commissioning Managementrelated documentation.

    t is within CML Techniques Commissioning Management System or CMS for

    short, that you will now be able to collate, and update much of yourCommissioning Management Documentation.

    CMS has been designed to be customizable to suit the needs of your project, whichI will discuss throughout this guide, and provide example what can be edited to suityour projects needs.

    If you cannot access Techniques, or your Project within Techniques, please contactthe Techniques Web Team who will resolve your issue, they can also be contactedfor any other issue you may be having with Techniques. (Callum King 0504522853)

    Note

    It is recommended that before using Techniques for the first timethat you arrange for a site visit by the web-team for training on howto use Techniques. This ensures you have a full understand, and areable to get the most out of what Techniques has to offer.

    File Tree and Project NavigationTo navigate your way around the CMS on your project, a file tree will be createdwhich will contain the modules that are required to be utilized on your project.

    The image to the left is a typical file tree for a CMSProject, which can be found on the left hand side ofyour project. Each of the systems on the file tree are

    known as Modules, and to open a Module forexample the Commissioning Plan Module, you will

    I

  • 7/29/2019 Guide to Tech CMS

    6/19

    C M L T E C H N I Q U E S

    3

    hover your cursor over the Commissioning Plan wording, and left click. This willbring up the Commissioning Plan Module main page onto your Browser.

    Notice how next to the CAS Sheets module, and a few of the other modules there

    is a small cross located within a box, this means that there are sub-modules locatedwith the module. The sub-modules will appear once Main Module is selected. If themodule doesnt have a cross next to it, it will take you straight in to the ModuleMain Page.

    Note

    It is recommended that you use Internet Explorer when usingTechniques, though we do hope to have it fully compatible withFirefox, Chrome and Opera in the near future.

  • 7/29/2019 Guide to Tech CMS

    7/19

    C M L T E C H N I Q U E S

    4

    Commissioning Activity Schedule (CAS) Module

    A live online version of CMLsCommissioning ActivitySchedules

    he most commonly used module within the CMS is the CAS Sheetmodule. We have taken CMLs standard excel CAS Sheet layouts, andcreated a system which allows for the CAS Sheets to now be created

    online.

    One of the many bonuses to the online creation of the CAS is that multiple usersare able to work on the same CAS Sheet at the same time no matter their location,

    which can improve CAS creation time, with smart planning of CAS creation. Forexample having two users focus on adding separate packages from one another onthe same CAS, one could be adding AHUs to the Mechanical CAS, while anotheradds the FCUs at the same time. There is no limit to the amount of users who canbe working on the sane CAS Sheet at any one time.

    The CAS Sheet is live, meaning when you update an item on the CAS, that update

    will appear on another users screen as it happens. This also allows for the Clientand other Contractors to be able to see exact Commissioning progress at the timeof their viewing.

    Note

    The Client and Contactors will not be able to edit the CAS Sheet,their access will only allow them to view, print, and apply filters to theCAS.

    There are other benefits to using the new online CAS, such as not having to issuethe CAS on a weekly basis, as Clients and other Contractors can be granted accessto Techniques, as will be able to see the latest progress themselves, and print theCAS if required.

    Weve also added filters which not onlyfilter out the items you do not require toview on your CAS, they also update the CAS to show progress of Commissioningsubject to the applied filters only. For example if you only wanted to know how theLV Commissioning was progressing within a certain building, a filter can be appliedto only show the items located within this building, and the Techniques system willautomatically work out the percentages for progress of that building only.

    Chapter

    2

    T

  • 7/29/2019 Guide to Tech CMS

    8/19

    C M L T E C H N I Q U E S

    5

    When printed with the filters selected, the print will also state at the top of the pagewhich filters have been selected to the CAS.

    Note

    We are continually working on the CAS Modules, and all areas ofTechniques to improve the usability and the speed of performingtasks. Any suggestions for improvements are welcomed by the Web-System Team.

    The image to the left is a screenshot of an expanded fileElectrical CAS fire tree, notice for this project there are fourElectrical CAS Sheets, Earthing & Lightning Protection, Low

    Voltage, Generators, and Emergency Lighting. Selecting andof the CAS sheets will lead you into their respective CAS SheetEntry pages.

    We have created online versions of the CAS Sheets for allservices, these are taken from CMLs master excel CAS. Though we can create newor edit existing CAS sheets to suit the needs of your project. Changes includeadding new columns, removing columns, changing the summary to show different

    weightings and results.

    Note

    If you require the web-team to make changes to existing CAS sheets,or create a new CAS that is not included in our current range, pleaseallow for time period normally of one day per CAS for the changes tobe made especially for the creation of new CAS.

    Each CAS Sheet Module is broken up into four sections and they are as follows:

    1. CAS Sheet EntryIt is within this section that the CAS Sheet is createdand built up

    2. Commissioning & TestingIt is within this section that you will inputyour testing completion dates

    3. Full ScheduleThis section is a full view of the CAS, where you can applyfilters, and print the CAS.

    4. GraphThis is a bar graph showing the Commissioning progress fromthe CAS.

    We will now run through now to navigate through, and use each of these CASsections.

  • 7/29/2019 Guide to Tech CMS

    9/19

    C M L T E C H N I Q U E S

    6

    Note

    Though the Example will only run through an LV CAS, the

    input/editing/viewing process remains the same for all other CASSheets.

    The CAS Sheet EntryThis section of the CAS module is used for building up of a specific CAS Sheet.

    The CAS SheetEntry section

    automatically

    appears whenupon selectingyour CAS from

    the File Tree.

    The above picture is a cropped picture of a basic CAS Sheet Entry page, with theselect package drop down box highlighted in a red box.

    Packages

    To get started, you must first select a package; a package is simply a system such aMain Distribution Boards, Air Handling Units, Generators etc. When selecting thepackage, you are telling the Techniques system which type of item you want toinsert into the CAS Sheet. To select a package just click on the drop down box,this will present you with a list of packages that can be inserted into your CAS. Ifthe package you are looking for is not included in the list, contact the Web-Systemsto have them add the package for you. It is also useful to tell them if any of thetests included in the CAS are not applicable for certain packages, otherwise they

    will be included in the overall percentages.

    Data Entry

    After selecting your package Techniques will auto-fill the Item No., and Categoryentry boxes for you. The Item No takes itself from the amount of items of thatpackage already inserted into the CAS. Though you may change the item number

    yourself, the benefit of doing so is that you may require to insert a new item in-between two previously entered items. If the auto-fill is not changed, the new item

    will just be added to the bottomof that packages schedule.If you look to the screenshot tothe left, youll notice this CASSheet has three MDBs, and ifyou want to insert a fourth

    MDB, but you want it placed between, EMDB-SCB and EMDB-G, you mustchange the item number to two, and the system will automatically update EMDB-G, and LV-PANEL-1 (Tenant) item numbers to three and four respectively.

    As for the category though you will be able to edit the category code, do not do so,as the system will not recognize your entry. This is provided for those that may

  • 7/29/2019 Guide to Tech CMS

    10/19

    C M L T E C H N I Q U E S

    7

    need to change the items category, as they may have inserted it into the wrongpackage.

    The Eng.Refcolumn is self-explanatory this is where the engineers reference given

    to the item you wish to insert is written. You cannot entre two items with the sameEngineers Reference number into the same CAS Sheet.

    The Building/Zone is also self-explanatory as to what data is inserted into thiscolumn. Though it is recommended that you carefully plan out the data that will beentered into this column, as if you want to show progress per building, this will be

    where the system works out which building/zone the item belongs to.

    Floor levels should now be of the same styleacross all projects, utilizing a new devisedthree numerical digit system. The table to the

    left is the new floor leveling system, any levelover three will just continue the numericalpattern, and the same goes for any levelbelow basement floor level 3.

    Some projects will not be able to follow thisrule, and if so you can follow what hasdevised for your project, though it is

    recommended that you follow the new floor leveling system if possible.

    Youll notice that to add a floor level you have to select the floor level from a drop

    down box. At the beginning of a project this list will be empty, it is up to you todecide which level will be put into this list. To add a levelinto the list, click the small button besides the drop downbox, and box will appear asking you to enter your new floorlevel, this box can be seen to the left of this text. Once you

    have entered your new floor level click the save button, and the new level shouldappear for selection from the drop down box.

    Care must be taken over thenext column which is theSeq.No column which is for

    obviously entering the sequentialnumber of the item you wish toinsert. The system will auto-fillthis column for you uponentering your itemsBuilding/Zone and Floor Level.

    This is because the newsequential numbering system is

    worked out by, the amount of same category items in a particular building/zoneand floor level.Looking to the table to the above, I have highlighted the sequential numbering

    sequences that have emerged. Though this example is a poorly ordered CAS,

    FloorLevel

    CML TechniquesFloor Level

    B3 -003

    B2 -002B1 -001

    Ground 000Mezzanine M000

    Level 1 001Level 2 002Level 3 003

    Building/ Zone

    CategoryFloorLevel

    Seq.No

    A MDB 000 001A MDB 000 002B MDB 000 001

    A MDB 000 003C MDB 000 001

    A MDB 001 001A MDB 002 002C MDB 000 002

  • 7/29/2019 Guide to Tech CMS

    11/19

    C M L T E C H N I Q U E S

    8

    hopefully it will help you to understand how the sequential numbering is nowdevised.

    Currently we have only touched on what is known as the Asset Code data, after

    these entries have been filled out, the following entry columns become unique foreach CAS sheet. Such as location, fed from, no of circuits, and description etc. forthese columns, it is not required that the entries have any data inserted into them,but is it recommended if possible you fill in the items data at the time of first entry,as it will take far longer to go back and edit each item.

    Editing/Deleting Items

    It is possible to go back and edit/delete previously inserted item. Youll notice nextto each item there is a tick box, to edit or delete item youll need to select the itemstick box, and then select the edit or delete button on the top right hand corner of

    the CAS sheet, depending on what you want to

    do the item.

    To the left is the box that appears when youclick the edit item option. It is very simple all youhave to do, it remove the entry data you wish toedit, and insert the new data you wish to replaceit with, and then select the update button. You

    are able to edit multiple entries for the same item. Though it is currently notpossible to edit multiple items, but this is a feature we hope to be working on in thenear future, to speed up the editing process, for example if you required to changethe building /zone for a number of items, you will be able to select all these items

    and change the building /zone for all these items in one swoop. Though it iscurrently is possible to delete multiple items by selecting multiple items tick boxes,and then selecting the delete button.

    Filters and Searching

    You may have also noticed that most columns have filters that can be utilized tomake finding an item you wish to edit/delete easier. We have also added a searchfunction which allows you to search for an item within the CAS sheet.

    Import from Excel

    This feature is only utilized for special cases, as it cannot be used once C&T datesare inputted into the Techniques version of the CAS sheet. Some projects will startto use Techniques after an excel CAS has already been built, so what the Web-Management team can do is take the at Excel CAS and edit into a format that isrecognized by the Techniques System, and can then be uploaded onto Techniques,saving you the time of having to recreate the CAS Sheet again.

    Note

  • 7/29/2019 Guide to Tech CMS

    12/19

    C M L T E C H N I Q U E S

    9

    If the Excel version of the CAS Sheet has T&C dates, these datescannot be uploaded on Techniques, and must be entered again afterthe entry upload is completed. We are working on a way to allow for

    the T&C dates to be uploaded along with the CAS Entry Data.

    Commissioning and TestingWithin this section you are able to enter the Commissioning and Testing Dates andResults to the items.

    Next to each item is an update button, if you wish to add C&T data to an itemclicks in update button, which will bring up a new box, as seen below. Simply to

    add dates ordata, select the

    box next the testthat has beencompleted, andthen from thesmall calendarthat has appearsselect the date oftesting. If the

    entry box does not require you to enter a date, but instead a number or text, thensimply just writing in the require number or text. Once you have completed addingthe entries, select the update button and the system will automatically fill out the

    CAS Sheet with these dates, and update all summaries and graphs.

    Full ScheduleThis section is what Clients and Contractors will have access to as well as CMLEmployees, it is basically a full view of the CAS Sheet. As discussed before, anyfilters that have been applied in this section will automatically update the summaryat the bottom of the page, and you may also print the CAS Sheet with the filters

    applied.

    GraphThis section is a bar chart graph plotted using the data from your CAS Sheet. Thereare also filters provided for the bar chart, which will update the chart as they areapplied. Make sure you click the small chart symbol next to the filters each time youapply filters, to properly update the graph.

    The graph can printed using the print button located just above the graph, and willprint to show the filters that have been applied.

  • 7/29/2019 Guide to Tech CMS

    13/19

    C M L T E C H N I Q U E S

    10

    ReportsLocated in the main navigation menu is a reports button, which will lead you tofurther graphs that collate data from multiple-CAS Sheets. There is also an optionto view a quick printable view of each of the CAS Sheets, which is good if yourequire too print many CAS Sheets in succession.

    CAS Sheet ReportAs discussed above the quick print view of each CAS.

    Project SummaryA bar graph showing the percentages of Electrical, Mechanical,ELV, and Public Health overall percentages

    CAS Sheet Service SummaryA bar graph showing the percentages of all of theCAS sheets individually for a select service.

    CAS Sheet Package SummaryA bar graph that is the same as the one located in

    CAS Sheet Module pages, just quicker to navigate between them all.

  • 7/29/2019 Guide to Tech CMS

    14/19

    C M L T E C H N I Q U E S

    11

    Commissioning Plan Module

    Designed to for uploading, viewing, and reviewing of theCommissioning Plan

    he Commissioning Plan module is a system designed to host your projectsCommissioning Plan, you are able to upload a PDF copy of your latest

    Commissioning Plan on Techniques, and then all users who have beengranted access to the module will be able to view the Commissioning Plan

    on an embedded PDF view on Techniques. Other features to this section is theallowance for users to review the Commissioning Plan on Techniques its self, withthe user of our comment boxes located next to the Commissioning Plan PDF

    viewer. CML users will be able to respond to these comments, and when changeshave been made, the latest revised copy of the Commissioning Plan can beuploaded. Weve also set the system to automatically email users upon an upload,comment given, or response given.

    Uploading the Commissioning Plan

    Select Commissioning Plan on your projects file tree to access the module. For newprojects obviously no Commissioning Plan would have been uploaded yet, so this

    module wont have much information to display. So what you wantto do is perform an upload, which means coming out of yourproject and entering the home page of Techniques. If you noticethe picture to the left of this text is the main page navigation panel,and to access theuploads section youllneed to select the

    Administration button, which isexclusive to CML users only. Youll then be prompted with a selection of four

    sections to access; youll want to access the Management section. Dont worry toomuch about the other sections, you wont be required to use them, and are for the

    web-team to perform certain background tasks.

    Once you are into the Management section youll be askedto select a module, and as the Commissioning Plan is partof the Commissioning Management System, so select itfor the drop down box and select the continue button.

    Now the next step is to tellTechniques which project youdlike to access, and the action you would like to perform for that project, as seen in

    the picture above. So select your project, and the action you want to perform isUploads, once you have selected both hit the go button.

    Chapter

    3

    T

  • 7/29/2019 Guide to Tech CMS

    15/19

    C M L T E C H N I Q U E S

    12

    Youll notice that a replica of your file tree has appeared navigate this file to selectthe Commissioning Plan folder, as this where youd like to uploadyour document. This will bringup a new area that allows you to

    finally upload your Commissioning Plan, asseen in the picture to the right. Simply all youmust do is type in a Document Name, forexample Commissioning Plan.R1-Exp Project, the next step is to select thebrowse button which will bring up a pop-up window, allowing you to browse yourPC/Laptop of the Commissioning Plan. The Do Not Send Email NotificationUpon Uploading will tell the system not to send out an email notifying the users ofthe Commissioning Plan upload, these option was implemented for project thatutilize Techniques after Commissioning has already began, and a fewCommissioning Plans may have already been revised, so this will allow you toupload these versions also, will notifying everyone.

    Note

    Uploads of the Commissioning Plan are required to be of PDFversion, do not upload in Word.Doc format.

    Viewing, Reviewing and RespondingNow that you have uploaded your Commissioning Plan you will be able to viewthe document on Techniques itself. Clients and other Contractors will able Review

    the document, and you will be able to respond to their comments.

    The above is a screenshot of what will be similar to when you now access yourCommissioning Plan Module, though the Document Name, and Upload Date willbe different. It also tell you what version(revision) of the Commissioning Plan it is,

    Total Comment which is the total amount of review comments given to the

    document, and, outstanding comments which is the amount of comments CMLhave yet to respond to.

    Top open the Commissioning Plan select the blue highlighted document name,and this will bring up a new page. One with a embedded PDF copy of theCommissioning Plan in the center, a few comment boxes to the left, and someaction buttons on the right.

    The comment boxes on the left are used by a reviewer of theCommissioning Plan to add their comments, and there are twoadditional boxes to include the page number, and section to whichtheir comment applies to.

    After finishing each comment, the user must select the add to

  • 7/29/2019 Guide to Tech CMS

    16/19

    C M L T E C H N I Q U E S

    13

    basket, which will build up a collection of comments on theright hand side of, which can be seen in the screenshot to theright. These will stay in the basket, even if the user logs off, asthey may not yet have finished reviewing the Comissioning Plan, but when they are

    ready to submit their comments, they must select the Commit & Save Commentsbutton, which will automatically tell the system to send out aemail notification to all, stating that comments have beenadded.

    It is now possible to respond to the Reviewers comments on Techniques itself. Todo so you must go back to the Commissioning Plan main page, and youll nownotice that in the Total Commentscolumn it is now displaying the total amount ofcomments the Reviewer left. The column to the right of the Total Commentsis theOutstanding Comments, which displays the total number of comments that are stillawaiting a reply from CML.

    To view all comments or outstanding comments, click the view buttons besides thetotal figures. If you want to respond to a comment, this can only be done in theOutstanding Commentssection.

    Click the view button will prompt a new window to open, containing comments,and the relevant details to the comments, as can be seen below.

    To respond to the comment, click the CML Responsebutton, which will prompt asmall window to open up onto the middle of your screen,

    which can be seen to the left.

    In the text box located in the response window, you can writeout your comment, and when youre happy with it, click thesave button to issue the response. The Typical CML response

    option fills out the response text box with Noted, but this option will soon be adrop down box, containing a list of typical CML response that you can use to auto-fill the text box with.

    Upon exiting the response section, if you have responded to any of the comments,Techniques will send out and auto-generated email, notifying the relevant of that aresponse has been given to the comments.

  • 7/29/2019 Guide to Tech CMS

    17/19

    C M L T E C H N I Q U E S

    14

    If you wish to print a copy of a comments, and the responses given there is a printoption, in both the Total Commentsand Outstanding Commentspages. In the top righthand corner of the pages there is a small printer icon, clicking this icon will bringup a printable version of the page, which can be seen in the image above. Notice in

    the bar above Document Comments Reportthere is a printer bar, with a few options,clicking the printer icon in this bar will allow you to print the Document CommentsReport.

  • 7/29/2019 Guide to Tech CMS

    18/19

    C M L T E C H N I Q U E S

    15

    Document Review Module

    It is now possible to create a Document Review usingtechniques, and for responses and replies to be given also.

    he Document Review Module, is designed to allow for the creation,response, and CML response of a Document Review all on Techniquesitself, doing away with the creation a Document Review on MS Word.

    Techniques automatically generates a log of all Document Reviews as theyare created, this log provides all the relevant details of the DRs, and also allows toprint a copy of the log. Techniques also keeps you up-to-date via email upon a DRbeing created, a Client/Contractor responding to any of the comments on a DR,and if a user has closed out a DR.

    The DR LogWhen you first setup a project on Techniques the DR log will obviously first beempty, but after creating your first DR the log will automatically build up. The Logalso acts as the DR main page, allowing you to view any of the DRs.

    The image above is of a DR log page, similar to one that would be created on excel,but without the fuss of having to update it yourself.

    As you can see there are various details about the DRs such as creation date, whocreated the DR, who it was issued too, and its status.

    In the Over Due (Days) column you can set a time period in which the user who wasissued too should responded within, if they dont respond with the timeperiod,

    3

    T

  • 7/29/2019 Guide to Tech CMS

    19/19

    C M L T E C H N I Q U E S

    Techniques starts to display how many days have passed since the response periodhas passed. Notice in the picture below, responses have been given, and the DRclosed out, so it displays the information in black text, and states the DR is nowclosed.

    Closing out of a DR is fairly simply, just lick the edit button besides the DR youwish to close out. This will prompt the box in the image to theleft to be displayed. In the drop down box will be the option tochoose the status of the DR, once selected click the Update

    button and this will change the status of the DR for you.

    To open a DR to view it, simply click on the DR number button the left hand side,which will prompt another tab to open on your browser showing a copy of theDR, as can be seen in the image below.