Create And Edit Custom Commands
You create a custom command by specifying how and where it appears to users, applying it to document types or folder types, and implementing its VBScript event procedures.
To create or edit a custom command:
- In Configurator, expand Commands in the configuration tree to display the existing commands.
- To delete an existing command, select the command and on the Edit menu, select Delete.
- To edit an existing command, select the command and click the Edit button.
- To create a custom command, on the Edit menu, select New Command. A new command is added to the configuration tree and its property pages appear in the right pane.
- Type or select options on the General page using the descriptions in the following table.
Option | Description |
---|---|
Display name |
Type the name of the command as you want it to appear to users as a button caption or shortcut menu item. |
Name |
A default internal name is calculated. Accept the default in most cases. |
Type command script |
Click the Meridian Enterprise Script Editor button to edit the command’s VBScript event procedures described in the Accruent Meridian Enterprise VBScript API Reference. |
Submenu name |
By default, custom command names appear on the folder or document shortcut menu together with the available Meridian Enterprise commands. To place custom commands on a submenu of the shortcut menu, type the name of the submenu as you want it to appear in the shortcut menu. All custom commands with the same value for this option will appear on the same submenu. |
Sort priority |
By default, custom command names appear grouped together on the folder or document shortcut menu and in alphabetical order. To configure a different order, type a number to set this command’s position among the other custom commands. |
Display line separator above the command |
Enable this option to display a line above this command’s name in the shortcut menu. |
Reference types affected |
If the command should also affect documents that are related to the documents that the user currently has selected, select Automatic, Manual, or both options. Automatic references are those created by the Meridian application links for AutoCAD, Microsoft Office, Autodesk Inventor, and so on. Manual references are those that users can create manually in the Meridian client applications. For more information on creating and using references, see the Accruent Meridian Enterprise User’s Guide. |
Execute recursively if applied to folders |
If enabled, this command can be run on a selected folder and the command will execute for each document in the folder and its sub-folders. |
Execute recursively for referenced documents |
If enabled (default), this command can be run on a document and the command will execute for each child reference of the parent document. |
- Click the Applies to tab. A list of the document types and folder types to which this command can be applied appears.
- Select each document type or folder type to which you want this command to be available.
- Click the Pages tab. A list of the custom property pages appears.
- Select pages that you want to appear when this command is executed, for example, to prompt the user for input before execution.
- If you want the command to only be available to the members of particular security roles, click Privileges and select the Can Execute privilege for the roles. This creates the privilege for the new command and makes it available in the Roles and Privileges dialog box as described in Create And Edit Security Roles. For more information about security roles, see Security Roles.
- Click OK to save your changes.
- To make the command appear on the shortcut menus of the document types and folder types to which you applied it in step 6, select the command on the Commands page of the document types and folder types, as described in Create And Edit Document Types and Create And Edit Folder Types.
- To add a button for the command to a property page, select the Command option when adding a panel element, as described in Configure the Property Type Of a Panel Element.