Note: Hot Folder communication method is available in MassTransit HP only.
A Hot Folder is a folder that behaves as a mailbox for sending and receiving files between MassTransit and another application (that can also be MassTransit). The actual Hot Folder communication is configured by creating sub folders of the hot folder for the incoming and outgoing MassTransit jobs. For this purpose, you need to set both MassTransit and the other system to watch the hot folder for files.
When you send files using the Hot Folder method of communication, MassTransit transfers the files to the outgoing hot folder you designated. Instead of listening for calls, MassTransit periodically checks the incoming hot folder for received files.
Hot folders may be on local or remote network volumes. You can use hot folders with any program that recognizes incoming and outgoing jobs in hot folders.
Configuring Hot Folder Incoming Calls
As mentioned above, instead of listening for calls, MassTransit periodically checks the incoming hot folders for received files. This section provides you with detailed instructions about how to set MassTransit to check for files in the incoming hot folders.
Info: For information about available additional configurations, see the Additional Configurations section on this page.
Configuring a Hot Folder Listen
Note: MassTransit allows you to configure multiple Hot Folder listens.
Follow the steps below to set MassTransit to check for files in the incoming hot folders.
In MassTransit Administrator, open the Setup window by clicking on the Setup button from the Navigation Bar or select the Setup... option from the Window main menu.
In the Incoming Calls tab, click on the Add... button.
The "Add Incoming Call" window appears. From the Method drop-down menu, select the Hot Folder option.
The Configure Hot Folder Polling window appears. Enter how often you want MassTransit to check for files in the incoming hot folders in the field of the window.
Click on the OK button to save the changed settings. The configured Hot Folder method should appear as active in the Setup window.
Click on the OK button in the Setup window.
Enabling and Disabling the Listen
In the "Incoming Calls" tab of the Setup window, all created listens are listed. In the first column of the list, there is an indicator showing whether the listen is enabled or not.
If the indicator is green, the listen is enabled.
If the indicator is red, the listen is disabled.
To enable a disabled listen, highlight it and click on the Enable button of the "Incoming Calls" tab.
To disable an enabled listen, highlight it and click on the Disable button of the "Incoming Calls" tab.
Configuring Hot Folder Outgoing Calls
Note: You can configure outgoing Hot Folder calls on MassTransit HP only.
To connect to a contact using the Hot Folder method, you need to set it as an outgoing communication method for each contact you want.
Info: For information about available additional configurations, see the Additional Configurations section on this page.
Configuring a Hot Folder Server Contact
Note: This configuration is per contact. You need to set the Hot Folder communication method for each contact that you want to use Hot Folders.
Follow these steps for setting an Hot Folder Server contact:
In the MassTransit Administrator, open the Contacts window.
In the Contacts window, click on the Add... button to add a new contact, or highlight an existing Server contact and click Edit... to edit it.
Enter/change the desired information:
if you are creating a new Server contact, see detailed information about how to do that on the Contacts page and then continue with the steps below.
if you are editing an existing Server contact, continue with steps below.
In the Outgoing Calls tab of the Setup window, select the Hot Folder option from the Communication method drop-down menu.
The Configure Hot Folder Calls window appears.
Click on the Choose... button next to the To field in order to select an outgoing sub folder of the hot folder. This would be the place where all files that are going to be sent to the contact are stored.
Click on the Choose... button next to the Staging field in order to select a staging folder. The staging folder is the location where outgoing files are copied before being moved into the To folder.
Click on the Choose... button next to the From field in order to select an incoming sub folder of the hot folder. All files for download are going to be stored in this folder.
Under the "Options" area, there is a Create unique folder while transferring files checkbox. Selecting this option places all folders and files inside a newly created folder with a unique name to ensure that there are no conflicts with existing files. If you want duplicate folders and files to replace ones that already exist, uncheck this option and ensure that this user has Allow User To Replace Files enabled under the Security tab of the "Contact Information" window.
Note: Disabling this option may cause problems with certain workflow systems such as WAM!NET.
When you are ready with the Hot Folder configuration, click on the OK button to save the settings. If you click "Cancel", the changed settings will not be saved.
Click on the OK button in the Setup window to save the settings. If you click "Cancel", the changed settings will not be saved.
The configuration of the Hot Folder Server contact is complete.
