Environments

Environments are used to organise changes and assets within a project.

Accessing the environments table screen

To view all environments within a project:

1. Log in to the GUI.
2. Click on projects on the navigation bar on the left side.
3. Navigate to your desired project.
4. Click on the environments tab to display the list of environments.

info

Just as with projects, if you don't see any environment in the list, it is possible that either no environment has been created for this project or you have not been granted access to any environment within it.

Environment table columns

Column	Description
Name	Displays the name of each environment.
Code	Shows a unique identifier for the environment.
Description	Provides a short summary or purpose of the environment.
Archived	Indicates the archival status of the environment.

Buttons & links

Buttons & links	Function
Create environment	Add a new environment to the project in OpsChain.
Bulk actions	Perform operations on multiple environments, such as archiving.

Managing environments in the table

• Use checkboxes to select multiple environments for bulk operations (archiving or restoring).
• Click on a column heading to sort the contents of the table.
• Click on an environment's row to navigate to its detailed view.

Archiving an environment

Archive an environment by selecting it from the environments table and choosing Archive from the Bulk actions menu.

Archiving an environment:

• archives every asset that belongs to the environment
• disables every scheduled activity defined on the environment (and on its child assets) - they will not run until the environment is restored
• prevents new changes, workflow runs and scheduled activities from being created in the environment (or its assets)

info

An environment cannot be archived if it contains a queued or running activity. Wait for those activities to complete (or cancel them) before archiving.

Creating a new environment

To create a new environment, follow these steps:

1. Click on the create environment button.
2. Fill in the mandatory fields in the dialog, including name and code.
3. (Optional) Add a description to clarify the purpose of the environment for other users.
4. Click the create environment button to finalise the creation of your environment. You will then be taken to the environment details screen for the newly created environment.

tip

The values entered for name and code must be unique within a project. i.e. there cannot be more than one environment with the same code or name in the same project.

Viewing the environment details

You can view the details of an environment by clicking on its row.

Environment details screen

This screen displays the changes, scheduled activities, assets, properties and settings specific to this particular environment and its child assets.

Activity tab

Lists the changes that have been deployed in this environment. Refer to the activities list for a detailed description of this table's contents.

Scheduled activities tab

This tab lists the scheduled activities defined for this environment. Refer to the scheduled activity details for a detailed description of this table's contents.

Assets tab

This tab lists the assets available for this environment. Refer to the assets page for a detailed description of this table's contents.

Properties tab

A set of properties can be specified against an environment. The properties are then available to the actions that are executed within the environment and its child assets. This allows the action to query the value and then influence the change. This tab lists the properties available for this environment. Refer to the properties page for a detailed description of this table's contents.

Settings tab

The settings tab allows you to specify configuration options that apply to the environment and its children. Refer to the settings page for a detailed description of this table's contents.