You are on page 1of 55

User Guide

CADWorx Datasheets User Guide


Copyright 1993-2008 COADE, Inc. All Rights Reserved.

Printed on 22 July 2008

CADWorx Datasheets License Agreement


Licensor: COADE/Engineering Physics Software, Inc., 12777 Jones Road, Suite 480, Houston, Texas 77070.

ACCEPTANCE OF TERMS OF AGREEMENT BY THE USER


YOU SHOULD CAREFULLY READ THE FOLLOWING TERMS AND CONDITIONS BEFORE USING THIS PROGRAM. USING THIS PROGRAM INDICATES YOUR ACCEPTANCE OF THESE TERMS AND CONDITIONS. The enclosed proprietary encoded materials, hereinafter referred to as the Licensed Program(s), are the property of COADE and are provided to you under the terms and conditions of this License Agreement. You assume responsibility for the selection of the appropriate Licensed Program(s) to achieve the intended results, and for the installation, use, and results obtained from the selected Licensed Program(s).

LICENSE GRANT
In return for the payment of the license fee associated with the acquisition of the Licensed Program(s) from COADE, COADE hereby grants you the following non-exclusive rights with regard to the Licensed Program(s): 1. Use of the Licensed Program(s) on one machine. Under no circumstances is the Licensed Program to be executed without a COADE External Software Lock (ESL) or properly authorized software lock license. 2. To transfer the Licensed Program(s) and license it to a third party if the third party acknowledges in writing its agreement to accept the Licensed Program(s) under the terms and conditions of this License Agreement; if you transfer the Licensed Program(s), you must at the same time either transfer all copies whether printed or in machine-readable form to the same party or destroy any copies not so transferred; the requirement to transfer and/or destroy copies of the Licensed Program(s) contained or merged into other programs. You agree to reproduce and include the copyright notice as it appears on the Licensed Program(s) on any copy, modification, merged portion of the Licensed Program(s). THE LICENSE DOES NOT GIVE YOU ANY RIGHT TO USE, MODIFY, OR TRANSFER THE LICENSED PROGRAM(S) OR ANY COPY, MODIFICATION, OR MERGED PORTION THEREOF, IN WHOLE OR IN PART, EXCEPT AS EXPRESSLY PROVIDED IN THIS LICENSED AGREEMENT. IF YOU TRANSFER POSSESSION OF ANY COPY, MODIFICATION, OR MERGED PORTION OF THE LICENSED PROGRAM(S) TO ANOTHER PARTY, THE LICENSE GRANTED HEREUNDER TO YOU IS AUTOMATICALLY TERMINATED.

TERM
This License Agreement is effective upon acceptance and use of the Licensed Program(s) until terminated in accordance with the terms of this License Agreement. You may terminate the License Agreement at any time by destroying the Licensed Program(s) together with all copies, modifications, and merged portions thereof in any form. This License Agreement will also terminate upon conditions set forth elsewhere in this Agreement or automatically in the event you fail to comply with any term or condition of this License Agreement. You hereby agree upon such termination to destroy the Licensed Program(s) together with all copies, modifications, and merged portions thereof in any form.

LIMITED WARRANTY
The Licensed Program(s), i.e. the tangible proprietary software, is provided, "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED AND EXPLICITLY EXCLUDING ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. The entire risk as to the quality and performance of the Licensed Program(s) is with you. Some jurisdictions do not allow the exclusion of limited warranties, and, in those jurisdictions the above exclusions may not apply. This Limited Warranty gives you specific legal rights, and you may also have other rights which vary from one jurisdiction to another. COADE does not warrant that the functions contained in the Licensed Program(s) will meet your requirements or that the operation of the program will be uninterrupted or error free. COADE does warrant, however, that the CD-ROM, i.e. the tangible physical medium on which the Licensed Program(s) is furnished, to be free from defects in materials and workmanship under normal use for a period of ninety (90) days from the date of delivery to you as evidenced by a copy of your receipt. COADE warrants that any program errors will be fixed by COADE, at COADE's expense, as soon as possible after the problem is reported and verified. However, only those customers current on their update/maintenance contracts are eligible to receive the corrected version of the program.

ENTIRE AGREEMENT
This written Agreement constitutes the entire agreement between the parties concerning the Licensed Program(s). No agent, distributor, salesman, or other person acting or representing themselves to act on behalf of COADE has the authority to modify or supplement the limited warrant contained herein, nor any of the other specific provisions of this Agreement, and no such modifications or supplements shall be effective unless agreed to in writing by an officer of COADE having authority to act on behalf of COADE in this regard.

LIMITATIONS OF REMEDIES
COADE's entire liability and your exclusive remedy shall be: 1. The replacement of any CD-ROM not meeting COADE's "Limited Warranty" as defined herein and which is returned to COADE or an authorized COADE dealer with a copy of your receipt, or 2. If COADE or the dealer is unable to deliver a replacement CD-ROM which is free of defects in materials or workmanship you may terminate this License Agreement by returning the Licensed Program(s) and associated documentation and you will be refunded all the monies paid to COADE to acquire the Licensed Program(s).

IN NO EVENT WILL COADE BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING ANY LOST PROFITS, LOST SAVINGS, AND OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LICENSED PROGRAM(S) EVEN IF COADE OR AN AUTHORIZED COADE DEALER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, OR FOR ANY CLAIM BY ANY OTHER PARTY. SOME JURISDICTIONS DO NOT PERMIT LIMITATION OR EXCLUSION OF LIABILITY FOR INCIDENTAL AND CONSEQUENTIAL DAMAGES SO THAT THE ABOVE LIMITATION AND EXCLUSION MAY NOT APPLY IN THOSE JURISDICTIONS. FURTHERMORE, COADE DOES NOT PURPORT TO DISCLAIM ANY LIABILITY FOR PERSONAL INJURY CAUSED BY DEFECTS IN THE CD-ROM OR OTHER PRODUCTS PROVIDED BY COADE PURSUANT TO THIS LICENSE AGREEMENT. GENERAL You may not sublicense, assign or transfer your rights under this License Agreement or the Licensed Program(s) except as expressly provided in the License Agreement. Any attempt otherwise to sublicense, assign or transfer any of the rights, duties or obligations hereunder is void and constitutes a breach of this License Agreement giving COADE the right to terminate as specified herein. This Agreement is governed by the laws of the State of Texas, United States of America. The initial license fee includes one (1) year of support, maintenance, and enhancements to the program. After the first 1-year term, such updates and support are optional at the then current update fee. Questions concerning this License Agreement, and all notices herein shall be made by contacting COADE in writing at COADE, 12777 Jones Road, Suite 480, Houston, Texas 77070. EXPORT RESTRICTIONS You acknowledge the Software is subject to U.S. export jurisdiction. You agree to comply with all applicable international and national laws that apply to the Software, including the U.S. Export Administration Regulations, as well as end-user, end-use, and destination restrictions issued by U.S. and other governments. For additional information see http://www.bis.doc.gov (http://www.bis.doc.gov).

TRADEMARKS
AutoCAD and ObjectARX are trademarks of Autodesk. Windows, Access, SQL Server, Excel, Word are trademarks of Microsoft Corporation. Oracle is a trademark of Oracle Corporation. Other trademarks are the property of their respective owners.

COADE Inc. 12777 Jones Road, Suite 480 Houston, Texas 77070 U.S.A. Copyright 1993-2008 COADE, Inc. All Rights Reserved.

Table of Contents
CADWorx Datasheets License Agreement Installation 3 9

Conventions ...................................................................................................................................9 Installation Overview ....................................................................................................................10 Installation Start............................................................................................................................10 License Manager..........................................................................................................................11

Instrument Datasheets

21

Startup ..........................................................................................................................................22 Project Information .......................................................................................................................22 List Revisions ...............................................................................................................................24 Entering Data ...............................................................................................................................24 Copy and Paste Commands ........................................................................................................27 Reports .........................................................................................................................................27 Reference Documents..................................................................................................................32 Datasheets ...................................................................................................................................35 Customizing..................................................................................................................................37

Equipment List

39

Equipment List..............................................................................................................................40 Project Information .......................................................................................................................40 Equipment List Revisions .............................................................................................................42 Entering Data ...............................................................................................................................42 Copy and Paste Commands ........................................................................................................45 Reports .........................................................................................................................................46 Reference Documents..................................................................................................................48 Lists ..............................................................................................................................................52 Customizing..................................................................................................................................54

Index

55

CHAPTER 1

Installation

In This Chapter
Conventions ....................................................................... 9 Installation Overview.......................................................... 10 Installation Start ................................................................. 10 License Manager ............................................................... 11

Conventions
Before reviewing this guide, it is important to understand the terms and conventions used in the documentation. Use the information below to identify the convention and the type of information. Convention
<INSTALL-DIR>

Type of Information
This refers to the CADWorx installation directory on your computer. For example, C:\CADWorx Datasheets. Substitute your installation directory anywhere this notation is used. This refers to your AutoCAD installation directory. For example, C:\AutoCAD 2000i. Substitute your installation directory anywhere this notation is used. This refers to your CD-ROM drive. Substitute your CD-ROM drive letter anywhere this notation is used.

<ACAD-DIR>

<CD-DRIVE>

10

CADWorx Datasheets User Guide User Guide


Command Line User Responses
Commands

Items that need to be typed in or appear at the AutoCAD command line. This refers to user responses to command prompts. CADWorx and AutoCAD commands. Command line options. AutoCAD system variables or keywords. Key combinations for which the user must press and hold down one key and then press another, for example, CTRL+P, or ALT+F4.

Options
CAPITALS KEY+KEY

Installation Overview
CADWorx Datasheets is installed on the system hard drive using the installation program called SETUP.EXE located on the CD ROM. This installation program has been designed to allow full installation and ease of updating. This section will explain the operation of the installation program, the format of CADWorx Datasheets program on the CD ROM, and the options available to the user. The installation process is relatively simple to accomplish. After starting the installation program the user will be prompted for the required information. If the computer that the installation is being performed has auto run enabled, the setup procedure will automatically start. The CD ROM contains various files, all of which are compressed into files that the installation can read. The only way to extract these files out is to run the installation program (SETUP.EXE).

Installation Start
Quick Start
Run the SETUP.EXE. To start CADWorx Datasheets, pick the icon created during installation. Dialogs will carry the user through the rest of the installation. First time execution of the program will require certain startup parameters to be set. Most of the time, the defaults will be sufficient.

Chapter 1 Installation

11

License Manager
CADWorx Datasheets uses software locking mechanism for license management. The installation program installs the license manager needed for running CADWorx Datasheets.

Evaluating CADWorx Datasheets


After CADWorx Datasheets has been installed, the user can evaluate the program for a period of 15 days.

After that time has expired, they must purchase a license if they wish to continue using the program. Evaluation extensions are processed on a case by case basis by COADE Inc. sales staff. Please contact sales@coade.com (mailto:sales@coade.com) for more information.

12

CADWorx Datasheets User Guide User Guide

Purchasing New Licenses


To purchase a new license of CADWorx Datasheets, use one of the options below: 1. Purchase online from COADE's web site: https://order.coade.com 2. Create an email message to sales@coade.com (mailto:sales@coade.com) or contact your COADE Reseller. Please include the following information in the email message: Your Name, Your Company Name (if applicable) Street Address, City, State, Zip Code and Country E-mail Address, Phone Number Site Code (see Site Code Retrieval below) Number of Licenses Pricing for CADWorx Datasheets can be found at http://ww.coade.com COADE, Inc can be contacted at: 12777 Jones Road Suite 480 Houston, Texas, 77070 USA Phone: +1 (281) 890-4566 or (800) 899-8787 (US Only) Fax: +1 (281) 890-3301 Web: http://www.coade.com E-Mail: sales@coade.com (mailto:sales@coade.com)

Site Code Retrieval


The user will have to retrieve the "Site Code" from their machine. The site code is a unique string identifying the machine the program is installed on. This will be required to purchase the product and should be emailed to sales@coade.com (mailto:sales@coade.com) along with buyer information as shown above. The licence manager, shown below, can be started several ways. The first way is from the CADWorx Datasheets program group. Go to Start->Programs->CADWorx Datasheets->License Manager.

Chapter 1 Installation

13

The other method for starting the license manager is from CADWorx Datasheets. When the program is started, it will ask if you would like to authorize it as shown below. By choosing the "Authorize" button, it starts the licence manager along with this help file. Note: You can start a 15 day evaluation from this dialog as shown. Picking "No" will exit the program.

After starting the program, retrieve the "Site Code" as shown on the following dialog. There is a button on the right of the Site Code edit box for copying this number to an email.

14

CADWorx Datasheets User Guide User Guide

Site Key Activation


To activate a purchased copy, enter the "Site Key" provided by COADE into the edit box. Once the key has been entered, click on the Save Site Key button to activate the license. If the site key is valid, the program will change the license status to "AUTHORIZATION OK". If the user purchased more than 1 license, the license count box will display how many licenses have been authorized. If the user had requested network licenses, then then the license count box will display the number of licenses and the word "floating" in parenthesis.

Floating Licenses
Setup
If you have purchased a floating license, please follow these additional steps: 1. Create a directory on a server to hold the license files (Example: \\CADWorx_LicDir). 2. Make sure all users have write privileges to this directory. 3. Extract the contents of the file <Install-Dir>\System\Network.exe to this directory.

Chapter 1 Installation

15

4. One of the files extracted from the Network.exe will be Network.htm, Follow the instructions in Network.htm file to setup floating licenses.

16

CADWorx Datasheets User Guide User Guide

Note: Each activation of CADWorx Datasheets from a machine will use a license. If CADWorx Datasheets is started twice on the same machine, two floating license will be used.

Note: To clear all license entries from the License Manager, exit out of the License Manager and all session of CADWorx Steel and delete the CADWorxS.tb2 file. This file will be located in the "License Path" folder that is displayed in the License Manager dialog. For CADWorx Datasheets, delete the file CADWorxD.tb2

Note: AutoCAD background plotting uses the last AutoCAD profile used to start a "silent" session of AutoCAD. This session will use the CADWorx_Steel profile if PUBLISH command is done from CADWorx Steel. This silent session of AutocAD will use a floating license .

View
If the user purchased network licenses of CADWorx Datasheets, they can view details regarding these floating licenses through the License Manager. Once the license manager starts, click on the View Floating Licenses button. A dialog will appear as shown below.

Chapter 1 Installation

17

This dialog will display the following information: List of licenses currently in use. Name of computer where the license is being used. Login name of the user using the license. Note: Running the license manager will use one license.

18

CADWorx Datasheets User Guide User Guide

Killing Licenses
Note: This procedure will permanently remove any license that has been installed on the machine. DO NOT perform this procedure unless required or instructed by COADE. If the user wishes to remove (kill) licenses from the current machine, they can do so through the License Manager. To start the license manager, go to Start->Programs>CADWorx->License Manager. Once the license manager starts, click on the Kill License button. The Kill License dialog will appear.

If the user clicks on the Generate button, a dialog will appear to confirm the user selection as shown below.

If the user clicks on the Yes button, the license will be killed and a kill code will be generated. A dialog will appear as shown below informing the user to send an e-mail to sales@coade.com (mailto:sales@coade.com) with the kill code generated.

Chapter 1 Installation

19

Once the user acknowledges that the license has been killed, the kill code will be displayed as shown below.

A KillCode.txt file will also be generated. The user can either copy the kill code or send the KillCode.txt file to sales@coade.com (mailto:sales@coade.com). The user must send the kill code to COADE if they wish to use the same license on a different machine.

Transferring Licenses
If the user wants to transfer licenses from one machine to another, they can perform the transfer through the License Manager. To start the license manager, go to Start>Programs->CADWorx->License Manager. Once the license manager starts, click on the Transfer License button. A dialog will appear as shown below.

20

CADWorx Datasheets User Guide User Guide

There are two ways to transfer licenses: 1. Indirect Transfer - This option can be used if the machines are NOT on the same network. 2. Direct Transfer - This option can be used if the machines are on the same network.

Indirect Transfer
To use this option, follow these steps shown in the Transfer License dialog

Direct Transfer
To use this option, follow these steps: 1. Copy the contents of folder containing the license files from <Source-System> to a new folder on the <Target-System>. 2. The folder containing the licenses files will be shown in the License Manage dialog on the <Source-System>. 3. For CADWorx Steel, delete all files starting with CADWorxS EXCEPT CADWorxS.lic in the new folder on the <Target-System>. 4. For CADWorx Datasheets, delete all files starting with CADWorxD EXCEPT CADWorxD.lic in the new folder on the <Target-System>. 5. Start the License Manager on the <Source-System>. Click on Transfer License button and then on the Direct Transfer button. 6. Browse to the <Target-System> and to new folder created. 7. For CADWorx Steel, select the CADWorxS.lic from the new folder and the license will be transferred from the <Source-System> to the <Target-System>. 8. For CADWorx Datasheets, select the CADWorxD.lic from the new folder and the license will be transferred from the <Source-System> to the <Target-System>. Note: The direct transfer method should be used to move the license folder from the default location to a new location

21

CHAPTER 2

Instrument Datasheets

In This Chapter
Startup ............................................................................... 22 Project Information............................................................. 22 List Revisions ..................................................................... 24 Entering Data ..................................................................... 24 Copy and Paste Commands.............................................. 27 Reports .............................................................................. 27 Reference Documents ....................................................... 32 Datasheets ......................................................................... 35 Customizing ....................................................................... 37

22

CADWorx Datasheets User Guide User Guide

Startup
When the user starts the application, they will be prompted to either create a new data sheets set or open an existing set of data sheets. Should the user desire to open an existing project, a list of the most recently used list files are available to choose from.

Project Information
When the user creates a new project, they will be prompted to enter the project information into a dialog as shown below.

Chapter 2 Instrument Datasheets

23

Although filling in this form is optional, it is important and recommended. The data entered will be used to automatically populate the Report Title and Datasheet Tile blocks.

The user may make changes to the information at any time by choosing Project Information on the Edit Menu. Click on Save to keep the changes; click on Refresh to update any changes made by another user if more than one user is using the project. Additional information associated with the project can be entered into this table and saved with the project. Any information the user desires to include can be added at the bottom of the table under the default Attribute Names. Properties added by the user may be deleted by selected the Delete command. Note: The seven default properties may not be deleted or the property names edited. The DefaultTemplateFolder value specifies the location where all the default templates are located. By default, this is set to <INSTALL-DIR>\Instrument\Templates. This value may be changed using the Browse button. The DefaultDatasheetFolder value specifies where new datasheets created by CADWorx Datasheets will be saved. By default, this is set to <INSTALLDIR>\Instrument\Datasheets. This value may be changed using the Browse button. Note: It is suggested that the user browse for the templates and datasheets folders using the Network Neighborhood option so that CADWorx Datasheets stores the UNC path in the database. It is acceptable to use a mapped drive letter, as long as it is always the same drive letter for all users on a given project.

24

CADWorx Datasheets User Guide User Guide

List Revisions
To complete the title block in the Index Report, the user has to fill in the revision information using the Index Revisions dialog box found on the Edit Menu. The Date field is formatted according to the Regional Settings in the Control Panel on the users computer.

Entering Data
Data may be entered into the index table by simply clicking on a field and typing in the data. The Tag field is a primary field and is required.

Chapter 2 Instrument Datasheets

25

The Datasheet, PID, Loop Dwg, Requisition, and Purchase Order fields contain dropdown boxes displaying documents the user has entered into the All Documents table through the Documents Menu. Only documents entered into this table can be entered into the fields in the database. Please refer to Reference Documents (see page 32) for more details. To delete a tag from the database, select the Tag field or row and click on Delete. The user will be prompted to confirm the deletion of the tag before it is permanently deleted The columns may be rearranged to suit the users preference. The user may find it helpful to move the Tag column frequently to ensure that data entered into a field is associated with the correct tag. To move the column, the user must select the column header and click and drag the column to the desired location. The user may collapse a column by right clicking on the column header. To restore the column width, the user must right-click on the collapsed column. The user cannot update the tag number and a document number (i.e., PID, Loop Dwg, Requisition, Purchase Order, or Datasheet fields) at the same time. The user must first modify the tag, save it and then modify the document number. The user cannot associate a document number to a tag when creating a tag. The user must first create the tag, save it, and then associate the document(s) to it. The Populate button allows the user to populate the index with instrument tags from a valid CADWorx P&ID database. The DefaultP&IDDatabase value specified in the Project Information (see page 22) section is used to retrieve the tags. The Import button allows the user to import data from CADWorx P&ID database into datasheets . The Export button allows the user to export data to the CADWorx P&ID database specified under Project Information (see page 22). The table and columns that get updated are controlled by the P&ID Database Map sheet located in each datasheet template.

26

CADWorx Datasheets User Guide User Guide

The column DB_Table indicates the CADWorx P&ID table which needs to be updated. For instrument datasheets, this must always be Components-Instruments. DB_Column indicates the column that will be updated. The next three columns, worksheet, column and row show which datasheet and which cell are tied to the particular database table and column.

Chapter 2 Instrument Datasheets

27

Copy and Paste Commands


Ctrl+C/Ctrl+V Keystroke Using this familiar method to copy and paste will only work for text in a cell. You cannot copy or paste an entire row of information using these shortcut keys. However, the program stores into memory the last section of text the user identified to copy. The user can continue pasting the stored text using Ctrl/V until another text selection is made with Ctrl+C even if the user copies a row using another copy method. The user cannot copy a reference document from one record to another using Ctrl+C. If the user attempts to copy using this method, the document number will appear as **DELETED**. In order to undo changes, the user must hit the escape key. Copy/Paste using Mouse When the user selects an entire row, they can choose to copy or delete it by right clicking. All fields can be pasted in another row except those fields requiring the user to enter data via a drop-down menu. The user must assign values to these fields manually. The user may sort data in the index by selecting the column heading. The user may sort by any column except Datasheet, PID, Loop Dwg, Requisition, or Purchase Order.

Reports

28

CADWorx Datasheets User Guide User Guide

CADWorx Datasheets is equipped with several reports found on the Reports Menu. The reports were written using Crystal Reports, and each generally performs in the same way. The reports cannot be modified.

Print
The report will print to the user's default printer. To change the target printer, the user must change the computer's default printer.

Group Tree
The user may toggle the group tree option using the Group Tree command button. On several reports, tag numbers are displayed in the group tree window under the Preview tab. When the user selects a tag number, the tag number and data are instantly displayed in the report sequence.

Percent View
The user may "zoom in" to get a close-up view of the report or "zoom out" to see more of the page at a reduced size using the zoom box.

Previous/Next Pages
The user may maneuver through the pages of the report a variety of ways using the Go To command buttons or by typing in the page number.

Search Text

Chapter 2 Instrument Datasheets

29

The user may search the text of the report for a specific word or phrase using the Search Text command button. This feature allows the user to view every instance where the text appears in the report in order. Index Report The data displayed in this report is grouped by loop number and is sorted by tag number. The Index Report displays the data entered in the following fields for each tag: Tag Number Loop Number Service Description Manufacturer & Model Number Equip/Line Number PID Number Requisition Number PO Number Datasheet Number Location Remarks

30

CADWorx Datasheets User Guide User Guide

To view the report, choose Index Report on the Reports Menu. Controller & Alarm Summary The data displayed in this report is not grouped but is sorted by tag number. The Controller & Alarm Summary Report displays the data entered in the following fields for each tag: Tag Number Location Instrument Type Signal Type Process Units Minimum & Maximum Process Value Process Set Point Minimum & Maximum Calibration Value Calibration Set Point Calibration Units To view the report, choose Controller & Alarm Summary on the Reports Menu. Installation Details The data displayed in this report is not grouped but is sorted by tag number. The Installation Details Report displays the data entered in the following fields for each tag: Tag Number Service Description PID Number Construction Area Process Piping Detail Pneumatic Detail Support Detail Electrical Detail Purge Detail Miscellaneous Detail

Chapter 2 Instrument Datasheets

31

To view the report, choose Installation Details on the Reports Menu. Maintenance Report The data displayed in this report is not grouped but is sorted by tag number with one tag per page. The Maintenance Report displays the data entered in the following fields for each tag: Tag Number Service Description Loop Number Operating Unit Number Manufacturer & Model Number Body Material Instrument Type Equipment/Line Number Location Process Unit Area Construction Area Electrical Area Signal Type Process Controller Range Process Controller Set Point Lo Set Point Lo Lo Set Point Lo Lo Lo Set Point Calibration Controller Range Calibration Controller Set Point Hi Set Point Hi Hi Set Point Hi Hi Hi Set Point To view the report, choose Maintenance on the Reports Menu.

32

CADWorx Datasheets User Guide User Guide

Reference Documents

Chapter 2 Instrument Datasheets

33

The user may view the information for all reference documents in the project by choosing All on the Documents Menu. To view the reference documents for a single tag, the user should select the tag by clicking in the Tag field and then choose Tags Reference Documents on the Documents Menu.

All Documents
The user may create a new document by entering in the document information directly into the All Documents dialog. If the user changes a document number in the All Documents form and the document has already been associated to a tag, the tag information in the index will be updated to reflect the change made. To save all changes made in the form, choose Save. To delete a document from the form, choose Delete. The user will be prompted to confirm deletion of the document. This action permanently deletes the document from the database. The user may define the Document Path and Document File Name by choosing the Map command button at the bottom of the form. The user can easily find the document using the Locate File dialog box. The program will place the path and file name into the form. When a document has a defined path and file name, the user may choose the View command button to view the document.

Tags Reference Documents


The commands in the Tags Reference Documents form are, for the most part, identical to the commands in the All Documents form. The Save, Refresh, View, Map, and Exit commands perform in the same way in the Tags Reference Documents form as in the All Documents form. If documents have already been referenced to the tag, all the information in the All Documents form associated with the document will appear in the Tags Reference Documents form. If the user chooses to reference a document from the Tags Reference Documents form it will be necessary to choose the Refresh command to view all information associated with the document. To reference an existing document, the user may use the drop down menu in the Tag field. The user may create a new document by choosing the Create Doc command on the Tags Reference Documents form. When the user chooses to create a new document on the Tags Reference Document form, a dialog box opens to assist the user in defining the new document. The user may choose from a drop down listing of document types or may choose to create a new document type. When the user saves the document information, the new document name is displayed in the Reference Document form as well as in the index in the appropriate field for that tag.

34

CADWorx Datasheets User Guide User Guide

The user may delete a reference to a document by choosing the Delete Ref command button. This action will not remove the document from the database entirely; only the reference to the tag number will be deleted. The user will be prompted to confirm the removal of the association.

Chapter 2 Instrument Datasheets

35

Datasheets
To view the Datasheet for the selected Instrument Tag in the Index, select Tags Datasheet on the Documents Menu or choose the Datasheet command button at the bottom of the Index window. CADWorx Datasheets contains 60+ intelligent datasheets. Entering Data The mouse pointer may be used to select a field, but all data must be entered via the keyboard. Check boxes will not be turned on using the mouse pointer. The datasheet templates provided by the software are designed for user efficiency. Since most of the time filling in an instrument datasheet is spent using the keyboard, the check boxes are actually selected by placing the letter X (or any other letter) in the spreadsheet cell over which the check box is superimposed. The user should notice the logic embedded in the S20.21 (Orifice Plates & Flanges) datasheet for the various datasheet lines using check boxes. Where appropriate, only one check box can be selected, and by selecting a different check box the previous one is blanked out. When keying in text for Other on such lines, any previously selected check box is blanked out automatically. There are exceptions to this rule, namely on Line 1 of S20.21. The user can have both the check box for Concentric selected and key in a value for Other and both values will remain in the datasheet. This is to permit the user to specify frequently used options such as Square Edged. Saving Changes To save changes to the datasheet, choose the Save command on the Main toolbar. The default directory is Datasheets in CADWorx Datasheets is the <INSTALLDIR>\Instruments\Datasheets. Synchronizing Data All data included in both the Datasheet and the index is synchronized. Should the user change any field in the datasheet that is linked to the index and save the changes, the data will be updated in the index automatically. Also, any changes made to the data in the index will be represented in the datasheet. In order for the data changes in the datasheet to be evident in the index, the datasheet must be saved first. The software will automatically remind you to save changes. Assigning Datasheet Type

36

CADWorx Datasheets User Guide User Guide

Any time the user chooses to view the datasheet for a specified instrument and the Datasheet Path field in the spreadsheet is not defined, the user will be prompted by the software to assign a datasheet type automatically. Saving Datasheet as File Any time the user chooses to view the datasheet for a specified instrument and the Datasheet File Name field in the index is not defined, the user will be prompted by the software to assign a file name automatically. When the user is prompted to save the datasheet, the software assumes that the instrument tag number will be used as the file name. Should the user continually use this default, they must also be aware that the file name is not automatically updated to reflect any changes the user makes to the tag number. The file name must be changed manually.

Chapter 2 Instrument Datasheets

37

Customizing
The software provided can be customized to a certain extent and still retain the integrity of the system. The user is encouraged to make any necessary format changes to the datasheet templates. However, if the user changes the cell address for the input cells, they may compromise the mapping of the index information to the input cells. Changing Index Column Headings The user can change the column headings on the index spreadsheet easily in the index.mdb table named FormColumnNames. Choose Refresh to reflect the changes in the index form. Un-protecting Datasheets All datasheets have the controls protected. The password is blank (i.e. there is no password to unprotect) if the user needs to move any of the datasheet controls such as the shapes for checkboxes or change out the company logo. It is recommended that the user re-protect any datasheets so that the controls cannot be inadvertently moved or deleted. The Index Report The index report is written using Crystal Reports. The user could also write an index report in the index.mdb file if he has a full version of Microsoft Access installed. If the report is written in Access, the user will have to run such a report outside of the CADWorx Datasheets system.

39

CHAPTER 3

Equipment List

In This Chapter
Equipment List ................................................................... 40 Project Information............................................................. 40 Equipment List Revisions .................................................. 42 Entering Data ..................................................................... 42 Copy and Paste Commands.............................................. 45 Reports .............................................................................. 46 Reference Documents ....................................................... 48 Lists.................................................................................... 52 Customizing ....................................................................... 54

40

CADWorx Datasheets User Guide User Guide

Equipment List
When the user starts the application, they will be prompted to either create a new equipment list or open an existing equipment list. Should the user desire to open an existing project, a list of the most recently used list files are available to choose from.

Project Information
If the user creates a new project, they will be prompted to enter the project information as shown below.

Chapter 3 Equipment List

41

Note: Although filling in the project information is optional, it is recommended that users enter all relevant data. The data entered will be used to automatically populate the report title and datasheet title blocks as shown below. The DefaultTemplateFolder and DefaultDatasheetFolder are mandatory fields which must be filled out. Click on Save to keep the changes. Clicking on Refresh displays any changes made by another user if more than one user is using the project. Additional information associated with the project can be added here and saved with the project. Properties added by the user may be deleted by selecting the Delete button. The default properties may not be deleted or modified. The DefaultTemplateFolder and DefaultDatasheetFolder values may be changed to direct the program to choose the templates from a different location and to place the datasheets created in a different location using the Browse buttons. If the user changes the default template folder, it is very important that the templates are copied in to the new folder.

42

CADWorx Datasheets User Guide User Guide

Equipment List Revisions


CADWorx Datasheets can automatically complete the title block in the Equipment List Report, the user will want to fill in the revision information using the Equipment List Revisions dialog box found on the Edit Menu.

Entering Data

Chapter 3 Equipment List

43

Data may be entered into the equipment list table by selecting the tab that corresponds to the equipment type the user is entering data for and then clicking on a field and entering the data. The Equip No field is required. Note: The user can only create new equipment number's under it's corresponding equipment type tab.

Selecting the All tab will display all equipment numbers that have been entered into the equipment list.

44

CADWorx Datasheets User Guide User Guide

The Datasheet, PID, PFD, Requisition, and Purchase Order fields contain dropdown boxes displaying documents the user has entered into the All Documents table from the Documents Menu. Only documents entered into this table may be entered into the fields in the list. Please refer to Reference Documents for more information. To delete a tag from the list, choose the EquipNo field or row and click on Delete. The user will be prompted to confirm the deletion of the equipment number before it is permanently removed. The columns may be rearranged to suit user preference. To move a column, the user can click the column header and drag the column to the desired location. The user may collapse a column by right clicking on the column header. To restore the column width, the user must right-click on the collapsed column. Note: The status bar at the bottom of the window indicates which record is currently active and the current project. The Import button allows the user to import data from CADWorx P&ID database into datasheets. The Export button allows the user to export data to the CADWorx P&ID database specified under Project Information (see page 40). The table and columns that get updated are controlled by the P&ID Database Map sheet located in each datasheet template.

The column DB_Table indicates the CADWorx P&ID table which needs to be updated. DB_Column indicates the column that will be updated. The next three columns, worksheet, column and row show which datasheet and which cell are tied to the particular database table and column.

Chapter 3 Equipment List

45

Copy and Paste Commands


Ctrl+C/Ctrl+V Keystroke Using this familiar method to copy and paste will only work for text in a cell. You cannot copy or paste an entire row of information using these shortcut keys. However, the program stores into memory the last section of text the user identified to copy. The user can continue pasting the stored text using Ctrl/V until another text selection is made with Ctrl+C even if the user copies a row using another copy method.

46

CADWorx Datasheets User Guide User Guide

Copy/Paste using Mouse When the user selects an entire row, he may choose to copy or delete it by right clicking. All fields can be pasted in another row except the Datasheet number field. The user must assign values to this field manually. The user may sort data in the list by selecting the column heading. The user may sort by any column except Remarks.

Reports

Chapter 3 Equipment List

47

CADWorx Datasheets is equipped with a report found on the Report Menu. The report was written using Crystal Reports. The report cannot be modified because it is embedded into the program code. Print The report will print to the user's default printer. To change the target printer, the user must change the computer's default printer. Percent View The user may "zoom in" to get a close-up view of the report or "zoom out" to see more of the page at a reduced size using the zoom box. Previous/Next Pages The user may maneuver through the pages of the report a variety of ways using the Go To command buttons or by typing in the page number. Search Text The user may search the text of the report for a specific word or phrase using the Search Text command button. This feature allows the user to view every instance where the text appears in the report in order.

48

CADWorx Datasheets User Guide User Guide

Equipment List Report The List Report displays the data entered in the following fields for each tag: Equipment Tag Number Name/Service Manufacturer & Model Number PFD Number PID Number Design Conditions Capacity/Duty/Etc Mat'l of Construction Dimensions Spec Number Orientation PO Number Remarks To view the report, choose Equipment List on the Reports Menu.

Reference Documents

Chapter 3 Equipment List

49

The user may view the information for all reference documents in the project by choosing All on the Documents Menu. To view the reference documents for a single equipment number, the user should select the equipment number by clicking in the EquipNo field and then choose <Equipment number> documents on the Documents Menu.

50

CADWorx Datasheets User Guide User Guide

All Documents The user may create a new document by keying in the document information directly into the All Documents form. If the user changes a document number in the All Documents form and the document has already been associated to a tag, the tag information in the list will be updated to reflect the change made. To save all changes made in the form, choose Save. To delete a document from the form, choose Delete. The user will be prompted to confirm deletion of the document. This action permanently deletes the document from the database. The user may define the Document Path and Document File Name by choosing the Map command button at the bottom of the form. The user can easily find the document using the Locate File dialog box. The program will place the path and file name into the form. When a document has a defined path and file name, the user may choose the View command button to view the document. Equipment's Reference Documents

When the user chooses the <equipment number> documents option, another menu appears listing the type of documents that can be created for that equipment number.

Chapter 3 Equipment List

51

When the user chooses to create a new document in this manner a dialog box appears requesting the user to input the number for the document type that the user specified. The next dialog box to appear asks the user to locate the file associated to that document. This allows the user to map the document file so that the View command button can be utilized. Once the user chooses Save the document number is saved to that equipment number. The user can choose to not map the file by choosing Cancel and the document number will be saved to that equipment number.

52

CADWorx Datasheets User Guide User Guide

Lists
To view the Datasheet for the selected Equipment Number in the Equipment List, select <equipment number> documents on the Documents Menu and then choose Datasheet or choose the Datasheet command button at the bottom of the List window. CADWorx Datasheets contains 20+ intelligent datasheets. Entering Data The mouse pointer may be used to select a field, but all data must be entered via the keyboard. Check boxes will not be turned on using the mouse pointer. The datasheet templates provided by the software are designed for user efficiency. Saving Changes To save changes to the datasheet, choose the Save command on the Main toolbar. The default directory is <INSTALL-DIR>\Equipment\Datasheets. The user may change this default setting to another file location by editing Default Datasheet Folder in Project Information (see page 40) on the Edit Menu. Synchronizing Data All data included in both the Datasheet and Equipment List is synchronized. Should the user change any field in the datasheet that is linked to the list and save the changes, the data will be updated in the list automatically. Also, any changes to the data in the list will be represented in the datasheet. In order for the data changes in the datasheet to be evident in the list, the datasheet must be saved first. The software will automatically remind you to save changes.

Chapter 3 Equipment List

53

Assigning Datasheet Type Any time the user chooses to view the datasheet for a specified Equipment Number and the Datasheet Path field in the spreadsheet is not defined, the user will be prompted by the software to assign a datasheet type automatically. Saving Datasheet as File Any time the user chooses to view the datasheet for a specified Equipment Number and the Datasheet File Name is not defined, the user will be prompted by the software to assign a filename automatically. When the user is prompted to save the datasheet, the software assumes that the Equipment number will be used as the file name. Should the user continually use this default, he must also be aware that the filename is not automatically updated to reflect any changes the user makes to the equipment number. The filename must be changed manually.

54

CADWorx Datasheets User Guide User Guide

Customizing
The software provided can be customized to a certain extent and still retain the integrity of the system. The user is encouraged to make any necessary format changes to the datasheet templates. However, if the user changes the cell address for the input cells, he may compromise the mapping of the equipment list information to the input cells. Changing List Column Headings The user can change the column headings on the list spreadsheet easily in the index.mdb table named FormColumnNames. Choose Refresh to reflect the changes in the list form. Un-protecting Datasheets All datasheets have the controls protected. The password is blank (i.e. there is no password to unprotect) if the user needs to move any of the datasheet controls such as the shapes for checkboxes or change out the company logo. It is recommended that the user re-protect any datasheets so that the controls cannot be inadvertently moved or deleted. The Equipment List Report The index report is written using Crystal Reports. The user could also write an index report in the index.mdb file if he has a full version of Microsoft Access installed. If the report is written in Access, the user will have to run such a report outside of the CADWorx Datasheets system

55

Index
C
CADWorx Datasheets License Agreement 3 Conventions 9 Copy and Paste Commands 27, 45 Customizing 37, 54

S
Startup 22

T
Transferring Licenses 19

D
Datasheets 35

E
Entering Data 24, 42 Equipment List 39, 40 Equipment List Revisions 42 Evaluating CADWorx Datasheets 11

F
Floating Licenses 14

I
Installation 9 Installation Overview 10 Installation Start 10 Instrument Datasheets 21

K
Killing Licenses 18

L
License Manager 11 List Revisions 24 Lists 52

P
Project Information 22, 40 Purchasing New Licenses 12

Q
Quick Start 10

R
Reference Documents 32, 48 Reports 27, 46

You might also like