---
title: "File System Synchronizer job"
slug: "file-system-synchronizer-job"
updated: 2025-09-16T13:43:59Z
published: 2025-09-16T13:43:59Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.encodify.com/llms.txt
> Use this file to discover all available pages before exploring further.

# File System Synchronizer job

## Overview

---

The **File System Synchronizer** job in Encodify allows you to link a module with an external file system. Each file in the external system is represented as an individual module item within Encodify. This scheduler job regularly scans the linked file structure for changes and automatically synchronises them with the module, ensuring that your module reflects the current state of the external file system.

> [!WARNING]
> **Note:** If the root folder of the external file system contains no files or subfolders, the job will not run. To prevent issues, ensure an empty folder exists in the root if the directory is cleared.

## Parameters

---

The table below provides an overview of parameters supported for the **File System Synchronizer Job**

| **Parameter** | **Description** |
| --- | --- |
| `joblist=FileSystemSynchronizer` | Name of the scheduler job to be executed. You may use a custom name instead of `FileSystemSynchronizer`. |
| `job.FileSystemSynchronizer.type` | Class that performs the synchronizer job: `dk.encode.ebms.core.file.externalFileSystem.ExternalFSSyncJob`. |
| `job.FileSystemSynchronizer.param.moduleId` | ID(s) of the module(s) to synchronize. Multiple IDs can be separated by commas. |
| `job.FileSystemSynchronizer.siteId` | ID(s) of the site(s) for which synchronization should occur. Multiple site IDs can be separated by commas. Some jobs ignore this parameter and apply to all sites. |
| `job.FileSystemSynchronizer.interval` | Interval in seconds at which the job will re-run. |
| `job.FileSystemSynchronizer.param.isDetectingOfEfsIdentifierEnabled` | If set to `true`, the job will only run when the `.efsIdentifier` file exists in the EFS root folder. If the file is missing, the job stops normally with an informative message. Default is `false`. |

## Example Configuration

---

The below is an example of the **File System Synchronizer Job**

```plaintext
joblist=FileSystemSynchronizer
job.FileSystemSynchronizer.type=dk.encode.ebms.core.file.externalFileSystem.ExternalFSSyncJob
job.FileSystemSynchronizer.param.moduleId=101,102
job.FileSystemSynchronizer.siteId=1
job.FileSystemSynchronizer.interval=300
job.FileSystemSynchronizer.param.isDetectingOfEfsIdentifierEnabled=true
```

**Explanation:**

- This example synchronises modules with IDs `101` and `102` for site `1`.
- The job runs every 300 seconds (5 minutes).
- Synchronisation only occurs if the `.efsIdentifier` file exists in the root folder.