Dashboard Version Control

This section provides information on how to create and maintain various version of dashboards.

Use Version Control to track changes to dashboards, collaborate safely, and restore prior versions. You can Push to VCS to create/check in a version and Pull from VCS to retrieve a prior version.

Prerequisites:

• You have access to Designer → Manage and permission to Push to VCS / Pull from VCS.

• Your organization’s VCS integration is configured (repository/remote and credentials, as applicable).

• Save your dashboard before pushing.

Push to and Pull from VCS

Pushing a Dashboard to VCS

1. Click Manage on the Designer homepage.

2. Select and open a Workspace from the list of Workspaces.

3. Select a dashboard from the dashboard list.

4. Click the Push to VCS icon for the selected dashboard. Result: The Push into Version Controlling System dialog opens.

5. Provide a commit message.

6. Select a Push Type:

   • Dashboard Versioning — create a new platform-managed dashboard version.

   • GIT Export — export changes to the configured Git repository (use per your team’s Git process).

7. Click Push.

• A confirmation message appears, and the selected dashboard version gets pushed to VCS.

Tip: Use clear commit messages (e.g., “Add FY25 filters, fix KPI thresholds”) and push after meaningful edits.

Pull from the VCS

1. Click Manage on the Designer homepage.

2. Select and open a Workspace from the list of Workspaces.

3. Select a dashboard from the dashboard list.

4. Click the Pull from VCS icon for the selected dashboard. Result: The Pull from Version Controlling System dialog opens.

5. Select a Version using the checkbox.

6. Click Pull.

Result: A confirmation message appears, and the selected version of the dashboard gets pulled.

Tip: Always Pull before you begin editing if others may have pushed new versions.

Notes & Best Practices

• Branching & review: If your team uses Git reviews, align with your branching policy (feature branches, PRs).

• Conflicts: If you edited locally and then pull an older version, you may overwrite changes. Save a copy (Save As) before pulling if unsure.

• Scope: Pushing/pulling affects the selected dashboard only (not the entire workspace).

• Publishing: Version control is separate from publishing. After pulling/pushing updates, Republish if you want Portal users to see the latest.

• Security: Do not commit secrets in component scripts or properties. Use secure connections and environment configs.

Troubleshooting

• Push disabled: Ensure you have edit rights and that the dashboard is saved. Confirm VCS integration is configured.

• No versions listed in Pull: The dashboard may not have any prior pushes, or you may be pointing to the wrong workspace/repo.

• Unexpected result after Pull: Verify you selected the intended version. Use Preview and, if needed, revert by pulling a different version.

• Authentication errors: Re-authenticate with the VCS or contact your admin to refresh tokens/keys.