Commands defined through the RM management script.

Overview

The RM script is used to create RM management commands. The Script Inventory provides functionality for persistent storage of scripts, and for organizing them in a tree structure by means of folders, therefore enabling scripts reuse. Scripts in the inventory are like text files organised in folders. Both, folders and scripts have respectively folder-name and script-name, and also have a folder path, which locates them in the script inventory tree. There may be folders and scripts with the same names but located in different parent folders.

The folder path is formed as a sequence of the names of all parent folders starting with the root and separated with "/".

For example: <folder_1>/…/<folder_n> /<script_name>.

The Script Inventory provides means for:

• Creating folders and scripts

• Renaming folders and scripts

• Moving folders and scripts in a different parent folder

• Deleting folders and scripts (deleting a folder deletes all its content)

• Assigning icons to specific scripts

• Importing and exporting scripts and whole folders

Exporting/Importing Scripts

Script definitions and whole folder-trees can be exported as ZIP files, which can be later imported at any time.

Each ZIP file with exported scripts contains a scripts.txt file and the icon files of all scripts in the ZIP. The scripts.txt file describes the properties of all contained scripts. A scripts.txt file looks like this:

Access Rights

RM restricts access to the actions on stored scripts:

• View scripts - The right to view scripts without changing is granted to users - members of the Procedure-View(<path>) group. Members of the general parametric role Procedure-View(<path>) have view rights on all scripts and folders. In addition, users may not have general view rights, but own view rights on specific scripts and folders by becoming members of the following user groups:

  • Procedure-View(folder:folder_1/.../folder_n/myFolder) will be associated with the script folder folder_1 /../folder_n/myFolder

  • Procedure-View(proc:folder_1 /.../folder_n/myProc) will be associated with the script folder_1 /.../folder_n /myProc

    By default users having the "modify" permission for scripts have the right to view them.

• Modify scripts - The right to add, remove and modify scripts and script folders is provided to users - members of the Procedure-Manager(<path>) group. Members of the general parametric role Procedure-Manager(<path>) have modify rights on all scripts and folders. In addition, users may not have general modify-view rights, but own such ones only on specific scripts and folders by becoming members of the following user groups:

  • Procedure-Manager (folder:folder_1 /.../folder_n/myFolder) for the script folder: folder_1/.../folder_n /myFolder

  • Procedure-Manager (proc:folder-1/.../folder_n/myProc) for the script: folder_1/.../folder_n /myProc

    Modify rights on given folders allow the user to create and remove folders and scripts under the given folder.

    Modify rights on given script allow the user to edit the script.

    By default members of the administration group have the Modify right for scripts.

By default every user has Modify rights on the ROOT folder. That is why every user is permitted to create initially its folder and/or script. Every time a folder or a script is created, the system sets the user that performed the creation to become member of :

• Procedure-Manager (folder:folder_1 /.../folder_n/myFolder)

or

• Procedure-Manager (proc:folder_1/.../folder_n/myProc), having Modify rights only on the new object created.

User Interface

The Script Inventory perspective of RM UI provides graphical user friendly interface for managing scripts and folders including creation, edition, deletion, importing and exporting of ready scripts.

Script API

The Script Inventory API allows you to create management scripts in a programming way.