Custom Commands - Intergraph Smart 3D - Help - Hexagon

Intergraph Smart 3D Catalog

Language
English
Product
Intergraph Smart 3D
Subproduct
Catalog
Search by Category
Help
Smart 3D Version
13

Provides end-user application programming capability for the 3D software. Using Microsoft® Visual Studio, you can create a custom command that groups a series of commands and instructions into a single command that runs as an operation in the 3D software. As a result, you can access the customized commands that directly relate to the work routine in your operation.

Use the Command Wizard to help you build a custom command. For example, the wizard's first step prompts you to identify general information including command name, project name, author, and company. Start the wizard in Visual Studio by clicking Command Wizard on the Add-Ins menu. See the Intergraph Smart 3D Installation Help.

After adding a custom command in the 3D software, you can edit the command using the Edit Custom Command Dialog, which requires you to specify the program identifier (prog_id), command name and description, command priority, and a command line of arguments in a string.

Delivered Custom Commands

The following list provides descriptions and ProgIDs for the delivered custom commands. See the Database Integrity (DBI) Help and the Common Help.

Custom Command

Audit Tool

ProgID

stAnalysisTool.AuditTool

Description

Compares two databases using an SQL query. The databases can be on different servers and have different catalog schema. Changed objects can be displayed in the workspace of the current model. This command is useful after performing a migration, synchronization, or hull swap.

Custom Command

Clean IFC

ProgID

FoulCheckCommand,Ingr.SP3D.FoulCheck.Client.Commands.CleanIFCObjects

Description

Deletes or cleans the invalid interference markers data. You must run this command from Project Management.

The Clean IFC custom command does the following:

  • Deletes the interference markers related to detached Reference 3D projects, deleted Reference 3D files, and deleted Reference 3D elements in an existing Reference 3D file.

  • Deletes the interference markers when both parts (Part A and Part B) are missing without creating any To-Do records (between Reference 3D – Reference 3D objects).

  • Deletes all the interference markers with fewer than two relations that are not Bad or Delayed – that is, corrupted interference markers.

  • Passes the interference markers to the To-Do List at the Host when a part that has a relationship to interference marker is deleted from the Satellite location.

  • Deletes the interference markers with missing relation names.

  • Deletes the duplicate interference markers.

The Clean IFC custom command contains the following arguments:

Argument: UpdateFoulsPostPCDemolish

Handles the point cloud related interference markers that are left out after performing the suppression of the point clouds.

When you suppress point cloud points on a Smart 3D object that has a clash with the point cloud, the software updates the notes of the clash marker as “This clash marker is no longer valid since the corresponding point cloud points are already suppressed. The software also sets the required action to None-Ignore Interference in the Interference Properties Dialog.

  • When you suppress point cloud points on a Smart 3D object that has another Smart 3D objects that falls in its range and also has a clash with point cloud, the software updates the notes of the clash marker as “This clash marker location might not be valid but the clash between Part A and Part B could still exist.

  • This argument acts on all the suppressed objects that are in Approved status.

  • This argument can only be invoked from Project Management. You should run this command only from the Host location.

  • We recommend that you run this command during the Clash Review phase.

Argument: DeletePointCloudFouls

Deletes all the non-approved interference markers that are associated with point clouds.

When you run the Clean IFC custom command with arguments, the software performs the actions specific to the arguments mentioned in the command.

Custom Command

Convert Smart Interop Object

ProgID

ConvertSmartInteropObject,Ingr.SP3D.Common.Client.Commands.ConvertSIOCMD

Description

Converts generic/equipment/member Smart Interop Object parts to a specific Smart Interop Object type. When you use the Generate SIO Utility to create Smart Interop Objects from PDS data and PDMS data, some objects in the source model are generated as basic geometry. These basic geometry types might not have the proper mapping needed for converting into Smart Interop Objects. The Convert Smart Interop Object custom command enables you to manually promote basic geometry objects to more intelligent Smart Interop Object types. For example, you can promote a collection of basic geometry that represents a slab to a slab. Running this command requires you to select the output object type and the parent system in which the output object is created. You can select and convert single or multiple objects. You can also select multiple Smart Interop Objects and merge them to a single object type. See Convert a Smart Interop Object to a different object type in the Project As-Built with HxGN SDx Help.

Custom Command

Create Drawing View

ProgID

MenuDrawView.CMenuDrawView

Description

Saves and converts the contents of a three-dimensional graphic view window into a snapshot view. This command creates a rectangular object associated to a clipping volume, or volumes, in the three-dimensional model.

Before you create a snapshot view using this command, you must have added at least one composed drawing type to the Management Console in the Drawings and Reports task.

You can save additional views by updating the view contents and then saving the new design. If you used the Tools Menu > Hide Command to avoid displaying certain objects, those objects are included in a composed drawing you create.

To use the Tools Menu > Snapshot View Command, you must have appropriate permissions to access composed drawing types. If you have only read permission, you receive a message that alerts you to this condition.

After you create the snapshot views, you can add them to composed drawings when you use the Tools Menu > Drawing Console Command.

Custom Command

Detect and Repair Hangers Missing Relations

ProgID

HangerCustomCommands,Ingr.SP3D.Support.Commands.DetectAndRepairHangersMissingRelations

Description

Creates missing relationships between Smart Interop Object supports and a Smart Interop Object route or a Smart Interop Object. See Detect and Repair Hangers Missing Relationships Custom Command in the Project As-Built with HxGN SDx Help.

Custom Command

Detect and Repair SIO Runs with Missing Run End Relations

ProgID

RouteDevCustomCmd, Ingr.SP3D.Route.Client.CustomCommand.SIORunsWithMissingRunEndRels

Description

Detects and repairs missing Run End relations between Smart Interop Objects. See the Detect and Repair SIO Runs with Missing Run End relations Custom Command in the Project As-Built with HxGN SDx Help.

Custom Command

Detect Discontinuous Runs

ProgID

RouteDevCustomCmd,Ingr.SP3D.Route.Client.CustomCommand.ReportDiscontinousRun

Description

Detects any discontinuities in the selected pipe run, cableway run, conduit run, or duct run. These discontinuities cause incorrect relationships during publishing.

Custom Command

Duplicate Part Numbers

ProgID

DuplicatePartNumbers,Ingr.SP3D.ProjectMgmt.Client.Commands.DuplicatePartNumbersCommand

Description

Repairs duplicate parts that exist in the catalog, including any proxies that might also exist in all the associated models. The command is available only when you have selected a catalog in the Project Management tree.

In a Global Workshare environment, you must run this command only from the host location.

Custom Command

Find Object by OID

ProgID

SP3DFindObjectByReport.FindObjects

Description

Finds objects with integrity problems in a graphic view. Before running this command, you must define your workspace to include these objects. Run a database integrity report, and use the reported OIDs of the objects in the workspace definition.

See the Database Integrity Help.

Custom Command

Large Sector Utility

ProgID

DwgBinaryEditorCmd.FixSectorSize

Description

Converts existing production drawings from a small to a larger sector format to avoid exceeding Microsoft structured storage limits and causing errors to occur.

Custom Command

Place Piles

ProgID

PileFoundation,PileFoundation.PileFoundation

Description

Provides a placement wizard to facilitate the modeling of pile members. Through the Place Piles custom command, you can specify the number of piles in each direction as well as edge clearances and depth dimensions. You can also specify the member cross section and material for the piles.

Custom Command

Placing Supports from XLS

ProgID

PlacingSupportsFromXLS,PlacingSupportsFromXLS.PlacingSupportsFromXLS

Description

Places support information from an .xls file into Smart 3D. You must run this command from Smart 3D, and not from Project Management. See Placing Supports from XLS Command in the Hangers and Supports Help.

Custom Command

PointCloudCyEnterpriseUpgradeCommand

ProgID

ProjMgmtCommands,Ingr.SP3D.ProjectMgmt.Client.Commands.PointCloudCyEnterpriseUpgradeCommand

Description

Enables you to connect the attached CyEnterprise point cloud models with a server that has been upgraded to Smart 3D 13.

Custom Command

Purge VUE Extraction Control Data

ProgID

PurgeVUEExtractionControlData,Ingr.SP3D.Drawings.Client.Commands.
PurgeVUEExtractionControlData.PurgeVUEExtractionControlDataCommand

Description

Enables you to purge VUE extraction control history data from the model database. The software writes this VUE history data when a user is allowed or denied access to perform various actions on VUE-based 3D model data and SPR Direct report nodes.

This command is only available for users who have Read permissions to the Purge VUE Export PG model permission group. This permission group does not exist by default. The administrator must create the Purge VUE Export PG permission group using Project Management.

Only run this command on a model in Smart 3D. Running this command in Project Management will result in an application error.

To add and run the command:

  1. Use the procedure described in Add custom commands to add the following Command ProgID:

    PurgeVUEExtractionControlData,Ingr.SP3D.Drawings.
    Client.Commands.PurgeVUEExtractionControlData.
    PurgeVUEExtractionControlDataCommand

  2. Run the custom command to open the Purge VUE Extraction Controls Data dialog.

Purge VUE Extraction Control Data

Use the date, query, and row filters to restrict the records that display. Click Reset to return the dialog to its initial state. Click Purge Selected to delete selected rows. Click Purge All to delete all records currently contained in the grid.

  • The software displays the message, "No VUE history data found or VUE extraction control not activated," when there is no VUE history in the model database, the VUE Export PG permission group does not exist in the model database, or records were previously purged. Click OK to open the Purge VUE Extraction Control Data dialog with no records.

  • The software displays a message stating that access is denied if you do not have access to the Purge VUE Export PG permission group, or if the permission group does not exist.

  • An administrator must create the following permission groups with Read access for the model using Project Management:

    • VUE Export PG

    • Purge VUE Export PG

  • See Configure project security in Smart 3D Project Management for information on creating permission groups and assigning levels of access.

VUE permission groups

Custom Command

Remove SDx2 Registration

ProgID

ProjMgmtCommands,Ingr.SP3D.ProjectMgmt.Client.Commands.ClearSDxRegistrationCommand

Description

Removes the SDx2 registration information from the model database.

Custom Command

Repair Duplicate Permission Group ID

ProgID

RepairDuplicatePermissionGrpID,Ingr.SP3D.ProjectMgmt.Client.Commands.
RepairDuplicatePermissionGrpIDCommand

Description

Lists all catalogs and models that have a duplicate permission group ID.

Select the catalogs and models to repair. You cannot select all of the databases under a particular duplicate permission group ID.

This command can only be invoked from Project Management.

This command cannot be run from a satellite location. You should run this command only from the host location.

Custom Command

Repair Permission Groups

ProgID

PermissionGroupsAndLocations,Ingr.SP3D.ProjectMgmt.Client.Commands.PermissionGroupsAndLocationsCommand

Description

Repairs the corrupted relationship between permission groups and the location for both catalog and model permission groups.

If a permission group has lost the relationship with a location or has multiple relationships, then this command re-establishes a proper relation. This command cannot be run from a satellite location. You should run this command only from the host location.

Users with full permissions in the corrupted permission group can only re-establish the relationship.

Custom Command

Repair Smart Interop Objects (Walls and Slabs)

ProgID

SPSSIORepairCommand,SPSSIORepairCommand.RepairDefectiveSIO

Description

Updates the defective Smart Interop Objects with the property values set in the defect report .xml file. Use the Report Smart Interop Object Defects custom command to generate the defect .xml file. See Run the Run the Repair Defective SIO Slabs and Walls Custom Command.

Custom Command

Repair Style Path

ProgID

DwgRepairCmd.RepairDocuments

Description

Fixes Symbol and Style paths on RAD documents.

Custom Command

Report Smart Interop Object Defects (Walls and Slabs)

ProgID

SPSSIORepairCommand,SPSSIORepairCommand.ReportDefectiveSIO

Description

Generates defect report .xml files showing the following defects:

  • Missing Slab Layer

  • Missing Slab Layer Property

  • Missing Wall Layer

  • Missing Wall Layer Property

  • Missing Wall Part Layer Property

See Run the Repair Defective SIO Slabs and Walls Custom Command.

Custom Command

Synchronize Drawing Component Templates

ProgID

DwgSynchTemplatesCmd.SynchTemplates

Description

Repairs a drawing component that has become corrupted by synchronizing it with a different, uncorrupted drawing component. This command requires that the source component is the same type as the corrupted component, and that the source component cannot be corrupted. Also, the number of views on the source component must be the same as the number of views on the corrupted component. The names of the views on the source component must match the view names of the corrupted component.

Custom Command

Synchronize Smart Interop Objects Unmapped Data to SDx

ProgID

IntegrationCommands,Ingr.SP3D.SPIntegration.Client.Commands.PublishUnmappedDataCmd

Description

Enables you to synchronize unmapped Smart Interop Object properties from translated PDS and PDMS data to SDx. The process generates a log file file that records the following:

  1. Number of objects the software has detected to process

  2. Number of objects the software processed successfully

  3. Number of objects remaining, and the number of objects in an error state.

See (Optional) Synchronize unmapped Smart Interop Object properties to SDx in the Project As-Built with HxGN SDx Help.

Custom Command

Synchronize Drawing Templates

ProgID

DwgSynchTemplatesCmd.SynchTemplates

Description

Synchronizes, or copies, a template from one drawing component to another.

Custom Command

Update Duct Features Orientation

ProgID

RouteDevCustomCmd,Ingr.SP3D.Route.Client.CustomCommand.ValidateDuctFeatsOrientation

Description

Defines the orientation angle of the straight and split features as 0 degrees when:

  • The orientation angle of the straight and split features for the selected duct features is 180 degrees.

  • There are no offline features.

  • The leg alignment is 0 degrees.

Custom Command

Update Weight and Center of Gravity

ProgID

RouteDevCustomCmd,Ingr.SP3D.Route.Client.CustomCommand.UpdateWCG

Description

Calculates and updates the weight and center of gravity for route parts.

Custom Command

View Smart Interop Object Unmapped Properties

ProgID

S3DDiagnosticCommands,Ingr.SP3D.Common.Client.Commands.
UnmappedPropertiesCommand

Description

Opens the Smart Interop Object dialog that displays the mapped and unmapped properties for the selected Smart Interop Object. Many custom properties in PDS and PDMS (such as company-specific and tool-specific properties) are unable to be mapped during Smart Interop Object generation. However, these unmapped properties and their corresponding values are stored on the respective Smart Interop Object and can be viewed using the View Smart Interop Object Unmapped Properties custom command.

The Smart Interop Object dialog consists of the following:

  • Unmapped Properties tab - Lists unmapped properties and their associated property values.

  • Mapped Properties tab - Lists mapped properties and their associated property values. The interface name for each property is also listed.

  • Export to Excel button - Exports unmapped properties and their values to an Excel spreadsheet.

See View unmapped properties for a Smart Interop Object in the Project As-Built with HxGN SDx Help.

Custom Commands Dialog

Add Custom Command Dialog

Edit Custom Command Dialog

What do you want to do?