Add/Edit Environments

Introduction

You can add and edit Environments on the Environment Manager page. You can also duplicate environments.

Pre-requisite

You must have ‘Create Environments’ and ‘Update Environments’ user permissions.

Environment > Manager

Add an Environment

To add an Environment:

  1. Navigate to the ‘Environment’ page.
  2. Click.
  3. The ‘Environment’ pop-up displays. Fill in the fields as follows to create a new Environment.

Details

Environment Definition

FieldDescription
Environment NameMandatory; Enter the Environment name.
DescriptionProvide a description of the Environment.
SystemMandatory; Select a System from the System drop-down menu.
The System’s ‘My Environment Booking’ approvers are listed in a clickable tooltip under the System drop-down menu so you know which person to ask for permission to use the System.
Administrators can prevent users from selecting Systems outside their Portfolio Association by selecting the My Portfolio Association checkbox for the ‘Restrict Site-Wide View of Environments’ user permission.
BuildEnables on selecting a System. Select a build.
Integrated withSelect an Integrated Environment Group. Integrated Environment Groups can be toggled on Environment Map. You can select an existing Environment Group from the drop-down menu or create a new Environment Group for the Environment, see Manage Environment Groups for details.
URLEnter the Environment’s URL.
Used for PhaseSelect a phase for which the Environment is used. You can customize this menu via Used For Phase Customization.
Scheduler DisplaySelect a display color for this Environment to appear on the Environment Schedule.
VendorEnter a vendor for this Environment.
Parent toAdd a linked Environment to which this Environment is a parent. For detailed steps, see Manage Linked Environment.
To enable Linked Environments, go to Environment Setup Customization.
Child ofAdd a linked Environment to which this Environment is a child. For detailed steps, see Manage Linked Environment.
To enable Linked Environments, go to Environment Setup Customization.
StatusSelect the Environment status. You can customize this menu in Status Customization.
IconSelect an Icon. Icons are displayed in the Environment Map and provide an extra layer of information about the Environment. For example, whether the Environment is a Cloud Server.
This is a Shared EnvironmentSelect this checkbox if the Environment can be booked multiple times simultaneously.
Any booking will be automatically approvedSelect this checkbox to automatically approve any booking of an Environment, whether booked from a TEBR (with or without a Release) or a Release (Enterprise, Project, or Independent). The booking will stay in an approved state even if the dates of the booking are changed.
Display booking alertBooking alerts pop-up to provide you with extra information when trying to book the Environment. Select the checkbox to make the alert pop-up appear. Type the message in the Message that will appear in the pop-up.

Technical Specs and Configuration

Fill in the Technical Specs and Configuration form. For more information, see Manage Technical Specs and Configuration.

Environment Schedule

The button is enabled only when editing the Environment. Refer to Edit Environment.

After making the required entries, click

Additional Information

The Additional Information tab contains custom fields, which administrators have added using Environment Custom Fields Customization. These fields will vary between each Plutora installation. Please consult your administrator for the procedure for filling in these fields. If you lack permission to see a custom field tab’s fields, that tab will be hidden for you. (The permission is set in Release Custom Fields Customization.)

Stakeholders

Add and manage stakeholders for the Environment in the ‘Stakeholders’ tab. For details, see Manage Environment Stakeholder.

Linked Items

See the TECRs and TEBRs associated with this Environment. Filter your linked TECRs and TEBRs by clicking on the radio buttons.

Automated Jobs

The Automated Jobs tab displays the list of automated jobs that are linked to that Environment’s System. The list can only be managed from the System. Parameters are managed at the TECR level, so any changes to the parameters in the Environment will not be used.

Click View Execution History to see all the automated job execution logs for that Environment, including every associated TECR and Deployment Activity job.

See the following articles for more information:

Click .

Edit Environment

To edit an existing Environment, search the Environment on the ‘Environment’ grid. For search and filter options, see Search and Filter Options on Environment Manager. Click on the Environment Name to open and edit. For details, see the above sections. The following options are visible/editable only in the edit mode:

Environment Health Check

Health Check Dashboard provides a view of the health of selected Environment and their associated TECRs and TEBRs. You must have enabled the Enable Health Check checkbox in Environment Setup Customization to view the Health Check.

To view the configured Health Check Dashboard information:

  • NO DATA: No data has been provided via the API.
  • ONLINE: The Environment is online.
  • OFFLINE: The Environment is offline.
  • ISSUE: The Environment is neither online nor offline but has an issue.

Click  to get the latest status.

See the Swagger article for how to generate a token and use Swagger to access Plutora’s external APIs.

Use the following API endpoints to update your Health Check Status:

  • POST /environmentHealthCheck: Populates the data in the Environment Health Check panel and Health Check Dashboard. Include the following data:
    • Test Name.
    • Status.
    • An optional Log File or Test File as a text file attachment.
  • POST /environmentHealthCheck/FullHistory
  • POST /environmentHealthCheck/CurrentStatus

Environment Schedule

To check the Environment Allocation Schedule click . The ‘Environment Schedule’ page displays showing all the bookings for that Environment. For details, see Environment Schedule.

More Information

Manage Linked Environment

Linking Environments enables you to select a parent Environment in a TEBR (with or without a Release) or an Enterprise, Project, or Independent Release.

Add a Linked Environment:

Ensure you have enabled Linked Environments (go to Environment Setup Customization. Environments already selected but outside the user’s Portfolio Association will be hidden if administrators select the My Portfolio Association checkbox for the ‘Restrict Site-Wide View of Environments’ user permission. Environments outside the user’s Portfolio Association will also not be available for selection)

  1. Click .
  2. Click the combo menu and select one or more of the Environment checkboxes.
  3. Click .

The Environment lists under the ‘Parent to’/’Child to’ column.

Apply Parent Environment Status to Child Environments by clicking Apply Status to all Children. This option provides a one-off Environment Status push.

If you change the Parent Environment status again, the Child Environments will not automatically update and you will need to click Apply Status to all Children again.

To unlink an Environment, click X. Then click .

View Audit History

View Audit History of a record to access the associated history of the events and updates. To view the ‘Audit History’, click  at the top-right corner of the pop-up. For more information, see Audit History.

Copy URL

You can share an Environment’s URL by clicking at the top right corner of the pop-up. Then paste the URL into another application or document to be shared. For further information, see Copy URL

Related Articles

Contents

Be the first to find out about new features. Subscribe to the Release Notes email.

Was this article helpful?

Thanks for your answer!