An engineering action provides a Java program sequence or general command sequence to use in Innovator. You can only manage engineering actions in the configuration editor.
Familiarizing Yourself with Engineering Actions
In the broader sense, an engineering action provides a Java program sequence or a general command sequence (e.g. .NET/C# or any other program) in Innovator.
More specifically, this type of action sequence (according to the description in the configuration editor) needs to have at least one engineering action.
The engineering actions included within the scope of delivery with Innovator use Innovator API interfaces for Java or .NET/C#.
In order for an engineering action to be used, it must be configured for the menu Extras>Engineering Actions>Commands.
New engineering actions appear in the interface
- Once the Reload Contents (F5) command has been run by selecting the root node and/or system model or model (that they were configured for) or
- After logging-in again.
Apart from the model administrator, only user groups which were assigned in the Execution Rights view can use engineering actions.
You can use the engineering action's logical name (in the root tab) for the API as it is language-independent.
Localized names are the choice of preference when displaying in language-dependent user interfaces. The localized name of the action is displayed as follows in accordance with the set interface language ($INOLANG):
- In the configuration editor
- In the profile tree and
- In the Edit/Properties dialog as a description of the root tab, as well as
- In the Innovator model editor in the Extras>Engineering Actions>Commands menu
Note
Assignment of execution rights for engineering actions takes place in the Execution Rights view .
Creating an Action Sequence
Prerequisites
You need to be in the Actions view in the Configuration Editor if you want to create engineering actions.
How to proceed
-
Jump to the Actions view.
-
Select the profile in the profile tree which you want to create an action sequence for.
-
If you want to create a Java action sequence, select Create>Action Sequence>Java Program Sequence or press [Shift]+[Ctrl]+[F5].
-
If you want to create a C# action sequence, select Create>Action Sequence>Command Sequence.
The action sequence is shown and selected in the profile tree. An action is automatically created and displayed in the list of profile elements. The root tab is selected in the action sequence's Edit/Properties dialog.
-
Rename the action sequence in the Name root tab. This is its logical name which can be used for the API.
-
Select the Localized Names entry in the tree on the left-hand side.
-
Enter the name for the action sequence.
-
Activate the Use Logical Name check box if you want to use them as localized names.
The name is visible in the tab once you click on Apply.
-
Select the Icon entry in the tree on the left-hand side.
-
To select the icon via a selection dialog:
-
Click on the
button in the Icon check box.The Select Icon dialog appears.
-
Select the icon group in the tree on the left-hand side and then the icon you want on the right.
-
Apply it with OK.
The icon is displayed to the right next to the check box.
-
-
To select the icon via a drop-down list:
-
Click on the
button in the Icon check box. -
Click on the icon you want in the drop-down list.
The icon is displayed to the right next to the check box.
-
-
Select the Properties entry in the tree on the left-hand side.
-
If you want to assign the action sequence to another profile, then click in the Owner row in the Value column.
The button for the selection dialog appears.
-
Click on the
button.The selection dialog appears.
-
Select the profile which you want to assign the action sequence to using the selection dialog and confirm the selection with OK.
-
Select the Description entry in the tree on the left-hand side.
-
Enter a description of the action sequence and confirm with Apply.
You have created the action sequence. The actual sequence contents consists of the added action/s.
Setting a Java Engineering Action's Properties
Prerequisites
You need to be in the Actions view in the Configuration Editor if you want to edit engineering actions.
Context
An action from the same type as the action sequence is automatically created when creating an action sequence. You can then set the properties of this action, as well as other actions in the action sequence.
Environment variables can also be used in the arguments. These are resolved by replacing the backslashes in the environment variable with forward slashes. Network paths such as \\server_name\release_name\path are exceptions here.
How to proceed
-
Select the automatically-added action from the list of profile elements.
The action's root tab is selected in the Edit/Properties dialog.
-
Enter the action's name in the Name field. The name needs to be unique within the action sequence; it does not, however, appear in the interface
-
Set the directory which contains the Location in the Working Directory field.
-
Set the class, Java archive or zip file which is to be carried out in the Location field. A class' path must be entered as a Java namespace relative to the selected working directory's bin directory. Archives are stored directly in the working directory.
-
Set the arguments for calling the action in the Arguments text box in the "option=value" syntax. (Set the virtual machine's arguments in another tab.)
-
If the application should wait until the action is closed or, in error cases, if the Inojava window closes, activate the Wait For Exit check box. This option must be selected if the action should produce a result that the application then uses (e.g. in the Innovator search too).
-
If you want to customize the execution parameters at the start of action execution, then activate the Show Arguments Dialog check box.
-
Select the Class Path entry in the tree on the left-hand side.
-
Click on the [+] button if you want to add a directory or a file.
A row is created in the Class Path table.
-
Click on the small selection arrow and on File in the submenu that appears to select a Java archive, a class or a zip archive or to create one, or on Directory to select or create a directory.
-
Select the Virtual Machine Arguments entry in the tree on the left-hand side.
-
Click on the [+] button to add an argument.
A row is created in the Arguments table.
-
Enter the argument for the virtual machine in the line.
You have defined an action.
Setting Properties for a Command Sequence's Action
Prerequisites
You need to be in the Actions view in the Configuration Editor if you want to edit engineering actions.
Context
An action from the same type as the action sequence is automatically created when creating an action sequence. You can then set the properties of this action, as well as other actions in the action sequence.
As well as programs which use the .NET API (e.g. C#), you can also use other programs or commands which run a command sequence's actions.
How to proceed
-
Select the automatically-added action from the list of profile elements.
The action's root tab is selected in the Edit/Properties dialog.
-
Enter the action's name in the Name field. The name needs to be unique within the action sequence; it does not, however, appear in the interface
-
Set the directory which should be used as the working directory for the action in the Working Directory field.
-
Set the name of the command to be run in the Location field or select the program using the selection dialog. Please ensure that the command is either entered with an absolute path or relative to the working directory, or ensure that it is in the system path.
-
Set the arguments for calling the action in the Arguments text box in the "option=value" syntax.
-
If the application should wait until the action is closed or, in error cases, if the Inojava window closes, activate the Wait For Exit check box. This option must be selected if the action should produce a result that the application then uses (e.g. in the Innovator search too).
-
If you want to customize the execution parameters at the start of action execution, then activate the Show Arguments Dialog check box.
Adding an Action to a Command Sequence
Prerequisites
You need to be in the Actions view in the Configuration Editor if you want to edit engineering actions.
Context
It is possible to add engineering actions to the action automatically created with the action sequence.
How to proceed
-
Select an action sequence in the profile tree.
-
Select Create>Engineering Action or press [Shift]+[Ctrl]+[F4].
The action is shown in the list of profile elements and selected. The action's root tab is selected in the Edit/Properties dialog.
-
Select the action's properties, as described above.
The action automatically has the action sequence type.
Related Topics
