Metis Action Editor
The Metis action editor enables the addition of actions to the events in the Metis workflows.
The home page of the Metis action editor is shown below.
When you select one of the listed workflows, you are taken to an editor that is similar to the workflow editor but now the focus is on assigning actions to a workflow's events and editing the parameters of each action. A number of actions can be assigned to a workflow's events. These actions include the following:
Bind Role to User or Group
The bind role action binds a particular role to a group or a user. For example, it binds a role reviewer to a particular user.
The above example assigns roles to different groups, based on the area attribute. Hence if area is set to archive then its bound to group subcommitteeA. New mappings can be assigned to the same attribute, for different attribute values, by clicking on the New Mapping button.
Cancel a Timer
The cancel timer action cancels a previously set timer.
Here the Name attribute is the name of the timer that had been set.
Create a User
The create user action creates a user based on the parameter values that were entered for the event when it was published. This action has two parameters userEmail and userName. The values for these parameter are set by the attributes of the corresponding event.
Retrieve Contents of URL
The download URL action has two parameters, destination and url. Here the user specifies the url of the file to be downloaded. The destination parameter is the destination of where this file should be stored.
In the above example the url is set to :url, this implies that the url is to be retrieved from the event attribute url, at the time the event is published.
Get Files on FTP Server
The ftp get action gets the file from a particular ftp directory. Here the user needs to specify the following parameters:
- fileToGet: The name of the file to download from the ftp server.
- login: The user login for this ftp server.
- passive: Defaults to false
- password: The password of the user, for this ftp server.
- remotedir: The directory on the ftp server, from where the file is to be downloaded.
- server: The name of the ftp server to connect to.
Put Files on FTP Server
This action puts a specified file on the ftp server. Its attributes are similar to the one above, except that now you specify the fileToSend.
Extract GZip Archive
This action gunzips a specified file. This action has 2 parameters: dest and src. Here the src parameter specifies the .gz file thats to be extracted. The dest parameter is the path where the file should be extracted to.
Gzip a File or Directory
The gzip action has 2 parameters: src and dest. Here the src parameter specifies the srouce file that needs to be compressed, while the dest parameter is this file with its .gz extension.
Move a file to a new directory
The move action moves a specified file to another directory. This action has 2 parameters: file and todir. Here the file parameter specifies the file that needs to be moved. The todit parameter is the new directory where the file needs to be moved to.
Send Email Notification
The send email notification action when executed, sends an email message to the specified email address. This action has no parameters. It takes the information for each user from the user registry. Users need to be assigned to this action, by selecting a user or a group and then clicking on the Add User button.
The body of this email notification includes information about the event that was published and the value of its attributes at that time. In the above example the notification is sent only to the admin.
Send Formatted Email
The send formatted email notification has 2 parameters: subject and template. The subject field will display this value entered as the subject for the email notification. On selecting a particular template from the list, and then clicking on Update Fields, gives a list of fields from the template that need to be assigned a value. Hence in the case of send formatted email, templates are created and the message body contains information from this template. Here also the users need to be assigned to the action. The email notification is only sent to these users.
In the above example the fields belonging to the template, that need to be filled are FIRSTNAME and URL. The values assigned to these fields is taken from the event attribute values and the user profiles. Also the above notification is only sent to the admin.
Set a Timer
This action sets a particular timer for the event to be published. Hence when the timer expires, a particular event is published. The set timer action has the following parameter:
- Deadline: This can be specified from the event attribute value or a specific date can be specified.
- Event: This parameter specifies which event should be published when the timer expires.
- Name: The name assigned to this timer.
- attribute.id: The id value here is the id of the event for which this action is executed.
Tar a File or Directory
The tar action tars a given file or directory. It has 2 parameters: basedir and tarfile. The basedir parameter specifies the base directory from which to add files to the tar file. The tarfile parameter, specifies the tar file to be created.
Extract Tar Archive
The untar action has 2 parameters: dest and src. The dest parameter specifies the destination directory, while the src parameter specifies the tar file to expand.
Extract Zip Archive
The unzip action has 2 parameters: dest and src. The dest parameter, specifies the destination directory, while the src parameter specifies the file to expand.
Zip a File or Directory
The zip action has 2 parameters: basedir and zipfile. The basedir specifies the base directory from which to add files to the ZIP file. The zipfile parameter specifies the name of the ZIP file to create.
