> For the complete documentation index, see [llms.txt](https://help.rbsgo.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.rbsgo.com/dineplan/backoffice/settings/folder-sync.md).

# Folder Sync

### **Overview** <a href="#overview.6" id="overview.6"></a>

Folder Sync is used to configure folder sharing and synchronization between the DinePlan Server and connected client machines. It allows a shared folder to be configured on the server and clients to be registered using a sharing token for folder synchronization.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-2e4caa5dcc061ead5d3c37d6ecfc076704e2d020%2Fatt_22_for_3425271811.png?alt=media" alt=""><figcaption></figcaption></figure>

### **Screen Elements** <a href="#screen-elements.6" id="screen-elements.6"></a>

#### **Shares** <a href="#shares" id="shares"></a>

| **Screen Element** | **Description**                                                            |
| ------------------ | -------------------------------------------------------------------------- |
| Enable Sharing     | Enables or disables folder sharing.                                        |
| Is DinePlan Server | Specifies whether the current system is configured as the DinePlan Server. |
| Share Folder       | Specifies the folder that is shared for synchronization.                   |
| Share Token        | Displays the token used to register client systems for synchronization.    |
| "Save"             | Saves the folder sharing configuration.                                    |
| "Copy Token"       | Copies the sharing token for use when registering clients.                 |

#### **Clients** <a href="#clients" id="clients"></a>

| **Screen Element** | **Description**                                                                |
| ------------------ | ------------------------------------------------------------------------------ |
| Machine Name       | Displays the name of the client machine registered for folder synchronization. |
| Path               | Displays the configured folder path associated with the client.                |
| Status             | Displays the synchronization status of the client.                             |
| Path               | Displays the folder path configured for synchronization.                       |

### **Working** <a href="#working.5" id="working.5"></a>

#### **Configure Folder Sharing** <a href="#configure-folder-sharing" id="configure-folder-sharing"></a>

1. Open "Folder Sync".
2. Select "Shares".

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-c1abf16f0a13a35eae87a4a220647e07f9d231d1%2Fatt_23_for_3425271811.png?alt=media" alt=""><figcaption></figcaption></figure>

3. Enable "Enable Sharing".
4. Enable "Is DinePlan Server" if the system is configured as the DinePlan Server.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-d98382e282819ce185789830ce41f9f45548219e%2Fatt_24_for_3425271811.png?alt=media" alt=""><figcaption></figcaption></figure>

5. Specify the required folder in "Share Folder".
6. Configure the "Share Token" used to register client systems.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-949fc1027f8e92cb6c92fb56a28edc1736264743%2Fatt_25_for_3425271811.png?alt=media" alt=""><figcaption></figcaption></figure>

7. Click "Save" to save the folder-sharing configuration.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-f74b3ca367114ef2972152ff27fddbfbe00bee84%2Fatt_26_for_3425271811.png?alt=media" alt=""><figcaption></figcaption></figure>

8. Click "Copy Token" to copy the sharing token when it is required for client registration.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-dae5444ba0e580ec58e9c0258454e61693239609%2Fatt_27_for_3425271811.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Register and View Clients** <a href="#register-and-view-clients" id="register-and-view-clients"></a>

1. Open "Folder Sync".
2. Select "Clients".

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-1b25dd70ef60a38d46ec9e677f5248d7726a0714%2Fatt_28_for_3425271811.png?alt=media" alt=""><figcaption></figcaption></figure>

3. Review the registered client machines in the list.
4. Verify the "Machine Name", "Path", and "Status" of the required client.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-38ee08050abb2d15bcab2da4d5119c8a3b11f23e%2Fatt_29_for_3425271811.png?alt=media" alt=""><figcaption></figcaption></figure>

5. Ensure that the configured path and synchronization status are correct.

### **Use Case** <a href="#use-case.5" id="use-case.5"></a>

1. Configure a central folder for sharing between DinePlan systems.
2. Set a system as the DinePlan Server for folder synchronization.
3. Share required folders with connected client systems.
4. Register client systems using the generated sharing token.
5. Synchronize required folder data between the server and clients.
6. Verify the machines registered for folder synchronization.
7. Check the synchronization status of connected clients.
8. Maintain a centralized folder-sharing setup for multiple DinePlan systems.

### **Notes** <a href="#notes.5" id="notes.5"></a>

* Configure "Enable Sharing" when folder sharing is required.
* "Is DinePlan Server" should be enabled only on the system configured as the DinePlan Server.
* The "Share Token" is used to register clients that need to synchronize with the shared folder.
* Verify the "Machine Name", "Path", and "Status" under "Clients" to confirm the client configuration.
* Configure Folder Sync according to the customer's server and client setup requirements.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.rbsgo.com/dineplan/backoffice/settings/folder-sync.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.