--- title: Getting Started slug: user-analytics/getting-started description: New to Unaric User Analytics? Follow our step-by-step getting started guide to set up, configure, and begin using the application. icon: {"faIcon":"fa-solid fa-rocket"} docTags: createdAt: 2025-10-21T14:53:12.990Z --- ## 1. Installation Unaric User Analytics is a component of Unaric Guide. The first step is to install Unaric Guide in your Sandbox or Dev Org or Production Org. :::hint{type="warning"} If you already have **Unaric Guide v1.58** installed, you can skip installation. If you need to upgrade, follow the instructions below. ::: Install *Unaric Guide *in a Sandbox/Dev Org first (recommended) on a few pages. Once you’re happy with it, install and set it up in your Production Org for best results. - **[Install in Sandbox/Dev Org](https://test.salesforce.com/packaging/installPackage.apexp?p0=04tKh000002BaPy)** - **[Install in Production Org](https://login.salesforce.com/packaging/installPackage.apexp?p0=04tKh000002BaPy)**** ## 2. Permissions 1. Grant **Helped User** permission set to all end-users. 2. Open the **Improved Help for Lightning** app and navigate to the ***Help Settings**** tab.* 3. Review ***Tracking*** options. 4. To remain on the free version, you need to set the **Lightning Interactions** to 7 and click the **Schedule Maintenance** button. :::hint{type="info"} By default, **Unaric Analytics** logs all interactions. Interactions are stored as records in the **Help Interactions** custom object. ::: ## 3. Tracking setup The **Position Detector** component is the core tracking mechanism of Unaric Analytics. It is a custom component that, when deployed on a page, logs user interactions and contextual information by creating a record in the **Help Interactions** object. The component needs to be setup in *Help Cue* mode. In this mode, the component itself is not visible, but every time a user visits a page (or even an area of the page, such as a sub-tab) a **Help Interaction **record is created trapping user and contextual information. Unaric User Analytics offers two distinct deployment options for the **Position Detector **component: **application-wide **and for** specific pages**. For the initial setup, we recommend application-wide deployment. This will capture all user interactions within your Org. :::hint{type="warning"} Deploying the **Position Detector** component application-wide and for specific pages together will result in double counting. We strongly recommend avoiding this setup. If your business requirements mandate this dual deployment configuration, you can set up a Salesforce Flow to delete unwanted duplicate **Help Interaction** records. ::: :::hint{type="info"} These instructions correspond to the Salesforce Lightning setup and do not work on Salesforce Classic, which requires setting up a Visualforce sidebar component. For more information, see [Salesforce Classic Setup](docId\:uAc6iDgkJEtMi8KgZ1yKR). ::: :::::Tabs ::::Tab{title="Application tracking"} You need to add the Position Detector component to the Salesforce Utility Bar of the application you want to track usage of. 1. On Salesforce, navigate to **Setup > App Manager**. 2. Locate the app you wish to track and click **Edit**. 3. Go to the **Utility Items **tab and click **Add Utility Item**. Choose the **Position Detector** component and apply this configuration - To hide the component from end users, set the **Label** as *- *and **Panel Width & Height** both to *1. *Further, you can place the component at the bottom of the list. ::Image[]{src="https://app.archbee.com/api/optimize/10Nod6Ww95R3dPr0k0TCJ/CtNL_1hWJ-sa3auGX1mfe_image.png" size="34" width="347" height="430" position="center" darkWidth="347" darkHeight="430" showCaption="false"} :::Paragraph{listStyleType="disc" indent="2"} Mark the **Start Automatically** checkbox. ::: :::Paragraph{listStyleType="disc" listStart="2" indent="2"} Set the **Role** attribute to *Help Cue*. ::: :::Paragraph{listStyleType="disc" listStart="3" indent="2"} Set **Navigating Checking **Interval to *1000*. ::: 4. Click **Save **to finish. :::: ::::Tab{title="Page tracking"} 1. On Salesforce, navigate to **Setup >** **Lightning App Builder.** 2. Open the page you wish to track. 3. From the **Components** panel, select the **Improved Help: Position Detector** custom components and drag it onto the page or sub-tab to track. 4. Set the following three component design attributes: - **Positioning Group**: A unique name for the component in the page, typically the page name or sub-page tab name. - **Role**: *Help Cue*. - **Navigating Checking Interval**: *1000*. 5. Optionally, you can use the **Help Context **attribute to add information defining the contextualise request to issue. For example, the **Help Topic ID** or (for **Fixed listings**) the API name of an object. This property supports using an expression to define its custom label. The correct format is `!$Label.customLabelName`. 6. Click **Save** to finish. :::hint{type="success"} You can add more **Position Detector **components to the page and measure user interactions with multiple elements. ::: :::: ::::: ### Experience Cloud deployments For Experience Cloud deployments, tracking works the same way. You need to add the **Position Detector** to your Experience Cloud pages, sub-pages, or Flow screens. We recommend using a clear naming convention for each Position Detector to easily distinguish data across different user communities. For tracking your Experience Cloud Users grant these the **Helped User (Experience) **Permission Set. ## 4. Next steps Once you're set up, explore how you can dive into your insights with Unaric User Analytics. There are three ways to access usage data: ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem ### [In-Page Statistics](docId\:rNEBIpR2eOsueZeyN4TiQ) Real-time feedback within Salesforce pages. ::: :::LinkArrayItem ### [Custom Reports](docId:3OmC7CotLpzLL2mdMv1Bb) Organization-wide tracking and trend analysis. ::: :::LinkArrayItem ### [Dashboards](docId\:KhcynrE4yKIRGhbxH-4G2) Visually track help usage across the entire organization. ::: :::: ###