Skip to content

Synchronization Job

Synchronization Job is a continuous, two-way file transfer across multiple agents, or it can be set up as a one-way synchronization. It allows you to create an exact copy of a folder and its contents on multiple endpoints. Every change within the specified folder is instantly replicated across all participating agents. Use the Synchronization Job to create backups in real- time or facilitate a continuous files exchange. The Synchronization Job has only one Job Run.

Create a Synchronization Job

To create a Synchronization Job:

  1. In the Management Console, from the top menu, select Jobs.
  2. Select Configure Jobs, then click + CREATE NEW JOB.
  3. Select Synchronization, then click Next.
  4. 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.

  5. On the SETTINGS tab:

    1. Select Job's priority.

      Job priority

      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. (Optional) Enable File Locking and adjust its parameters:

      • File lock timeout - Locked file idle time after which the lock server releases a locked file.

      • Locked files update interval - Time interval between locked file's status check.
        Note: For optimal performance, we recommend leaving the default value unchanged.

      • When Agent is not connected to Lock server - Access level to shared files when the locking server is unavailable.

      • Ignore locks for these files and folders - A regular expressions (PCRE2 syntax) to match files and folders that you want to exclude from locking. Add each regular expression in a separate line.

    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.

  6. 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.

    Mc Configure Job Synchronization Profile

  7. On the AGENTS tab:

    1. Select individual agents, or agent groups, that will participate in the Job.

      Tip

      Click + CREATE NEW GROUP to define a new Agents group. For details, see Groups tab and adding new groups.

    2. Select options:

      • Read-only - Agent will be only allowed to download the files. Any files copied or added to the synchronization folder manually won't be propagated to other Agents.
      • Selective sync - File system browsers will display files as placeholders to conserve storage space. Download will be triggered automatically upon accessing the file. For more information, see Transparent Selective Sync (TSS) for macOS Agents, Transparent Selective Sync (TSS) on Windows.
      • Priority Agent - Priority Agents store a full copy of files in the synchronized folder. This ensures that when there are Agents with the Transparent Selective Sync (TSS) enabled, there's a full copy of the data available. If a TSS-enabled Agent wants to offload some of the files, it will be allowed to do so only when the upload to one of the Priority Agents has been completed. While all Agents comprise a mesh network and exchange the data with each other, data transfers to Priority Agents are prioritized.
      • Lock server - Agent will be responsible for keeping track of locked files. For details, see File locking in Resilio Active Everywhere Jobs.
    3. Click Specify path to select path or click the suggested path to modify it.

    4. 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.

    5. Click Browse to browse the file system and navigate to location where you want to store the synchronization folder for this Job. Select an existing folder or click + CREATE FOLDER to create a new one, then click Select.

      Note

      For Agents with the limited user option enabled, file system browsing is limited to the default storage folder path. For details, see Limiting admin's access to the Agent.

    6. Click Save , then click Next.

  8. On the REFERENCE AGENT tab, select a Reference Agent, then click Next.

    Mc Configure Job Synchronization Reference Agent

    Note

    Reference Agent is mandatory for Jobs configured to synchronize NTFS or POSIX permissions. In other cases, selecting a Reference Agent isn't necessary, but it can speed up the initial merging of contents of non-empty synchronization folders. Read-only Job participants cannot be Reference Agents, thus they're not available for selection. For more information, see Reference Agent.

  9. 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.
  10. On the SUMMARY tab, verify your Job's configuration, then click Save.