Environments
An environment is a complete, separate copy of Cloud Connector: its own configuration, its own variables, its own run history and its own loaded data, in databases of its own. Nothing is shared between environments except the install-wide setup (API keys of other environments, runtime settings, email, branding) and global variables.
Every install has one environment with the key default, named Default.
It uses the databases the install always had, and any request that names
no environment lands in it, which is why trigger URLs and Gateways from
before environments existed kept working. The default cannot be deleted, and
the role cannot be moved to another environment; you can rename it, for
example to "Production".
Enterprise installs may add environments (three in total unless agreed otherwise with Datawareness). On Basic and Standard the feature is not available, and the Environments entry is hidden.
The Environments page
Setup → Environments lists the environments with their Key, Name (description underneath) and Configuration database. The row you are in is tinted in the environment's colour.
Add environment opens a short form:
- Key — lowercase letters and digits, starting with a letter, at most 16 characters. It names the databases and cannot be changed later.
- Name and Colour.
A new environment starts completely empty: no source systems, no variables, no data. Build it from scratch, or load a configuration package into it (see Configuration Packages). It gets its own API key and its own default failure-email subscriptions.
The pencil opens Edit environment, where you change the name, colour and description, manage the environment's API key (Generate new key; anything using the old key stops working when you save), build a configuration package, and, for every environment but the default, delete it.
Switching environment
The environment band at the top of the page shows which environment you are in. On a desktop, clicking it opens Setup → Environments; clicking a row there switches the whole app into that environment and returns you to the page you came from. On a phone the band itself is a menu.
The selection is remembered per browser. Switching reloads the app; a detail page falls back to its list, because the object's id does not exist in the other environment.
What is per environment, and what is shared
| Per environment | Shared by the install |
|---|---|
| Source systems, instances, credentials, headers, parameters, endpoints, datasets, catalogue tables | The list of environments and their API keys |
| Variables, export systems, actions, jobs, schedules | Global variables ({{g:name}}) |
| Data access roles, notification subscriptions | Runtime settings, email transport, failure-notification recipients, branding |
| All run history and all loaded data | Scoped API keys (each still bound to one environment) |
Plan limits (source systems, instances, actions) count per environment.
The Setup pages always read the default environment, whatever the band says.
Reaching an environment from outside
The trigger and webhook URLs are identical in every environment. What sends a call to a given environment is the API key: each environment has its own, and no two environments may share one. The copy popover on every object shows the key of the environment you are in and says so. Gateway and webhook keys are issued for the environment you are in at the time and stay bound to it.
API callers that use a sign-in token instead of a key name the environment
with the header X-CC-Environment: <key>; no header means the default. The
Data API also accepts ?environment=<key>. A key and a header that disagree
are refused.
Emails name the environment in the subject and body once the install has more than one. The "View the run" link in a mail opens in whatever environment that browser last selected.
Deleting an environment
Edit environment → Danger zone → Delete environment and all its data drops the environment's configuration database and its loaded-data database. Every source system, dataset, variable, job and schedule in it goes with them, and every record ever loaded into it. There is no undo and no copy. Other environments are untouched. If you were working in the deleted environment, the browser returns to the default.