Installation
Learn about the different ways available for installing Umbraco Engage on your project.
This article covers two ways to install Umbraco Engage:
Via NuGet, or
Installation via NuGet
Install Umbraco Engage via Nuget in your IDE such as Visual Studio, JetBrains Rider, or VSCode (With C# DevKit).
The example shown below uses the Nuget Package Manager in Visual Studio.
Open the project in Visual Studio.
Go to Tools -> NuGet Package Manager -> Manage NuGet Packages for Solution.
Navigate to the Browse tab.
Search for the Umbraco.Engage package.
Select the package.
Choose which project to install it into.
Install the package.
Installing using the terminal
You can install Umbraco Engage using a terminal, like the Package Manager Console in Visual Studio. The steps for doing so are outlined below.
Open the project in Visual Studio.
Find and open the Package Manager Console from the Tools menu.
Type the following into the terminal:
Alternatively, Umbraco Engage can be installed via the console on your operating machine.
Open a terminal window on your operating system.
Navigate to the folder containing your Umbraco website.
Install the Umbraco Engage Nuget package with the following command:
Next steps
When you have installed Umbraco Engage, build or restart your website, and the Engage section will appear in the backoffice, as shown above.
The next step is to configure a license.
It is recommended to consider the information detailed in the section below, to get the best out of Umbraco Engage.
Add-ons
Umbraco Engage has add-ons that connect it to Umbraco Forms, Umbraco Commerce, Umbraco Deploy, and AI. Each add-on is a separate NuGet package. See the overview of available add-ons to learn about their functionality and what they add to the product.
Clientside tracking
To capture events that happen on the clientside (frontend) of your website, you need to add the clientside tracking script. This is done by including the following snippet on all of your pages.
Cockpit
The Cockpit is a tool to help with testing segments and diagnosing the data that Umbraco Engage collects. It can be viewed on the front end of your website, only if you are logged into Umbraco as well.
As of Umbraco Engage 16, the cockpit is automatically installed.
Learn more what the Cockpit is and how you can use it.
Optional Extras
Here are some optional extras you can do to improve your experience with Umbraco Engage.
Add a Google Analytics bridging script that automatically sends events that you send to Google Analytics, to Umbraco Engage as well.
Add the Google Analytics blocker detection script. This gives you insights in which page traffic Umbraco Engage will track, and Google Analytics will not track.
Cookie consent
To change the default Umbraco Engage cookie behavior, see the GDPR & EU regulation article. Alternatively, check the implementation using Cookiebot, which can serve as a reference for other cookie consent providers.
If you change the default cookie behavior make sure to perform a client side reload of the initial page after cookie consent. If this is not done, visitor referrer and/or campaigns will not be tracked.
Load balancing and CM / CD environments
Are you using a load-balanced setup or separate CM and CD environments? Check our documentation about this topic.
The first run
When you visit your site locally for the first time, Umbraco Engage will begin tracking page views, visitors, etc. If you go to Engage -> Analytics, you won't see any data until the first reporting run. By default, reporting data will be generated at 04:00 AM automatically.
To generate reporting data manually on your local installation, follow these steps:
Go to the Settings section.
Navigate to Engage > Configuration.
Select the Reporting tab.
Click the red Regenerate button.
Use the Regenerate button only in non-production environments because it can cause temporary performance degradation.
Last updated
Was this helpful?