Add Or Edit Environments

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

1. Details Tab

To add or edit an Environment:

1. Add:
   1. By + New:
      1. Go to + New > Environment > Manager.
         
         Administrators can use Title Names Customization to customize the name of the Environment module where it appears throughout Plutora.
   2. By Environment Manager:
      1. Go to Environment > Manager:
      2. Click + New Environment.
2. Edit:
   1. Go to Environment > Manager.
   2. Click a blue-linked Environment Name.
      
3. Click the Contact stakeholders button:
   1. Choose one of the following:
      1. To send the email to all the Stakeholders click to select the Send to all Stakeholders radio button.
      2. To select from a list of Stakeholders who will receive the email, click to select the Send to selected Stakeholders radio button:
         1. Click the combo box and click to select the checkboxes of the Stakeholders you would like to email.
            
            
            Stakeholders are listed from the selected Environment and any related Environment Group. 
   2. Type a single email address into the From field. (Mandatory field.)
   3. Type an email Subject.
   4. Type an email Body.
   5. Click Send.
4. Fill in the Environment Definition form:
   1. Type an Environment Name.
   2. Add or edit Description.
   3. 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 users 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.
      • Once you have selected a System, you can select a Build that is linked to that System.
        
        Builds must be enabled before the Builds field will appear.
   4. Select a Build:
      • Once selected, the Build can be run in a TECR or Deployment Plan Activity linked to the Environment.
   5. Select an Integrated Environment Group from the Integrated with menu or:
      
      Integrated Environment Groups can be toggled on Environment Map.
      1. Select an existing Environment Group from the drop-down menu.
         
         Administrators can prevent users from selecting Environment Groups outside their Portfolio Association by selecting the My Portfolio Association checkbox for the Restrict Site-Wide View of Environments user permission. 
      2. Create a new Environment Group for the Environment:
         1. Click the + and see Manage Environment Groups for the procedure.
            
   6.  Type the URL.
   7. Select Used for Phase.
      
      This menu is customized in Used For Phase Customization.
   8. Select a Scheduler Display color or type a Hex color to choose the color that is displayed in Environment Schedule.
   9. Type a Vendor.
   10. Manage Linked Environments:
       
       Linking Environments enables users to select a parent Environment in a TEBR (with or without a Release) or an Enterprise, Project, or Independent Release and drag and drop the Environment, its Child, and Grandchild Environments all at once.
       1. Add a Linked Environment:
          
          
          To enable 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 a green cross.
             
          2. Click the combo menu and click to select one or more of the Environment checkboxes.
          3. Click Save & Close.
       2. Apply Parent Environment Status to Child Environments:
          1. Click Apply Status to all Children.
             
             
             The Apply Status to all Children button 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.
             
             
       3. Remove an Environment link:
          1. Hover your mouse cursor over the blue Environment link until the delete button appears.
          2. Click the red delete button.
             
   11. Click to select an Environment Status.
       
       This menu is customized in Status Customization. 
   12. Click to select 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.
   13. Click to select the This is a Shared Environment checkbox if the Environment can be booked multiple times simultaneously.
   14. Click to select the Any booking will be automatically approved 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.
   15. Manage booking alerts:
       
       
       Booking alerts pop up to provide a user with extra information when they try to book the Environment.
       1. Click to select the Display booking alert checkbox to make the alert pop up appear.
          
          If you cannot see this checkbox, use the scrollbar to scroll down.
       2. Type the Message that will appear in the pop up.
5. Manage the Health Check Dashboard status for this Environment:
   
   
   Health Check Dashboard provides a view of the health of selected Environments, both now and over the previous 24 hours, and their associated TECRs and TEBRs.
   1. Select the Enable Health Check checkbox in Environment Setup Customization first.
   2. See the Swagger article for how to generate a token and use Swagger to access Plutora’s external APIs.
   3. 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
   4. Any health status recorded in Plutora will only be valid for a 24-hour period. If no updates are received within a 24 hour period, the current status will default back to No Data.
   5. When no data is present, the Environment Health Check panel looks like this:
      
6. View the configured Health Check Dashboard information:
   1. View the Environment status:
      • 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.
   2. Click Refresh to get the latest statuses.
7. Fill in the Technical Specs and Configuration form:
   1. Click Add Host to add a new Host.
   2. Click to select a host and click Add Layer.
   3. Select a Layer Name from the drop-down menu.
      • See Jenkins Integration for how to use Update on Build.
      • The Layer Name drop-down menu contains the default stack layers defined in the Stack Layer Customization.
      • Double click next to Component Name to edit its Version.
      • Host Name, Component Name, and Version are free text fields.
      • A Layer cannot be saved without a Component under it.
      • View Stack opens the Environment Stack.
   4. Click to select a Summary Version checkbox for a Component to make that version number appear in the Continuous Delivery Pipeline:
      • If Builds are enabled, the Build Tag and Build Number will display on the Continuous Delivery Pipeline instead of the Summary Version.
      •  Jenkins automation is no longer necessary to use the Continuous Delivery Pipeline.
      • Users can manually enter a Version Number, click the Summary Version checkbox, and see the Version number displayed on the Continuous Delivery Pipeline.
8. Click the copy button to copy all Technical Specs Configurations to your clipboard.
   • Now, while using Environment Map or adding or editing an Environment, users can select one or more Technical Specs fields and copy them using right click copy, Control + C, or Apple Key + C.
   • The user permission Update Environments is not required to copy configurations and the copy button will be grayed out if there is no data.
9. Import Technical Specs and Configurations from another Environment: Save time by importing configurations rather than creating them from scratch.
   
   If you are adding a new Environment, click Save or the Import button will be grayed out.
   
   
   1. Click to select an Environment from the Select Environment to Import Tech Specs & Config from.
   2. Click to select a radio button to choose an Import Behaviour:
      1. Import and replace all existing Tech Specs & Config: Choosing this radio button will delete and replace all existing tech specs and config. This cannot be undone.
      2. Import and append to existing Tech Specs & Config: Choosing this radio button will add the tech specs and config from the selected Environment to the bottom of the existing ones.
   3. Click Import.
10. Check the Environment Allocation Schedule:
    • The previous Environment Allocation Schedule panel, which only showed bookings for Releases and TEBRs with a Release, has been replaced by a button.
    • The button is only clickable when editing an Environment.
    • Clicking the button:
      • Opens the Environment in Environment Schedule’s Environment View with:
        • The Grouping set to None.
        • The Timeline set from now to six months’ time.
      • Shows all bookings for that Environment, not just Release-related bookings.
11. Click Save.

2. Additional Information Tab

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.

1. Click Additional Information tab.
2. Fill in the fields.
3. Click Save when you have finished.
4. Click Stakeholders tab.

3. Stakeholders Tab

To manage the stakeholders associated with your Environment:

1. Add a Stakeholder:
   1. Click Add Stakeholders.
      

      When users are added as stakeholders more than once, they will appear as a stakeholder only once with all their Roles and Stakeholder RACI Roles merged.

      For example, if a stakeholder with Role A and all the RACI Roles was added again with Role B and no RACI Roles, the stakeholder would appear only once with Roles A and B and all the RACI Roles.

      
      
   2. Select a User Name or a User Group from the Name or User Group drop-down menu.
   3. Select a role from the Role drop-down menu.
      
      Administrators can add roles using the Stakeholder Role Customization.
   4. The Email field is not editable.
   5. Click to select a Stakeholders RACI checkbox.
   6. Click Add & Close.
   7. Click Save.
2. Delete a Stakeholder from an Environment:
   1. Click to select a Stakeholder.
      The Stakeholder will highlight in yellow.
   2. Click Remove.

4. Linked Items Tab

See the TECRs and TEBRs associated with this Environment:

1. Filter your linked TECRs and TEBRs by clicking the View by radio buttons.

5. Automated Jobs Tab

Automated Jobs tab displays the list of Jenkins jobs for that Environment’s System. The list can only be managed in 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 Jenkins job execution logs for that Environment, including every associated TECR and Deployment Activity job.

See Setting Up Jenkins Integration and Continuous Delivery Pipeline for more information.

6. Save & Close

1. Click Save & Close.

View Audit History

Click the clock-shaped button  to view the Audit History of the record. To see more information about Audit History, click here.

Copy URL to Clipboard

Users can copy an Environment’s URL to the clipboard by clicking the Copy to Clipboard  button on the top right of the pop up.