Synchronization

Projects in the Quick Tables plugin can be in two different states: unsynchronized (by default) and synchronized. When the project is unsynchronized, all the table data is stored in the plugin's storage. But when the project is synchronized, the tables are stored in a custom field created by our plugin.

To synchronize any project, go to Quick Tables Configuration in the Apps settings sidebar, choose the Synchronization tab, and click on the "Add Project" button above.

In the appearing modal window, select the project you want to synchronize and click "Next." After that, the plugin will create a new custom field (if it hasn't been created previously), assign the custom field to all the screens of the project, and transfer all existing tables from the app's storage to the custom field.

Note: Only company-managed and Service management projects are available for synchronization.

After that, the app will read and write data to the custom field, and you can import tables from third-party systems using Jira Cloud REST API.

image-20240603-084408.png

Desynchronization

As you can see on the screen above, the ‘Desync' button appears on the added project. It allows you to revert the project from using a custom field as storage (which enables you to use third-party system integration) back to internal plugin storage. Synchronization was designed as a one-time process: you're either using internal storage or a custom field. Switching between these two stages is a bad idea because it will take longer, depending on the number of tables in the project. Every time you click on ‘Desync’ button - it takes all the tables stored in custom field for issues and writes them to internal storage. After that it removes the custom field from all the project screens. That’s why it may take a while.

Repair

If something goes wrong and the synchronization process is interrupted, you will need to repair the project. This repair process rewrites tables that have been moved to the custom field back to internal storage to prevent any data loss. After you have successfully 'repaired' the project, you can try to synchronize it once more.