The Environments Feature

Optimize Experiment Tracking with Multi-Environment Flexibility in Convert Experiences

THIS ARTICLE WILL HELP YOU:

• Understand the Environment feature
• Learn its key features and benefits
• Use the Feature: Step-by-step guide
  • Access Environments
  • Add new Environments
  • Switch between new and Legacy tracking scripts
  • Edit or Delete an Environment
  • Setup tracking script for each environment
  • Default Environment and Migration Process

Introduction

The "Environments" feature in the Convert app provides enhanced flexibility for managing, tracking, and testing experiments across different deployment stages. This feature allows users to create multiple environments, such as Production, Staging, and Testing, streamlining the A/B testing workflow.

Key Features and Benefits

1. Environment Management:
   • Multi-Environment Support: The "Environments" feature allows users to configure multiple environments based on their subscription plan. New plans support up to six environments. Options include, but are not limited to, Production, Staging, Development, and QA, enabling a full testing cycle from development to production. Note that you may choose any name for your environment.
2. Tracking Script per Environment:
   • Each environment has a unique tracking script, identified by an environment parameter in the script URL. This ensures that the backend only returns experiences associated with the selected environment.
   • Legacy Compatibility: Existing users with legacy tracking scripts will default to a single production environment, ensuring continuity without requiring immediate migration.
3. Plan-Based Limits:
   • Environment availability varies by plan, with older plans limited to one production environment, while newer plans offer up to six environments. Users can select environments according to their testing needs, with standard setups for Local, Development, Integration, Testing, Staging, and Production. Check our pricing page for more information.
4. UI/UX Enhancements:
   • Unified View: The “Tracking Code” and “Environments” sections have been merged into one consolidated "Environments & Tracking Code" page.
   • Visual Cues: Greyed-out options and lock icons guide users on features available only in the new tracking script while allowing legacy users to see what additional functionality the upgrade would provide.

Step-by-Step Guide to Using the "Environments" Feature

Step 1: Access the Environments & Tracking Code Page

1. Navigate to Project Settings:
   • Open your project in Convert Experiences and go to Project Configuration.
   • Click on Environments & Tracking Code to access the environment management section. 
2. View Available Environments
   • You’ll see the default environments, which will depend on your current plan. New plans typically start with a "Production" environment, with options to add additional environments up to your plan’s limit.

Step 2: Adding a New Environment

1. Click on Add Environment:
   • Select the Add Environment button within the environments section.
2. Name Your Environment:
   • Assign a name to your environment, such as "Staging" or "QA." Note that only one environment can be designated as "Production" to prevent confusion. 
3. Generate Tracking Script:
   • Upon creating an environment, a unique tracking script with an environment parameter will be generated. Copy this script and add it to your site’s pages as needed to track actions within that specific environment.
     
     
4. Plan-Specific Limits:
   • If you attempt to add more environments than your plan supports, you’ll receive a notification explaining the limit based on your subscription.

Step 3: Switching Between New and Legacy Tracking Scripts

1. Toggle to Legacy Tracking (if available):
   • Legacy script users will see a Switch to Legacy toggle. Once selected, environments will be locked, and a message will inform you that only a single production environment is supported with the legacy script. 
   • If you decide to switch back, all created environments will again be available. 
2. Understanding Script Differences:
   • The new tracking script allows environment-specific tracking, while the legacy script supports only a single production environment. Visual cues in the UI highlight this difference, helping you understand the value of upgrading.

Step 4: Editing and Deleting Environments

1. Editing an Environment:
   • Select the Edit option next to the environment name to change settings or rename the environment.
   • Production environments cannot be deleted if they are the only production environment in the list. This restriction ensures continuity and prevents accidental deletion of a primary environment.
2. Deleting Environments:
   • To delete, click the delete icon. If it’s the only production environment, deletion will be restricted.
   • A confirmation message will prompt you to confirm deletion. For legacy script users, deletion of additional environments will not be possible, as only one environment is supported.
     
     

Step 5: Setting Up Tracking Code for Each Environment

1. Copy Environment-Specific Tracking Code:
   • Once an environment is created, the system will generate a unique tracking script containing an environment parameter.
   • Copy the generated code and insert it on the pages of your site corresponding to that environment. Each environment’s tracking script ensures that only the relevant experiments for that environment are loaded. 
2. Legacy Script Users:
   • Users on the legacy tracking script will see a message clarifying that environment-specific tracking is unavailable. They can still access a generic tracking code but won’t be able to utilize multiple environments until switching to the new tracking script.

Step 6: Default Environment and Migration for Existing Projects

1. Migrating Existing Projects:
   • Existing projects will automatically receive a default “Production” environment. This transition will not affect tracking or data and provides users with a simple setup to start using environments.
2. Ensuring Compatibility:
   • For projects with the legacy script, environments will not be displayed, and only the standard production tracking code will be accessible, ensuring a smooth transition without configuration changes.