The Macro properties dialog can be used to specify the properties of a User Defined Macro or a System Macro. If the user does not have the 'Customization' right, the    icon will be displayed at the top right hand corner of the dialog and all fields will be disabled.


General

    • Name is the name listed in Macro Manager and the Tools - Macro Menu.
    • Description is the description displayed in the Macro Wizard. This field is optional but it is advised to describe here which functions the Macro will perform.
    • Type identifies whether the Macro is a User Defined Macro or a System Macro. Do not change the type if you are defining a Macro which is to be executed by a V-Suite CORE users. You will not be able to change the type of an existing Macro. The type will be disabled if you are modifying and existing Macro.
    • Localized Name identifies the language specific name. This property cannot be modified. Refer to the Language Glossary topic for more details.


Locking

The Locking section is only relevant to User Defined Macros. This section will be disabled if you are defining a System Macro. If the Macro will be modifying, deleting or creating Assets in a workspace which is being accessed by multiple users you should check the Lock Database option. This will instruct the Macro Wizard to lock the project prior to executing the Macro. The project will be unlocked again once finished. By locking the project you are preventing a situation were the Macro attempts to change or delete an Asset which is in use by another V-Suite CORE user. Please recognize the following limitations when executing a Macro for which the Lock Database option is set:

  • No other users can be logged into the project. You will not be able to execute the Macro if other users are logged into the project.
  • The user that executes the Macro must have the right to lock the project. If the user does not have the right to lock the project, Macro execution will be canceled.


Parameters

Parameters are only relevant to User Defined Macros. Click on the Parameter tab to enter or modify Macro Parameters.

Parameters provide input to the macro. The Parameter values must be entered by the user when the macro is executed. To add a new parameter specify the Name, Description, Type and optionally the Default Value of the Parameter and click the Add button. The parameter will be added to the parameter list. The Type of a Parameter is one of the following:

Angle

The User will be prompted to enter an angle in degrees.

Asset ID

The User will be prompted to select an existing Asset.

Asset IDs

The User will be prompted to select multiple existing Assets.

Asset Template

The User will be prompted to select an existing Asset Template (Type) e.g. "Equipment".

Boolean

The User will be prompted to enter True or False.

Diameter

The User will be prompted to enter a diameter in diameter units of measure.

Direction

The User will be prompted to specify a direction.

Distance

The User will be prompted to enter a distance/length in dimension units of measure.

Filename

The User will be prompted to browse for a filename which could be used for reading or writing purposes.

Position

The User will be prompted to specify a position.

Primitive Template

The User will be prompted to select an existing Primitive Template (Type) e.g. "Box".

String Value

The user will be prompted to specify a string e.g. "V-101"

Value

The user will be prompted to specify a number value e.g. 18

To modify an existing parameter select the parameter in the parameter list and modify its properties. Click the Update button to apply the changes.

Select an existing parameter in the parameter list and click the Delete button to delete the parameter. The order in which parameters are presented to the user when the macro is executed is the same as the order in which parameters are displayed in the parameter list box. To change the order of the parameters select the parameter in parameter list box and use the    button to promote the selected parameter or the button    to demote the selected parameter.

The values of parameters can be used in the JScript Expression. Refer to reserved global variable PARAMETERS for information on how to obtain parameter values.


JScript Expression

Click on the JScript Expression tab to enter or modify the script that will execute the commands. This will display the JScript Expression Editor. Use the editor to modify or write the JScript Expression.

If you wish to define a System Macro you must change the Type to the desired system macro type. V-Suite CORE currently support one system macro type only (Attach Assembly). Notice that an additional tab Custom Options is displayed.

More information on defining the JScript Expression and custom options for Attach Assembly Macro can be found here.