Provides you with 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.
The Command Wizard helps you to build a custom command. For example, the first Command Wizard step prompts you to identify general information, including command name, project name, author, and company. You can start the wizard in Visual Studio by clicking Command Wizard on the Add-Ins menu. For information about installing the Command Wizard and other programming resources, refer to the PPM Smart Community.
After adding a custom command in the 3D software, you can edit it. The Edit Custom Command dialog 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:
Custom command |
ProgID |
Description |
---|---|---|
Check Database Integrity |
SP3DCheckDatabaseIntegrity. |
Creates records for the objects that need to be cleaned. You run this custom command directly on a database (site, catalog, or model). After you run this command, you can generate a report to review the errors that the Check Database Integrity Command generated. See the Database Integrity Help. |
Clean Database |
SP3DCleanDatabaseCmd. |
Deletes or cleans an object. This command is used when an action on the Check Database Integrity report is To Be Removed or To Be Repaired. See the Database Integrity Help for information on deleting and cleaning objects in the database. |
Create Drawing View |
MenuDrawView. |
Saves and converts the contents of a three-dimensional graphic view window into a snapshot view. The 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 > Hide command to avoid displaying certain objects, those objects are included in a composed drawing you create. You must have appropriate permissions to access composed drawing types, or you cannot use the Tools > Snapshot View command. 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 > Drawing Console Command. |
Drawings Check and Repair Utility |
DwgCheckUtility,Ingr.SP3D. |
Opens the Drawings Check and Repair Utility. The Repair Drawings tab enables you to check drawing items for problems, such as mismatches or duplicates of views, smartframes, and OIDs, and invalid dimensions with missing smartframe attributes. Select Repair to fix any problems. The Update Drawing Templates tab enables you to save updated templates to a specific folder, and updates all templates in that folder to the latest version. This command is intended for use by your administrator. |
Find Object by OID |
SP3DFindObjectByReport. |
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 for information on the Find Objects by OID custom command. |
Fix Project Root |
SP3DPRJMGTRepairCmd. |
Synchronizes the model name in the Model database and the Site database. The name in the Site database prevails. You must run this command from a task in the model, not from Project Management. |
Fix Sector Size of Documents |
DwgBinaryEditorCmd. |
Adjusts the sector size from small to large. Documents that have many sheets and a small sector size can cause the software to run out of memory. |
Reset Design Basis Time |
IMSEngFrameworkCmd. |
Modifies the Design Basis timestamp. With this command, you can set the time and date back to a point in the past. This command is useful if, for any reason, there are delete instructions that could not be processed. |
Synchronize Drawing Component Templates |
DwgSynchTemplatesCmd. |
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, the source component must have a template, 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. |
Verify P&ID Integrity |
SP3DDisplayPIDService. |
Validates the internal connections between objects on a P&ID and objects in the Model database. This command is useful when there is a problem displaying a P&ID or selecting objects on a P&ID. The command provides some basic troubleshooting statistics: Number of design basis objects, number of 3D objects (correlated), number of P&ID objects, number of deleted P&ID OIDs, and number of duplicate OIDs. |
What do you want to do?