Device ID QuickStart

Objective

This guide shows the end-to-end process for enabling and using Shape Device ID for those utilising the JS Tag injection method.

Using the instructions provided in this guide, you can enable Device ID functionality, generate a javascript tag, add it to your application, and monitor data in VoltConsole.


Prerequisites

You must have a valid Volterra Account. If you do not have an account, see Create a Volterra Account.


Enable and Use Shape Device ID

Perform the following steps to enable and use the Shape Device ID:

Step 1: Get the JS and inject into the application.
  • In the System namespace, click Shape Device ID -> Overview in the left-hand menu.

did nav
Figure: Navigate to Device ID Page

Note: Click on the System icon on the namespace selector to change to system namespace.

  • On the Dashboard view, you should see a Shape Device ID tile. Click on Enable Device ID.

enable did
Figure: Enable Device ID

  • After clicking on the Enable Device ID button, a new tile should appear: Shape Device ID is enabled. Click on Add Application.

did add app
Figure: Device ID Enabled

Note: In case the Device ID is already enabled, the dashboard view shows Shape Device ID is enabled tile.

  • In the Add Application pane, select JS Tag as your JS injection method.

vc add app
Figure: Select JS Injection Method

  • Click Next. Instructions for enabling Device ID with the JS tag appear in the pane.

did jstag
Figure: Java Script Method Instructions

  • Copy the script tag in Step 2 (see image above) and manually add it to the <head> section of the webpages(s) where you want to collect Device IDs.

    Note: F5 recommends copying the JS tag to all web pages in your application.

Step 2: Test the JS injection.

There are two ways to test if the JS tag insertion was successful:

  • Add the URL of the application in the text field (Step 4 in the image shown in previous step) and click Test JS Injection. If the injection was successful, then a green success checkmark will appear.
  • Go to the application and right-click Inspect. In the <head> section, locate the script tag. If the injection was successful, then the script tag should be present.

Click Done after verifying the JS injection.

Step 3: Monitor the Device ID dashboards to view the device data.
  • Go to Dashboard under Shape Device ID.

Note: The dashboard requires a few hours before showing any meaningful data. (For best results, wait for a few days.)