# createDefaultUserTraits

Creates an object containing the default user traits used to identify a user in a Workleap web application.

# Reference 

const traits = createDefaultUserTraits(identification)

# Parameters

  • identification: An object that uniquely identifies the current user and provide additional context about the user environment.
    • userId: A value that uniquely identifies the current user.
    • organizationId: The organization's unique id.
    • organizationName: The organization name.
    • isMigratedToWorkleap: Whether or not this user's organization has been migrated to use the WLP, or if the user has signed up to the new experience directly.
    • isAdmin: Whether or not the user is an administrator in the current workspace.
    • isOrganizationCreator: An optional value indicating whether or not the user originally signed up to create the workspace.
    • isReportingManager: An optional value indicating whether or not the user is a reporting manager in the current workspace.
    • isTeamManager: An optional value indicating whether or not the user is a team manager in the current workspace.
    • isExecutive: An optional object including boolean values indicating whether or not the user is an executive for specific product:
      • wov: An optional value indicating whether or not the user is an Officevibe executive.
      • lms: An optional value indicating whether or not the user is an LMS executive.
      • onb: An optional value indicating whether or not the user is an Onboarding executive.
      • sks: An optional value indicating whether or not the user is a Skills executive.
      • wpm: An optional value indicating whether or not the user is a Performance executive.
      • pbd: An optional value indicating whether or not the user is a Pingboard executive.
    • isCollaborator: An optional object including boolean values indicating whether or not the user is a collaborator for specific product:
      • wov: An optional value indicating whether or not the user is an Officevibe collaborator.
      • lms: An optional value indicating whether or not the user is an LMS collaborator.
      • onb: An optional value indicating whether or not the user is an Onboarding collaborator.
      • sks: An optional value indicating whether or not the user is a Skills collaborator.
      • wpm: An optional value indicating whether or not the user is a Performance collaborator.
      • pbd: An optional value indicating whether or not the user is a Pingboard collaborator.
    • planCode: An optional object including string values indicating the user plan code for specific product:
      • wov: An optional value indicating the user plan code for Officevibe.
      • lms: An optional value indicating the user plan code for LMS.
      • onb: An optional value indicating the user plan code for Onboarding.
      • sks: An optional value indicating the user plan code for Skills.
      • wpm: An optional value indicating the user plan code for Performance.
      • pbd: An optional value indicating the user plan code for Pingboard.

# Returns

An object including the default user traits matching the provided identification values:

User Trait Name Description
User Id

A value that uniquely identifies the current user.
(in case of multiple workspaces, this id would be different per workspace)

ex. fa88ed6b-9ff4-48a0-b3a6-cee17b4855e9
Organization Id

The organization's id.
(in case of multiple workspaces, this id would be different per workspace)

ex. 6a3f4a88-b4bd-42cf-b404-7fd83ec1808d
Organization Name The organization's name.
Is Migrated To Workleap true if this user's organization has been migrated to use the WLP, or if the user has signed up to the new experience directly.
Is Admin true if the user is an administrator in the current workspace.
Is Organization Creator true if the user originally signed up to create the workspace.
Is Reporting Manager true if this user is a reporting manager in the current workspace.
Is Team Manager true if this user is a team manager in the current workspace.
Is Executive true if this user is an executive in any product in the current workspace.
Is Executive - Officevibe
Is Executive - LMS
Is Executive - Onboarding
Is Executive - Pingboard
Is Executive - Skills
Is Executive - Performance		 true if this user is an executive of the corresponding product in the current workspace.
Is Collaborator true if this user is a collaborator in any product in the current workspace.
Is Collaborator - Officevibe
Is Collaborator - LMS
Is Collaborator - Onboarding
Is Collaborator - Pingboard
Is Collaborator - Skills
Is Collaborator - Performance		 true if this user is a collaborator in the corresponding product in the current workspace.
Plan Code - Officevibe
Plan Code - LMS
Plan Code - Onboarding
Plan Code - Pingboard
Plan Code - Skills
Plan Code - Performance

Indicates the plan code for the corresponding product in the workspace.

ex. wov-essential-monthly-std

# Usage

# Get default traits 

import { createDefaultUserTraits } from "@workleap/logrocket";
import LogRocket from "logrocket";

const traits = createDefaultUserTraits({
    userId: "6a5e6b06-0cac-44ee-8d2b-00b9419e7da9",
    organizationId: "e6bb30f8-0a00-4928-8943-1630895a3f14",
    organizationName: "Acme",
    isMigratedToWorkleap: true,
    isOrganizationCreator: false,
    isAdmin: false
});

Logrocket.identify(allTraits.userId, allTraits);

# Send additional traits

You can send custom user traits to improve filtering in LogRocket. To do so, merge the default user traits with your additional traits before sending them:

import { createDefaultUserTraits } from "@workleap/logrocket";
import LogRocket from "logrocket";

const allTraits = {
    ...createDefaultUserTraits({
        userId: "6a5e6b06-0cac-44ee-8d2b-00b9419e7da9",
        organizationId: "e6bb30f8-0a00-4928-8943-1630895a3f14",
        organizationName: "Acme",
        isMigratedToWorkleap: true,
        isOrganizationCreator: false,
        isAdmin: false
    }),
    "Additional Trait": "Trait Value"
};

Logrocket.identify(allTraits.userId, allTraits);