Register scripts

designation

Under this name, the script will appear later in the Actions menu, so make sure that the name is meaningful, but not too long.

Platform

Here you can specify which (code) language the script is in:

• Python: This is the default and preset for new script entries. Python Scripts are cloud ready and can also be executed in the Cloud App and the Web App. As of Vertec 6.7.0.12 only Python scripts can be registered as menu items.
• VBScript: This setting is available for backward compatibility. Vbscripts in vertec can only run in the desktop Desktop App or in non-restricted mode (on-premises). On-Premises should no longer be used.

In Vertec versions before 6.6, this field does not yet exist. In this case, the script text must start with a # if it is a Python script.

Classes

Specify here the type of objects (classes) for which the script can be executed in Vertec. The menu item appears in the Actions menu (or in the context menu) only where it was registered for. If a class is not present in the selection, it can also be typed into the field by hand. Note that class names must be capitalized.

 Versions before 6.7.0.12: Valid are all classes in Vertec Entry inheriting from the class Classes. Script cannot be registered to containers (folders).

Versions from 6.7.0.12 for scripts of a new type (see section ): All Classes in Vertec that inherit entry from the class are valid. Script can also be registered on containers (folders, Expression folders, link containers, etc.).

Display condition

Here you can specify a display condition as an OCL expression, with which you can control whether the script appears in the Actions menu (or in the context menu) or not. Click on the button with the three dots opens the Expression Editor. The result of this expression must return a Boolean Yes/No value. Only if the condition is met will the script appear in the Actions menu.

Versions before 6.7.0.12

The condition applies only to scripts on individual objects. Script configured to display on lists does not evaluate the condition. The OCL expression refers to the argobject. Example:

• verrechnet for a script that should only appear on invoices that have already been charged.

Versions from 6.7.0.12

For scripts of the new type (see section Changes since vertec version 6.7.0.12), the display condition refers to the list of selected objects (selectedobjects) In the OCL expression Editor, self of this list. Examples:

• self->size = 1 for scripts that should behave as previously scripts on individual objects. Appear only if exactly one object is selected.
• self.oclAsType(Rechnung)->select(not verrechnet)->size = 0 for an invoice script that should only appear when all selected invoices have already been charged.
• self->first.objid = xxxx for container scripts that should only be shown on a specific folder. Alternatively also possible with Entry id.
• self->collect(oclType.asstring)->asSet->size = 1 for a script to appear only if all selected objects have the same type.

Applicable to individual objects

Vertec versions before 6.7.0.12. Check this box if the script can be applied to the individual object (e.g. on an invoice).

For scripts registered before 6.7.0.12, this checkbox will be on the More Info page after updating to 6.7.0.12. See

Applicable to lists (containers)

Vertec versions before 6.7.0.12. Check this box if the script can be applied to a list of objects (e.g. to a project list).

For scripts registered before 6.7.0.12, this checkbox will be on the More Info page after updating to 6.7.0.12. See Changes since vertec version 6.7.0.12

Extended user rights

If registered scripts should later be able to be executed by users with restricted user rights, extended user rights can be accepted for the corresponding code locations. See the article Extended user rights in scripts.

Script Text

This is where the script code is inserted. See Code in scripts as menu items below.

Executing...

Script Editor...

Opens the script, if it is a Python script, in the Script Editor. The Script Editor is then linked to the Script. This means that if you change code in the Script Editor, the script text in the script will also change.