Set Up Aternity User Journey Intelligence App

This article details the set up procedure for Aternity UJI (User Journey Intelligence powered by Blue Triangle), Aternity APM, and customers' web application.

Before you begin

  • Verify you have fully functional Aternity UJI (User Journey Intelligence powered by Blue Triangle), Aternity APM, and your web application.

  • User in Aternity UJI must have the role Account & Site Creator/Editor (with access level Partner Consultant and Partner Admin).

  • On the Aternity UJI side, make sure that the application has Aternity UJI’s page tag (snippet) on the desired pages.

    • Access to the site configuration page and write down somewhere for further use:

      • Site ID (this will be used on the Aternity APM side)

      • custom variable carrying tracing.id (this will be used on the Aternity APM side, User Journey Intelligence Configuration Page)

      • custom variable carrying the page.id (this will be used on the Aternity APM side, User Journey Intelligence Configuration Page)

  • On the Aternity APM side, make sure that the application has Aternity APM’s JavaScript Snippet on the desired pages and the JavaScript Instrumentation (JSI) configuration includes the ujisid (Aternity UJI site ID).
    Tip

    JavaScript Snippet is a snippet in Aternity APM that users insert into your web application. The snippet collects data from the web page and sends it over to the APM Analysis Server.

Procedure

  1. Step 1 Set up Aternity UJI by doing the following:
    1. a Open a browser and sign in to Aternity UJI.
    2. b Select Settings and Administration button on the top right of the screen and then select Sites.
      Set up site
    3. c To create a site, select the Create Site button on the top left.
    4. d Fill in the required fields with a few additions:
      Field Description

      Site Name

      Enter the name of the site as it will appear in the UI.

      First Part Domains

      Enter the URL of the site.

      Allowed URL List

      Enter the URL of the site.
      • Custom Variable 1 (V2 220601): 
        (function(){ try{ if (typeof OPARX !== 'undefined') { return OPARX.ensureAixId() ||
            "undefined" } else { return "undefined" } } catch(e){ return "undefined"}
            })()

      • Custom Variable 1 Display Name: Aternity APM tracing.id

      Example

      Make sure the site includes these Custom Variables, allowing the UJI JavaScript to collect the the tracing.id injected by the APM server instrumentation.

      Important

      Ensure that all datacenter locations, pageload.id, tracing.id are consistent across UJI sites.

      Important

      All the sites integrated with APM need to have the same datacenter location and custom variables for pageload.id and tracing.id.
      • Custom Variable 2 (V2 220601): 
        (function(){ try{ if (typeof OPARX !== 'undefined') { return OPARX.ensurePID() ||
            "undefined" } else { return "undefined" } } catch(e){ return "undefined"}
            })()

      • Custom Variable 2 Display Name: Aternity APM pageload.id

      Example

      Make sure the site includes these Custom Variables, allowing the UJI JavaScript to collect the pageload.id generated by the APM EUE JavaScript.

      Important

      Ensure that all datacenter locations, pageload.id, tracing.id are consistent across UJI sites.

      Important

      All the sites integrated with APM need to have the same datacenter location and custom variables for pageload.id and tracing.id.
      Aternity Integration
      Enable the integration.
      Enable integration
    5. e Select Save, wait a few minutes, and then refresh the page.

      The newly created site should appear in the list.

  2. Step 2 Configure Partner Portal Information by doing the following:
    1. a Select Settings and Administration button on the top right of the screen again and then select Partner Portal Information (also called PPI).
      Set up partner portal information
    2. b Select Create Configuration on the top left to create a site.
    3. c Create a configuration for each Custom Variable created earlier in the site setup step.
      Field Description

      Create a Configuration for Custom Variable Name: Aternity APM pageload.id

      Create a Configuration for Custom Variable Name: Aternity APM tracing.id
      View example of partner portal information configuration
  3. Step 3 Set up Aternity APM by doing the following:
    1. a Open a browser and sign in to Aternity UJI,
    2. b Go to the Real User Monitoring > Web Browser > Performance Overview for the specific site and record its Site ID (sid).
      Obtain the Site ID

      You can directly obtain the Site ID from the URL (make sure you are viewing the correct site). For example, https://portal.bluetriangle.com/btportal/web/index.php?r=real-user-monitoring/performance-detail&sid=327568 where the Site ID is 327568

    3. c Make sure that the site name is displayed (for example, IMS YourApp)
      Write down the site name and ID number
    4. d Open a browser and sign in to Aternity APM.
    5. e Hover over the panel, click the gear icon , and select Configurations.
      Open Configuration page in the APM console
    6. f Select Define a Configuration button on the top left to create a configuration.
    7. g Fill in the required fields:
      Field Description

      Current Configuration

      Make sure there is a name in the Current Configuration field.

      Data Collection Settings

      Set Data Collection Settings to Custom.

      Collect End-User Experience Data

      Mark the check box Collect End-User Experience Data.

      Customize Snippet

      1. Expand Customize Snippet

      2. Go to the Advanced Options tab and enter the site ID in the Field names and values as ujisid: "[Aternity UJI Site ID]"

        (For example, ujisid: "327568").

      Define a configuration
    8. h Save the configuration.
    9. i Hover over the panel, click the gear icon , and select Configurations.
      Open UJI page in the APM console
    10. j Set the values of the site that was already set and configured. Save the configuration.
      Construct the redirect link:

      • Include the Portal Address

      • Include pageload.id (can be found in the trace, select which customVariable it is listed under Aternity UJI)

      • tracing.id (found in the trace, would need to select which customVariable it is listed under Aternity UJI)
        Note

        This settings can work only if the application is instrumented by APM agent on the server side (so that the instrumentation can inject the APM EUE JavaScript snippet and the tracing.id via the RVBD_EUE_PARAM.pageId variable)

      Select variables
  4. Step 4 Set up your web application.
    There are two scenarios:
    • The first scenario does not require any action. When the web application (.Net or Java) is instrumented by the APM Agent, the page tag will be injected in every page automatically.
    • The second scenario, when a web application is not instrumented by the APM Agent, requires a further action. In this case, get the page tag from the APM configuration page and then manually inject it to each page of the application.
    1. a Open a browser and sign in to Aternity APM.
    2. b Hover over the panel, click the gear icon , and select Configurations.

      In the Configurations screen, you can view or edit the current configuration.

      Go to APM Configuration
    3. c Select the configuration that was previously set up for the application that matches the UJI site.
    4. d Select View Snippet button and copy the JavaScript Snippet (page tag).
    5. e In the application, insert the APM EUE snippet as high as possible in the html head tag of each page of the application (enter the title tag and meta tags first, so the APM EUE tag comes right after)
      Note

      The snippet (page tag) injection can be done directly in the source code or using a Tag Manager.

      View example of example of pasting to the source code
    6. f Open a browser and sign in to Aternity UJI.
    7. g Select Settings and Administration button on the top right of the screen and then select Sites.
      Set up site
    8. h Find the site that was previously set up. Keep the Tag Prefix is the UJI Site identifier
      Check tag prefix
    9. i Construct the correct UJI snippet (page tag), replacing {uji_site_id} with the actual UJI site ID (see Tag Prefix in the above figure):
      Here is a snippet template: 
      <script src="https://{uji_site_id}.btttag.com/btt.js"
        async></script>
      View the sample snippet for the UJI site IMS YourApp with site ID aternityyourapp3271271z): 
      <script src="https://aternityyourapp3271271z.btttag.com/btt.js"
            async></script>
      Note

      This snippet format has been optimized and triggers warnings in the developer IDE.

    10. j Forward the snippet to the application development team and ask to insert it in the html head section of each page of web application.
      Note

      The snippet injection can be done directly in the source code or using a Tag Manager.

      Sample of the script with inserted page tag
  5. Step 5 Switch between Aternity APM and Aternity User Journey Intelligence application (powered by Blue Triangle) for deeper analysis.
    Field Description

    You can drill down to Aternity APM for further analysis right from inside Aternity User Journey Intelligence application (powered by Blue Triangle).

    There are several ways to switch to Aternity APM:
    • In the Real User Monitoring (RUM) Performance Detail for the specific site, select Search Transactions at the bottom of the Performance Measurement Details screen to drill down to Aternity APM.
      Drill down to Aternity APM to trace transactions
    • In the Real User Monitoring Performance Overview, you can find Aternity links at the bottom of the screen:
      Drill down to Aternity APM

    You can switch to Aternity UJI from the Aternity APM
    In the Overview for the specific transaction, users are able to get redirected to Aternity UJI from the Details screen by clicking on the (View) or (Search) next to the Site ID, pageload.id, and tracing.id.
    Note

    This will only show up if a UJI Site ID exists in the transaction. The links for (Search) will only show up if there is a pageload.id or tracing.id and the configuration on the User Journey Intelligence page is set up properly.

    Drill down to Aternity UJI