website logo
⌘K
Welcome to Relicx
How does Relicx work ?
Benefits of Relicx
Getting Started
Sign-up
Instrumenting Your App
Security and Privacy
Application & Environments
Adding Application
Adding a new Test Environment
SDK
getSessionUrlCallback()
identify()
Log()
sessionVars()
sessionLabels()
User Sessions
Session Replay and Detail
Developer Console
Automatic Release Validation
How Does Relicx Release Validation Work?
Benefits of Relicx Release Validation
Running Release Validation
Interpreting the results
Adding Tests
Smart Tests
Interactive Test Authoring
Generating Tests from User Sessions
Editing Tests
Running Tests
Test Run Page
Test Suite
CI/CD Integration
Notifications
Slack
Email
Additional Resources
Importing tests into Relicx
Testing Firewall Protected Apps
Timezones
How-to-Guides
Instrumenting Your App
Convert a session with errors to test
Video Resources
Changelog
Docs powered by
Archbee
SDK

sessionVars()

5min

Method

JS
|
relicxSDK.sessionVars(vars);


Attach custom key/value data to the session.

Parameters

Name

Description

vars

(Required) An object containing key/value pairs that provide additional context for the session.

The keys can be arbitrary but special support is provided for some keys.

Key

Description

email

E-mail address for the user.

user_name

A human readable name for the user.

tenant

A name/identifier for the tenant the user belongs to.

build_version

An identifier for the current build of your app.

Examples

JS
|
relicxSDK.sessionVars({
    // Special keys
    email: "foo.bar@test.com",
    user_name: "Foo Bar",
    tenant: "Amazing Bazz Org",
    build_version: "v1.2.3"
    // Arbitrary keys
    role: "UX designer",
});


Multiple calls to relicxSDK.sessionVars() are resolved by using the latest value for each key.

Updated 06 Mar 2023
Did this page help you?
PREVIOUS
Log()
NEXT
sessionLabels()
Docs powered by
Archbee
TABLE OF CONTENTS
Method
Parameters
Examples
Docs powered by
Archbee