SP3D Automation Toolkit

User Guide
Intergraph PPM SP3D Automation Services Group

Contents
HOW TO INSTALL & CONFIGURE MENUS _______________________________________________________________ 4
Customizing Commands and Utilities in this Toolkit _______________________________________________ 4
Advanced Configuration _____________________________________________________________________ 5
Adding Custom Menu items to Toolkits PopupMenu ______________________________________________ 5
Adding Custom Tasks to Smart3Ds Tasks menu. _________________________________________________ 5
SUPER SHORTCUTS _____________________________________________________________________________ 6
Using Commands and Utilities in this Toolkit ____________________________________________________ 6
SELECT FILTERS AND OBJECT SET MANIPULATION COMMANDS ________________________________________________ 8
Select Filter Commands with only Keyboard Shortcuts _____________________________________________ 8
Select Set Browser for SmartPlant 3D __________________________________________________________ 8
Add On-the-Fly Select Filter _________________________________________________________________ 11
Add Configured Select Filters ________________________________________________________________ 11
Filter Selected Objects _____________________________________________________________________ 11
Manage Object Sets _______________________________________________________________________ 12
HELPER COMMANDS ___________________________________________________________________________ 13
SmartSketch Settings Palette ________________________________________________________________ 13
PinPoint Lock / Unlock Commands ___________________________________________________________ 14
Lock PinPoint to Centroid Of Geometry Command: ______________________________________________ 14
Set and Lock PinPoint Target to Object: _______________________________________________________ 14
VIEW MANIPULATION COMMANDS _________________________________________________________________ 15
View Manipulation with only Keyboard shortcuts _______________________________________________ 15
View Manipulation with Numeric Keypad ______________________________________________________ 15
FILTER CREATION COMMANDS _____________________________________________________________________ 17
Create Filter from Select Set_________________________________________________________________ 17
Create Nested Systems Filter by Name ________________________________________________________ 17
Create Filter by Specification(s) ______________________________________________________________ 17
SURFACE STYLE RULES, STYLES AND FILTER IMPORT EXPORT COMMANDS ________________________________________ 18
Surface Style Rule Set Manager ______________________________________________________________ 18
Export Surface Styles, Surface Style Rules and Filters _____________________________________________ 18
Import Surface Styles, Surface Style Rules and Filters _____________________________________________ 19
WORKSPACE MODIFICATION COMMANDS _____________________________________________________________ 20
Add Selected Objects to Workspace __________________________________________________________ 20
Add Interfering Objects to Workspace_________________________________________________________ 23
Add Connected Objects to Workspace _________________________________________________________ 23
Add to Workspace by Range ________________________________________________________________ 25
ROUTE COMMANDS ____________________________________________________________________________ 28
Select Empty Runs ________________________________________________________________________ 28
Change Bend Radius _______________________________________________________________________ 28
Spool Selected Pipelines ____________________________________________________________________ 31
Insert Isometric Break _____________________________________________________________________ 31
Isometric Troubleshooting Utility ____________________________________________________________ 32
Join Features _____________________________________________________________________________ 34
Replace Elbow With Tee ____________________________________________________________________ 34

Page ii

Intergraph Process Power & Marine SP3D Automation Services Group

Replace Tee With Elbow ____________________________________________________________________ 36

Split Run ________________________________________________________________________________ 36
Merge Runs______________________________________________________________________________ 37
STRUCTURE COMMANDS_________________________________________________________________________ 40
Find Duplicate/Overlapping Members and Duplicate Slabs ________________________________________ 40
Bulk Modify MemberPart CrossSection ________________________________________________________ 40
Export / Import Object names (via Text File) ____________________________________________________ 41
MARINE PRODUCT-SPECIFIC COMMANDS _____________________________________________________________ 42
Auto-Assign Margin at Assembly or Block Butt __________________________________________________ 42
Profile Endcuts Modification Command _______________________________________________________ 44
Modify Collar Material Properties Command ___________________________________________________ 46
Modify Collar Material Properties Command _____________________________Error! Bookmark not defined.
COMMON COMMANDS__________________________________________________________________________ 49
Precision Move Selected Objects _____________________________________________________________ 49
Show Only Selected Objects _________________________________________________________________ 49
Edit Snapshot Filter _______________________________________________________________________ 49
Compare Object Properties _________________________________________________________________ 50
IFC Local Detect ON/OFF ___________________________________________________________________ 51
Part Change Impact Analysis ________________________________________________________________ 51
DBI Analysis (Analyze objects in DBI) __________________________________________________________ 52
Remove Text Copy Of _____________________________________________________________________ 52
Copy OIDs to clipboard _____________________________________________________________________ 53
Find Object By Report ______________________________________________________________________ 53
Show / Hide Reference File(s)________________________________________________________________ 53
COMMANDS WITHOUT TOOLBAR ICONS (MADE AVAILABLE AS PROGIDS) ________________________________________ 54
Show Reference File Name __________________________________________________________________ 54
Make Views Like Active ____________________________________________________________________ 54
Apply Named Style to Objects _______________________________________________________________ 54
Expand Select Set For Move _________________________________________________________________ 55
Delete Multiple Systems ____________________________________________________________________ 55

Page iii

Intergraph Process Power & Marine SP3D Automation Services Group

SP3D Automation Toolkit - How to Install & Configure Menus

How to Install & Configure Menus

1. Unzip the files into a Local Directory say C:\Program Files\SP3DAutomation,
2. Run the Install.VBS from the Local Directory (double-click it from Windows Explorer)
In case of any installation errors, review Install.log generated in the local directory and take
appropriate corrective action.

Uninstallation
1. Run the Uninstall.BAT from the Local Directory where you installed the toolkit. (double-click
it from Windows Explorer)

Customizing Commands and Utilities in this Toolkit

A config file named S3DAutomationToolkitConfig.txt is delivered with this toolkit. This provides means
for administrator to customize the toolkit functionality as stated below. Users can also customize certain
portions by saving it as MY-S3DAutomationToolkitConfig.txt in toolkit installation directory.
1. Specify your own Configurable Select Filters to add to ALL or a specific list of tasks.
[All Tasks] or [TaskName] sections in config file.
2. Specify your own Configurable Filters for the Filter Selected objects command.
[Filter Selected Objects Command] section in config file.
3. Specify which commands in this toolkit are restricted and disabled for all users except those
controlled users/permission groups. Administrator can use this facility to disable commands as
per his need.
[Restricted Commands], [Users Without Command Restrictions], [Permission Groups
Without Command Restrictions] sections in config file.
4. Specify a list of Custom Commands accessible from the Admin/User Configurable portion of the
ToolBar (3rd column of Buttons on S3D Automation Toolkits Toolbar)
[Custom Super ShortCuts] section in config file.
5. Admin/User configured 'Custom Attribute/Relation Watch' values in Select Set Browser.
[Select Set Browser - Custom Attribute/Relation Watch Entries] section in config file.

Page 4

SP3D Automation Toolkit - How to Install & Configure Menus

Advanced Configuration
Adding Custom Menu items to Toolkits PopupMenu
A file named menuSP3DAutomationCustomPopupTools.xml is delivered with the toolkit into the
products CommonApp\Environment\Xml directory. You can customize it before/after installing the
toolkit. This allows you to add your own menu items and menus to the toolkits popup menu.

Adding Custom Tasks to Smart3Ds Tasks menu.

A file named menuSP3DAutomationCustomTasks.xml is delivered with the toolkit into the products
CommonApp\Environment\Xml directory. You can customize it before/after installing the toolkit. This
allows you to add custom task entries into the Smart3Ds Tasks menu.

Note: Being an Advanced Configuration, any customization to the below mentioned files must be done
carefully and ensured that it works on a local machine before deploying on to many machines. For more
information, refer to the comments in the respective files delivered with the toolkit.

Page 5

SP3D Automation Toolkit - Super ShortCuts

Super ShortCuts
This functionality called the Super ShortCuts, is something which
uses Ctrl and Shift key combinations to invoke some of the most
commonly used commands in this toolkit. Tapping them (i.e. press and
release) in quick succession (anywhere inside the SP3D application,
but not on any active command form) will invoke the functionality.
For example, tapping Shift key thrice, i.e. Shift Shift Shift shows up
the Toolbar that provides access to all commands in this toolkit.
Similarly, another Super ShortCut is Ctrl Ctrl Shift. Tapping that
key sequence in quick succession brings up the PopupMenu of this
Toolkit at the mouse position. This Toolkit PopupMenu has the most
commonly accessed commands and also to Show toolbar that
provides access to all additional commands.
In the above menu which includes all Super ShortCuts, C stands for Ctrl, S for Shift.
Super ShortCut keys can be enabled / disabled by using the key combination Shift Shift Ctrl.
Tip: To turn off the Windows Sticky Keys functionality from getting invoked with 5 consecutive shift
key taps, turn off Sticky keys functionality from the Settings option on the sticky keys dialog which shows
up.

Using Commands and Utilities in this Toolkit

All the functionality in this toolkit is made available from

The Toolbar of the Toolkit shows up with Shift Shift Shift Super ShortCut.

The PopupMenu of the Toolkit shows up with Ctrl Ctrl Shift Super ShortCut.

Super ShortCuts Explained in above section.

Other Keyboard ShortCuts offered by this toolkit. Listed in various sections in this document.

The Toolbar may be invoked by using the Super ShortCut Shift Shift Shift. This is how the toolbar
appears on the screen.
Note: Some less frequently used commands are hidden by default as delivered, and you can double click
on the toolbar to toggle their show/hide visibility.

Page 6

SP3D Automation Toolkit - Super ShortCuts

Select Set Browser

Add to Workspace by Range

SmartSketch Settings

Add Interfering to Workspace

Copy OIDs to Clipboard

Add Connected to Workspace

Filter Selected Objects

Compare Object Properties
NumPad View Control
DBI Analysis

Add Selected to Workspace

Create Filter By Spec
Create Nested Systems Filter By Name
Create Filter From Select Set

Part Change Impact

Remove Text Copy Of

Manage Object Sets

Insert Isometric Break

Show Selected Objects

Precision Move Selected Objects

Find Objects By Report

Flip Connection Owner

Add Configured Select Filters

Delete Empty Runs

Add On-The-Fly Select Filter

Change Bend Radius

Isometric Troubleshooting
Lock PinPoint toUtility
Zero

Edit Snapshot Filter

Lock PinPoint to Centroid of Geometry

Codelist Value Lookup
Find Duplicate Members or Slabs
Name Rule Check
Save Snapshot Of Views

Use Run Insulation

Spool Selected Pipelines
Split Run
Merge Runs
Propagate Properties
Join Features

Select Supports on Selected Runs/Features

Copy Run

features
Set and Lock PinPoint Target to Object

Replace Elbow With Tee

Explore SymbolShare

Replace Tee With Elbow

Bulk Modify MemberPart CrossSection
Export / Import Object Names

Cycles 3rd column of buttons - configurable Custom Super ShortCuts

[CC, CS, SC, SS] with a numeric[0-9] or alphabetic [A-Z] key.
You can also have your own icons for these.
See [Custom Super ShortCuts] section in config file for more information.
Toggles ToolBar Positioning Left/Right of main window.
Delivered Example of a Configurable Custom Super ShortCut.
Simple ONE line entry in config file adds a command to the toolbar.
Page 7

SP3D Automation Toolkit - Select Filters and Object Set Manipulation Commands

Select Filters and Object Set Manipulation Commands

Select Filter Commands with only Keyboard Shortcuts
Ctrl Tilde (~)
Change Active Select Filter up / down.
Ctrl Shift Tilde (~)
Ctrl Space
Set Active Select Filter to 'All'
Note: These shortcuts get disabled if Super ShortCuts are disabled.

Select Set Browser for SmartPlant 3D

You can invoke the Select Set Browser function using the Shift Ctrl Shift Super ShortCut. The Select
Set Browser form stays on top of all windows. For any reason, if it goes behind and you cannot see it,
you can use the Ctrl - Ctrl - Ctrl Super ShortCut to bring it back to the top, along with any other active
forms from this toolkit. You can use Ctrl-C to copy value(s) from informational fields shown.

Page 8

SP3D Automation Toolkit - Select Filters and Object Set Manipulation Commands

Object Navigation: Use the navigation controls

to go to First
(Home Key), Previous (PageDown Key), Next PageUp (Key), or Last (End Key) Object, or Object By Index.
Information:
The Entire set of Objects being browsed is hilited in Yellow and the Current Object is hilited in Red. The
Active Objects Index within the List being browsed, Type, OID and PG are displayed. Coordinates are
also displayed if the object has any meaningful Location or Origin. If the Object is a Named Item, its
name is displayed. To add a custom watch (objects attribute, or Objects related Object attributes, or
count of related objects over a given relation/role ), you can edit the (<Custom Attribute/Relation
Watch>) placeholder row. Specify Custom watch as below.
Custom Watch text Format
InterfaceName.AttributeName
InterfaceName>RoleName

Interface>Role(Interface)

Interface>Role[n]

Interface1>Role1(Interface2)[n]:
Interface3>Role3[1]:
Interface4>Role4[1]:
Interface5.Attribute

{LabelName}

Purpose / Remarks/Example
Show value of an attribute of the currently browsed object.
Ex: On any Object, IJDObject.ApprovalStatus shows approval status.
Show currently browsed objects related object count. If evaluates to one object, shows its
OID. Relation is specified by Interface and Role names.
Ex: On a PathRun (Piping/Cabletray/Cableway/Ducting) Object
IJDesignParent>thePathRunFeatures shows count of features on the currently browsed
PathRun object (Piping/Cabletray/Cableway/Ducting)
Same as above, but only shows count of Related Objects which only satisfy a given
interface.
Ex: On a PathRun object (PipeRun/Cabletray/Cableway/DuctRun),
IJDesignParent>thePathSystemFeatures(IJRteStraightPathFeat) shows count of Straight
path features of the currently browsed PathRun object.
th
Refers to n related object (1-based index) over given Interface/Role names. Can be used
to further traverse its related objects or show its properties.
Ex 1: On a PipeRun object, IJRtePathRun>Spec[1]:IJDPipeSpec.SpecName shows Spec
Name of the browsed PipeRun object.
Ex 2: On any PathRun object (PipeRun/Cabletray/Cableway/DuctRun),
IJSystemChild>SystemParent[1]:IJNamedItem.Name shows Parent System name.
Notice the use of colon : to traverse two or more relationship paths, and/or attributes.
th
Traverses Interface1>Role1, gets related Objects which implement Interface2, gets n
st
such object, then traverses such objects Interface3>Role3 and gets 1 such related object,
st
further traverses Interface4>Role4 of such object and gets 1 such related object and
finally get such objects Interface5.Attribute
As an Example, IJRtePathRun>Spec[1]:IJDSpec>PathRun gets you the number of runs in
the model which use a selected runs spec.
Evaluates the given LabelName for the object. Label must be a bulkloaded one and not
interactively created one.

(note the curly brackets)

Admin / User can preconfigure such Custom Attribute/Relation Watch entries in the section named [Select Set Browser Custom Attribute/Relation Watch Entries] in the Toolkit Config file
Admin SymbolShare\S3DAutomationToolkitConfig.txt
User ToolkitInstallDir\MY-S3DAutomationToolkitConfig.txt
The entries have to be like Display Name = Custom Watch string, like Spec Name = IJRtePathRun>Spec[1]:IJDPipeSpec.SpecName

Page 9

SP3D Automation Toolkit - Select Filters and Object Set Manipulation Commands
Options:
Zoom: Fits the Active View to the new Object on Selection Change. Checking this ON is
equivalent to pressing the Fit View to Current Object button on each Selection Change. The
ZoomOut Factor can be specified.
Track: On each Selection Change, the Select Set is cleared and loaded with the new Object. Any
associated commands / ribbon bars active will reflect this change. For example, if you have
Property Page up, then it would show the properties of the new object which we navigated to.
Checking this ON is equivalent to pressing the Select Current Object alone button on each
Selection Change.
Actions:
Fit View to Current Object: Fits the Active View to the Current Object.
Fit View to All Objects: Fits the Active View to All the Objects.
Select Current Object alone: Clears the Select Set and adds the active Object alone to it. If the
Object representing the active Object has a ribbon bar, it comes up. Or, if the Property page is
active, it refreshes to the new object.
Reselect All Original Objects: Restores the Original Select Set, with which this Command was
initialized. If the Refresh action was performed earlier, or a Remove Action was performed,
then it will Restore to that last known Select Set.
Refresh (F5) Restarts this command with Active Select Set.
Note: Remember, if you have Track option ON, then you would only have ONE object,
the active object in the Select Set as you navigate. If you press Refresh at this time, then
the Select Set Browser form would restart with that one object in the list.
Remove Current Object from List: Removes this object from the Current Browsed List and
moves to the next object. If you do not have Track option ON, then the browsed object list is not
the same as Selected Object List. In such case, this action doesnt remove it from the Select Set.
Objects from Clipboard OIDs: If your clipboard contains OIDs list (eg from a Database Query
results list), you can use this function to initialize Select Set with the objects representing those
OIDs. Later you can use the Object Navigation Commands.
Copying values: You can copy any text value shown in the Select set Browsers list view,
including OIDs, custom attribute/relation watch values.
Hiliting Related Objects: Selecting any Relation watch row in the list view hilites those objects in
Blue Color.

Page 10

SP3D Automation Toolkit - Select Filters and Object Set Manipulation Commands

Add On-the-Fly Select Filter

This command allows user to add
Select Filters interactively.
The command prompts as shown in
the picture. Provide the necessary input, i.e.
the Filter definition in Name = Criteria format
as explained in the picture. Once correct
inputs are specified, the specified Select Filter
shows up in the available select filters list. Such custom select filters are not preserved on changing task.

Add Configured Select Filters

This command adds the Configured Select Filters in the S3DAutomationToolkitConfig.txt file
in the active plants symbol share. See the S3DAutomationToolkitConfig.txt delivered with
this toolkit for more information on how to configure your own select filters. Typically an
administrator will finalize this file based on the use cases. Note that the added filters are lost on task
switch (done so with an intent to revert to select filters as delivered with SmartPlant 3D / SmartMarine
3D product). This gives facility to administrators to define new select filters at individual task, group of
tasks and all tasks.

Filter Selected Objects

This command facilitates filtering selected Objects to either Filter-Out or Keep-Only certain
types of objects by specifying simple criteria. It comes with some predefined filters and also
allows on-the-fly filter by specifying Name and Criteria. An administrator can configure more
filters as needed by customizing [Filter Selected Objects Command] section in the config file.

Page 11

SP3D Automation Toolkit - Select Filters and Object Set Manipulation Commands

Manage Object Sets

This Command is used to Manage Object Sets. Its Super
ShortCut is Ctrl Shift Shift. This allows one to create
private Selected Sets of objects for further use in the
active session. Note that the object set information is not saved
to session file and will not be available when you re-open the
session file.
For example, while you are modeling, you arrived at a list of
Equipment you realized you have to review later. You would
select them and invoke this command, save them by giving the
set of objects a name of your choice Later, you would just use
the same User interface to select those objects back as a set.
The active select set can be saved as a given name by just typing in a name of your choice in the Name
field. Just click to start the edit and then type the name of your choice. It gets saved as a new entry. You
can also rename existing sets, or refresh them with active select set. The sets always are in sync with
model contents i.e. any deletes done in the model will update the lists accordingly.
Later you can add more sets of elements in the same workflow. To remove one or more saved Object
Set(s), just select the row(s) and press delete.
These saved select sets can be accessed anytime just click on the entry to Hilite them. Double clicking a
row, or pressing Activate will activate the objects in the saved set of that row to the select set.
The Add button adds the saved object sets representing the selected row(s) to the current selected
elements set. The Remove button removes the objects in the saved object sets rows from the current
selected elements set.
Also note, you can select more than one rows to Activate/Add/Remove, in which case all the selected
rows are processed.
Just in case there is an ambiguity with the graphic colors, the hilite colors and weight can be changed
interactively as below (The keys are expected to be pressed on the commands form).
To cycle between available Hilite colors, press Ctrl + 0 (upward) or Ctrl + 9 (downward).
To increase/decrease the hilite line weight, press Ctrl + Shift + 0 / Ctrl + Shift + 9.
Note that the above mentioned keys are from the main keypad and not the Numeric Keypad.

Page 12

SP3D Automation Toolkit - Helper Commands

Helper Commands
SmartSketch Settings Palette
The SmartSketch Settings Palette allows one to Control active SmartSketch Options. The
Super Shortcut key to show up this Palette is Ctrl - Shift - Shift.

The palette moves to / shows up at the current mouse position whenever invoked via menu/shortcut
key. Press Esc key to dismiss it. It stays on top of all windows. For any reason, if it goes behind and you
cannot see it, you can press the Super Shortcut key combination again and it comes back to the top, at
your current mouse position. You can also use the Ctrl - Ctrl - Ctrl Super ShortCut which brings all active
Forms from this toolkit to Top.
The options can be toggled at any time, or the 'Number of Divisor points' or the Offset value can be set.
When 'Number of Divisor points' is changed, intuitively the Divisor Point option is turned on.
The Smart Sketch options currently ON show up in Pressed state (green), and those OFF will be in
UnPressed state (red). Note that some options require other options turned on. For example,
Intersection option requires Point on Curve option.
The 'X' button clears the active Smart Sketch Objects list. Intuitively, it turns off the 'Locate only from
List' option.
The '+' button adds currently selected objects to active Smart Sketch Objects list. Intuitively, it turns on
the 'Locate only from List' option. If the stack size is lesser than the number of selected elements, the
active stack size is increased (to a maximum of 10). If you selected fewer objects than the active stack
size, the stack size is not altered, and the list is rolled up, i.e. oldest elements are cleared to add the
selected elements. The combo box at the end shows the active stack size and can be set anytime.
At times you may want to exclusively turn on an option i.e. turn off all except a given one. For
example, to Measure between Ports you may want only Nozzle/Port Points ON and all others OFF. This
can be achieved by Right Mouse button click instead of Left. The previous state can be restored by Right
Mouse Click on the option which was exclusively turned on previously. The previous state is preserved
even when you are switching from one exclusive option to another.

Page 13

SP3D Automation Toolkit - Helper Commands

PinPoint Lock / Unlock Commands

The PinPoint commands facilitate locking and unlocking of all the three PinPoint fields (E,N,El) with one
menu click on the Automation Toolkit Popup Menu (which shows up with Ctrl Ctrl Shift Super
ShortCut).
PinPoint > Lock to Zero menu item or

icon locks all PinPoint fields (E, N, El) to zero.

PinPoint > Lock menu item Locks all the three PinPoint fields (E, N, El) at their current values.
PinPoint > Unlock menu item unlocks all PinPoint fields (E, N, El).

Lock PinPoint to Centroid Of Geometry Command:

This command is useful to get centroid of a Planar surface, Open Curve, Closed Curve or a
Structural Opening [on Slab or Plate etc]. If the PinPoint ribbonBar is active, it locks the
Pinpoint to the Centroid Point it calculates. This is useful in situations where you want the
centroid point as a reference point for some other operation, like measure or use as a placement
reference. The advantage of locking the pinpoint to this point is that you can just click in graphics
anywhere to pick that point when any command is expecting a point. The calculated centroid point is
also added to the constrained points generated by SmartSketch on that object. This is similar to the
Tools > Get Point command, but it has the additional facility to get centroid of Structural openings and
also lock the PinPoint to the centroid calculated. For example, this provides a convenient means to pick
geometric center of Triangular, Rectangular, Rounded Square/Rectangular or Oval openings while you
intend to route pipe through them.

Set and Lock PinPoint Target to Object:

This command is useful to Set and Loc PinPoint Target to an Objects Position. This works with
any object where a Position is meaningful. If the PinPoint ribbonBar is active, it locks the
Pinpoint to 0,0,0. This is useful in situations where you want the objects position as a
reference point for some other operation, like measure or use as a placement reference. The advantage
of locking the pinpoint to this point is that you can just click in graphics anywhere to pick that point
when any command is expecting a point.

Page 14

SP3D Automation Toolkit - View Manipulation Commands

View Manipulation Commands

View Manipulation with only Keyboard shortcuts
The below keyboard shortcuts work for view manipulation even when any other modeling command is
active.
Ctrl +

Zoom-in in the active view.

Ctrl

Zoom-out in the active view.

Ctrl Shift +

Rotate active view clockwise about Active axis.

Ctrl Shift

Rotate active view clockwise about Active axis.

Ctrl Shift BackSpace

Change Active Axis (cycle between X Y Z)

Ctrl Shift Capslock

Change zoom/rotate factor (fast/slow)

Ctrl Shift V

Active View Style - Cycle between Wireframe/Shaded/Smooth style

Ctrl-0

Set Active View to Next Standard Viewing direction.

Ctrl-9

Set Active View to Previous Standard Viewing direction.

Ctrl-PageUp / PageDown

Previous / Next View function as on View menu (v9.1 HF03 and above)

Note: These shortcuts get disabled if Super ShortCuts are disabled.

View Manipulation with Numeric Keypad

+
All in One View Command
The Super Short Cut key for this is Ctrl Shift Ctrl.
The previously delivered All in One View Commands
functionality is also merged into this command now after adding
some more enhancements.
The command displays 3D Co-ordinates of Mouse Position in the
RibbonBar on MouseMove. If a Local Coordinate System is active
and is not same as Global Coordinate System, both the Local and
Global Coordinates are shown.
The Command also provides Basic View Manipulation (Pan, Zoom and Rotate) using Numeric Keypad as
indicated in the picture. The direction reverses when Ctrl Key is pressed in combination with the
numPad keys. For example, Ctrl * will rotate in opposite direction as just * would do. In case of
ZoomIn or ZoomOut, pressing Ctrl key would give fine control on the zoom factor.

Page 15

SP3D Automation Toolkit - View Manipulation Commands

When the view is in Perspective mode, the Up/Down Arrow keys will simulate a walk in effect, and the
Left/Right arrow keys will simulate a turn effect. The Ctrl and Shift keys provide control on axis of turn
with the Left/Right keys.
It has a ribbon bar
in, Set / Clear View depth.

with options to Center View to a Point by Coordinate key-

The Set View Depth functionality works on the active View. It is meaningful for orthogonal views. It
prompts you to provide two points (usually best provided from other orthogonal views) defining the
clipping planes in the Active Views viewing direction. Such clipping planes can be edited using the Clip
By Volume command. The Clear View Depth function clears clipping.
The other functionality using Mouse/Keyboard actions is as follows
Mouse / Keyboard
Action
Click and <quickly>
Click across views
Ctrl-Click
Shift-Click
Alt-Click
Left Drag
Left+Right Drag
Scroll (Middle Button)
Right Drag
Middle Drag
S Key
L Key
T Key
Z Key
G Key
Home Key
Space Key

Functionality
Center View to Point 1st Click Picks Point, next quick Click(s) identify view(s)
to Center (the picked Point must be an intelligent point like Point on
line/object/plane etc where you see a glyph from SmartSketch and not a point
in free space)
Center View to Picked Point
Center View to Last Picked Point
Center ALL Other Views to Picked Point
Rotate (Can rotate about a Linear Objects Axes)
Pan
Zoom In/Out
Dynamic Zoom
Zoom Area
Show MessageBox current tracked position coordinates.
Lock PinPoint to currently tracked position. (pinpoint must be running)
Set currently tracked position as PinPoint Target. (pinpoint must be running)
Lock Pinpoint to Zero. (pinpoint must be running)
Center View to Position by Keyin
Fit View
Center to Selected Objects (must be selected before starting the command)

Page 16

SP3D Automation Toolkit - Filter creation commands

Filter creation commands

Create Filter from Select Set
This command is useful to create a System Hierarchy Filter
which includes all selected objects.
Just select the objects you want included in the Filter and start the
command. It then prompts you for the Filter Name and whether to
include nested objects.
A filter is created under the MyFilters folder and below message is
shown. If more than 200 items are in the select set, the edit filter dialog
may show a blank system tab. However the filter will still work.

Create Nested Systems Filter by Name

This command is useful to create System
Hierarchy filter with System objects with a
given name or name pattern , including their
nested children.
It prompts for the names of systems. You can also use
wild cards as indicated. It then prompts you to specify
the filter name and creates such filter under My Filters
with all systems matching the specified critiera (at the
time of running this command) selected on the system tab and include nested items checked.

Create Filter by Specification(s)

This command is useful to create a Filter for
Route Objects using given Spec(s). The Filter
created (under My Filters) will have all the runs
using the specified Spec(s) on the system tab and 'include
nested items' checked. Multiple specs can be specified by
separating with comma. The command works with Piping,
Electrical, Duct and Conduit specs.
Note that, the filter only remembers the current objects at the time of creation. If further modeling
created more runs using that spec, they will not be automatically included. You need to delete and
recreate the filter if desired.

Page 17

SP3D Automation Toolkit - Surface Style Rules, Styles and Filter Import Export commands

Surface Style Rules, Styles and Filter Import Export commands

Surface Style Rule Set Manager
This command allows a user to save a set of surface style rules applied to the workspace into an
XML file as a set and to load such a saved set back to the workspace. It extends the functionality
of the Format Surface Style command and enables users to load a set and apply it to their workspace. A
text file containing the list of style rule names is also saved so it could be easily copied to a SPRDirect
input file.

Export Surface Styles, Surface Style Rules and Filters

This command allows a user to export surface style rules and simple filters to a XML file. Surface
styles are exported to a text file named the same as the corresponding XML file (with a Styles
suffix) and saved in the same output location. User can choose which filters (Catalog Filters, Plant Filters
or My Filters) to export. If the user selects the Export Selected Filters check box, the Select Filter
dialog is displayed. All filters selected in this dialog (multi select using Ctrl and Shift) are exported.
Information is exported from the system (systems and coordinate systems), assembly (blocks and
assemblies), analysis, WBS, Reference3D, object type and properties tabs. Compound filters are
exported to the XML file as well and all filters needed by compound filters are included in the export.

Page 18

SP3D Automation Toolkit - Surface Style Rules, Styles and Filter Import Export commands

Selecting the check box to export styles and style rules exports all styles and style rules in the model
database. The styles are exported to a text file with the same name as the XML file suffixed with Styles.txt.

Import Surface Styles, Surface Style Rules and Filters

This command allows a user to import surface style rules and filters from a XML file exported
using the Export Surface Styles, Surface Style Rules and Filters command. Surface styles stored
in a text file with the same name as the XML file suffixed with Styles.txt can also be imported.

When importing filters, user can choose whether to import catalog filters, plant filters, my filters or
some combination of the three. All filters present in the file are imported and filter folders are created
as desired. Filters are imported into the plant using the active permission group while filters are
imported to the catalog using the first catalog permission group to which the user has write access.
When compound filters are imported, the command ensures that all nested filters are present before
importing the compound filters.

Page 19

SP3D Automation Toolkit - Workspace Modification Commands

Workspace Modification Commands

Add Selected Objects to Workspace
Sometimes relationship navigation from one object will take you to another object which is
not in the current workspace filter. Say, you have defined a filter with all piping and supports
in a particular unit, say U01.

This then shows you the hanger PS-01.

Page 20

SP3D Automation Toolkit - Workspace Modification Commands

Navigating from properties of the hanger, one can see there is a supporting structure Beam-1-0032.
Selecting it and clicking GoTo will put this beam in the select set, bringing in a ghost representation.

Page 21

SP3D Automation Toolkit - Workspace Modification Commands

However we cannot measure any distances or visualize the beam properly without adding it to the
workspace. This command fills the need. Once the beam is in the select set, one can invoke the
command and add the beam to the workspace.
This command can be similarly used to add a volume for a snapshot or composed drawing to a
workspace. If the 2D/3D select from drawings is used, the volume is shown in the view, but it cannot be
modified until it is added to workspace. The workflow then is
Open drawing for editing.
Start 2D/3D selection command.
Turn view selection ON using space bar.
Select the view; this selects the volume in 3D.
Run the command, this adds the volume to 3D. It can then be modified using any of the space
management commands.

Page 22

SP3D Automation Toolkit - Workspace Modification Commands

Add Interfering Objects to Workspace

Often times, in an example similar to
above one may add objects of one
discipline to the workspace and this
adds all interferences related to those objects
to the workspace. For instance if there is an
interference between a pipe and a slab, and
one is working with pipe in the workspace, the
interference marker is shown. Selecting the
interference marker highlights the slab in ghost
form but does not allow one to work with it
anyway.

This command, when used with the interference

marker in the select set, adds both interfering
objects to the workspace.

The command also works with multiple

interferences in the select set and adds all
interfering objects.

Add Connected Objects to Workspace

Frequently one begins working with a limited workspace and it is desired to progressively
expand the workspace to include related/connected objects. A command has been developed
to do this for the specific case of piping and equipment nozzles. If the command is executed
with a terminal part (i.e. a part which is connected to a part in another pipe run/line/nozzle) in the select
set, the command will add the connected pipeline or equipment to the workspace. If the command is
invoked with a nozzle in the select set, the connected pipeline is added.

Page 23

SP3D Automation Toolkit - Workspace Modification Commands

Initially the workspace

may consist of just
equipment. A pump
discharge nozzle is
selected and the
command is invoked. The
Connected piping gets
added to the workspace.

In case the nozzle does not have any connected piping, a message is shown.

If the selected item is a piping

part and the connection is to a
nozzle, the connected equipment
is added to the workspace.

Page 24

SP3D Automation Toolkit - Workspace Modification Commands

If there is piping
connected to the
selected part, then
the connected
pipeline is added to
the workspace.

Add to Workspace by Range

It is often desired to see everything that is around a particular object or set of objects that is
to say within their range box. This may be needed for a quick review of ones surroundings
and has temporary value. Presently one can use the following workflow:
Define a space management volume by selection set.
Grow the volume by handles as desired if something outside the object range is also needed.
Define a filter which selects the volume on the system tab.
Select object types on the object type tab if you wish to restrict to certain disciplines.
Define workspace using the new filter (this means objects outside the selected range will necessarily get
thrown away) or create a compound filter that combines current workspace filter with the newly
created volume filter
After the review is complete, delete the filter (and compound filter if created) and the volume.
To simplify above multiple step workflow, this command may be used. Select a set of graphical objects
(objects must have range). Pipelines are the only non-graphical object allowed.

Page 25

SP3D Automation Toolkit - Workspace Modification Commands

Run the command, and it shows this form.

The values will expand the range of the selected objects as shown. By default the lock is on which
ensures that the expansion is by the same value on all sides, a value may be entered in any of the fields.
To expand by different dimensions on each
side, press the lock icon to toggle it to unlock
state. One may select the disciplines, whose
objects need to be added. A dynamic volume
is created by expanding the range. View
commands can be used at this time. On
Apply, a range query is run and qualifying
objects are added to the workspace. Once
you are satisfied with the range expansion
and the results obtained, you can exit the
command by pressing Cancel.

Page 26

SP3D Automation Toolkit - Workspace Modification Commands

Checking the Clip View check box clips the view to the newly expanded volume.

Invoking Workspace Refresh command (F5) will preserve the added elements in the workspace.
However File Define Workspace and click OK will return to the workspace defined by the filter.

Page 27

SP3D Automation Toolkit - Route Commands

Route Commands
Select Empty Runs
This Command helps find empty pipe runs (to begin with, empty runs get created and left in model
when a new run command is started but aborted before any pipe is placed.)
The command brings up a form that shows empty runs. You may select runs as desired. To delete them,
use the normal delete command. To choose a different discipline, click on the respective option.
The command is closed using the close box at the top of the form.

Change Bend Radius

This command lets you specify an arbitrary value of bend radius for a pipe bend. Piping specifications
currently allow the placement of bends with pre-defined radii, however certain usage scenarios allow a
user specified radius for a given pipe bend.
After the command is invoked, first the value for the catalog option for user defined bend radius is
checked. If bend radius by user is disabled, the following message is shown and the command exits

If the command is allowed, first a ribbon is shown and the user is prompted to pick pipe turn feature(s).

Page 28

SP3D Automation Toolkit - Route Commands

If a single feature is selected, or if multiple features with identical bend radius multiplier are selected,
the command shows the current value of the bend radius.

If the selected turn features have different bend radii, this is shown in the ribbon bar.

If all turns are deselected, the ribbon bar shows Empty

Page 29

SP3D Automation Toolkit - Route Commands

When turn features are selected, and the value in the input field is numeric and positive, the apply
button is enabled.

The user may enter a new value and press Apply and the change is committed.
After this the change is committed to the database and the command stays active allowing user to pick
more bends.
If user wishes to change absolute value instead of bend radius multiplier, the absolute value entered
must be in meters.

Page 30

SP3D Automation Toolkit - Route Commands

Spool Selected Pipelines

This command allows a user to select one or more pipelines and execute the spooling
command. The options stored in the catalog are used to generate the spools. The chief
benefit is that the pipelines to be spooled may be added to the select set by any means and it
is not necessary to pick the pipelines in the spool generation dialog box one by one.

Insert Isometric Break

The current functionality for adding an isometric break point requires many steps. This
command simplifies the same.
To place the control point of the type Iso break, select a single route connection and run the command.

A control point, child to the connection, of the type Piping Mfg Limit Point, named Iso Break is placed
assoc-on to the connection. This means that it will move with the connection if the connection moves

Page 31

SP3D Automation Toolkit - Route Commands

due to any modification. The control point is selected in case the user wishes to change its sub type or
rename it. For ease of visibility, the size of the control point is 1.5 times the diameter of the pipe.

The reference geometry aspect is turned on for all views to show the control point in case its not
already on.

Isometric Troubleshooting Utility

This command helps to troubleshoot some common Isometric extraction issues due to
modeling and catalog inconsistencies.
Before you can run this command, you have to select an object which can be used to extract an
isometric. That is, a Pipeline, or a PipeRun or a WBSItem.
The command shows up the below form.

You can choose from the below options.

Select All Open Ends : This allows one to investigate the end points of the Pipeline. Typically, useful if
you are trying to resolve multiple disconnected segments on the pipeline. When Run with this option,
the Open End Features of the Pipeline will be selected (which can be reviewed using Select Set Browser)
Select All Open Ends + Closure Items: This allows one to investigate the end points and terminal items
on the Pipeline. Typically, useful if you are trying to resolve multiple disconnected segments on the

Page 32

SP3D Automation Toolkit - Route Commands

pipeline. When Run with this option, the Open End Features of the Pipeline along with any Closure items
(eg Caps, Plugs etc) will be selected (which can be reviewed using Select Set Browser)
Items with ToDo List Entries: For the selected Isometric Extractable object (Pipeline / PipeRun /
WBSItem), this option allows one to check if there are any items with ToDo list entries and selects them.
Items missing Catalog Definition: For the selected Isometric Extractable object (Pipeline / PipeRun /
WBSItem), this option allows one to check if there are any items which are now not available in the
Catalog. i.e. those objects which have been deleted from Catalog after they have been placed in Model.
Apart from the above options, the command can also be used to review the Multiple Start Points
detected by Isogen while processing the Isometric. Save the MES file generated by Isogen and open it
using the browse button () The file is read and multiple start points logged in it are listed in the
combo box. Picking the Combo item will show the point in the graphic views, and also zooms in the
active view to that point. If the Isometric has been configured to use a local coordinate system, then you
must have that coordinate system active in the PinPoint active coordinate system to interpret the point
correctly.

Page 33

SP3D Automation Toolkit - Route Commands

Join Features
This command helps to join Piping Features which are joinable in a meaningful fashion. The
two features could be like
- Two End Features [Join Ends Situation], or
- One End Feature and One Nozzle [Join To Nozzle Situation], or
- One End Feature and One Straight Feature [Branch Situation] or
- One End feature and One Tap Feature [Connect to Tap Situation]
The user must select the two features to be connected and invoke the command. Depending on the
nature of the two features and their relative position, appropriate turn or branch is generated.

Replace Elbow With Tee

This command allows user to replace a 90 degree piping elbow or a bend (turn) with a full
size tee (branch). The user must select the turn and run the command.
The command will pick one of the legs connected to the elbow, highlight it and prompt the
user to select if that is the header.

Page 34

SP3D Automation Toolkit - Route Commands

Depending on the answer either the selected leg or the other leg is chosen as the header and the tee is
oriented accordingly.

Page 35

SP3D Automation Toolkit - Route Commands

If nothing is selected or the selected object is not a 90 degree elbow, a message is shown and the
command exits.

Replace Tee With Elbow

This command allows the user to replace a full size piping tee with an elbow. The tee
selected must have one of its header ports open (unconnected).
The command will replace the tee with an elbow or a bend (turn).

If the item connected is not a tee or it does not satisfy the criteria (one header port open), a message is
displayed.

Split Run
This command allows the user to split a contiguous run into two runs. All the properties of
the original run are retained. The user must select a feature on the run and invoke the
command. The command highlights all features including the selected feature to one end of
the run and asks if that is the way to split. If confirmed, the run is copied and all the highlighted features
are moved to the new run. If declined, the set of features to the other end of the run are highlighted
and the question is asked again.

Page 36

SP3D Automation Toolkit - Route Commands

Merge Runs
This command allows the user to merge two adjacent runs with the same nominal size into a
single run. The user must select the connection between the two runs and invoke the
command. The command highlights one of the two runs at the connection and prompts if
that is the run to keep. If confirmed, all the features of the other run are moved into the chosen run and
the other run is deleted. If declined, the other run is chosen and prompted for confirmation.

Page 37

SP3D Automation Toolkit - Route Commands

If the selected connection is not at the boundary of two runs, a message is shown.

If the selected connection is connected to an equipment nozzle, a message is shown.

Page 38

SP3D Automation Toolkit - Route Commands

Page 39

SP3D Automation Toolkit - Structure Commands

Structure Commands
Find Duplicate/Overlapping Members and Duplicate Slabs
There are times when multiple members or slabs end up at exactly the same position as
other members or slabs. Due to the members being constrained to gridlines, when members
are copied and pasted, they may end up at the same position as existing members. Also, if
structure objects are imported using import commands and the same input file is accidentally imported
more than once, it is possible to get multiple members or slabs at the same position. This is not a
difference that is easy to spot either visually or using the interference checker.
This command will find such duplicate or overlapping members or duplicate slabs and retain them in the
select set. To run the command, add member systems and slabs to the select set and invoke the
command. If more than one member is found at a given position, the newer member (the one with a
later creation date) is considered duplicate and retained in the select set.

Bulk Modify MemberPart CrossSection

This command lets you select
MemberParts based on a wildcard
match for CrossSection. It also allows
you to modify CrossSection of MemberParts
matching the From CrossSection/match criteria,
to the specified To CrossSection.
Caution: This is a powerful bulk modification
command. Review your selections carefully
before applying the changes.
The command works off the select set if there
were any member parts selected. Otherwise, it
defaults to work on the workspace.
You begin by specifying an exact or wildcard match for the From CrossSection. You can also pick from
the list of sections matching the wildcard search.
Once you specified/selected From CrossSection, clicking the Select button selects the member parts
matching the same (within selection/workspace).
To set a new CrossSection for those MemberParts, pick a To CrossSection, and click Preview to see the
change. Once you are satisfied with the preview, and want to proceed to apply the change, click Apply.
Click Cancel or just close the form to cancel any unapplied changes and end the command.

Page 40

SP3D Automation Toolkit - Structure Commands

Export / Import Object names (via Text File)

This command lets you Export and Import names
of Objects (via Text File).

To Export Object Names: Select Objects, Start command, Specify File Name and Click Execute.
The Generated text file contains OID of the object and the Name of the Object, separated by |.
You can use usual text editors (eg Notepad++) to modify the names in that text file.
Once you have edited the file to change the Names of objects to your needs, you are ready to Import
the file to get the new names you desired for the objects.
Also note, you can use this command to Keep current names and remove NameRule
association. To do this check the Remove NameRule (Set to User Defined) option before you
click Execute, and then discard the generated file.
To Import Modified Names: Start Command, Specify File Name and Click Execute
Note that, when you import, you dont need to select any objects. The command finds the objects by
the OIDs in the file.
Note that, when you want to Import Names, it implies you are really intending to set user defined
names for those objects, so naturally, they will lose the NameRule specified.
The Import Names action will generate a Log file in the same directory appending an .import.log to the
file name which was specified for import.
If the current Name of the object is same as the Name specified in the Text file being imported, then,
unless you check the Remove NameRule (Set to User Defined) option, the Import Names action will
not do any modifications to that object (its NameRule association if any will still be intact).

Page 41

SP3D Automation Toolkit - Marine Product-Specific Commands

Marine Product-Specific Commands

Auto-Assign Margin at Assembly or Block Butt
Users of the Structural Manufacturing environment have the need to place margin on the
edges of plate parts and ends of profile parts occurring at an assembly or block butt where no
adjacent assembly or block exists that would allow the use of the Margin by Assembly
Connections command. For example, note the ports highlighted below in bright yellow:

This command is ribbonbar driven and consists of four steps utilizing inputs selected from the
Workspace Explorer and graphic view as well as user-specified values, which are described below.
Command Steps / Ribbonbar

Page 42

SP3D Automation Toolkit - Marine Product-Specific Commands

Plate Margin Value:

Amount of margin to be placed on all selected plate edges (textbox

supports unit of measure entry)

Profile Margin Value:

Amount of margin to be placed on all selected profile ends (textbox

supports unit of measure entry)

Margin Direction:

Values same as Fabrication Margin command:

Perpendicular to Edge Margin placed normal to plate edge face or
profile end face
Global
Plate margin placed in the X, Y or Z axis
direction. Profile margin applied along landing
curve direction

Range Volume Depth: Depth dimension of range box used to locate potential margin ports at
the selected assembly butt. The range volume is centered about the
plane of the assembly or block butt. The other dimensions of the range
box are derived from the overall range of the assembly. The calculated
range volume is outlined with green dashed lines as shown here:

A plate edge port or profile end port must lie completely within the
assembly butt range volume to be eligible for margin placement.
Overwrite Margin:

Overwrite any existing constant margin found on a selected port. If this

box is not checked margin will not be placed on a selected port having
existing constant margin and a warning message will be displayed.

Note that the following property values are automatically set (per command spec) for all placed
margins and cannot be specified by the user. However, any margin object created with this

Page 43

SP3D Automation Toolkit - Marine Product-Specific Commands

command may be modified later, including these properties, in the Fabrication Margin
command:
Margin Mode (Constant)
Margin Type (End Face)
Geometry Change (As Margin)

Profile Endcuts Modification Command

Description: By current design, user needs to select profile endcuts or assembly connections
one by one, go to property page, locate Selection tab and then modify selection.
If the features of the profiles need to be modified, users will have to open some other
property pages again and change the values. To improve the efficiency, profile endcuts
modification command can enable selection on profile parts then both ends of the profile part and the
feature children can be modified at the same time.
GUI: After run the command, a ribbon bar is displayed on S3DHost as below.

Selector filter is set to profile part. The parts to be selected must have two free endcuts or assembly
connections at the ends or one for each.
After select profile parts, the parts will be highlighted in white. The start endcuts will be highlighted in
blue and the end endcuts will be in magenta. The current selection of the two endcuts will be shown in
the combo boxes.

Rule-Based option is provided, so that user can set all the selections back to rule driven result.

If click the property page button, property page will be shown as below.

Page 44

SP3D Automation Toolkit - Marine Product-Specific Commands

User can switch between tabs to modify the corresponding features. When the property page is open,
only the features being modified are highlighted in graphic view.
Note: User need to click Apply button before leave current tab and select another tab, if the
modification to current tab needs to be committed.

Note: This command wont work for catalog which doesnt have EndCutTypeCodeList exists or being
used for profile endcuts smart occurrence.

Page 45

SP3D Automation Toolkit - Marine Product-Specific Commands

Modify Collar Material Properties Command

Description: By current design, collar material, grade and thickness properties are decided by
rule. For most cases they are decided by the attached plate part. When user wants to change
these properties, She\He needs to select collar parts, go to property page, uncheck Controlled
Interfaces, apply it and then re-open property page to enable the modification.
To improve the efficiency, Collar Properties Modification Command can enable selection on collar parts
then directly modify those properties.
GUI: After run the command, a ribbon bar is displayed on S3DHost as below.

In the graphic view or Workspace Explorer select collars to be modified.

After select collar parts, the parts will be highlighted in yellow color.
After get collar parts selection, Cancel Selection and Confirm Selection buttons are activated.
User can click the cancel button to clear the current selection or click confirm selection button to
confirm current selection.

After confirm selection, the properties will be shown as below and user can modify them to different
result.

If user has multiple collars selected and their properties are not homogenous, the non-homogenous
property will have empty result selected in the drop-down list, but user can still choose to change it to
certain value.

If one of multiple selected collar parts is not in working status or user doesnt have permission to modify
it, after click confirm selection button, user will see below message box.

Page 46

SP3D Automation Toolkit - Marine Product-Specific Commands

Those collar parts not in working status will be highlighted in blue color as below. User then can change
selection to enable modification.

Click Finish button to proceed with applying the property value to selected collar parts.

Collar Part Planning Assigning Command

Description: For most cases collar parts are in the same assembly with either penetrated
plate or penetrating profile. By current design, user needs to find penetrating/penetrated
structure, get the target assembly and then move the collar part to the same assembly. This
process is very time-consuming and mistakes are very easy to make. To improve the efficiency, Collar
Part Planning Assigning Command can enable easily selection on collar parts and then directly assign
them to desired planning parent.
GUI: After run the command, a ribbon bar is displayed on S3DHost as below.

Selecting filter is set to collar part by default. In the graphic view or Workspace Explorer select collars to
be modified.

Page 47

SP3D Automation Toolkit - Marine Product-Specific Commands

After select collar parts, the parts will be highlighted in white color.
Other Selecting Method:
Assembly/Block: Select assembly or block to add all the collars under it into selection.
Penetrating Profile: Select detailed profile part used as penetrator to generate collars, which will be
added into selection.
Penetrated Plate: Select detailed plate part used as penetrated structure to generate collars, which will
be added into selection.
Workspace: All collars in current workspace will be processed.
Database: All collars in database will be processed.
Click Finish button to assign selected collars.
Note: Since the command is used to assign collars to the same assembly of penetrated or penetrating
structures, we are assuming there are existing assemblies.
If the new assembly parent is System root, we dont take any action, but just record the collar part
name\OID into log file

Page 48

SP3D Automation Toolkit - Common Commands

Common Commands
Precision Move Selected Objects
This command allows moving selected objects by a precise keyed in values of delta X Y Z.
Once can choose to specify the delta values in either Global Coordinate System or Active
Local Coordinate System last set on PinPoint RibbonBar. Note that PinPoint RibbonBar need
not be active. If there wasnt any last set Active Local Coordinate System, the Move In Active Local
Coordinate System option will be greyed out.
Select the objects to move, invoke the command, provide the
required delta values (can leave fields blank as required, e.g. if
you only want to move along X by a delta of 2 inches and along Y
by a delta of 3 inches, just key-in 2in for the X field and 3in for the
Y field and leave the Z field blank) and press Compute. To make
another movement, hit Compute again. Can change Delta values
at any time and Compute again. Once you have reached the
desired position, you can press Commit. To reset to the original
state (or the last applied state, if Apply was done earlier) just press Reset.
Note that, all validations which happen in SmartPlant 3D with generic move command will also happen
when done with this specialized move command.
Make sure you dont have parent-child objects in this, e.g. Equipment and Equipment Components. This
may result in double movement in some situations.

Show Only Selected Objects

When this command is invoked with a some objects in the select set, only the selected objects
are kept visible and all other objects are hidden. This is the counterpart to the Hide command.
To return to seeing all objects in the workspace, use Show All command in Tools menu.

Edit Snapshot Filter

When users snapshot views for placement on drawings, the active workspace filter is copied
and stored away internally. Sometimes it is desired to view and edit the definition of the filter.
This command operates with the snapshot volume and shows the edit filter dialog for the
filter associated with the snapshot volume/view. User may edit the filter definition as necessary and
commit changes to the database.

Page 49

SP3D Automation Toolkit - Common Commands

In case the object selected is not a snapshot drawing volume, below message is shown

Compare Object Properties

This command facilitates comparing Object properties to show Different, Identical and All
attribute values.
When invoked with some objects selected, it compares those objects at one time. When invoked
without any objects selected, it defaults to compare two items (and lets you select them). New Objects
can be selected while the command is running for comparison. The objects list is kept rolling, i.e. if
objects A, B, C are selected for comparison initially, later selecting object D would forget object A and

Page 50

SP3D Automation Toolkit - Common Commands

show the comparison status for objects B, C, D. Later when Object E is selected, it would show
comparison status for objects C, D, E and so on.

If non-homogeneous objects are selected, then it would show only common properties between them.
Clicking on the Header column representing the object hilites the corresponding object in graphics.

IFC Local Detect ON/OFF

This command is available on the Toolkits PopupMenu, which you can invoke using the Super ShortCut
Ctrl Ctrl Shift. Use this command to toggle the IFC local detect Status.
This is a quick short cut to the same done using Tools > Check Interference Click Properties icon on
the Interference Toolbar > Local Detect tab > check Activate local interference detection and hitting ok.

Part Change Impact Analysis

This command is useful to analyze the effect of changing a Part in catalog. It can be used in a
wide range of situations. For example, Equipment Parts, Piping Parts, equipment Component
Parts, Equipment Shape Parts and so on.
When this command is invoked, the below ribbonbar shows up.

Page 51

SP3D Automation Toolkit - Common Commands

The command allows one to select a Part Instance in the model, following which it shows the part
number, and it shows the below information on the ribbon bar.

all occurrences of that part in current workspace

all occurrences of that part in entire database
all approved occurrences of that part in current workspace
all approved occurrences of that part in entire database
all drawings containing the currently selected part
all approved drawings containing the currently selected part
all drawings containing one or more such parts in the entire model database
all approved drawings containing one or more such parts in the entire model database

One sample output is as below.

One can select the objects by double-clicking the label on the ribbon bar pertaining to part occurrences.
One can get the associated drawing names by double-clicking the label on the ribbon bar pertaining to
drawings involving those part occurrences.
Apart from graphic Selection of part occurrence, one can also key in the Part Number and hit enter, to
search for part instances by such part number. Wild card searches are possible % matches any number
of characters, and ? matches a single character.

DBI Analysis (Analyze objects in DBI)

This command allows one to perform analysis of Database Integrity check results.
The command brings up the below RibbonBar

It allows one to query the DBI records by Severity, Date Created/Modified, DBI recommended Action DBI
Status, and allows one to filter only for First Class Objects. Filtered objects can be selected for further
analysis, for example using the Select Set Browser or Manage Object Sets commands.

Remove Text Copy Of

After a copy/paste of multiple objects, frequently the object names have Copy Of as a prefix.
It may be desired to quickly remove this text from multiple objects. This command renames
objects removing the text.

Page 52

SP3D Automation Toolkit - Common Commands

Select objects whose name starts with Copy Of. One way to do this is to set the locate filter to All and
enter Copy Of* in the workspace explorer search combo.

Once the objects are selected, run the command, this removes the text Copy Of

Copy OIDs to clipboard

This command copies the oids (comma separated)
of the selected objects to clipboard.

Find Object By Report

This button invokes the SP3D delivered Find Object By Report command. Please refer to the
Database Integrity Guide delivered as part of the S3D Help to know about this command.

Show / Hide Reference File(s)

A new popup menu is made available on Reference files. Select one or
more Reference file(s) in the References tab of the Workspace Explorer,
or graphics view and then press right mouse, which shows up the below
menu.

Page 53

SP3D Automation Toolkit - Commands without Toolbar Icons (made available as ProgIDs)

Commands without Toolbar Icons (made available as ProgIDs)

This section lists some rarely used commands, which hence do not have icons on the toolbar. Their
ProgIDs are provided here to configure using Custom Super ShortCut keys.

Enable / Disable Idle Generator

These commands to enable/disable Idle Generator are useful if you write and debug your own VB6
based commands. Idle Generator service keeps calling OnIdle(), which makes debugging your commands
difficult. Disabling the Idle Generator helps in this situation.
(Disable Idle Generator ProgID: SP3DAutomation.MiscCmds01; DisableIdleGenerator)
(Enable Idle Generator ProgID: SP3DAutomation.MiscCmds01; EnableIdleGenerator)
Add the below under [Custom Super ShortCuts] section of your toolkit config file (you can choose your
own super shortcuts too).
SSD = Disable Idle Generator ;HighPriorityCmd;SP3DAutomation.MiscCmds01;DisableIdleGenerator
SSE = Enable Idle Generator ;HighPriorityCmd;SP3DAutomation.MiscCmds01;EnableIdleGenerator

Show Reference File Name

(ProgID : SP3DAutomation.MiscCmds01; ShowRefFileName)

This command, when invoked after the

user selects an element from an external
reference file, shows the name of the file
in a message box and offers to select the
reference file in case the user wants to
further process it, e.g. to hide or delete it.

Make Views Like Active

(ProgID : SP3DAutomation.MiscCmds01; MakeViewsLikeActive)
This command copies the properties of the current 3D graphic view such as perspective mode, rendering
and aspects and sets it to all other views.

Apply Named Style to Objects

(ProgID : SP3DAutomation.MiscCmds01; ApplySurfaceStyleToSelectSet;<StyleName>)
This command sets the specified named Style (Blue, Black etc) on selected objects (drawable objects
such as Parts, Equipment etc). If you dont specify the StyleName then it applies the Style by Rule.

Page 54

SP3D Automation Toolkit - Commands without Toolbar Icons (made available as ProgIDs)

Expand Select Set For Move

(ProgID : SP3DAutomation.MiscCmds01;ExpandSelectSetForMove;<True/False>)
This command is useful to expand selection from currently selected Route Features so as to enable
moving all features on the Leg. The optional True/False argument (defaults to True if not specified) at
the end is to control inclusion of Legs of short branches (<1m long).

Delete Multiple Systems

(ProgID : SP3DAutomation.MiscCmds01;DeleteOneByOne)
This command is useful to Delete Systems which contain lot of nested objects. Normal delete command
tries to delete objects in one transaction, which can take long time and possibly run out of memory. This
command deletes the selected systems/runs in a scalable one-by-one fashion (bottom-to-top approach
in system hierarchy), effectively deleting systems one by one. Need to follow below workflow.
CAUTION: DO NOT configure this command as a Custom Super Short Cut. This command is useful in very
rare circumstances, and most of those are one time use cases to clean up system hierarchy.
How to use :
Start with a workspace definition using a filter which only includes System kind of objects.
Select the system(s) you want to delete in workspace explorer, right click and do select nested.
(without this it works just like normal delete command)
Start the command. It brings up a form which shows how many
Systems / Runs are selected.
Click Delete Selected Systems
The command reports about any objects it skipped (due to
permissions / non-working status etc)
Click Close to close the form.

Page 55