Updating and Migrating Customized Dashboards

Following the changes made to PSA Analytics in the Summer 2022 release, we recommend migrating any customized dashboards held in PSA Analytics apps created with versions of PSA Analytics up to and including Spring 2022 to the new PSA Analytics apps available in the Summer 2022 release.

You can copy customized dashboards from PSA Analytics apps created with versions of Business Analytics up to and including Spring 2022 to your PSA Core Analytics and PSA Advanced Analytics apps once you have created them.

Before you migrate your PSA Analytics apps to the Summer 2022 apps, we recommend that you replicate any additional fields in your PSA Core Analytics app which have been added to your PSA Analytics app. To do this, navigate to Analytics Studio | Reconfigure and then review the list of additional fields.

After migrating a customized dashboard to the PSA Advanced Analytics app, we recommend that you update the datasets it uses to those contained in the PSA Core Analytics app. From Summer 2022 all datasets are contained in the PSA Core Analytics app. Performing this step ensures that your customized dashboards read their data from the upgraded PSA Core Analytics app, and avoids maintaining two dataflows.

Updating Customized Dashboard Datasets

You can reconfigure existing customized dashboards in pre-Summer 2022 versions of PSA Analytics to use the datasets provided in PSA Core Analytics.

The guidance below contains steps for updating datasets on a like-for-like basis, for example, exchanging the PSA Capacity dataset in your PSA Analytics app for the PSA Capacity dataset in the PSA Core Analytics app.

Warning: We recommend that you perform these steps to avoid maintaining multiple dataflows with identical data, and to avoid discrepancies in the data displayed between your old app and your new app.

To update the dataset used in a customized dashboard, you must update each reference to the old dataset with a reference to the new dataset. To do this, you must edit the JSON configuration of the dashboard and replace each occurrence of the ID and the API name of the PSA Analytics dataset with the PSA Core Analytics dataset.

The parameters that need updating are shown below:

JSON Parameters

Parameter

Example

Description

Action
"id": "datasetID" "id": "0Fb8d000000TrSnCAK" The identification number of the dataset. Find and replace all instances of this parameter with the replacement dataset ID.
"name": "datasetname" "name": "Capacity" The name of the dataset. Find and replace all instances of this parameter with the replacement dataset name.
load \"dataset\. load \"Capacity\. The SAQL query used to load the dataset in the dashboard. Find and replace all instances of this parameter with the replacement dataset name.

Retrieving PSA Core Analytics App Dataset Details

To update the dataset, you must first find the ID and API name of your new PSA Core Analytics dataset that you will be copying across to your customized PSA Analytics dashboard. You can do this by following the steps below:

  1. Navigate to Analytics Studio.
  2. Click the Datasets tab and find the dataset that you want to copy.
  3. Click Edit in the Data Refreshed column.
  4. The ID for the dataset consists of alphanumeric characters and appears in the final part of the URL after the last forward slash. For example, yoursite.com/analytics/dataset/ID. This is the new ID that you want to enter into the JSON file of your customized dashboard.
  5. The API name for this dataset appears in the API Name field. This is the new API name that you want to enter into the JSON file of your customized dashboard.

Amending the Dashboard's Dataset References

To amend the dataset you must replace the parameters shown in the table above. You can do this by performing the following steps:

Warning: You must replace all your required parameters in the JSON file before clicking Done.
  1. Open the customized copy of the dashboard contained in your PSA Advanced Analytics app.
  2. Save your customized dashboard. This creates a version that you can revert to in the event of errors.
  3. Open the edit view for the dashboard's JSON file by clicking Command + E (Mac), Ctrl + E (PC).
  4. Ensure your cursor is in the JSON, and then click Command + F (Mac), Ctrl + F (PC), and edit the parameters shown in the table above. Using the Find and Replace functionality ensures that your search query is case-sensitive and avoids errors in your dashboard JSON file.
    1. Replace "id": "oldDatasetId" with "id": "newDatasetID". For example, replace "id": "0Fb8d000000TrSnCAK" with "id": "0Fb8d000000TrSnCIJ".
    2. Replace "name": "oldDatasetApiName" with "name": "newDatasetApiName". For example, replace "name": "Capacity" with "name": "Capacity1".
    3. Replace load \"oldDatasetApiName\" with load \"newDatasetApiName\". For example, Replace load \"Capacity\" with load \"Capacity1\".
  5. Click Done.
  6. Save your updated customized dashboard in your PSA Advanced Analytics app.

To check that you have successfully removed the reference to the dataset in your PSA Analytics app, perform the following steps:

  1. Navigate to Analytics Studio and open the dataset in your original PSA Analytics app by clicking | Edit on the drop-down menu.
  2. Check the list of dashboards displayed in the Dashboards tab under Usage, to confirm that your edited dashboard is not displayed.