Manage Builds

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

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.

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.

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.

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.

Promote 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.

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!