Installation

This article covers two ways to install Umbraco Engage:

• Via NuGet, or

• Via a terminal.

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.

1. Open the project in Visual Studio.

2. Go to Tools -> NuGet Package Manager -> Manage NuGet Packages for Solution.

1. Navigate to the Browse tab.

2. Search for the Umbraco.Engage package.

3. Select the package.

4. Choose which project to install it into.

5. 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.

1. Open the project in Visual Studio.

2. Find and open the Package Manager Console from the Tools menu.

3. Type the following into the terminal:

PM> install-package Umbraco.Engage

Alternatively, Umbraco Engage can be installed via the console on your operating machine.

1. Open a terminal window on your operating system.

2. Navigate to the folder containing your Umbraco website.

3. Install the Umbraco Engage Nuget package with the following command:

dotnet add package Umbraco.Engage

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.

Umbraco Forms

If you have installed Umbraco Forms as well and want to automatically track submissions of Umbraco Forms. Install the package Umbraco.Engage.Forms via NuGet or using your preferred approach as above.

PM> install package Umbraco.Engage.Forms

dotnet add package Umbraco.Engage.Forms

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.

<script src="/Assets/Umbraco.Engage/Scripts/umbracoEngage.analytics.js"></script>

Cockpit

Cockpit is a tool to help with testing segments and diagnose the data Umbraco Engage collects. It can be viewed on the frontend of your website, only if you are logged into Umbraco as well.

Install cockpit on your website by adding the following Razor Partial View in your templates in Umbraco before the closing </body> tag

@Html.Partial("Umbraco.Engage/Cockpit")</body>

Learn more what 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.

<script src="~/Assets/Umbraco.Engage/Scripts/umbracoEngage.analytics.ga4-bridge.min.js"></script>

• 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.

<script src="/Assets/Umbraco.Engage/Scripts/umbracoEngage.analytics.blockerdetection.js"></script>

Cookie consent

If you need to influence the default The Umbraco Engage cookie behaviour please go here. Or go to an example implementation using Cookiebot which can be used as an example for other cookie consent providers.

Load balancing and CM / CD environments

Are you using a load-balanced setup or separate CM and CD environments? Please 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, go to Engage -> Configuration. Scroll down to Reporting section and click the red Regenerate button.