Smart 3D: Graphic Clash Reports

User Guide

SmartPlant 3D Automation Services Group,

Intergraph Corporation.

Intergraph Smart 3D (SmartPlant 3D and SmartMarine 3D) automation

services enable users to create customizable Graphic Clash Reports.
This functionality offers means to create clash reports with pictures.
Reports are customizable to allow reporting basic information from
clashing objects and the clash itself.
Copyright
Copyright © 2009 Intergraph Corporation. All Rights Reserved.
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 Rights 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
P.O. Box 240000
Huntsville, AL 35813
Street address: 170 Graphics Drive, Madison, AL 35758
Terms of Use
Use of this software product is subject to the End User License Agreement and Limited Product Warranty ("EULA")
delivered with this 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. 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.
Warranties and Liabilities
All warranties given by Intergraph Corporation about equipment or software are set forth in the EULA provided with the
software or applicable license for the software product signed by Intergraph Corporation, and nothing stated in, or
implied by, this document or its contents shall be considered or deemed a modification or amendment of such
warranties. 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 discussed in this document is furnished under a license and may be used or copied only in accordance
with the terms of this license. No responsibility is assumed by Intergraph for the use or reliability of software on
equipment that is not supplied by Intergraph or its affiliated companies. 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.
Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, SmartMarine, FrameWorks, I-Convert, I-Export, I-Sketch, IntelliShip,
INtools, ISOGEN, MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler 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.
 Table of Contents
1. Introduction ____________________________________________________________ 1
2. Setup / Configuration ____________________________________________________ 1
3. User Interface ___________________________________________________________ 1
4. User Interface Description _________________________________________________ 2
5. Usage Workflows ________________________________________________________ 3
5.1 Choose Clashes to Review ______________________________________________________ 3
5.2 Review the clashes ___________________________________________________________ 3
5.3 Generate Graphic Clash Report __________________________________________________ 3
5.4 Open to review previously generated Graphic Clash Report __________________________ 3
6. Suggested Settings for Creating Graphic Clash Reports __________________________ 4
7. Customizing Graphic Clash Report Templates _________________________________ 4
8. Data Placeholders usable in Templates ______________________________________ 5
1. Introduction
This document describes the Graphic Clash Reports functionality in Smart 3D Applications.

Graphic Clash Reports functionality allows a user / administrator to

 review clashes in active workspace or selected objects,
 update their status/remarks and
 create and review Graphic Clash Reports.
 open and review Graphic Clash Reports created previously.

An administrator can customize the format of clash reports by editing the templates.

Note: In a workshare scenario, just like OOTB product functionality with updating Clash
properties, even though the Clashes belong to the Host location, any user from any location with
write access on Clash’s PG will be able to update the clash.

2. Setup / Configuration
The command functionality, documentation and sample templates are made available as a
package in the ‘Tools and Utilities’ section of eCustomer Website. To Install,
 Unzip the files to folder, say C:\Program Files\SmartPlant\3D\Automation\GraphicClashReports\,
 Run the Install.VBS from the Local Directory (double-click it from Windows Explorer)
 Unzip SymbolShare-GraphicClashReports.zip as $SymbolShare\GraphicClashReports\*.*

In case of any installation errors, review Install.Log and take appropriate corrective action.

Repeat the same steps on downloading any updated versions of this Utility.

3. User Interface
The command is made available in SmartPlant/Marine 3D’s Tools menu as
Tools > Automation Services > Graphic Clash Reports …

If you lost the menu item as a result of updating your Smart3D application to newer
hotfix/service pack, Run (double-click) the Install.VBS again.

The User interface elements of the command are described next.

Smart 3D: Graphic Clash Reports – User Guide

4. User Interface Description
Name of the Clash Report Index of the Current Clear Other Hilite (Just
File to Create or Open. Clash being reviewed Hilite Current Clash)
Restart with Active
Selection
Hilite / Select Disconnect from Excel
Clashes of Item
A / B. Open Existing Report.

Hilite / Select Create New Report.

Clashes of Item Show More/Less info.
A/B
Viewing Options…
Select / Unselect Extent, Zoom,
Clash Item A / B Excluded Views

Choose to update
Select / Unselect
Active Clash or
Clash
All Selected Clashes
Select Objects
from Excel (must Update Status, or
be OIDs) Remarks, or Both – of
Clear Selection Active Clash or
All Selected Clashes
Update Active
Clash’s Picture Note: In a workshare
in excel – scenario, just like
Selected picture OOTB product
or Default functionality, any user
picture - (uses from any location with
Active View) write access on
Clash’s PG will be
Select All Clashes able to update the
clash.
Item A Clashes
Salient Information of
Item B Clashes
Clashing Objects

Filter For Clashes by

- Status and/or
- Type

5.

Smart 3D: Graphic Clash Reports – User Guide

5. Usage Workflows
Typical usage workflows with this command are as follows.
5.1 Choose Clashes to Review
(This can be done using any one of the options below)
 Select the clashes to review and start the command, OR,
 Select the object(s) to review clashes and start the command, OR,
 To view clashes in workspace, start the command with no objects selected, OR,
 Open a previously created Clash (Index) report to review clashes in that report.

5.2 Review the clashes

 Review Details of Clashing Items (items A and B).
 Hilite or Select all clashes of Item A or Item B.
 Specify Zoom level (in active view / all views) – zoom into Clash / Clashing items.
 Select Clashes / Objects while reviewing, or select from active excel report.
 Update Status and/or Remarks of active clash / several selected clashes en-masse.

5.3 Generate Graphic Clash Report

 Choose the clashes you want to generate a report for (as per 5.1),
 Press “Create…” – and specify a basename for the report you want to create.
 The command begins processing – this may take long time based on the number of
clashes being processed. To ensure correct generation of report(s)
 DO NOT lock / do any other actions on the system during this time.
 DO NOT activate any other windows overlapping the Graphic Views.
 To Stop Report Generation in the middle, just invoke normal Select Command.
 The process ends when it finally generates
o A basename.xls (the Index report), and
o A set of workbooks with same basename and a running sequential number suffix
(like baseName-001.xls, BaseName-002.xls …), each containing 25 clashes per
workbook – with the requested data and pictures populated.
 Each picture will be captured from View #1 as per the view direction
specified in the picture’s Alt-Text (#PICTURE#TOP# / #PICTURE#LEFT#
etc) – Isometric viewing direction will be used for default picture
(#PICTURE#).
o Just after a report has been generated, you can update pictures of the clashes
as desired to capture a better view – To do this,
 Navigate to the clash you want to update,
 In excel - select the Picture you want to Update - (to update default picture,
[the one with Alt-Text as #PICTURE#], ensure no picture is selected.)
 Orient and adjust Zoom level of the Graphic View you intend to capture.
 Press the ‘Update Clash Picture in Report’ button.

5.4 Open to review previously generated Graphic Clash Report

 Open a previously created Clash (Index) report to review clashes in that report.

Smart 3D: Graphic Clash Reports – User Guide

6. Suggested Settings for Creating Graphic Clash Reports
 Set background color to White, and use ‘Shaded View with Enhanced Edges’ mode.
 Configure a StyleRule to make All workspace objects translucent gray.
 Hide All Interferences using Tools > Check Interferences > “Hide All” toolbar button.
 If you are using Windows 7 and generated images come out blank, choose Windows 7
Basic or Windows 7 Classic theme.

7. Customizing Graphic Clash Report Templates

The delivered zip file contains two customizable templates – Index.xls and Detail.xls. An
administrator is expected to customize them to suit your reporting needs.

The Index and Detail Template workbooks are expected in a directory named
GraphicClashReports in the SymbolShare directory of the Plant.

Important Notes:
 If you use Microsoft Excel version 2003 or lower, you can only use xls format files.

 If you use Microsoft Excel version 2007 or higher, it is highly recommended to use xlsx
(or xlsm or xlsb) format templates. Just open the delivered xls templates and save them
as one of such desired extension and remove the xls files from that location. Otherwise,
if you choose to use xls format, Office 2007 compatibility warning message could popup
during report generation depending on the Excel v2007 features you used in cell
formatting, requiring manual intervention, thus interrupting the clash report generation.

You can customize the reports by editing the templates as described below.

Index Template workbook

 The Index sheet in this workbook is used to create the Index report.
 Review the delivered template to know how to customize it.

Detail Template workbook

 The Detail sheet in this workbook is used to create a sheet for each reported clash.
 Review the delivered template to know how customize it.
 The Detail Sheet can contain any number of data placeholder fields and any number of
pictures.
o Each picture must specify the view orientation for that clash’s view in the report in
its ‘Alt-Text’ property (accessible in Excel by right-clicking the picture, choose Size and
Properties, and the Alt-Text tab)
 The Alt-Text can be one of the standard view names like #PICTURE#TOP# or
#PICTURE#FRONT# or #PICTURE#LEFT# or #PICTURE#RIGHT# etc.
 Specifying it just as #PICTURE# will use Isometric View for the picture.

The section named “Data Placeholders usable in Templates” later in this document explains
all the data placeholders you can include in Index / Detail reports.

Smart 3D: Graphic Clash Reports – User Guide

8. Data Placeholders usable in Templates
You can use the below placeholders in the Index and Detail templates

Field Placeholder Resulting Value

#NOW# Current Date/Time
#CLASH_ID# Index number of the Clash.
#CLASH_STATUS# Clash Status
#CLASH_TYPE# Severity Type of the Clash
#CLASH_PG# Permission Group of the Clash
#CLASH_OID# OID of the Clash
#CLASH_XYZ# or #CLASH_X# or #CLASH_Y# or #CLASH_Z# X / Y / Z Coordinates of the Clash
#CLASH_LOCAL_XYZ# or #CLASH_LOCAL_X# or X / Y / Z Coordinates of the Clash
#CLASH_LOCAL_Y# or #CLASH_LOCAL_Z# in active Local Coordinate System
#CLASH_NAME# Name of the Clash
#CLASH_SPECIFIED_CLEARANCE# Specified Clearance on Clash
#CLASH_INTERFERENCE_CLEARANCE# Clash Clearance
#CLASH_REMARK# Clash Remark
#CLASH_CREATEDDATE# Clash Created Date
#CLASH_MODIFIEDDATE# Clash Modified Date
#CLASH_MODIFIEDBY# Clash Last Modified User
#CLASH_LABEL[label]# Any Label to resolve on Clash

#ITEM_HIERARCHY_A# Item A's Full System Path

#ITEM_NAME_A# Item A's Name
#ITEM_ASPECT_A# Item A's Aspect
#ITEM_PG_A# Item A's Permission Group
#ITEM_OID_A# Item A's OID
#ITEM_PARENT_A# Item A's Parent Name
#ITEM_DESC_A# Item A's Description
#ITEM_CREATEDDATE_A# Item A’s Created Date
#ITEM_MODIFIEDDATE_A# Item A’s Modified Date
#ITEM_CREATEDBY_A# Item A’s User Created
#ITEM_MODIFIEDBY_A# Item A’s Last Modified User
#ITEM_CLASHES_A# Total Clashes Involving Item A
#ITEM_A_LABEL[label]# Any Label to resolve on Item A

#ITEM_HIERARCHY_B# Item B's Full System Path

#ITEM_NAME_B# Item B's Name
#ITEM_ASPECT_B# Item B's Aspect
#ITEM_PG_B# Item B's Permission Group
#ITEM_OID_B# Item B's OID
#ITEM_PARENT_B# Item B's Parent Name
#ITEM_DESC_B# Item B's Description
#ITEM_CREATEDDATE_B# Item B’s Created Date
#ITEM_MODIFIEDDATE_B# Item B’s Modified Date
#ITEM_CREATEDBY_B# Item B’s User Created
#ITEM_MODIFIEDBY_B# Item B’s Last Modified User
#ITEM_CLASHES_B# Total Clashes Involving Item B
#ITEM_B_LABEL[label]# Any Label to resolve on Item B

Smart 3D: Graphic Clash Reports – User Guide