Defining a precheck for deploying a package

When the deployment package is in the Draft state, as an administrator or Package Creator, you can optionally define a precheck for a package.

You define a precheck qualification to validate preconditions for deployment, such as the version, or to validate content, such as a form. The package content is deployed only if the precheck passes. You can also customize the error messages that are displayed when the precheck fails.

Related topics

Defining-and-deploying-data-and-object-packages

Accessing-the-AR-System-Deployment-Management-console

Package-level precheck

A package-level precheck qualification checks package status and version compatibility before you deploy or roll back a package. For example, you can perform a precheck that validates and shows an error message when you deploy a patch for version 18.05 on version 9.1.04.

If a qualification you have set for the package-level precheck fails, the package status on the Deployment Management console changes to Rejected, and the package is not deployed.

Content-level precheck

A content-level precheck qualification checks the contents of a package. 

Example

When you want to deploy a BMC Helix ITSM patch that contains fixes for all applications such as  Asset Management, Knowledge Management, and Service Request Management. However, you do not use Asset Management. So you define a content-level precheck that excludes the Asset Management patch deployment.

Additionally, if a content type fails a content-level precheck, the current content entry of the deployment package is skipped, and the next content entry or a content type is processed for the precheck and the package is successfully deployed.

To create a precheck qualification for a package

  1. Define a package.
  1. Click Manage precheck.
    The RDA:DeploymentPackagePreCheck form is displayed.
    221_content precheck.png
  2. Select a Precheck Type from the following options:
    • Package Deploy
    • Package Rollback
    • Content Deploy
  3. If you selected Content Deploy, in the Content Name, select the content type for which you want to set a precheck qualification.
  4. Enter a Precheck Name.
  5. In the Form Name list, select the form name.
  6. In the Qualification field, enter a query to build the precheck qualification.
  7. In the Activity Log Message field, enter the error message or warning that you want to display if the qualification fails.
  8. Click Add and click Close.
    A precheck qualification is created for your deployment package.

Important

After you click Refresh on the RDA:DeploymentPackagePreCheck form, the form displays all prechecks instead of displaying the precheck for which the content is selected.

To modify or delete an existing precheck qualification

A deployment package must be in a Draft state to modify an existing precheck.

  1. In the RDA:DeploymentPackageDetails form, click Manage Precheck.
  2. From the Deployment Package Pre-check list, select an existing precheck.
  3. In the Qualification field, perform one of the following actions:
    • Click Modify and modify an existing qualification.
    • Click Remove to delete an existing qualification.
  4. Click Close.

Where to go from here

Importing-and-exporting-a-package

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*