Save Project

Save Project

The Save Project command exports the current repository configuration into a structured folder system for backup, version control, and environment migration.

Unlike the single-file backup option in the File menu, this export creates human-readable folder structures that integrate seamlessly with Git and other version control systems, enabling granular tracking of changes at the individual object level.

Icon	Feature	Description
	Save project	Exports the current repository metadata into a structured folder system containing 18 specialized subdirectories.

Overview

Save project generates a complete snapshot of your data warehouse metadata as a file system hierarchy. This approach provides several advantages over traditional backup formats:

• Version Control Integration: Each object is stored as a separate file, enabling Git to track changes, diffs, and histories
• Human Readable: Object definitions are stored as JSON/XML files that can be inspected and edited with standard tools
• Selective Recovery: Individual objects can be restored from the folder structure without importing the entire repository
• Team Collaboration: Multiple developers can work on different objects and merge changes using standard VCS workflows

Folder Structure

When you save a project, AnalyticsCreator creates a root folder containing 18 specialized subdirectories. Each folder stores specific object types as individual metadata files:

Using Save Project

To export your repository:

1. Click the "Save project" button in the Project section of the ribbon
2. Browse to the location where you want to create the project folder (e.g., C:\Projects\ or a Git repository folder)
3. Enter a name for the project folder (e.g., Northwind_Demo)
4. Click "Save" to begin the export
5. AnalyticsCreator will create the folder structure and populate it with JSON/XML files representing your repository objects

File Format

Objects are exported as:

• JSON Files: Most metadata objects (tables, sources, transformations) are stored as formatted JSON for easy diff comparison
• XML Files: Complex packages and deployment configurations may use XML format
• Subfolders: Objects are grouped by type into the 18 folders listed above
• No Data: Only metadata is exported - actual data rows remain in source systems

Best Practices

• Synchronize First: Run Sync DWH before saving to ensure all source metadata is current
• Version Control: Initialize a Git repository in the exported folder:
  git init
git add .
git commit -m "Initial project export"
• Naming Conventions: Use descriptive names with version indicators (e.g., Northwind_Demo_v2.1)
• Regular Exports: Save before major changes to enable easy rollback via Git history
• Exclude from Backup: If using File > Backup & Restore, exclude the exported folder to avoid duplication
• Documentation: Include a README.md in the root folder describing the project purpose and environment details

Integration with Version Control

Example Git workflow:

1. Save project to a local folder
2. Initialize Git repository (if first time) or pull latest changes
3. Stage and commit changes: git commit -am "Updated customer dimension"
4. Push to remote: git push origin main
5. Other developers can pull and use Load project to import changes

Troubleshooting