How to version-control workbooks by importing and exporting tables¶
Use the Version Control section of the Autory Excel ribbon from any sheet in the workbook.
Configure paths¶
On the VCS sheet, the VCS settings (VcsSettings) table has Key and Value columns:
| Key | Value |
|---|---|
VcsImportSource |
Folder or ZIP containing the tables to import. |
VcsExportDirectory |
Main folder for exported table files. |
Paths can be absolute, relative to the workbook folder, or contain environment variables such as %USERPROFILE%.
Settings are identified by their keys, so sorting the table does not change their meaning.
Configure which tables to export¶
Add or edit rows in List of workbook tables (VcsTablesExportList) on the VCS sheet.
Enter the table or named range in Table, and use ListObject or Range in Type, respectively.
| Column | Purpose |
|---|---|
Output directory |
The table's output folder, relative to VcsExportDirectory. Blank uses the main folder. |
Include data |
Whether to export the table's rows. |
Include headers |
Whether to export the table's column definitions. |
Deploy |
Whether to include the exported table when packaging a deployment ZIP using the CLI. |
Enable at least one of Include data or Include headers to export a table.
When exporting headers, keep the column definitions in Version control system metadata (VcsTableHeaderMetadata) up to date.
Export¶
Click Export (in the Autory ribbon) to write the configured table data,
headers and workbook metadata to VcsExportDirectory.
This includes current unsaved workbook contents.
It does not save the workbook or remove obsolete exported files.
Command-line alternative: autory vcs workbook export.
Import¶
Set VcsImportSource to the supplied folder or ZIP file and click Import (in the Autory ribbon).
This applies the supplied data, headers, renames and deletions,
then records the changes in the Version control system table import log (VcsTableImportLog).
The workbook is not automatically saved after the import.
Command-line alternative: autory vcs workbook update.
Package an export for deployment¶
After exporting, review the exported files.
If they are in Git, commit the changes and ensure the working tree is clean.
Run autory vcs workbook deploy
with explicit export-folder and ZIP paths:
autory vcs workbook deploy "export" "release.zip"
This packages the last export,
including only tables where Deploy was set to TRUE at the time of export.
It does not export again or include subsequent workbook edits.
Any existing destination ZIP is replaced.
Share the ZIP with the people who need to import it.