Distribution Job

A Distribution Job is a one-time data transfer from a source endpoint to selected destination agents. A Distribution Job run can be launched manually or triggered automatically based on a predefined schedule. Distribution Job is commonly used for delivering software updates or important documents to remote workstations.

Create a Distribution Job

To create a Distribution Job:

In the Management Console , from the top menu, select Jobs.
Select Configure Jobs , then click + CREATE NEW JOB.
Select Distribution , then click Next.
On the DETAILS tab:
1. Enter the name.
2. Enter the optional description that will help understand the purpose of this Job, then click Next.
On the SETTINGS tab:
1. Select Job's priority.
  Note : Job priority determines the order in which the Agent handles its data transfers queue. High priority Jobs' transfers are handled first. While the lower priority Jobs are waiting for their transfer window, the Agent is performing non-transfer related tasks such as indexing files or merging the folder tree. In case of multiple Jobs with the same priority, their data transfers are performed simultaneously. For more information, see Job Priority.
2. In the File retention and deletion settings section, select what to do with the source files after a successful Job run:
  - Default behavior - do not delete the files from the source(s) - Source files remain intact after the Job run finishes.
  - Delete files from the source(s) and move them to archive for x days - Agent will remove the files from the source folder and place them in an archive folder in the .sync. Archived files are deleted from the file system, without being moved to the recycle bin, after the specified number of days.
  - Delete files from the source without archiving - Source files are deleted after the Job run finishes.
    
    For more information, see Deleting files from source after transfer in distribution Jobs.
3. In the User groups section , click + ADD USER GROUP , then select a group. Click Add and choose access level to the Job:
  - View only - Permission to view the Job on the Jobs list and access its status information.
  - Run - Permission to initiate a Job run (applicable to Distribution, Consolidation and Script Jobs).
  - Edit & Run - Permission to edit the Job's configuration and initiate Job runs. Users with Edit & Run permission cannot delete a Job.
  - Full Access - Permission to edit and delete a Job as well as initiate Job runs.
4. Click Next.
On the PROFILE tab, select Job settings - a pre-defined set of parameters that fine-tunes the Job run, then click Next.
Tip : Select Unique for this Job to customize profile settings specifically for the Job being set up.
On the SOURCE AGENT tab:
1. Select an individual agent, a High Availability group or a Speed Scaleout group, that stores the source files to be distributed.
2. Click Specify path.
3. Select storage location option:
  - Direct path - Provide a direct, absolute path to the Job folder.
  - Storage connector - Select a previously defined cloud storage connector or add a new one. For details, see Setting up cloud storage and configuring Jobs.
  - %FOLDERS_STORAGE% - A special path macro pointing to agent's default storage folder location.
    Note : Select Ask user to prompt the user in the Agent UI to select folder upon initializing the Job.
  - %DOWNLOADS% - A path macro pointing to downloads folder location. The path that the macro is resolved to depends on the operating system the Agent is running on. For details, see Path macros.
  - %HOME% - A path macro pointing to the home folder location. The path that the macro is resolved to depends on the operating system the Agent is running on. For details, see Path macros.
  - %USERPROFILE% - A path macro pointing to user profile folder location. The path that the macro is resolved to depends on the operating system the Agent is running on. For details, see Path macros.
    1. (Optional) Select Choose on start to allow Partner Group users to select source files and folders when they start a Job run.
      Note : Applicable to Direct path and Storage connector types. This option is available in Resilio Active Everywhere 5.0.1 and newer.
4. Enter folder's path or click Browse to browse the file system and select the source folder location.
  Note : If you enable Choose on start , the Path that you provide will be the root directory when browsing the file system to select files. Users won't be allowed outside the specified path.
5. Click Save , then click Next.
On the DESTINATION AGENTS tab:
1. Select individual destination agents or agent groups.
2. Click Specify path to select path or click the suggested path to modify it.
3. Select storage location option:
  - Direct path - Provide a direct, absolute path to the synchronization folder.
  - Storage connector - Select a previously defined cloud storage connector or add a new one. For details, see Setting up cloud storage and configuring Jobs.
  - %FOLDERS_STORAGE% - A special path macro pointing to agent's default storage folder location.
    Note : Select Ask user to prompt the user in the Agent UI to select folder upon initializing the Job.
  - %DOWNLOADS% - A path macro pointing to downloads folder location. The path that the macro is resolved to depends on the operating system the Agent is running on. For details, see Path macros.
  - %HOME% - A path macro pointing to the home folder location. The path that the macro is resolved to depends on the operating system the Agent is running on. For details, see Path macros.
  - %USERPROFILE% - A path macro pointing to user profile folder location. The path that the macro is resolved to depends on the operating system the Agent is running on. For details, see Path macros.
4. Enter destination folder path, or click Browse to browse the file system and select the destination folder location.
5. Click Save , then click Next.
On the TRIGGERS tab:
1. Select an event that will trigger a script run:
  - Before file-indexing begins - When you create a Job, the first thing the source Agent does is indexing files in the specified folder. This option enables running a script before the indexing begins. The script can, for example, scan the folder and remove irrelevant, temporary files that are output automatically along essential artifacts.
  - Before finalizing download - With this option enabled, destination Agents download the files to a temporary location before they're moved to the destination folder. This script can, for example, adjust file permissions in the destination folder so that the existing files can be replaced with the new ones.
  - After an agent completes downloading - With this option enabled, each destination agent runs the given script after it finishes downloading the files from the source Agent, without waiting for other destination Agents to finish their downloads.
    Important: We highly recommend not to remove or update the distributed files with scripts initialized by this trigger. Otherwise, the file will have to be re-downloaded from the source Agent.
  - After all agents complete downloading - The script initialized by this trigger is run on both the source and the destination agents, after all destination agents finish downloading files.
2. Provide the script for each operating system in use. For more information on scripts, see Scripts.
3. Click Next.
  Note: Scripts won't run on Resilio Agents with the limited user option enabled.
On the JOB SCHEDULER tab, select if you want to run this Job manually, or if it should run periodically.
- Run manually - Job run will be initialized manually.
- Run at - Initialize Job run on a specified date and time.
  Note: The Job run will be initialized at the Agent's local time. A scheduled Job run will start only if the previous one has been completed no later than 5 minutes after the scheduled run time. For example:
- A Job run is scheduled for 11:00 AM, but the Job run launched manually finished at 11:04 - the scheduled Job run will be initiated.
- A Job run is scheduled for 11:00 AM, but the Job run launched manually finished at 11:06 - the scheduled Job run will not be initiated.
- Run every N minutes/hours/days - The Job run will be initialized at a specified frequency. You can define start and end date of this scheduled Job runs. In case the current Job run isn't finished on time (before it's time for the new run), the consecutive run is initialized right after the current Job run completes.
- Repeat weekly/monthly - Initialize Job runs on specific weekdays or days of the month.
  Note: The Job run will be initialized at the Agent's local time. A scheduled Job run will start only if the previous one has been completed no later than 5 minutes after the scheduled run time. For example:
  - A Job run is scheduled to start daily at 11:00 AM. The Job run started on Monday, completes on Tuesday at 11:06 AM - the next Job run will be initialized the following day at 11:00 AM.
  - A Job run is scheduled to start daily at 11:00 AM. The Job run started on Monday, completes on Tuesday at 11:04 AM - the next Job run will be initialized immediately.
Note: You cannot enable the Job scheduler with the Choose on start option selected.
On the NOTIFICATIONS tab:
1. Click + ADD NOTIFICATIONS.
2. From the Trigger drop-down list, select an event that will trigger notification.
3. (Optional) Click Skip notice if Jobs did not transfer files to disable notification in case there were no files transferred during the scheduled Job run.
4. Click + ADD RECIPIENT and select one of the options:
  - Add me - Add the currently logged in user.
  - Add user - Add another Resilio user.
  - Add e-mail - Add an email address of the recipient.
  - Add webhook - Add a predefined webhook URL.
5. Click Save , then click Next.
On the SUMMARY tab, verify your Job's configuration, then click Save.