If you have set up version 2023.3 or 2023.4 of Analytics, you can apply the changes in version 2024.1 by downloading the update package and running the script against your current Analytics instance.
The update package includes the bicep files to update the ADF and scripts to modify the database tables and procedures. You can read more about the updates in the release notes for this version.
Tip: If you have a large number of customizations, we recommend that you set up a new Analytics instance with new DW and ADF beside the older instance of Analytics, and move your customizations between them before you start using the new instance.
Download update
Use the link you received from LS Retail Licenses to access the download form and request an update package.
When you have entered the relevant information to the form and submitted, you will receive an email with a download link to a zip file that includes everything you need.
If you are updating from an older version and do not have a license, you can read more about the Analytics license on our Prerequisites - Before you start page.
Preparation
Before you run the Update script you need to disable the Scheduled Run trigger in the Analytics instance you want to update. If you view the instructions on how to activate the trigger, you can follow those, but this time you set Activated to No and then apply and publish the changes.
Update Analytics for LS Central
- Open the update package folder you just downloaded, in VS Code or navigate to the update folder in your PowerShell client.
- To open the whole folder in VS Code, you open it in File Explorer and then right-click in a white space, not a file, and select Open with Code.
- In order to install bicep, we have added a PowerShell script with code from Microsoft learn, InstallBicep.ps1. You will need to run this script once.
- Open the UpdateAnalytics.ps1 script in VS Code, and run by clicking F5. Or run the script from PowerShell.
- The script will first ask, if you have access to the file path to the parameter file (Parameters.json) that is located in the Analytics project folder that was created when Analytics was deployed (YYYYMMDDHHMM-MyProject).
- If you still have access to the project folder, you can reuse the parameters by answering Yes and providing the full path to the Parameters.json file.
- If the project folder has been removed or deleted, you just answer No and enter the parameters when prompted.
Note: You need to use the same parameters you supplied when you installed Analytics. You can find the connection parameters and the names of your current SQL server, database, and Azure Data Factory in the Azure portal.
- The script then prompts for Azure subscription ID and login to Azure.
- Next, the script collects the parameters that have not been set, and validates connection parameters to LS Central and Analytics.
- The script now runs the updates.
- When the script has finished running, it displays a message.
Post update
After updating and before you run the first Scheduled run, you need to at least run PopulateQueryBase pipeline, with GetLSCentralMetadata set as false, to add queries for the new staging tables. Or if your data warehouse is still small, you can run Factory Reset pipeline instead, and the whole data warehouse will be reset.
If you want to start using the new Sales or Hospitality reports, you must either set up a new Analytics instance for this version or run the Factory Reset pipeline after the update. If you do not care about getting data into the new columns of factSalesPosted, you can just move on to restarting the trigger without running a Factory Reset.
You need to start the Scheduled run trigger again and verify that it is still set to the time and timezone you want.
Note: Remember to publish after you have reactivated the trigger and deleted the folder.