Skip to end of metadata
Go to start of metadata



MassTransit Actions


You can set MassTransit actions to occur before, during, and after the transfer process. Actions include such things as notifying you of a problem, copying/moving files, or running scripts. You can set up SMS or email notifications of file arrivals and other key events. You can automate processes by running scripts when events occur. MassTransit servers feature a number of  actions that can provide additional flexibility to your critical workflows, and also provide new levels of logging and notification to keep you in complete control.

The configuration of each action includes setting a trigger condition for the action to occur and a task that should be executed when the trigger condition is fulfilled. You can also configure filters with specific conditions.

Below is a list with the available actions:

  • Email notification
  • Script
  • Launch process
  • SMS notification
  • Write to log
  • Copy/Move file



Go to top


Configuring Actions

 


All MassTransit actions can be configured locally and remotely to the server through the MassTransit Administrator interface. To create or configure an action, connect to your MassTransit Server through the MassTransit Administrator. The configuration settings of the MassTransit actions are in the Actions tab of the Setup window of the MassTransit Administrator.

Options of the Actions Tab

 


    1. Open the Setup window of the MassTransit Administrator by clicking on the Setup button from the Navigation Bar or by selecting the Setup... option from the Window main menu.

    2. Open the Actions tab of the window.

        


Add a New Action


To add a new action to the list:

    1. In the Actions tab of the Setup window, click on the Add... button.

    2. In the Add Actions window that appears, enter a name for the action in the Name field.

        

    3. From the When drop-down menu, select a condition which will trigger the action.

  • for MassTransit HP:
    • Connection Completes
    • Connection Fails
    • File Transfer Fails
    • After Files Are Added
    • After Files Are Sent
    • Files Are Received
    • Before A File is Processed
    • After A File is Processed
    • Output Processing Fails
    • All Errors
    • Contact Added
    • Contact Deleted
    • Before Log Entries Are Auto-Purged
    • Before File Entries Are Auto-Purged
    • After Each File is Sent
    • After Each File is Received
    • Before Files Are Transmitted
    • Database Disk Space Low
    • Mailbox Disk Space Low
    • Periodic Event
    • License Expiring Soon
    • Files Requested
    • After Ad-Hoc Contact Is Created

      NOTE:

      The After Ad-Hoc Contact Is Created action trigger is available in MassTransit 7.2 and later. This action fires when new contacts are created as a result of files being sent to or requested from arbitrary email addresses.

    4. In the Who section of the window, you can filter the contacts the action will apply for:
         a. when the All Contacts radio button is selected, the action will apply for all contacts;
         b. if you select the Selected Contacts radio button, a list with all registered contacts and available contact groups will appear – highlight the contacts and/or groups you want to apply the action for (you can select multiple contacts and groups by holding the Ctrl key and highlighting the desired contacts; if you hold the Shift key and click on contacts, sequential records can be selected); after you have configured the desired contacts, click on the OK button. The selected contacts will appear in the field next to Selected contacts radio button.

         The available groups are:

 

  • All Application Clients – Triggers the action for all Application type contacts.
  • All Servers – Triggers the action for all Server type contacts(not including Satellite servers).
  • All Web Clients – Triggers the action for all Web Client type contacts.
  • All Satellite Servers – Triggers the action for all Satellite Server type contacts.
NOTE:

If you have selected a type of group (e.g. All Servers), when adding new contacts of that type, the configured Action will get triggered for the new contacts as well.


         The Who filter can be set for the following trigger conditions only:

  • Connection Completes
  • Connection Fails
  • File Transfer Fails
  • After Files Are Added
  • After Files Are Sent
  • Files Are Received
  • Before A File is Processed
  • After A File is Processed
  • Output Processing Fails
  • All Errors
  • After Each File is Sent
  • After Each File is Received
  • Before Files Are Transmitted
  • Files Requested
  • After Ad-Hoc Contact Is Created(This action trigger is available in MassTransit 7.2 and later.)

    5. For some of the trigger conditions you can set filters in the Filter area of the window:

        

         Filters can be set only for the following trigger conditions:

  • Connection Fails
  • File Transfer Fails
  • After File Are Added
  • After Files Are Sent
  • Files Are Received
  • After A Files Is Processed
  • Output Processing Fails
  • All Errors
  • After Each Files Is Sent
  • After Each Files Is Received
  • Before Files Are Transmitted

         a. If you click on the Set... button, the Configure Action Filters window appears. In it, you can choose the type of filter you want to set by checking the corresponding check box:

           

            i. File name – can be used along with the Path name filter;
            ii. Path name – can be used along with the File name filter;
            iii. Log message – cannot be combined with the other filters from this window.
         b. After you have selected a filter type, select the conditions that must be met from the drop-down menu next to the chosen filter. Only those files and log entries that meet the conditions will be passed to the action tasks. The following options are available in the drop-down menu:

NOTE:

You can configure multiple conditions for all three filters types using AND/OR logic.

            i. starts with – filters files/paths/log messages that start with a defined word or phrase; the phrase must be specified in the field next to the drop-down menu;
            ii. does not start with – filters files/paths/log messages that do not start with a defined word or phrase; the phrase must be specified in the field next to the drop-down menu;
            iii. contains – filters files/paths/log messages that contains a defined word or phrase; the phrase must be specified in the field next to the drop-down menu;
            vi. does not contain – filters files/paths/log messages that do not contain a defined word or phrase; the phrase must be specified in the field next to the drop-down menu;
            v. ends with – filters files/paths/log messages that end with a defined word or phrase; the phrase must be specified in the field next to the drop-down menu;
            iv. does not end with – filters files/paths/log messages that do not with a defined word or phrase; the phrase must be specified in the field next to the drop-down menu;
         c. When you are ready with the filter configuration, click on the OK button and the set filter(s) will be displayed in the Filter area.  

    6. In the Tasks area of the Add Action window, click on a button in order to select a task that will be executed when the trigger condition is fulfilled. As mentioned above, the available tasks are the following depending on the MassTransit flavor you have:
         a. for MassTransit HP:
            i. Email notification;
           iii. Script;
           iv. Launch process;
            v. SMS notification;
           vi. Write to log;
          vii. Copy/Move file;

         The task configuration is specific for each type of task. Detailed information on how to configure each task is shown below. You can add more than one Action Task for each action.

    7. When you have configured the action, click on the OK button in the Add Actions window. The action should appear in the list of the Setup window.

    8. Click on the OK button in the Setup window in order to save the changes. If you click Cancel, the action(s) changes will not be saved.


Go to top


Edit an Existing Action

 


To edit an existing action from the list:

    1. In the Actions tab of the Setup window, click on the Configure... button.

    2. In the Add Actions window that appears, edit the desired properties. Follow the steps from 3 to 8 from the Add a New Action section to configure the action.


Go to top


Duplicate an Existing Action

 


MassTransit allows you to duplicate configured actions. The duplicate actions will have the same names as the original ones but with a postfix appended. They will have exactly the same configurations and status as the action they have been duplicated from. To duplicate an action:

    1. In the Actions tab of the Setup window, click on the Duplicate button.

    2. The duplicated action should appear in the list. Click on the OK button in the Setup window in order to save the changes.


Go to top


Enable/Disable an Action

 


If you currently do not want to use a configured action, you can just disable it instead of deleting it. This way, you will be able to enable and use it whenever you decide to without having to reconfigure it.

In the first column of the actions list in the Setup window, there is an indicator showing whether the action is enabled or not.
    A. If the indicator is green, the action is enabled.
    B. If the indicator is red, the action is disabled.

To enable a disabled listen, highlight it and click on the Enable button of the "Actions" tab.

To disable an enabled listen, highlight it and click on the Disable button of the "Actions" tab.


Go to top


Delete an Action

 


In order to delete an action:

    1. In the Actions tab of the Setup window, highlight an action.

    2. Click on the Delete... button.

    3. In the window for deletion confirmation that appears, click Delete if you want to delete the action. Otherwise, click Cancel.


Go to top


Configuring Action Tasks

 


As explained above, MassTransit actions are composed of action triggers and action tasks. Action tasks are the tasks that will be performed when the trigger conditions are met.

Detailed steps for configuring each type of action are displayed below.

NOTE:

Please remember that when you configure the action task, you need to go back to the action creation steps in order to finalize the operation.



Go to top


Email Notification Task

 


Email Notification action tasks serve to send preconfigured email messages to specified contacts. MassTransit email notification can contain tokens for contact names, files to transfer, contact email addresses, date, time, etc. The tokens are replaced with live text when the email is generated. A list with all available tokens can be found on the Email Notification Tokens page.

In order to be able to send emails, you need to configure the SMTP server settings first. Then, you can configure the Email notification action task.


Follow the steps below to configure the settings for the SMTP server:

    1. Open the MassTransit.cfg file located in the MassTransit installation directory. By default, this folder is placed on the system drive in:
         a. for 32-bit machines:
            i. MassTransit HP 7.0 – C:\Program Files\Group Logic\MassTransit Server 7
            ii. MassTransit HP 7.1 and later – C:\Program Files\Group Logic\MassTransit Server
         b. for 64-bit machines:
            i. MassTransit HP 7.0 – C:\Program Files (x86)\Group Logic\MassTransit Server 7
            ii. MassTransit HP 7.1 and later – C:\Program Files (x86)\Group Logic\MassTransit Server

NOTE:

All lines beginning with "%%" in the MassTransit.cfg file are considered commented and therefore ignored. Please ensure that all settings you change are uncommented (if you see "%%" characters at the beginning of any of the settings you modify, delete them).

    2. Under the SMTP SERVER CONFIGURATION section in the MassTransit.cfg file, find the notification_smtp_server_address= setting and set it to the address of your SMTP server.

    3. Under the same section, find the notification_smtp_server_port= setting and set the port number which will be used for the communication between the MassTransit server and the SMTP server.

    4. If you have configured encryption of the entire web traffic on your web server, you should set the notification_smtp_server_secure= setting to true, as shown below. Otherwise, leave the setting to false.
          notification_smtp_server_secure=true

    5. You can configure a name and an email address that will be displayed as a sender's name and address in all emails sent by MassTransit. To do that:
         a. Enter an email address as a value of the notification_smtp_from_address= setting.
         b. Enter the name that will be displayed as a sender name in the emails to the users as a value of the notification_smtp_from_display_name= setting.

    6. Enter the user name and the password for logging into the SMTP server in order to authenticate and allow MassTransit sending emails. If you leave these settings blank, the default login credentials will be used.
         a. Enter the username for authenticating on the SMTP server as a value of the notification_smtp_auth_user= setting.
         b. Enter the password for the used in point a username as a value of the notification_smtp_auth_password= setting.

    7. After setting up the desired configuration settings, save and close the MassTransitEngine.cfg file.

    8. Restart the MassTransit services from the Services console.

NOTE:

Any time you make a change to the MassTransit.cfg file, you must restart the MassTransit services for the changes to take effect.



To configure an email notification task:

    1. In the Add Actions window, click on the first button from the Tasks area:

        

    2. The Configure Email Action window appears next:

        

In MassTransit 7.2 and later the Configure Email Action window contains a From field.

        

    3. In the To field of the window, you can specify the email notification receiver by entering his email address:
         a. you can leave the To field empty and check the Include Contact Email Address When Available check box below – this will make the email notification available for sending to all contacts. If you want to apply this action for all contacts, you need to use this option.
         b. if you specify the receiver's email address in the To field, it will be sent only to the configured address; you may add multiple email recipients by separating addresses with a semi-colon; you can also have the Include Contact Email Address When Available check box checked.

    4. In the From field of the window, you can specify the email notification sender by selecting one of the three available options:
         a. you can configure the From field to use the sender email address, specified in the MassTransit.cfg file. To do so please select the first available option:"Use default email address specified in the MassTransit.cfg file".
         b. you can configure the From field to "Use originating user email address if available" by selecting this option in the menu.
         c. you can configure the From field to "Use custom email address:", if you choose this option you can specify the desired sender email address in the field available. You can actually add multiple email senders by separating the address with a semi-colon.

    5. In the Subject field of the "Configure Email Action" window, you can enter a subject for the email that will be sent when the action is triggered:
         a. if you leave the Subject field with the default option or if you leave it blank, the automatic message from MassTransit will be applied;
         b. if you modify the Subject field, the entered message will be displayed as a subject of the sent emails. You can also enter MassTransit tokens in the email subject in order to include the contact name, contact email address, date, time, etc. The tokens are replaced with live text when the email is generated.

INFO:

See the full list with available tokens that can be used in the Subject field on the Email Notification Tokens page.

    6. In the Message field of the window, enter text to be displayed in the sent email notifications.
         a. if you leave the Message field with the default option or if you leave it blank, the automatic message from MassTransit will be applied;
MassTransit 7.2 and later does not apply automatic message to the Message field when left blank.
         b. if you modify the Message field, the entered text will be displayed in the message body of the sent emails. You can also enter MassTransit tokens in the email subject in order to contact name, contact email address, date, time, and file transfer information such as number of files, length of transfer, size of transfer, etc. The tokens are replaced with live text when the email is generated.

INFO:

See the full list with available tokens that can be used in the Message field on the Email Notification Tokens page.

    7. If you check the Include File List check box, a list with files will be included in the message body when applicable.

    8. If you check the Include Error Messages (When Available) check box, a list with all errors will be included in the message body if they occur.

    9. When you are ready with the email notification task configuration, click on the OK button to save the task. The task should appear in the Tasks area of the Add Actions window.

    10. Go back to the action creation steps in order to finalize the action configuration.

Go to top


Script Task

 

Script action tasks are designed to execute a predefined script when an event occurs. For example, you can use a script which lets you know when files are ready to be sent so that you can review the list of files and make changes.

You can use example scripts for MassTransit which can be downloaded from the Group Logic's web page or you can create your own to perform Actions. The scripts used must be Visual Basic scripts (with *.vbs filename extension) or JavaScript scripts (with *.js filename extension).

NOTE:

Because MassTransit stores passwords in encrypted form, it cannot provide a contact’s remote login password in clear text for use in scripts. Scripts that ask for the password must be updated to reflect this change.

To configure a script task:

    1. In the Add Actions window, click on the third button from the Tasks area:

        

    2. The Choose Script window appears next:

        

    3. Click on the Choose... button and select a script file (*.vbs or *.js file), then click OK.

    4. When you have chosen a script, click OK in the Choose Script window. The task should appear in the Tasks area of the Add Actions window.

    5. Go back to the action creation steps in order to finalize the action configuration.


Go to top


Launch Process Task
NOTE:
 

The Launch Process action task is available to users running MassTransit HP Server. This type of action task enables users to configure an action that launches other programs and scripts. Programs and scripts launched by MassTransit launch process actions run in the same fashion as the MassTransit Engine. They run as the same user as the MassTransit service, with the same permissions. They do not have any user interface to display dialogs and prompts.

NOTE:

You should not configure processes and scripts that have any user interface or require user input of any kind to complete.

Launch Process action tasks enable greater flexibility because users may configure the action task to run a variety of different executable file types. Since MassTransit data is accessible externally via MySQL, users may use Launch Process action tasks to create custom MassTransit workflows more easily by using a variety of languages that include MySQL support such as Python and Perl.

When a Launch Process action task has been triggered to run, MassTransit will do the following:

  • Launch the specified executable file
  • Pass a standard set of command line arguments to the file
  • Define a standard set of predefined environment variables
  • Define any additional environment variables that the user specified during configuration of the action task

To configure a launch process task:

    1. In the Add Actions window, click on the fourth button from the Tasks area:

        

    2. The Configure Launch Process Action window appears next:

        

    3. Within the "Configure Launch Process Action" window, click the Choose… button to select the executable file that MassTransit will launch when the action is triggered. After selecting the desired executable file, click the Select button. Within the "Configure Launch Process Action" window, the file name and path should now be displayed in the "Selected Executable" text field.

    4. In addition to the standard set of command line arguments and predefined environment variables that MassTransit always provides to the executable file, users have the option to define additional environment variables that may be accessed by the executable file.
         a. If additional environment variables are not needed for the executable file to run as desired, then click the OK button to complete configuration of the action task and proceed directly to step 6.
         b. If additional environment variables are needed for the executable file to run as desired, then please follow the steps below.

    5. Click the Add... button to add an additional environment variable:

        

         a. In the Edit Environment Variable window, enter the name of the variable and the corresponding value that MassTransit should assign to that variable. Please note that the Value field cannot be left blank.
         b. When done entering the information, click the “OK” button to save the environment variable.
         c. In the "Edit Environment Variable" window, the list of environment variables should have refreshed to include the environment variable that was just defined. At this point, users may either:
            i. Add additional environment variables by following the instructions in steps a and b above;
            ii. Edit or remove environment variables currently in the list by highlighting the corresponding row in the list and then clicking either the Edit or Remove button to perform the desired function;

    6. Save the current configuration by clicking the OK button in the Configure Launch Process Action window. The configured action task should appear in the Tasks area of the Add Actions window.

    7. Go back to the action creation steps in order to finalize the action configuration.


Predefined Command Line Arguments:

Argument #

Contents/Value

        1

Comma-separated list of file IDs that are related to this event
(will return 0 if there are no related files)
* Relevant table in MT DB: "dfiles"

        2

Contact ID of the contact that the event triggered for
(will return 0 if there was not a contact related to the event)
* Relevant table in MT DB: "dclient"

        3

ID of any related log entry
(will return 0 if there are no related log entries)
* Relevant tables in MT DB: "dlog" and "dlogmsgs"

        4

ID of any related job ticket
(will return 0 if there are no related job tickets)
* Relevant table in MT DB: "djob"

        5

Which MassTransit event triggered this action
(will return a numeric digit, please refer to the key below)

1) Connection Completes
2) Connection Fails
3) File Transfer Fails
4) After Files are Added
5) After Files are Sent
6) Files are Received
7) Before a File is Processed
8) After a File is Processed
9) Output Processing Fails
10) All Errors
11) Contact Added
12) Contact Deleted
13) Before Log Entries are Deleted
14) Before File Entries are Deleted
15) After Each File is Sent
16) After Each File is Received
17) Before Files are Transmitted
18) Database Disk Space Low
19) Mailbox Disk Space Low

* File ID, Contact ID, Log ID, and Job Ticket ID are all referring to specific columns within the MySQL database schema that stores MassTransit data.


Accessing the Command Line Arguments:
How the above-referenced command line arguments are accessed will vary depending on the language that was used to develop the executable file.

For C/C++ files, users may access the arguments using the usual argv/argc mechanism. For shell script files (like SH), the arguments will typically be specially defined environment variables (in BASH for example they are available as $1, $2, $3, $4, and $5 respectively).


Predefined and User-defined Environment Variables:

Variable Name

Contents/Value

MT_DBHOST

IP or DNS address of the MySQL server hosting the MassTransit
database; same value as the DATABASE_HOST in the
MassTransitEngine.cfg file

MT_DBNAME

Name of the MassTransit database; same value as the
DATABASE_NAME in the MassTransitEngine.cfg file

MT_DBUSER

Name of the MySQL user account that MassTransit uses to
connect to the database; same value as the DATABASE_USER in
the MassTransitEngine.cfg file

MT_DBPASSWD

Password used to connect to the database using the MySQL user
account specified above; same value as the
DATABASE_PASSWORD in the MassTransitEngine.cfg file



Accessing the Predefined and User-defined Environment Variables
How the above-referenced predefined environment variables are accessed will vary depending on the language that was used to develop the executable file.

For example, BASH environment variables are the name of the variable prefixed with a dollar sign ($), so "$MT_DBHOST" (without the quotes) would be used to access the predefined environment variable "MT_DBHOST".

User-defined environment variables (configured by the user in the MassTransit Administrator application – step 5 above) may be accessed in the same way that predefined environment variables are accessed.


When running interpreted scripts (e.g. Perl scripts, Python scripts, PHP scripts) using this feature, your Windows file associations will need to be properly configured to ensure that MassTransit can call the appropriate file interpreter for the script.

A good way to test that the associations are set correctly is to run the script at the Windows command line and see if the script runs properly.

    1. Find the path to the script (e.g. c:\scripts\myscript.py).

    2. Open the Windows command line.

    3. Enter the full path to the script in quotes and press enter (e.g. "c:\scripts\myscript.py"):
         a. if the script runs correctly, MassTransit action tasks for that script should work properly;
         b. if the script does not run or runs unexpectedly, you can use the following commands to determine and set the file associations:
            i. enter the following command at the command line:
               assoc [EXTENSION],
               where [EXTENSION] is the extension of your script (e.g. assoc .py). You should see the type of the file as recognized by Windows (e.g. .py=Python.File).
            ii. to determine the actual command used to launch that file type, enter the following command at the command line:
               ftype [FILETYPE],
               where [FILETYPE] is the type listed by the assoc command (e.g. ftype Python.File). You should see the command that will be used to launch files of that type (e.g. "Python.File="C:\Python\python.exe "%1" %*).
         c. if your association or file type are not set or are incorrect, you should try reinstalling your script interpreter. The interpreter installer generally has an option for configuring file associations. If this does not solve the problem, you can use the assoc and ftype commands to manually set associations.

If you follow these instructions and are still having problems getting your scripts and programs to run as MassTransit action tasks, please contact Group Logic technical support.

INFO:

On the Launch Process Action and Web Service Integration page, you can find information on how to trigger notifications from MassTransit to an external web service using the Launch Process action and a script.



Standard file settings for Launch Process action task

If the executable you've configured to launch has standard output or generates error messages, you can also configure MassTransit to save those in text files in a specific location. By default this location is the same as the location of the executable or the batch file. These settings are located in the MassTransitEngine.cfg file, normally located in:
         a. for 32-bit machines:
            i. MassTransit HP 7.0 – C:\Program Files\Group Logic\MassTransit Server 7
            ii. MassTransit HP 7.1 and later – C:\Program Files\Group Logic\MassTransit Server
         b. for 64-bit machines:
            i. MassTransit HP 7.0 – C:\Program Files (x86)\Group Logic\MassTransit Server 7
            ii. MassTransit HP 7.1 and later – C:\Program Files (x86)\Group Logic\MassTransit Server

  1. Open the MassTransitEngine.cfg file.
  2. Locate the following lines:
    %% actions_stdout_redirect=C:\TMP\STDOUT.TXT – This file contains any text output from the process.
    %% actions_stderr_redirect=C:\TMP\STDERR.TXT – This file contains any error messages from the process.
  3. Uncomment the lines you need by removing "%%".
  4. Replace the default paths with paths of your choice.



Troubleshooting:

Problem: Nothing happens when the Launch Process action task should have triggered

Solution:
First, ensure that the executable file can be run manually (outside the context of MassTransit) and achieve the desired results before attempting to run the executable file in a MassTransit Launch Process action task. If the executable file does not run as expected outside the context of MassTransit, then it may be one of two common issues:

  1. Ensure that the executable file is using UNIX line endings (the file may have Macintosh or DOS/Windows line endings which are preventing it
    from running properly). Text editors often have default line break/ending settings that may need to be adjusted to specify that UNIX line endings should be used.
  2. Ensure that the executable file has the proper file permissions. At a minimum, the user account that MassTransit is running within will need read & execute permissions for the executable file.



Go to top


SMS Message Notification Task

 

 

SMS Message Notification tasks send text messages to your mobile phone using standard SMS delivery.

To configure it:

    1. In the Add Actions window, click on the fifth button from the Tasks area:

        

    2. The Configure SMS Message window appears next:

        

    3. In the Message field, enter the custom text message that you wish to send to the mobile phone of your choice. The message may be 140 characters in length unless Generate Multiple SMS Messages If Message Exceeds 140 Characters is checked.

    4. Check the Generate Multiple SMS Messages If Message Exceeds 140 Characters check box, if you want multiple messages to be sent when the message text (entered in step 3 above) exceeds 140 characters. MassTransit will automatically span your text across multiple text messages, until message delivery is complete.

    5. In the Phone Number field, enter mobile telephone number of the recipient.

    6. From the Cell Carrier area, select the recipient’s mobile carrier by clicking on the appropriate radio button. The available options are the following:
         a. AT&T;
         b. Cingular;
         c. Nextel;
         d. Sprint;
         e. T-Mobile;
         f. Verizon.

    7. Click the OK button to save these changes. The configured action task should appear in the Tasks area of the Add Actions window.

    8. Go back to the action creation steps in order to finalize the action configuration.

NOTE:

Please note that standard text messaging rates may apply to message recipients. Please check with mobile carriers for additional information.



Go to top


Write to Log Task

 

 

Using the Write to log action task, you will have the flexibility to customize log messages. With this feature, you may have user-configurable text appear within the standard MassTransit Administrator Log window when the Who and When conditions are met.

To configure it:

    1. In the Add Actions window, click on the sixth button from the Tasks area:

        

    2. The Configure Write To Log window appears next:

        

    3. In the Message field, enter the custom text message that you wish to be displayed in the MassTransit Administrator Log window.

    4. From the Entry Type area, select the type of the custom log message entry to choose when you would like your custom message to appear by clicking on the appropriate radio button. The available options are the following:
         a. Error;
         b. Connection;
         c. File Transfer;
         d. Output;
         e. Notification;
         f. Summary;
         g. Info.

    5. From the Severity area, select the severity of the custom log message entry:
         a. Error;
         b. Warning;
         c. Info.

    6. Click on the OK button when you are ready with the action task configuration. The configured action task should appear in the Tasks area of the Add Actions window.

    7. Go back to the action creation steps in order to finalize the action configuration.


Go to top


Copy/Move File Task

 

 

Using the Copy/move files action task, you can copy and move files to a destination of your choice, without the need for a Service. This feature eliminates the necessity of remote servers configuring "Print to" and "Output to" folders to comply with your internal workflow. When this feature is enabled, MassTransit will automatically move or copy files to the specified destination when Who and When events are configured.

To configure it:

    1. In the Add Actions window, click on the last button from the Tasks area:

        

    2. The Configure Copy/Move Files window appears next:

        

    3. Click on the Choose... button and select a destination location. This will be the location where files will be copied/moved into.

    4. From the Operation area, select the operation that will be performed on the files by clicking on the corresponding radio button:
         a. Copy Files – this option will make an exact copy in the remote destination of choice, while keeping the original file in the Received mailbox folder.
         b. Move Files – this option will send the file to the remote destination of your choice, while removing the original file from the Received mailbox folder.

    5. If you check the Replace Existing Files In Destination Folder check box, files with the same names will be replaced automatically. Otherwise, an error message will appear stating that files cannot be copied/moved.

    6. Click on the OK button when you are ready with the action task configuration. The configured action task should appear in the Tasks area of the Add Actions window.

    7. Go back to the action creation steps in order to finalize the action configuration.

Pitfalls With The Copy/Move Files Action Task

One possible problem with the Copy/Move Files action task is that when an event happens no files are copied or moved. This usually occurs because the event that the task is configured to trigger on does not have any files associated with it. For example, there are never any files associated with the “Contact Added” event, so a Copy/Move Files action task will have nothing to do if it is configured to fire on this event. The list below shows the MassTransit events that may have files associated with them:

  • After Files Are Added
  • After Files Are Sent
  • After Files Are Received
  • Before A File Is Processed
  • After A File Is Processed
  • Output Processing Fails (May or may not have file associated with the event depending on what the error is and when it occurred)
  • Before File Entries Are Deleted
  • After Each File Is Sent
  • After Each File Is Received
  • Before Files Are Transmitted
  • File Transfer Fails (May or may not have file associated with the event depending on what the error is and when it occurred.)

If you configure this type of task to run for other MassTransit triggers, no files will be moved or copied.

Broken Workflows

Another common problem with the Copy/Move Files action occurs where its use causes a workflow to break. Usually the cause of the problem is that the action task has been used to move files to a different folder and that MassTransit or some other component of the workflow can no longer find these files.

For example, consider the situation where you have a Copy/Move Files action task configured to trigger “after files are added” and to move the files to a folder at /tmp/a_folder. When files are then added to MassTransit the action will fire and move all of the added files to /tmp/a_folder. When MassTransit later connects to send the added files it will not be able to find them because they have been moved and will therefore generate a “File Not Found” error for each missing file. Similar problems can occur in workflows that use forwarding or services if move actions are configured to trigger “after files are received”.

In general, it is safest to use the copy files action task to avoid moving files that are needed by later steps in the workflow. Please assess your workflow carefully before using the move files action task to avoid errors.


Go to top


License Expiration Action Event Settings

 


You can set up an action to remind of the expiration of your MassTransit Server license. The action can be activated from the Actions tab in the Setup window in MassTransit Administrator. For advanced configuration of the action, you can edit the following settings located in the MassTransitEngine.cfg file which is normally located in:
         a. for 32-bit machines:
            i. MassTransit HP 7.0 – C:\Program Files\Group Logic\MassTransit Server 7
            ii. MassTransit HP 7.1 and later – C:\Program Files\Group Logic\MassTransit Server
         b. for 64-bit machines:
            i. MassTransit HP 7.0 – C:\Program Files (x86)\Group Logic\MassTransit Server 7
            ii. MassTransit HP 7.1 and later – C:\Program Files (x86)\Group Logic\MassTransit Server

Before they can take effect you need to uncomment them by removing the '%%'.

The following setting specifies (in days) how far in advance of license expiration the "license expiring soon" actions will fire:
%% LICENSE_EXPIRATION_WARNING_PERIOD = 14
The default is 14 days. Note that the action will NOT fire once the expiration date is passed.

The following setting specifies whether license expiration warning events should fire only once or once a day until the license is updated:
%% REPEAT_LICENSE_EXPIRATION_WARNING = true
If true, "license expiring soon" events will fire once a day starting with the number of days in advance specified by LICENSE_EXPIRATION_WARNING_PERIOD. The default is true.

NOTE:

When you make changes to the MassTransit configuration files you need to restart the MassTranist services for the changes to take effect. The correct way to do this operation is to stop the MassTransit Transporter service, restart the MassTransit engine and start the MassTransit Transporter again.



Go to top