Skip to main content

Gradual Rollout

This guide explains how to implement a controlled rollout of the Cartesian Agent across your user base. We provide multiple deployment methods to help you test and gradually introduce the Agent to your users.

Testing Methods​

Before deploying to production, you can use our browser plugin for testing:

  • Test the Agent on any website without code changes
  • Verify Agent behavior in different environments
  • Debug integration issues in real-time

Initial Setup with Auto-Start Disabled​

To maintain control over the Agent's activation, you can disable automatic startup:

Before the Agent starts (just after the snippet or in the initial call to the NPM module), set autoStart to be false.

window.Cartesian('settings:set', { autoStart: false });

This will prevent the Agent from loading.

Key considerations:

  • Place this configuration immediately after the installation snippet
  • For NPM installations, set before any other Cartesian calls
  • Configuration will persist across page reloads

Activation Methods​

We currently allow two methods to activate the Agent for specific users:

1. URL Query Parameter Activation​

Add the following parameter to your URL to activate the Agent:

https://my-url/my-app?cartesian-force-started=true

This will "start" the Agent.

2. Programmatic Activation​

You can also control Agent activation through your application code:

const shouldStartAgent = true;
if (shouldStartAgent) {
  window.Cartesian('start');
}