Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

By default, all active Environments are displayed in the search results. To refine the search results, type all or part of the Environment name into the Search box, and the list will automatically filter.

Click the Inactive toggle to show the inactive environments.

...

Creating/Editing an Environment

To create an Environment, click the Create button in the top right. To edit an Environment click on it’s name, or click on the 3 dots of an existing Environment row from the list.

...

Field Name

Required

Description

Code

Yes

Short name for the Environment.

Name

Yes

Long display name for the Environment.

Description

No

A description of the Environment.

ActiveEnvironment Color

Yes

Whether or not the Environment is active in the system. Defaults to "Yes"No

To display specific color to the environment.

Build Environment

Yes

Identifies whether the Environment is used for builds.

Production Environment

No

Whether to use Environment as used for production

Sort Order

Yes

A sort index to control the order in which the Environment is displayed within lists.

Environment Color

No

To display specific color to the environment.

Environment Permissions

Yes

You can toggle a slider to override the default permissions. If overriding, you can assign certain groups permission to modify the environment.

If users have write access to both the target group and environment, then they can modify the target’s properties and endpoints.

Active

Yes

Whether or not the Environment is active in the system. Defaults to "Yes".

Click the Save button to save the changes to the Environment, or to cancel the changes Cancel button is to be clicked.

To delete the existing Environment, click on Delete option.

...

If you want to change the order in which the environments appear, simply click and drag that environment.

Inactivating/Activating

To inactivate an Environment at any time, click the Active link on the desired Environment, and it will toggle to Inactive. This will hide that Environment after leaving the screen, until the Active checkbox is unchecked. To reactivate an Environment, click the Inactive link and it will toggle back to Active. This Environment is now active in the system again and ready for use.