Professional Documents
Culture Documents
Cadworx: Datasheets User'S Guide
Cadworx: Datasheets User'S Guide
October 2015
DICAS-PE-200001E
Copyright
Copyright © 2003-2015 Intergraph® Corporation. All Rights Reserved. Intergraph is part of Hexagon.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement; contains
confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret law, and
international treaty, and may not be provided or otherwise made available without proper authorization from Intergraph Corporation.
Documentation
Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides,
Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a
particular software product.
Other Documentation
Other Documentation shall mean, whether in electronic or printed form and delivered with software or on Intergraph Smart Support,
SharePoint, or box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph
as guidance for using a software product.
Terms of Use
a. Use of a software product and Documentation is subject to the End User License Agreement ("EULA") delivered with the
software product unless the Licensee has a valid signed license for this software product with Intergraph Corporation. If the
Licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take
precedence and govern the use of this software product and Documentation. Subject to the terms contained within the
applicable license agreement, Intergraph Corporation gives Licensee permission to print a reasonable number of copies of the
Documentation as defined in the applicable license agreement and delivered with the software product for Licensee's internal,
non-commercial use. The Documentation may not be printed for resale or redistribution.
b. For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid license
agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other
Documentation for Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensee’s internal, non-commercial. The Other Documentation may
not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and for any
reason by Intergraph Corporation by giving written notice to Licensee.
Disclaimer of Warranties
Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software, Documentation and Other Documentation discussed in this document are furnished under a license and may be used
or copied only in accordance with the terms of this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.
Export Controls
Intergraph Corporation’s software products and any third-party Software Products obtained from Intergraph Corporation, its
subsidiaries, or distributors (including any Documentation, Other Documentation or technical data related to these products) are
subject to the export control laws and regulations of the United States. Diversion contrary to U.S. law is prohibited. These Software
Products, and the direct product thereof, must not be exported or re-exported, directly or indirectly (including via remote access)
under the following circumstances:
a. To Cuba, Iran, North Korea, Sudan, or Syria, or any national of these countries.
b. To any person or entity listed on any U.S. government denial list, including but not limited to, the U.S. Department of Commerce
Denied Persons, Entities, and Unverified Lists, http://www.bis.doc.gov/complianceandenforcement/liststocheck.htm, the U.S.
Department of Treasury Specially Designated Nationals List, http://www.treas.gov/offices/enforcement/ofac/, and the U.S.
Department of State Debarred List, http://www.pmddtc.state.gov/compliance/debar.html.
c. To any entity when Licensee knows, or has reason to know, the end use of the Software Product is related to the design,
development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or sensitive
nuclear uses.
d. To any entity when Licensee knows, or has reason to know, that an illegal reshipment will take place.
Any questions regarding export or re-export of these Software Products should be addressed to Intergraph Corporation’s Export
Compliance Department, Huntsville, Alabama 35894, USA.
Trademarks
Intergraph, the Intergraph logo, CADWorx, and CAESAR II are trademarks or registered trademarks of Intergraph Corporation or its
subsidiaries in the United States, and other countries. Microsoft, and Windows are registered trademarks of Microsoft Corporation.
Oracle, JD Edwards, PeopleSoft, and Retek are registered trademarks of Oracle Corporation, and/or its affiliates. AutoCAD,
ObjectARX, and RealDWG are trademarks of Autodesk. HOOPS is a trademark of Tech Soft 3D, L.L.C. Other brands, and product
names are trademarks of their respective owners.
CADWorx Design Review contains Autodesk® RealDWG by Autodesk, Inc., copyright © Autodesk, Inc. All rights reserved.
Autodesk, Inc., 111 McInnis Parkway, San Rafael, California 94903 ("Autodesk") is a third-party beneficiary to this Agreement to the
extent that the Software Product contains RealDWG, and to the extent that the provisions herein relate to Licensee’s use of the
Software Product containing RealDWG. Such provisions are made expressly for the benefit of Autodesk, and are enforceable by
Autodesk in addition to Intergraph.
Introduction ................................................................................................................................................ 11
Index ........................................................................................................................................................... 53
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.
[Product Folder] The CADWorx installation folder on your computer, for example,
C:\CADWorx. Substitute your installation folder anywhere this
notation is used.
[AutoCAD Folder] The AutoCAD installation folder on your computer, for example,
C:\AutoCAD 2000i. Substitute your installation folder anywhere
this notation is used.
Key + Key Key combinations for which you must press and hold down one
key and then press another, for example, CTRL+P or ALT+F4.
Datasheets Click Help > About to display a dialog box that contains
the required information.
In addition to the information above, the table below lists the additional files that are usually
required to assist Intergraph CAS in resolving your technical issues:
CADWorx Plant (Piping, Steel, HVAC) Email the AutoCAD model drawing (DWG) files.
If the model consists of several line numbers,
indicate in the email which line numbers you are
having issues with.
If the model consists of many drawing files with
dependent reference drawings (XREFs), use the
AutoCAD ETRANSMIT command to create a ZIP
file of all the drawings used in the master model.
CADWorx Plant (component data file Email information about the part's dimension from the
creation) manufacturer's catalog.
CADWorx Isogen Email the AutoCAD model drawing (DWG) files, any
isometrics generated by Isogen, and the Isogen
style files.
If the model consists of several line numbers,
indicate in the email which line numbers you are
having issues with.
The Isogen.FLS file located in the Isogen style
folder lists all the files used (*.OPL, *.MLS, *.FLS,
*.DDF, *.POS, *.ALT, *.DWG*.DXF, *.FDF, *.ATT).
Email all files listed in the Isogen.FLS file, including
the Isogen.FLS file.
CADWorx Equipment to PV Elite Email the AutoCAD model drawing (DWG) file and PV
interface Elite input file (*.PVI).
CADWorx P&ID or CADWorx IP Email the complete P&ID project, which includes
Project.CFG, Database.TBL, Map.TBL, and all the
DWG, and MDB files. Usually, all of these files are
located in one folder.
If the project has many P&ID drawing files, indicate
which P&ID drawings and components you are
having issues with.
If you are experiencing database errors, include the
file [Product
Folder]\P&ID\System\Sql_Error_Log.TXT.
If you are emailing MDB files, use a compression
utility such as WinZIP. Most email servers have
restrictions on transmitting MDB attachments.
CADWorx Datasheets Email the datasheets MDB file and any datasheet file
generated (XLS).
If emailing MDB / XLS files, use a compression
utility such as WinZIP. Most email servers have
restrictions on transmitting MDB / XLS attachments.
CADWorx Plant to CAESAR II Email the AutoCAD model drawing (DWG) file and
interface CAESAR II input file (*._A, *.C2).
Run the CADWorx GETALLSPECDATAFILES
command to copy all specifications and data files
used in the model into sub-folders under where the
model drawing file is located.
Zip the contents of these folders and email the ZIP
file to Intergraph CAS Support.
If the model consists of several line numbers,
indicate in the email which line numbers you are
having issues with.
CADWorx Design Review Email the AutoCAD model drawing (DWG) files.
If the model consists of several line numbers,
indicate in the email which line numbers you are
having issues with.
If the model consists of many drawing files with
dependent reference drawings (XREFs), use the
AutoCAD ETRANSMIT command to create a ZIP
file of all drawings used in the master model.
CADWorx Design Viewer Email the AutoCAD model drawing (DWG) files and the
*.CDR file.
If you are attaching large or multiple files to your eCustomer log, use a compression utility
such as WinZIP.
If you cannot attach your drawing files, then try to duplicate the issue in a new drawing with
as few components as possible. If the issue can be duplicated in a new drawing, attach the
duplicate drawing to Intergraph CAS.
For hardware lock issues, first verify that you have an Intergraph CAS hardware lock.
CADWorx Plant Professional, CADWorx P&ID, CADWorx P&ID Professional, CADWorx
Plant Ductile Iron, and CADWorx Plant Sanitary use the Intergraph CAS hardware lock for
licensing. For more information, see Licensing in the CADWorx Installation Users Guide.
Introduction
The CADWorx Datasheets module is a customizable utility for the generation of instrument and
equipment datasheets. The module can be used standalone or in conjunction with external
databases, such as those linked to CADWorx P&ID Professional projects, to provide bi-
directional links for instrumentation and equipment tables. The datasheets are generated using
industry standard (ISO) datasheet templates in Excel® formats. The datasheet formats are easily
customizable to suit your specific project requirements.
The documentation delivered with Welcome to CADWorx Datasheets provides complete
information for using the software.
CADWorx Instrument Datasheets (on page 12)
Provides documentation for the instrument datasheets portion of CADWorx Datasheets.
CADWorx Equipment Datasheets (on page 32)
Provides documentation for the equipment datasheets portion of CADWorx Datasheets.
Customize the Software (on page 51)
Explains how to make format changes to the datasheet templates.
A printed version of this documentation is delivered as a PDF file in the root install folder.
When you specify that you want to work with an existing project, the software opens the
selected instrument index and displays its contents in a table grid on the CADWorx Instrument
Datasheets dialog box, similar to the one shown in the example below.
Location
Specifies the location of the plant.
Operating Unit
Specifies the operating unit of the plant.
Contract
Specifies the contract number of the project.
Default Template Folder
Defines the location where all the default templates are located. By default, this location is
set to [Product Folder]\Instrument\Templates. To change this location, click Browse and
navigate to an alternative location.
Default Datasheet Folder
Defines the location where new datasheets created by CADWorx Datasheets are saved. By
default, this location is set to [Product Folder]\Instrument\Datasheets. To change this
location, click Browse and navigate to an alternative location.
When you browse for template and datasheet folders, use the Network
Neighborhood option so that the software stores the UNC path in the database. You can use a
mapped drive letter if the same drive letter is used for all users on a given project.
Logo file
Defines the location to the graphic file that displays in the title block of a report.
Default P&ID Database
Defines the P&ID database used for the project. Click Browse to open the Locate P&ID
Database dialog box and navigate to the appropriate database.
Save
Saves the project information.
Delete
Removes the selected user-defined property from the project information list.
Browse
Opens a dialog box so that you can navigate to an alternative location or file. Browsing
capabilities are enabled only for Default Template Folder, Default Datasheet Folder,
Logo and Default P&ID Database.
Refresh
Updates any changes made by another user if multiple users are using the same project.
Default properties cannot be deleted, nor can you edit their property names.
To define additional project-specific properties, use the empty row at the bottom of the table.
User-defined project properties can be deleted.
Click Edit > Project Information to re-open the dialog box and modify project information
as needed.
1 - Menu Bar
Provides access to such functions as opening projects, editing project information, and viewing
reports and reference documents. Click the name of a menu to display the commands it
contains.
3 - Command Panel
Populate
Populates the index with instrument tags from the P&ID database defined by Default P&ID
Database on the Project Information dialog box.
Import
Imports data from a CADWorx P&ID database into the datasheets.
Export
Exports tag data defined in the index table grid to the CADWorx P&ID database defined by
Default P&ID Database on the Project Information dialog box.
Datasheet
Specifies the type of datasheet to be used for the selected tag. Select a datasheet in the list.
For more information, see Tag Datasheets (on page 20).
Save
Saves the tag data to the project database.
Delete
Removes the selected tag permanently from the project database.
Refresh
Updates any changes made by another user if multiple users are using the same project
database.
4 - Status Bar
Displays the name of the currently selected record and the active project.
You must define a value for Tag. All other properties are optional.
You cannot simultaneously update the tag number and a document number that appears in
the PID, Loop Dwg, Requisition, Purchase Order, or Datasheet cells. You must first
modify the tag, save it, and then modify the document number.
When creating a tag, you cannot associate a document number to it. You must first create
the tag, save it, and then associate the document to it.
The Datasheet, PID, Loop Dwg, Requisition, and Purchase Order cells contain lists that
display reference documents. Only those reference documents that have been added to the
All Documents table appear in these lists. For more information, see Reference Documents
(on page 27).
Delete a record
1. In the table grid, select the row that contains the record that you want to remove.
2. Click Delete.
3. Click Yes in the confirmation box.
The software removes the record from the active project database.
The DB_Table column indicates the CADWorx P&ID table that needs to be updated. For
instrument datasheets, this table must always be Components-Instruments. DB_Column
indicates the column to be updated. The next three columns, Worksheet, Column, and Row,
show the datasheet and cell that are tied to the particular database table and column.
Tag Datasheets
CADWorx delivers over 60 intelligent instrument datasheets. To view the datasheet in the index
for the selected instrument tag, click Documents > Tag's Datasheet. Alternatively, you can
click Datasheet on the CADWorx Instrument Datasheets dialog box.
Data Entry
The datasheet templates provided by the software are designed for user efficiency. Although the
mouse can be used to select an individual cell, you must enter all data using the keyboard.
Check boxes, too, must be selected/cleared using the keyboard. To select a check box, type a
letter, typically the letter X, in the cell over which the check box is superimposed.
In most cases, you can select only one check box. If you select a check box and then select a
different one, the previous check box returns to its cleared state. Also, when you type text in
cells labeled as Other, any previously selected check box is automatically cleared. There are
exceptions to this rule. In instances where the data entered for Other provides additional
information related to the selected check box, both values are allowed on the datasheet. This is
typically the case when specifying frequently used options such as Square Edged.
Saving Changes
To save changes to the datasheet, click Save on the datasheet toolbar. By default, the
datasheet is saved to the [Product Folder]\Instruments\Datasheets folder. You can change this
default setting by editing Default Datasheet on the Project Information dialog box. For more
information, see Instrument Index Projects (on page 12).
Data Synchronization
Data in the datasheet and the index is synchronized. If you change any cell of data in the
datasheet that is linked to the index and save the change, the data is automatically updated in
the index. Also, any changes made to the data in the index are reflected in the linked datasheet.
Reports
CADWorx delivers with the four reports listed below, all of which are accessed using the
Reports menu. Reports are written using Crystal Reports and cannot be modified.
Instrument Index
Controller and Alarm Point Summary
Installation Details Report
Maintenance Report
When you select a report for viewing, the software displays it in the Report Viewer. Using the
commands on the Report Viewer toolbar you can control how a report looks on the screen.
Print Report
Prints the report to the default printer. To change the target printer, you must change the
default printer.
Group Tree
Toggles on and off the group tree option. On several reports, tag numbers are displayed in a
Group Tree window under the Preview tab. When you select a tag number, the tag number
and data are instantly displayed in the report sequence.
Percent View
Increases or reduces the view of the report, depending on the value you select in the zoom
box. You can zoom in to get a close-up view of the report or zoom out to see more of the
page at a reduced size.
Previous/Next Pages
Allows you to move through the pages of the report. You can type a specific number in the
Page Number box, or use the toolbar commands listed below:
Go to First Page
Go to Previous Page
Go to Next Page
Go to Last Page
Search Text
Searches the text of the report for a specific word or phrase. This feature allows you to view,
sequentially, every instance where the user-specified text appears in the report.
If more than one person is using the same project, click Refresh to update any changes
made by another person.
To remove a row, highlight it and press Delete.
Reference Documents
Reference documents can be defined for the entire project as well as for specific tags.
Document properties can be viewed and modified at any time, and then saved. You can also
reference new and existing documents to a specific tag.
You can make changes to any of the listed documents. Click Save to save your changes.
Select a document and click Delete to remove it from the project database.
You can make changes to any of the listed documents. Click Save, to save your changes.
To remove a document as a reference, select it and then click Delete. Deleting a reference
impacts only the association between a document and an instrument tag. It does not remove
the document from the project database.
When you work with an existing project, the software opens the selected equipment list index
and displays its contents in a table grid in the CADWorx Equipment Datasheets dialog box,
similar to the one shown in the example below.
Operating Unit
Specifies the operating unit of the plant.
Contract
Specifies the contract number of the project.
Job Number
Specifies the number of the job.
Default Template Folder
Defines the location where all the default templates are located. By default, this location is
set to [Product Folder]\Equipment\Templates. To change this location, click Browse and
navigate to an alternative location.
Default Datasheet Folder
Defines the location where new datasheets created by CADWorx Datasheets are saved. By
default, this location is set to [Product Folder]\Equipment\Datasheets. To change this
location, click Browse and navigate to an alternative location.
When you browse for template and datasheet folders, use the Network
Neighborhood option so that the software stores the UNC path in the database. You can use if
the same drive letter is used for all users on a given project.
Default P&ID Database
Defines the P&ID database used for the project. Click Browse to open the Locate P&ID
Database dialog box and navigate to the appropriate database.
Save
Saves the project information.
Delete
Removes the selected user-defined property from the project information list.
Browse
Opens a dialog box so that you can navigate to an alternative location or file. Browsing
capabilities are enabled only for Default Template Folder, Default Datasheet Folder,
Logo, and Default P&ID Database.
Refresh
Updates any changes made by another user if multiple users are using the same project.
Default properties cannot be deleted, nor can you edit their property names.
To define additional information associated with the project, use the empty row at the bottom
of the table. User-defined project properties can be deleted.
Click Edit > Project Information to re-open the dialog box and modify project information
as needed.
1 - Menu Bar
Provides access to such functions as opening projects, editing project information, and viewing
reports and reference documents. Click the name of a menu to display the commands it
contains.
2 - Equipment Tabs
Data is entered into the table by selecting the tab that corresponds to the equipment for which
you are entering data. You can only create a new equipment number under its corresponding
equipment type tab. Click All to view all equipment numbers that have been entered into the
equipment list.
4 - Command Panel
Datasheet
Specifies the type of datasheet used for the selected equipment number. Select a datasheet
in the list. For more information, see Equipment Datasheets (on page 40).
Save
Saves the tag data to the project database.
Delete
Removes the selected equipment tag permanently from the project database.
Refresh
Updates any changes made by another user if multiple users are using the same project
database.
Import
Imports data from a CADWorx P&ID database into the datasheets.
Export
Exports tag data defined in the index table grid to the CADWorx P&ID database defined by
Default P&ID Database on the Project Information dialog box.
5 - Status Bar
Displays the name of the currently selected record and the active project.
Click Import to import data from a valid CADWorx P&ID database into the table grid.
2. After the data is entered, click Save to write the new data to the active project database.
You must define a value for EquipNo. All other properties are optional.
You cannot update the equipment number and a document number that appears in the PID,
Loop Dwg, Requisition, Purchase Order, or Datasheet cells simultaneously. You must
first modify the tag, save it, and then modify the document number.
When creating an equipment number, you cannot associate a document number to it. You
must first create the equipment number, save it, and then associate the document to it.
The Datasheet, PID, PFD, Requisition, and Purchase Order cells contain lists that display
reference documents. Only those reference documents that have been added to the All
Documents table appear in these lists. For more information, see Reference Documents (on
page 44).
Delete a record
1. In the table grid, select the row that contains the record that you want to remove.
2. Click Delete.
3. Click Yes in the confirmation box.
The software removes the record from the active project database.
The DB_Table column indicates the CADWorx P&ID table that needs to be updated. For
equipment datasheets, this table must always be Components-Mechanical. Next, DB_Column
indicates the column to be updated. The next three columns, Worksheet, Column, and Row,
show the datasheet and cell that are tied to the particular database table and column.
Equipment Datasheets
CADWorx delivers over 20 intelligent equipment datasheets. To view the datasheet for the
selected equipment number in the equipment list, click Documents > <Equipment Number>
Documents > Datasheet. Alternatively, you can click Datasheet at the bottom of the CADWorx
Equipment Datasheets dialog box.
Data Entry
The datasheet templates provided by the software are designed for efficiency. Although the
mouse can be used to select an individual cell, you must enter all data using the keyboard.
Check boxes, too, must be selected/cleared using the keyboard. To select a check box, type a
letter, typically the letter X, in the cell over which the check box is superimposed.
In most cases, you can select only one check box. If you select a check box and then select a
different one, the previous check box returns to its cleared state. Also, when you type text in
cells labeled as Other, any previously selected check box is automatically cleared. There are
exceptions to this rule. In instances where the data entered for Other provides additional
information related to the selected check box, both values are allowed on the datasheet.
Saving Changes
To save changes to the datasheet, click Save on the datasheet toolbar. By default the
datasheet is saved to the [Product Folder]\Equipment\Datasheets folder. You can change this
default setting by editing Default Datasheet on the Project Information dialog box. For more
information, see Equipment List Projects (on page 32).
Data Synchronization
Data in the datasheet and the equipment list is synchronized. If you change any cell of data in
the datasheet that is linked to the list, the equipment list is updated automatically when you save
the change. Also, any changes made to the data in the equipment list are reflected in the linked
datasheet.
Reports
CADWorx delivers a default Equipment List report, which is accessed using the Reports menu.
The report is written using Crystal Reports and cannot be modified.
When you open the Equipment List report, the software displays it in the Report Viewer. Using
the commands on the Report Viewer toolbar you can control how the report looks on the
screen.
Print Report
Prints the report to the default printer. To change the target printer, you must change the
default printer.
Group Tree
Toggles on and off the group tree option. On several reports, tag numbers are displayed in a
Group Tree window under the Preview tab. When you select a tag number, the tag number
and data are instantly displayed in the report sequence.
Percent View
Increases or reduces the view of the report, depending on the value you select in the zoom
box. You can zoom in to get a close-up view of the report or zoom out to see more of the
page at a reduced size.
Previous/Next Pages
Allows you to move through the pages of the report. You can type a specific number in the
Page Number box, or use the toolbar commands listed below:
Go to First Page
Go to Previous Page
Go to Next Page
Go to Last Page
Search Text
Searches the text of the report for a specific word or phrase. This feature allows you to view,
sequentially, every instance where the user-specified text appears in the report.
If more than one person is using the same project, click Refresh to update any changes
made by another project member.
To remove a row, highlight it and press Delete.
Reference Documents
Reference documents can be defined for the entire project as well as for a single equipment
number. Document properties can be viewed and modified at any time, and then saved. You
can also associate new and existing documents to a specific equipment number.
You can make changes to any of the listed documents. Click Save, to save your changes.
If you change a document number of a document that has already been associated to an
equipment number, the equipment number information in the list is updated to reflect the
change.
Select a document and click Delete to remove it from the project database.
The software opens the Document Management for Tag <ID> dialog box and displays the
documents that have been referenced to the selected tag.
You can make changes to any of the listed documents. Click Save, to save your changes.
To remove a document as a reference, select it and then click Delete. Deleting a reference
only impacts the association between a document and an equipment number. It does not
remove the document from the project database.
4. Navigate to the file that you want to associate to the new document and then click Save.
The software maps the document file, saves the document to the equipment number, and
opens the referenced document for viewing.
Alternatively, you can click Cancel to save the document number to the equipment
number without mapping the file so it can be viewed.
5. After viewing the document, close it to return to the CADWorx Equipment Datasheets main
window.
<Template File Name> Properties dialog box as shown in the example below.
I
Instrument Index Projects • 12
Instrument Index Table • 16
Introduction • 11
O
Open an existing equipment list • 35
Open an existing instrument index • 15
P
Preface • 6
R
Reference an existing document • 50