Plug-in Documentation

IBM Rational Asset Manager

Overview

With the steps that the IBM Rational Asset Manager Integration plug-in provide you can download, work with, and upload Rational Asset Manager assets during component processes.

This plug-in includes these steps.

Compatibility

This plug-in requires IBM UrbanCode Deploy version 6.0 or later.

This plug-in runs on all operating systems that UrbanCode Deploy supports.

Installation

No special steps are required for installation. See Installing plug-ins in UrbanCode Deploy.

Steps

Process steps in the IBM Rational Asset Manager Integration plug-in

Categorize an Asset

Assign one or more categories to an asset.

Input properties for the Categorize an Asset step
Name Type Description Required
Asset ID String The asset ID for the asset to which a category is being assigned. Yes
Categorization String The list of categories to add to the asset. Press Enter after each category. To specify a hierarchy of categories, use a forward slash (/) to separate categories, for example, Continuous Delivery/Build/Integration. Yes
Password Password The password to authenticate with the repository. No
Repository URL String The URL of the Rational Asset Manager repository. Yes
User String The user name to authenticate with the repository. No
Version String The version for the asset. Yes

Create Relationship to an Asset

Create a relationship from one asset to another asset.

Input properties for the Create Relationship to an Asset step
Name Type Description Required
Asset ID String The ID for the source asset. Yes
Asset Version String The version of the source asset. Yes
Password Password The password to authenticate with the repository. Yes
Related Asset ID String The ID of the related asset. Yes
Related Asset Version String The version of the related asset. Yes
Relationship Type String The ID of the relationship type from the source asset to the related asset. The relationship ID is not necessarily the same as the relationship name. Contact the repository administrator for the relationship ID. Yes
Repository URL String The URL of the Rational Asset Manager repository. Yes
User String The user name to authenticate with the repository. Yes

Download Assets

Download assets from the IBM Rational Asset Manager repository.

Input properties for the Download Assets step
Name Type Description Required
Assets String A list of assets to download. Press Enter after each entry. Verify that each entry has one of these forms:
id/version or id/ramSearch:(SearchString).

If the ID contains a forward slash (/), prefix the forward slash with a backslash (\).

Yes
Directory Offset String The working directory to use when you run this command. The directory is relative to the current working directory. Yes
Include Dependent Boolean Download dependent assets. No
Password Password The password to authenticate with the repository. No
Repository URL String The URL of the Rational Asset Manager repository. Yes
User String The user name to authenticate with the repository. No

Download Related Assets

Download related assets of an asset.

Input properties for the Download Related Assets step
Name Type Description Required
Asset ID String The ID for the asset. Yes
Asset Version String The version of the asset. Yes
Directory Offset String The working directory to use when you run this command. The directory is relative to current working directory. Yes
Password Password The password to authenticate with the repository. Yes
Related Asset ID String The ID for the related asset. No
Related Asset Version String The version for the related asset. No
Relationship Types String The ID of the relationship types from the source asset to related asset, separated by comma. The relationship ID is not necessarily the same as the relationship name. Contact the repository administrator for the relationship ID. No
Repository URL String The URL of the Rational Asset Manager repository. Yes
User String The user name to authenticate with the repository. Yes

Set Attribute

Set attribute on an asset.

Input properties for the Set Attribute step
Name Type Description Required
Asset ID String The ID for the asset. Yes
Attribute Name String The name of the attribute. Yes
Attribute Value String The value of the attribute Yes
Password Password The password to authenticate with the repository. No
Repository URL String The URL of the Rational Asset Manager repository. Yes
User String The user name to authenticate with the repository. No
Version String The version for the asset. Yes

Upload Asset

Upload asset to a Rational Asset Manager repository.

Input properties for the Upload Asset step
Name Type Description Required
Asset ID String The ID for the asset. Yes
Community String The community for the asset. Yes
Directory Offset String The working directory to use when you run this command. The directory is relative to current working directory. Yes
Password Password The password to authenticate with the repository. Yes
Repository URL String The URL of the Rational Asset Manager repository. Yes
Type String The asset type for the asset. Yes
User String The user name to authenticate with the repository. Yes
Version String The version for the asset. Yes

Usage

Before you begin

To use this plug-in, a supported version of Rational Asset Manager must be installed.

Example: Deploying an application and running Selenium test

The following example is a component process that completes three actions:

  • The process deploys an application.
  • The process runs an associated Selenium test on the deployment.
  • The process updates the status of the asset in the library server, baseing the status on the test results.

The following diagram shows this process.

This example requires that the application binary files are in the component and the Selenium test cases are part of the component.


rationalassetmanager_3

  1. The Download Artifacts step retrieves the binary files.
  2. The Execute Test Case step runs tests against the application. To learn more about running test cases, see the Rational Quality Manager plug-in.
  3. Based on the outcome of the Execute Test Case step, the Categorize an Asset step is used to mark the status of the component asset as Test Passed or Test Failed.
  4. The Upload Asset step publishes the Selenium test results to the Rational Asset Manager server.
  5. The Create Relationship to an Asset step creates a relationship between the Selenium test results and the application component. The step uses the environment properties that were stored when the application was deployed to access the correct application component and version.

Example: Running Rational AppScan tests

In this example, the component process deploys an application, runs an associated IBM Security AppScan test on the deployment, and updates the status of the asset in the library server, basing the status on the test results.

This example requires that the application binary files are in the component.


rationalassetmanager_4

  1. The Deploy step deploys the application by using the process that was created in an earlier step in the scenario.
  2. The Download Related Assets step downloads the IBM Security AppScan test template that is associated with the component asset.
  3. The Execute Test Case step runs the specified IBM Security AppScan tests.
  4. The Upload Asset step publishes the IBM Security AppScan test results to the Rational Asset Manager server.
  5. The Create Relationship to an Asset step creates a relationship between the IBM Security AppScan test results and the application component. The step uses the environment properties that were stored when the application was deployed to access the correct application component and version.