Creating projects
Project creation workflow
-
Navigate to Metric Store
- Go to
/metrics-storepage - Or click “Metric Store” from navigation
- Go to
-
Access project creation
- If no projects exist: Click “Create project” button
- If projects exist: Click project name in header → “New project”
-
Fill project details
- Project name (required, unique, max 50 characters)
- Repository type (Platform Managed or Imported)
- Environment selection
- Deployment options
- Protected branches (optional)
-
Add project
- Click “Add Project” button
- Wait for repository cloning (if imported)
- Project will be created and initialized
Repository types
- Platform Managed
- Imported
Choose Platform Managed when you want 5X to handle repository management:When to use:
- Creating new projects from scratch
- Quick setup without Git configuration
- Projects that don’t require complex Git workflows
- Learning and experimentation
- 5X-managed Git repository
- Automatic repository initialization
- Ready-to-use development environment
- No GitHub configuration required
- Project name (used to generate repository name)
- Environment selection
- Deployment options
Project settings
Project name- Unique identifier for your project
- Maximum 50 characters
- Used for display and repository naming
- Can be edited after creation
- Select the environment where your data warehouse is configured
- Different environments can have different data sources
- Environment selection affects deployment and API access
- Always on - Service runs continuously
- On demand - Service starts when needed
- Scheduled - Time-based scheduling
- Specify branches that should be protected from direct changes
- Protected branches typically require pull requests for changes
- Common choices:
main,master,production
Editing projects
Edit project details
-
Access project settings
- Click “Settings” button in header (gear icon)
- Or click project name → “Edit project”
-
Modify settings
- Edit project name
- Change environment
- Update deployment options
- Modify protected branches
-
Save changes
- Click “Save” to apply changes
- Changes take effect immediately
Editable fields
- Project name - Update display name
- Environment - Change deployment environment
- Deployment options - Modify how service runs
- Protected branches - Add or remove protected branches
Read-only fields
- GitHub URL (for imported repos) - Cannot be changed after creation
- Subdirectory (if set) - Cannot be modified
- Deploy key (for imported repos) - Displayed for reference
Deleting projects
Delete workflow
-
Access project settings
- Go to project settings
- Scroll to “Danger Zone” section
-
Delete confirmation
- Enter project name to confirm
- Click “Delete Project” button
- Confirm deletion in modal
-
Post-deletion
- Project and all associated data are permanently removed
- Cannot be undone
- Repository data is deleted
Permanent deletionDeleting a project permanently removes:
- All cube definitions
- All branches and history
- All API credentials
- All BI connections
- All project settings
Branch management
Understanding branches
Branches allow you to work on different versions of your cube definitions:- Main/master branch - Production-ready cube definitions
- Feature branches - Development work for new features
- Environment branches - Different configurations for dev/staging/prod
Branch operations
Switch branches:- Click branch name in header
- Select branch from dropdown
- System automatically:
- Loads files for selected branch
- Updates Cube Playground
- Refreshes API credentials
- Click branch name in header
- Click “Create Branch” option
- Enter branch name
- Select source branch to branch from
- New branch is created and selected
- Available in project settings
- Only non-protected branches can be deleted
- Cannot delete currently selected branch
Protected branches
Purpose:- Prevent accidental changes to critical branches
- Enforce code review workflows
- Maintain production stability
- Set in project settings
- Specify branch names (e.g.,
main,master,production) - Protected branches cannot be deleted or directly modified
Repository synchronization
Sync now
Manually pull latest changes from Git repository:- Click “Sync now” button in header
- Wait for sync to complete
- Changes reflected automatically:
- Files are refreshed
- Cube Playground reloads
- API credentials update if needed
- After pushing changes from external Git client
- When collaborators make changes
- After merging pull requests
- To ensure you have latest schema definitions
Automatic sync
The system automatically:- Syncs when switching projects
- Refreshes when switching branches
- Updates when project is first loaded
Project selection
Selecting active project
- Click project name in header
- Select project from dropdown menu
- System automatically:
- Switches to selected project
- Starts heartbeat polling
- Loads files and branches
- Initializes Cube Playground
Project list
The dropdown shows:- All available projects
- Project names
- Current project indicator
- “New project” option (if you have permissions)
Best practices
Project organization
One project per environment
Separate environmentsUse separate projects for dev, staging, and production to isolate changes and prevent accidents.
Logical naming
Clear project namesUse descriptive names that indicate purpose: “Sales Analytics”, “Marketing Metrics”, “Finance KPIs”.
Protected branches
Protect productionAlways protect main/master branches in production projects to prevent accidental changes.
Regular syncing
Stay updatedSync regularly to ensure you’re working with the latest cube definitions and changes.
Branch management
- Use descriptive branch names -
feature/new-metrics,fix/revenue-calculation - Protect critical branches - Always protect main/master branches
- Sync before switching - Ensure you have latest changes before switching branches
- Clean up unused branches - Delete branches that are no longer needed
- Review before merging - Use pull requests for protected branches
Repository selection
- Platform Managed - Best for new projects and quick setup
- Imported - Best for existing projects and team collaboration
- Consider team workflows - Choose based on your team’s Git practices
Troubleshooting
Common issues
Project creation fails
Project creation fails
Possible causes:
- Project name already exists
- Environment not selected
- Invalid GitHub URL (for imported repos)
- Deployment key not added to GitHub
- Use a unique project name
- Verify environment is configured
- Check GitHub repository accessibility
- Ensure deployment key is added to repository settings
Branch not showing
Branch not showing
Possible causes:
- Branch hasn’t been synced from repository
- Protected branch restrictions
- Repository not fully cloned
- Click “Sync now” to refresh branches
- Check project settings for branch restrictions
- Wait for repository cloning to complete
Sync not working
Sync not working
Possible causes:
- Git repository access issues
- Network connectivity problems
- Repository structure issues
- Verify repository access permissions
- Check network connection
- Review repository structure and files
- Try refreshing the page and syncing again