Manage Builds

Manage the Builds for your enterprise.

1. Enable Builds

To enable Builds entity:

  1. Go to Settings  > Customization > Builds.
  2. Click Build Setup.
  3. Click to select the Enable Builds checkbox.
    The saving of CI application console logs can also be toggled from Build Setup Customization

2. Enable User Permissions

To enable user permissions so that Builds can be used:

  1. To enable user permissions so that Builds can be used:
    1. Go to Settings  > User Management.
    2. Click Manage Permissions.
    3. Under System Manager, click to select the following user permissions:
      Select only All Portfolio Associations checkboxes if you want users from all teams to be able to manage Builds. Select only My Portfolio Association checkboxes if you have multiple teams and you only want them to be able to manage their own Builds. 

      • Create Builds.
      • Edit Builds.
      • Delete Builds.
      • Create/Delete Build Public Query Builder: Users can create and delete public filters in the Build grid’s Query Builder.

3. Manage Builds

3a. Manage Builds Using APIs

Builds can be created, updated, and removed using the following API endpoints:

Change logs and build logs are attachments to the Build. They can be managed via the API using BuildChangeLog and JobExecutionLog in the Type field of Attachment endpoints.

  • GET /Builds
  • POST /Builds
  • DELETE /Builds/{id}
  • GET /Builds/{id}
  • PUT /Builds/{id}
  • POST /Builds/{id}/JobExecutions
  • GET /Builds/{id}/Changes
  • PUT /Builds/{id}/Changes

Builds (buildId and buildNumber) can be associated with other entities using the following endpoints:

  • Environments:
    • GET /environments
    •  POST /environments
    • GET /environments/{id}
    • POST /environments/build
  • TECRs:
    • POST /TECRs/{id}/Environments/{EnvId}
    • GET /TECRs/{id}/Environments/{EnvId}
    • PUT /TECRs/{id}/Environments/{EnvId}
  • Deployment Plans:
    • GET /DeploymentPlanActivities/GetGridActivities
    • GET /DeploymentPlanActivities/GetActivities
    • POST /DeploymentPlanActivities/BatchCreate
    • PUT /DeploymentPlanActivities/BatchUpdate
    • GET /DeploymentPlanActivitySets/ActivitySets
    • PUT /DeploymentPlanActivitySets/BatchUpdate

3b. Add or Edit a Build Manually

Builds created manually have fewer fields, and can be added via Systems or via the Builds grid.

To add a Build from a System or the Build grid:

  1. From the Builds grid:
    1. Go to Environment > Builds.
    2. Click + New Build.
  2. From the Systems Grid:
    1. Go to Environment > Systems.
    2. Open a System.
    3. Click New Build.
  3. Select a System:
    • Builds grid: The System can be selected.
    • System: System is grayed out, with the current System selected.
  4. Select a Linked Release:
    • Linked Releases available for selection are:
      • Active. In other words, not Completed or in an end state.
      • Linked to the selected System.
      • If a parent Enterprise Release is selected, the child Releases will also be displayed.
      • If a child Release is selected, the parent Release will not be displayed.
  5. Select a Linked Change:
    • Linked Changes available for selection are:
      • Linked to the selected System.
      • If a Linked Release is selected above, only Changes linked to the System and the Release can be selected.
  6. Select an Environment:
    • Environments available for selection are:
      • Linked to the System.
  7. Click the Manual tab if it is not already selected.
  8. Type a Build #. (Mandatory.) (Usually, the internal version number.)
  9. Type a Build Tag. (Usually, the external version number, such as 3.1.1.)
  10. Type a Branch. (Usually, the name of the branch from the source control management tool.)
  11. Select a Build Status. (Mandatory.)
  12. Click Create New Build.

3c. Add a Build using Automated Jobs

To add Jenkins jobs to Builds from a System or the Builds grid:

  1. From the Builds grid:
    1. Go to Environment > Builds.
    2. Click New Build.
  2. From the Systems Grid:
    1. Go to Environment > Systems.
    2. Open a System.
    3. Click New Build.
  3. Select a System:

    • Builds grid: The System can be selected.
    • System: System is grayed out, with the current System selected.
  4. Select a Linked Release:
    • Linked Releases available for selection are:
      • Active. In other words, not Completed or in an end state.
      • Linked to the selected System.
      • If a parent Enterprise Release is selected, the child Releases will also be displayed.
      • If a child Release is selected, the parent Release will not be displayed.
  5. Select a Linked Change:
    • Linked Changes available for selection are:
      • Linked to the selected System.
      • If a Linked Release is selected above, only Changes linked to the System and the Release can be selected.
  6. Select an Environment:
    • Environments available for selection are:
      • Linked to the System.
  7. Click the Automated tab if it is not already selected.
  8. Click to select the checkboxes of Automated Jobs (sourced from Jenkins or Integration Hub).
  9. Select Parameters:
    1. Click + Parameters and select or type the parameters:
      • If default parameters were set, their values can be edited at this point but new parameters cannot be added.
    2. Click Save & Close.
  10. Click Create New Build.

3d. View Build Details

To view and manage Builds in their Systems, go to Environment > Systems and open a System.

Opened Systems show the following panels.

Recent Builds Panel

Loads the 25 most recent Builds for that System.

The Build Status updates in real-time when a Build is run.

To see all the Builds for this System, go to Environment > Builds and filter by System.

Click a Build # to open the following information about that Build.

Build Name

If a Build has been created manually, you can edit its name. Hover the mouse cursor over the Build name and click the pen icon to edit.

Details Panel

The Details panel Build Tags and other information about the Build.

Click to edit:

  • Build Tag.
  • Branch Name.
  • Build Status.
  • Linked Release.

Click to view the Change Log, which is the commit information generated by the CI tool.

Deployment History Panel

The Deployment History panel shows the list of deployments of the Build to various Environments belonging to the Build’s System. This can show the Build’s progression through Environments, from Development to Production, and where the deployment has been triggered from, for example, a TECR or a Deployment Plan Activity.

Job Execution History Panel

The Job Execution History panel shows the data from the automated jobs from Jenkins and Integration Hub that have been linked to the Build.

Click View Log to see the console output.

Changes Panel

The  Changes panel shows the Changes that were selected when creating a Build. These Changes are only selectable if they are linked to the Build’s System and, if a Release is selected, to the Release as well.

4. Promote a Build between Environments

Once a Build has been associated with a System, the System’s Environments can be associated with the Build directly or you can track the promotion of the Builds to Environments via a TECR or a Deployment Plan Activity.

Builds can be promoted between Environments by:

  • Using the API.
  • Manually updating the Build in the Environment.
  • TECRs.
  • Deployment Plan Activity.

4a. One Environment at a Time

To manually update the Build associated with a single Environment:

  1. Go to Environment > Manager.
  2. Open an Environment.
  3. Select a Build.

  4. Click Save & Close.

4b. Multiple Environments at a Time

Builds can be manually bulk updated for selected Environments:

  1. Go to Environment > Manager.
  2. Click to select the checkboxes of two or more Environments (in the left column of Environment Manager).
  3. Select Bulk Update from the Action drop-down menu.
  4. Select a System, and once a System has been selected, you can select a Build.

    Changing a System once a Build has been selected will de-select the Build.
  5. Click Update.

4c. Promote a Build using TECRs

To update an Environment:

  1. Go to Environment > TECR.
  2. Open a TECR.
  3. Click Add Environment.
  4. Click Save before continuing.
  5. Continue with either With Automated Jobs or Without Automated Jobs below, depending on what is enabled.

With Automated Jobs

If Jenkins or Integration Hub automated jobs are enabled:

  1. Select a Build. The Builds associated with the selected System and Release are listed.
  2. Click Save.
  3. Click Select Jobs and select the Jenkins jobs to run.
  4. Select Parameters:
    1. Click +Parameters and select or type the parameters for this Environment.
    2. Click Save & Close.
  5. Click Save again.
  6. Click Run Automated Jobs:
    • The Jenkins jobs in the Build are triggered and will run in sequence.
    • Upon successful completion of the automated jobs, the Build will be associated with the Environment.
  7. Click View History for the job execution history, including the name of the job, execution date and time, the parameters used for the execution, and the application used.
  8. Click Save or Save & Close.

Without Automated Jobs

  1. Select a Build. The Builds associated with the selected System and Release are listed.
  2. Update the Status to an end state, such as Completed.
  3. Click Save or Save & Close.
    The selected Build is now associated with the Environment.

4d. Promote a Build using Deployment Plan Activities

Add Builds in Draft Mode

To add a Build to a Deployment Plan Activity:

  1. Go to Deployment > Manager.
  2. Click the Draft mode tab.
  3. Click to open a Deployment Plan in Draft mode.
  4. Click the Activities tab.
  5. Click + New to add a new Activity. The new Activity form opens in the right-hand panel.
    Or:
    Click a blue-linked Activity Name in the left-hand panel to make it open it in the right-hand panel.
  6. Type or edit the Activity Name. (Mandatory field.)
  7. Type or edit the Activity Description. 
  8. Click to select a System:
    • You can only select from the Systems chosen in the Systems field under the Information tab.
    • To run Builds in Deployment Activities, Systems must be selected that have those Builds associated.
  9. Select an Environment:
    • The Environments belong to the Systems selected above.
  10. Select a Build:
    1. The System and its Environment must have been selected first.
    2. Listed Builds are also filtered depending on the selected Release under the Information tab.
  11. Click Select Jobs and select the Jenkins jobs to run.
  12. Select Parameters:
    1. Click + Parameters and select or type the parameters for this Environment.
    2. Click Save & Close.
    3. Click Save & Close to close the Parameter pop up.
  13. Click Close to close the Activity.
  14. Click Save & Close on the Deployment Plan.

Run Builds in Execution Mode

To promote a Build using a Deployment Plan Activity:

  1. Go to Deployment > Manager.
  2. Click to open a Deployment Plan in Execution mode.
  3. Click the Activities tab.
  4. Continue with either With Automated Jobs or Without Automated Jobs below, depending on what is enabled.

With Automated Jobs

  1. Click to open an automated Activity. (With the cogwheel icon.)
  2. Click Run Automated Jobs.
    • The Jenkins jobs in the Build will be triggered and will run in sequence.
    • Upon successful completion of the automated jobs, the Build will be associated with the Environment.
  3. Click View History for the job execution history, including the name of the job, the execution date and time, the parameters used for the execution, and the application used.

Without Automated Jobs

  1. Open an Activity with a selected Build.
  2. Click the Completed status.

    The Build will be deployed to the selected Environment.

5. View Builds

5a. View Builds on the Environment Map

To view Builds data per Environment on the Environment Map:

  1. Go to Environment > Map.
  2. Select an Environment Group from the Environment Group drop-down menu.
  3. Click View.
  4. Click an Environment icon to see more information about that Environment.
  5. View the Builds field:

    • The data is: Tag | Build Number (Branch Name) or just Build Number (Branch Name) if there is no tag.

5b. View Builds on the Continuous Delivery Pipeline

To view Builds data on the Continuous Delivery Pipeline, go to Environment > Continuous Delivery Pipeline.

 

Back to the top arrow

Be the first to find out about new features. Subscribe to the Release Notes email. Subscribe Now
Updated on October 18, 2021

Was this article helpful?

Related Articles