Catalog Placement Tester User's Guide

Catalog Placement Testing User's Guide

Version 10.01.01.0007 May 2016 PPM-15-2458

Copyright Copyright © 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.

U.S. Government Restricted Righ ts Legend Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was developed at private expense and is "restricted computer software" submitted with restricted rights in accordance with subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at 52.227-19 of the Federal Acquisition Regulations ("FAR") and its successors, and is unpublished and all rights are reserved under the copyright laws of the United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS 252.227-7014 and the rights of the Government are as specified at DFARS 227.7202-3. Unpublished - rights reserved under the copyright laws of the United States. Intergraph Corporation 305 Intergraph Way Madison, AL 35758

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 si gned 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 numbe r 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.


2

Limitation of Damages IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL INCIDENTAL, SPECIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO, LOSS OF USE OR PRODUCTION, LOSS OF REVENUE OR PROFIT, LOSS OF DATA, OR CLAIMS OF THIRD PARTIES, EVEN IF INTERGRAPH CORPORATION HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. UNDER NO CIRCUMSTANCES SHALL INTERGRAPH CORPORATION’S LIABILITY EXCEED THE AMOUNT THAT INTERGRAPH CORPORATION HAS BEEN PAID BY LICENSEE UNDER THIS AGREEMENT AT THE TIME THE CLAIM IS MADE. EXCEPT WHERE PROHIBITED BY APPLICABLE LAW, NO CLAIM, REGARDLESS OF FORM, ARISING OUT OF OR IN CONNECTION WITH THE SUBJECT MATTER OF THIS DOCUMENT MAY BE BROUGHT BY LICENSEE MORE THAN TWO (2) YEARS AFTER THE EVENT GIVING RISE TO THE CAUSE OF ACTION HAS OCCURRED. IF UNDER THE LAW RULED APPLICABLE ANY PART OF THIS SECTION IS INVALID, THEN INTERGRAPH LIMITS ITS LIABILITY TO THE MAXIMUM EXTENT ALLOWED BY SAID LAW.

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 i s 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.

e.

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, Intergraph Smart, PDS, SmartPlant, SmartMarine, FrameWorks, I-Sketch, IntelliShip, ISOGEN, SmartSketch, SPOOLGEN, SupportManager, SupportModeler, Sapphire, and FreeView 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. MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product names are trademarks of their respective owners.


3

Contents Preface .......................................................................................................................................................... 5 Int ro du ct io n ..................................................................................................................................................6 Software Prerequisi tes................................................................................................................................ 7 Catalog Placement Tester – user in ter face ............................................................................................... 8 Salien t featu res of th e to ol ....................................................................................................................... 11 Runn in g th e Catal og Placem ent Tester Tool .......................................................................................... 12 Catalog Placement Tester too l – Out pu ts ............................................................................................... 14


4

Preface This guide provides information to help users run the Catalog Placement Tester tool to test all the components which are referred in a S3D Piping Specification.


5

SECTION 1

Introduction There might be situations, when as a S3D user you need to ensure that all the components in a piping specification(s) can be placed successfully in the model without any issues. You might also want to see the graphics of all the components placed, to confirm that they are as per your design. Manually testing all the components in a piping spec is a tedious and time consuming process. Most of the time, you need to test the correctness of the data of a spec in a model test environment before using the spec in a production environment. These requirements form the basis of creation of the Catalog Placement Tester tool. The Catalog Placement Tester tool provides the ability f or a S3D user to test all the components which are referred in a S3D Piping Specification.


6

SECTION 2

Software Prerequisites Tool version

10.01.01.0007 (Compatible with S3D 2014R1) Catalog Placement Tester Compatibil ity Matrix:

Catalog Placement Tool

S3D Version

10.01.**.****

S3D 2014R1

Supported Operating Systems 

Microsoft Windows 7 Service Pack 1



Microsoft Windows Server 2008 R2



Microsoft Windows 8

Software Prerequisites 

Microsoft Office Excel 2010 or higher

Note: On invoking, Catalog Placement Tester pulls a S3D License.


7

Catalog Placement Tester – user interface

SECTION 3

Catalog Placement Tester – user interface The screenshot below shows the User Interface of the tool


8

Catalog Placement Tester – user interface Select Plant Name

The Plant Name list box is auto populated with the plants available under the active site configured on the machine. You need to select the required plant from the list. The Catalog Name text box is auto populated with the catalog associated with the selected plant. It is a read only box.

Select Specifications

The Select specification s grid lists all the piping specifications available in the selected plant. You can select single or multiple specs using the checkboxes provided in the grid. The disabled specs in the grid are not allowed for selection in the selected Plant. To enable those specs you need to add the specs to allowed specs from S3D system and specifications task in S3D.


9

Catalog Placement Tester – user interface Select Target System

You can specify the target system under which all t he pipes and the components are placed. It is an optional input. If no input is provided the components are created under a Pipe Run created under the Plant Root Node.

Start Position

You can specify the global location in the plant where the pipe and the components are to be placed. By default the values are X = 0 m, Y = 0 m, Z = 0 m.

Report Folder Path

You can specify the folder under which the Catalog Placement Tester report would be created for the specs.

Place compon ents

You can start the placement by click ing Place Compon ents . You can close the tool by clicking Close.

Mnemonics and Short cut Keys are provided on the UI for usability purpose.


10

Salient features of the tool

SECTION 4

Salient features of the tool Below are few salient features of the Tool: 













Provides the ability to select single or multiple piping specifications under a plant allowing you to place pipe and components for a single or multiple piping specification in a single run of the tool. Provides the ability to specify the target system under which all the pipe and the components are placed. Provides the ability to specify the global location in the plant where the pipe and the components are placed. For a selected piping specification(s), for every size in the spec the tool places the pipe and the applicable components on it. Places the components for a pipe size, by placing different ShortCodeHierarchyType values in the following way; Valves, InlineFittings, Flanges (except Orifice and Blind Flanges), Branch components on o a straight pipe along the X-direction. Remaining all types (Reducers, elbows etc.) are placed by placing a default branch, o routing a pipe from it, and placing the components at the end of the pipe. o Pipe is routed from each port of the placed component. Places the calculated spec sizes in the following manner: o For calculated specs, NPD’s with calculated schedule are placed after placing the pipes with the schedule. o For the various service limit combinations defined for the piping spec, a pipe is routed with that Pressure and Temperature combination. All the components are placed on that pipe with the logic specified above. The placement test results are written to an Excel workbook. o Along with the plant, site, catalog information, the start and end time of spec placement are reported. o The count of the total number of parts in Piping Commodity Filter, Successfully Placed parts, Connection Warnings, Placement Errors, Pipe Not Placed, Parts to be tested manually, are reported in the report. o For each component the information related to the Short Code, Option Code, First Size, First Size Units, Second Size, Second Size Units, Multi Size Option, Selection Basis, Commodity Code, Service Temperature, Service Pressure, Status, Error Description, Pipe Run, oid, is written into the report.


11

Running the Catalog Placement Tester Tool

SECTION 5

Running the Catalog Placement Tester Tool The Catalog Placement Tester tool provides the ability to run in following modes o

As a standalone executable

o

As a S3D Custom command

Important Notes:

1.

It is recommended to run the tool as a standalone executable for performance reasons.

2. Add the following to the System variable ‘PATH’ in Environment Variables. \Core\Runtime \GeometryTopology\Runtime 3. 4.

The current login user needs to have write permissions on any of the Permission group. “Report Folder Path” needs to be a Trusted location for Excel application.

Running as Standalone applic ation

1. Copy the folder to a local folder. 2. Run CatalogPlacementTester.exe from the local folder. 3. Select all the required inputs from the User interface. 4. Click Place Compon ents to start placement of components. A progress window is displa yed to show the progress. 5. After placement check the log files in the specified log folder. Running as S3D custom co mmand

1. Copy the folder to a local folder. 2. Open Smart3D and follow the below steps 1. Go to Tools

 Custom

Commands.

2. Click Ad d and provide the below custom command progid along with the path of the copied folder in the Command Progid section. “

\\Local Folder Path\Catalog Placement Tester\CatalogPlacementTesterCommand,Ingr.S3D.CatalogPlacementTester.Client. PlaceComponents ”

3. Provide Command name as required and click Ok . 4. Go to Tools

 Custom

Commands .

a. Run the above custom command. 3. Select all the required inputs from the User interface.


12

Running the Catalog Placement Tester Tool 4. Click Place Compon ents to start the placement of components. A progress window is d isplayed to show the progress. 5. After placement check log files in the specified log folder.


13

Catalog Placement Tester tool – Outputs

SECTION 6

Catalog Placement Tester tool – Outputs Placed compo nents in the Model

Below are few snapshots of the components placed in the model.


14



15


Catalog Placement Tester Report

The Catalog Placement Tester tool generates the report in the form of an Excel workbook, which reports Information regarding the placement of the components. Below is a screenshot of a generated Catalog Placement Tester Report:


16

Catalog Placement Tester User's Guide

Recommend Documents