Escolar Documentos
Profissional Documentos
Cultura Documentos
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 Toolkit’s PopupMenu ______________________________________________ 5
Adding Custom Tasks to Smart3D’s 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__________________________________________________________________________ 51
Precision Move Selected Objects _____________________________________________________________ 51
Show Only Selected Objects _________________________________________________________________ 51
Edit Snapshot Filter _______________________________________________________________________ 51
Compare Object Properties _________________________________________________________________ 52
IFC Local Detect ON/OFF ___________________________________________________________________ 53
Part Change Impact Analysis ________________________________________________________________ 53
DBI Analysis (Analyze objects in DBI) __________________________________________________________ 54
Remove Text ‘Copy Of’ _____________________________________________________________________ 54
Copy OIDs to clipboard _____________________________________________________________________ 55
Find Object By Report ______________________________________________________________________ 55
Show / Hide Reference File(s)________________________________________________________________ 55
COMMANDS WITHOUT TOOLBAR ICONS (MADE AVAILABLE AS PROGIDS) ________________________________________ 56
Show Reference File Name __________________________________________________________________ 56
Make Views Like Active ____________________________________________________________________ 56
Apply Named Style to Objects _______________________________________________________________ 56
Expand Select Set For Move _________________________________________________________________ 57
Delete Multiple Systems ____________________________________________________________________ 57
Page iii Intergraph Process Power & Marine – SP3D Automation Services Group
SP3D Automation Toolkit - How to Install & Configure Menus
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)
1. Specify your own Configurable Select Filters to add to ALL or a specific list of tasks.
2. Specify your own Configurable Filters for the Filter Selected objects command.
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.
4. Specify a list of Custom Commands accessible from the Admin/User Configurable portion of the
ToolBar (3rd column of Buttons on S3D Automation Toolkit’s Toolbar)
[Select Set Browser - Custom Attribute/Relation Watch Entries] section in config file.
Page 4
SP3D Automation Toolkit - How to Install & Configure Menus
Advanced Configuration
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.
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.
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.
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
Page 7
SP3D Automation Toolkit - Select Filters and Object Set Manipulation Commands
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
Information:
The Entire set of Objects being browsed is hilited in Yellow and the Current Object is hilited in Red. The
Active Object’s 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 (object’s attribute, or Object’s 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.
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.
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 doesn’t 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 Browser’s 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
Page 11
SP3D Automation Toolkit - Select Filters and Object Set Manipulation Commands
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 command’s 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
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
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).
Page 14
SP3D Automation Toolkit - View Manipulation Commands
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 with options to Center View to a Point by Coordinate key-
in, Set / Clear View depth.
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 View’s viewing direction. Such clipping planes can be edited using the ‘Clip
By Volume’ command. The Clear View Depth function clears clipping.
Mouse / Keyboard
Functionality
Action
Center View to Point – 1st Click Picks Point, next quick Click(s) identify view(s)
Click and <quickly> to Center (the picked Point must be an intelligent point like Point on
Click across views line/object/plane etc where you see a glyph from SmartSketch and not a point
in free space)
Ctrl-Click Center View to Picked Point
Shift-Click Center View to Last Picked Point
Alt-Click Center ALL Other Views to Picked Point
Left Drag Rotate (Can rotate about a Linear Object’s Axes)
Left+Right Drag Pan
Scroll (Middle Button) Zoom In/Out
Right Drag Dynamic Zoom
Middle Drag Zoom Area
S Key Show MessageBox current tracked position coordinates.
L Key Lock PinPoint to currently tracked position. (pinpoint must be running)
T Key Set currently tracked position as PinPoint Target. (pinpoint must be running)
Z Key Lock Pinpoint to Zero. (pinpoint must be running)
G Key Center View to Position by Keyin
Home Key Fit View
Space Key Center to Selected Objects (must be selected before starting the command)
Page 16
SP3D Automation Toolkit - Filter creation commands
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.
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
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.
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
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
Page 22
SP3D Automation Toolkit - Workspace Modification Commands
Page 23
SP3D Automation Toolkit - Workspace Modification Commands
In case the nozzle does not have any connected piping, a message is shown.
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.
Grow the volume by handles as desired if something outside the object range is also needed.
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
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
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.
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.
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
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 it’s not
already on.
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.
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
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.
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.
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.
Page 38
SP3D Automation Toolkit - Route Commands
Page 39
SP3D Automation Toolkit - Structure Commands
Structure Commands
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.
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
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 don’t 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
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.
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:
Page 43
SP3D Automation Toolkit - Marine Product-Specific Commands
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.
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.
Page 44
SP3D Automation Toolkit - Marine Product-Specific Commands
Note: This command won’t work for catalog which doesn’t have EndCutTypeCodeList exists or being
used for profile endcuts smart occurrence.
Page 45
SP3D Automation Toolkit - Marine Product-Specific Commands
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.
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 doesn’t 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.
Page 47
SP3D Automation Toolkit - Marine Product-Specific Commands
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.
After select collar parts, the parts will be highlighted in white color.
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 don’t take any action, but just record the collar part
name/OID into log file
Page 48
SP3D Automation Toolkit - Marine Product-Specific Commands
The command’s RibbonBar allows user to choose new CrossSection and Material for the Member
system. User can select Member Systems that need to be converted. The command works with
preselected Member Systems. It only can process homogeneous type, i.e. you cannot have a few
designed and few standard members in the selection at the same time.
The command deletes the original Member System and replaces it with a newly created one of the
requested type. The command preserves settings like end positions, Member Type, Rotation Angle,
Mirror Status, and CardinalPoint [it the same point exists in the new CrossSection]. The Cardinal Point is
obtained from the Member part at the start Frame Connection.
Caution is recommended while using this command, since it deletes and recreates Member Systems.
Important Note: Objects related to the Member System to be converted will lose their relationship with
this object. User will have to manually reset those relations. For example
Other Member Systems having this Member System as a related object will lose the connection.
This occurs because the original Member System is deleted.
Any openings on this Member System will be deleted.
Advanced Plate Systems or Bracket plate systems using this Member System as supports will
lose their support.
If the Member is involved in any Split connection as a Splitter or a Splittee, the associated Split
connection will get deleted.
Detailing on the selected Member Systems will get deleted. Any related detailing information
like Member End Cuts or Structural Detailing Features will be lost.
Manufacturing information will not be preserved.
A To-Do-List message is generated in cases where the relationship is mandatory and has been deleted.
Depending on the existing Connections amongst the members, and ones that have been selected for
change, and the order of selection (which implies order of processing), will have an effect on what
connections are preserved and what cannot be preserved.
As an alternative, to reconnect with other Member Systems, you can use the ‘Reconnect Member
Systems’ command provided in the Automation Toolkit.
Page 49
SP3D Automation Toolkit - Marine Product-Specific Commands
Since this command does intensive processing, it is highly recommended to NOT use it with large
number of objects (> 100) at one time. It can process them, but may take a longer processing time.
Step 1(Select Member Systems): User selects Member Systems which need to be connected. (If any
members already have connections at any end, such connections are not disturbed). Objects selected in
this step are highlighted in RED.
Step 2 (Select Supporting elements): User selects relatable supporting objects, to which the Member
Systems selected in Step 1 should be analyzed for connections. This step allows selecting Gridlines, Grid
arcs, Member Systems or Frame Connections. Frame Connections of Member systems selected in this
step are automatically included. Objects selected in this step are highlighted in BLUE.
Clear Selection: This button clears elements selected in the active step [Step 1 or Step 2].
Mode: This lets the user finely control which objects from Step 2 should be analyzed for supporting the
unsupported ends of Member Systems selected in Step 1.
Review: When this button is clicked, the command highlights the selections as follows.
- Objects from Step 1 - RED,
- Objects from Step 2 - BLUE,
- Objects from Step 2 filtered by the Mode selected - Yellow.
Finish: Processes the selections and connects the satisfying member ends. It prompts the user to finally
accept the connections. Changes are committed if the user accepts the results.
Page 50
SP3D Automation Toolkit - Common Commands
Common Commands
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 don’t have parent-child objects in this, e.g. Equipment and Equipment Components. This
may result in double movement in some situations.
Page 51
SP3D Automation Toolkit - Common Commands
In case the object selected is not a snapshot drawing volume, below message is shown
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 52
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.
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.
Page 53
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.
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.
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.
Page 54
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’
Page 55
SP3D Automation Toolkit - Commands without Toolbar Icons (made available as ProgIDs)
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
Page 56
SP3D Automation Toolkit - Commands without Toolbar Icons (made available as ProgIDs)
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 57
SP3D Automation Toolkit - Commands without Toolbar Icons (made available as ProgIDs)
# Objects: Limits number of objects you can select. (One, Two, Multiple (with a practical limit of 25)).
Selection rolls forward. As an added convenience, Objects selected here are synced to SelectSet, so you
can use Fit View.
Draw One Box/Object: If checked, one box is drawn for each object. Otherwise, if unchecked, one box is
drawn for the cumulative range of the selected objects. The length of the sides of the box, and its
volume are also displayed. If two objects are being compared, it also displays if they intersect.
Use Standard RangeBox: if checked, Standard rangebox is calculated and displayed. Otherwise, if
unchecked, an OrientedRangeBox is calculated and displayed.
Expand/Shrink by: A length value to expand / shrink the box on all sides. (If the original box size is
smaller then it will not be shrunk in that dimension).
Page 58