Environments

Introduction

Multiple environments on the same server can be used to run and have access to different releases simultaneously.

A release is set on environment x therefore the endpoint should specify the environment: https://[hostname]/?environment=[x].

For example, the current release can be run from the production environment that is normally used, while a newer release can be made active on a second environment, e.g., called acceptance, for acceptance testing. The second environment can then be accessed by putting environment=acceptance in the URL (https://[hostname]/?environment=acceptance). If no environment is chosen in the URL, the default environment, as configured in the server settings, is used. Only one release can be active at a time per environment.

Note: End user access is determined by the modules that are active on an environment, not by the environment itself.

Creating Environments

New environments can be specified in the Server Settings by using the Environmentsfield. If it is not set, it defaults to a single environment, production.

Follow these steps to create environments.

Step	Action
1	Go to the Superadmin Settings tab.
2	Add the following line to the Server Settings to the left: , "Environments": ["production", "acceptance"].
3	Click on SAVE.

Now two environments are available: production and acceptance.

Setting a Default Environment

The default environment that is accessed if no environment is given in the URL can be configured in the server settings using the DefaultEnvironment setting. If this is not set, it defaults to production.

Follow these steps to set a default environment.

Step	Action
1	Go to the Superadmin Settings tab.
2	Add the following line to the Server Settings to the left: , "DefaultEnvironment": "acceptance".
3	Click on SAVE.

If no environment is specified in the URL, the acceptance environment is accessed.

Activating a Release on an Environment

A release can be activated on any environment. In the demo below it is assumed that there are two environments, production and acceptance.

Follow these steps to activate a release on the acceptance environment.

Step	Action
1	Go to the Superadmin Releases tab.
2	Right click on the release you want to activate.
3	Select Make active on - Acceptance.
4	Click on OK.

The Active on column now says acceptance in front of the activated release and the release can be accessed by users with the proper access rights once a cache has been generated.

Generating a Cache for a Specific Environment

Each environment has its own set of data instances as shown in the Superadmin Released data tab. The user can select for which environment the data instances are displayed by selecting the desired environment in the drop-down list at the top with the label Data instances for.

Caches must be generated for a specific environment. In the demo below it is assumed that there are two environments production and acceptance.

Follow these steps to generate a cache for the acceptance environment.

Step	Action
1	Go to the Superadmin Released data tab.
2	Select the acceptance in the Data instances for drop-down menu.
3	Click on Generate Cache Now.
4	Click on GENERATE CACHE.

A new column is visible containing information on the newly generated data instances.