User Identification helps you accurately identify users to determine whether your Apty Content is extensively being used. For example, let's assume that you created a Workflow that is visible to a segment of 10 engineers in your organization. With the help of Apty's User Identification process, you can precisely identify who visited your application, who completed the Workflow, and who did not. Apty enables you to use a variety of matrices, including the user's Apty ID, Application ID, and Custom ID to uniquely identify a user.
How it works?
The user identification is performed every time a user visits your application and for every HTML change at the backend.
Apty provides 3 options for you to identify your users:
- Apty ID
- Application ID
- Custom
| Apty ID |
Whenever Apty is loaded on your application, a random Apty ID for every new device/browser is generated and stored in application storage. This unique ID is retrieved from the application storage to identify the user. Note: Apty ID is a default name and can be customized to any other name such as Unique ID. |
| Application ID |
Using the user's login ID from the host application, you can record the user's identification. Unlike in the case of Apty ID, the Application ID remains same across all devices & browsers. Note: Application ID is applicable only for Apty certified apps like PPM, Salesforce & Workday. |
| Custom |
The Custom JavaScript gives you the ability to define your own custom variable(a key:value pair) to identify a unique user. |
Identifying Unique users using Apty ID and Application ID may have certain issues as follows:
- The same user when using different browsers/machines is counted again.
- Whenever the application is refreshed or closed, the user information along with the Apty ID is lost since it is randomly generated.
We recommend using the Custom option to correctly identify users and provide more accurate values.
Identifying Unique Users by Custom JavaScript
The Admin Portal's Custom JS field provides you additional ability to manipulate screen elements, define new variables, and create custom solutions for certain use cases. A custom variable can be declared in the source code as a key-value pair that when executed, returns a JSON property. The key and value in the example below are user and userRoles, respectively. On execution, the key will return the value it was declared with, allowing you to identify the user possessing that value.
Configure User Identification in the Admin Portal
To uniquely identify the users,
1. Login to the Admin Portal.
2. Select your Application from the left panel.
3. Click the application settings icon.
4. In the Manage Current Application page, click User Identification.
5. Click the Identify Users By dropdown and then select your required parameter.
Note:
The Application ID and Custom settings are by default disabled when you use Apty for the first time, leaving only Apty ID enabled for use. Please connect with your Apty representative to enable these features.
6. Click Save.