Policies for lifecycles in Rational Asset Manager

You can apply several policies in asset lifecycles.
These policies are included in the product:

ALE

When this policy runs, it refers to the mapping configuration file for the connection to IBM® WebSphere® Service Registry and Repository (WSRR). Then, the policy runs any actions that you defined in the mapping file.

You can validate transition rules for a manual user action by selecting the Action check box. Before the ALE policy moves an asset to another state, the policy checks the transition rule in the ALEConfiguration.xml file to validate the rules for transitions. The policy also checks that the policy is in the Approve condition. For automated transitions, use the ALE transition policy.

Configuration:
Property Value
Connection For your community, select a connection to WSRR.

ALE transition

This policy validates the rules for each ALE transition that is defined in the ALE configuration file. When this policy runs, it refers to the mapping file for the connection to WebSphere Service Registry and Repository (WSRR). Then, the policy validates rules that you defined in the mapping file, such as rules for artifacts, categorizations, relationships, or WSRR states.

You can use the ALE transition policy to configure policies for automated state transitions. You base your policy configurations on rules in the ALE configuration mapping file. You can use the policy on a state for each transition. The ALE transition policy validates whether an action can be taken on a given state for a given transition. You specify a transition in the Action property of the policy.

For example, for a business solution that is in the Proposed state, the possible transitions are Approve and Reject. You can add an ALE transition policy for each action to validate the rules for the transitions that are in the ALEConfiguration.xml file.

To configure the exit condition for a specific transition, remove the manual action condition from the ALE policy and add the ALE transition policy. Then, use the rules in the ALE configuration file to configure the ALE transition policy for validating the transition or action.

Configuration:
Property Value
Connection For your community, select a connection to WSRR.
Action Enter the action for which the transition rule is evaluated.

(Back to top)

Append artifacts

Use this policy to copy all of the artifacts from an asset into other assets. For example, if an asset must include a file that contains legal information about your company, you can create an asset with that file. Then, you can use this policy to add the file to other assets as they progress through a lifecycle.

Configuration:
Property Value
Source Asset GUID Type the unique identifier for the asset to copy the artifacts from. You can find the GUID for an asset on the General Details page.
Source Asset Version Type the version number for the asset to copy the artifacts from.
Artifact Label Type a label for artifacts that are copied to assets by using this policy.
Override on collision If an asset has an artifact that is being copied, select whether the artifacts from the source asset must overwrite the existing artifacts. To always use the artifacts from the source asset, select Yes; to preserve the artifacts, select No.

(Back to top)

Artifact validation

With this policy, you can set up artifact constraints that are like the constraints that you can require when configuring an asset type. For example, you can require that a software asset for Windows must include a file with a .exe extension.

Configuration:
Property Value
Operator Select one logical operator: Exactly, At least, or At most.
Number of artifacts Enter the number to apply to the Operator.
Artifact type Select a type: Format of, Label of, File extension of, or Full file name of.
Value Enter the value to check against the Artifact type. For example, if you selected File Extension, you can type exe for the required file extension.
Applies to Category To limit the policy to certain categories of assets, enter the categories of assets that this policy runs against.

To apply the artifact validation policy to all assets that enter the state that you are configuring, leave this field blank.

To specify a required hierarchy of categories, use a forward slash (/) to separate categories. For example, if you enter Operating Systems/Windows/XP, only assets with the category XP are checked when the policy runs. If the hierarchy is Operating Systems/Windows, the assets that are categorized as either Windows or any child of Windows are checked when the policy runs.

Separate multiple policies with a semicolon (;) to indicate OR. For example, if you enter Operating Systems/Windows/;Operating Systems/Linux, assets with the categories of Windows or Linux are checked.

(Back to top)

Asset and artifact scanner

This policy scans either the general details or the artifacts of an asset for words or phrases. For example, you might scan an asset to find legal notices or to check for inappropriate words.

Configuration:
Property Value
Scan assets Select this option to check the attributes and descriptions of assets.
Assets must contain all of the words/phrases Type the words or phrases that must be present. To group phrases, use double quotation marks ("). To separate words or phrases, use spaces.
None of the words/phrases Type the words or phrases that must not be present. To group phrases, use double quotation marks ("). To separate words or phrases, use spaces.
Scan artifacts Select this option to scan the artifacts that are attached to the asset.
Restrict search to Artifacts of File types Type the file extensions of artifacts to scan. Separate multiple extensions with spaces. To scan all artifacts, leave this field blank.
Artifact must contain all of the words/phrases Type the words or phrases that must be present. To group phrases, use double quotation marks ("). To separate words or phrases, use spaces.
Artifact must not contain any of the words/phrases Type the words or phrases that must not be present. To group phrases, use double quotation marks ("). To separate words or phrases, use spaces.
On failing the policy Select whether the policy issues a warning or an error if it fails.

(Back to top)

Asset cleanup

When this policy runs, it retires or deletes all earlier versions of the asset. For example, when version 2.0 of a software asset is approved, you might delete all earlier versions that you no longer support.

Configuration:
Property Value
Delete or Retire Select whether to delete previous versions or to automatically move them to the Retire lifecycle, which limits who can find and download the asset.

(Back to top)

Attribute validation

Use this policy to force an asset attribute to be required. You can also require a specific value. For example, you can require that a software asset must have a support contact, which is an attribute of the User type.

Configuration:
Property Value
Attribute name The name of the attribute that users must always supply a value for.
Required Select this check box to make attribute that you specified required.
Attribute value Optionally, add a value that users must enter for the policy to pass. If any value can pass, leave this field blank.

(Back to top)

Build Forge

Use this policy to launch a project in IBM Rational® Build Forge®. For example, if a software asset moves from a development state into a staged state in preparation for testing, you can run a Rational Build Forge project that automatically builds and deploys the software for others to see.

This policy is not installed by default, but it is included with the product. To install the policy:
  1. In the web client, click the Help icon and then Extensions.
  2. In the Build Forge Policy section, download the buildforge.zip file. Do not extract the file.
  3. Click Administration.
  4. In the Repository Administration sidebar, click Custom Extensions.
  5. In the Policy Extensions section, click New Policy Extension.
  6. In the New Extension window, in the Class name field, type com.ibm.ram.buildforge.policy.BuildGovernor
  7. In the .jar or .zip file field, click Browse and navigate to the buildforge.zip file that you downloaded. Then, click OK.
Configuration:
Property Value
Server host URL The URL for the Rational Build Forge server. For example: http://example.com:9080/
Project name The name of the project to launch when the policy runs.
User name The user ID to use to log in to the Rational Build Forge server.
Password The password for the user name.

(Back to top)

Categorize asset

Use this policy to add or remove categories for an asset when the policy runs. For example, you might want an asset to always be assigned a specific category when it enters a certain state.

Be careful when adding or removing categories from assets. If the categories change and trigger the conditions for a different lifecycle, an asset might enter a different lifecycle.

Configuration:
Property Value
Add or remove categories Select to either add or remove categories from an asset.
Asset categories Select one or more categories to add or remove from an asset when the policy runs.

(Back to top)

Category validation

Use this policy to require assets in a lifecycle to have specific categories applied to them.

Configuration:
Property Value
Required categorization Specify the categories that assets must have for this policy to pass. Include the category schema name and optionally follow it by child category names.

To specify a required hierarchy of categories, use a forward slash (/) to separate categories. For example, if you enter Operating Systems/Windows/XP, only assets with the category XP can pass when the policy runs. If you specify Operating Systems/Windows, assets that are categorized as either Windows or any child of Windows can pass when the policy runs.

(Back to top)

Copy attribute

Use this policy to copy the value of an attribute from one related asset and apply that value to an attribute on this asset.

Make sure that the attributes are of the same attribute type. For example, both attributes might be of the User type.

Use this policy with assets that have only one related asset of a particular relationship type. For example, the each of the assets might have one related asset of the Implementation relationship. You cannot select multiple relationships. The policy copies only one attribute from one asset.

Configuration:
Property Value
Copy from Attribute Name Select the attribute from the related asset to copy.
Copy to Attribute Name Select the attribute on this asset that will receive the copied value from the related asset.
Relationship Specify the relationship type of the related asset. You cannot specify multiple related assets or relationships.

(Back to top)

Create service request

You can use the Service Request policy to create a service or process request to deploy an asset on an IBM Tivoli® Change and Configuration Management Database (CCMDB) server. This policy creates a link to the service or process request on the asset. You can also link from the service or process request in CCMDB back to Rational Asset Manager.

To enable this policy you must create the RAMPMCOMSR and RAMSR object structuresby using Tivoli Service Request Manager.

Configuration:
Property Value
Policy display name Display name for the policy.
Url Base URL of the Change and Configuration Management Database (CCMDB). For example, https://www.example.com:9443.
Username Username of the requestor.
Password Password of the requestor.
Reported By User on whose behalf the request is being made.
Request Type Select Service Request or Process Request.
Description Description for the request.
Summary Summary for the request.

(Back to top)

Default versioning

Use this policy to require assets in a lifecycle to increase version numbers in a specific way when the asset is modified. For example, you can specify that the second digit in a version number must increase if someone adds or removes an artifact from the asset. You can manage version numbers up to five digits. For example: 10.1.20.12.2.

Configuration:
Property Value
Versioning scheme Select Numeric.
Change in asset classification To require the version number of the asset to increase when the categories of an asset change, select which digit must increase. If any digit must increase, select Version must increase.
Change in asset artifacts To require the version number of the asset to increase when the artifacts of an asset change, select which digit must increase. If any digit must increase, select Version must increase.
Change in asset description To require the version number of the asset to increase when the description of an asset changes, select which digit must increase. If any digit must increase, select Version must increase.
On failing the policy Select whether the policy issues a warning or an error if it fails.

(Back to top)

DLA Generation

When this policy runs, it generates a Discovery Library Adapter (DLA) output file for the asset for IBM Tivoli Change and Configuration Management Database (CCMDB). For example, you can configure the policy to generate the file when an asset has completed a review process and is approved for use. The policy either sends an email to the DLA file or uploads it to a server by using FTP.

Configuration:
Property Value
Email all reviewers Select this property to notify all collaborators for the asset that the DLA output file was generated.
Email lifecycle managers Select this property to notify all lifecycle managers for the lifecycle that the DLA output file was generated.
Email asset owners Select this property to notify all owners of the asset that the DLA output file was generated.
Email others Type additional email addresses to notify users that the DLA output file was generated. To separate multiple addresses, use commas (,).
Attach DLA to Email Select this property to attach the DLA file to the email notification.
Upload DLA file via FTP Select this property to upload the DLA file to a server by using FTP.
FTP Hostname Type the host name of the FTP server. Do not type ftp://.
FTP User Type the user name of the user for the FTP server.
FTP Password Type the password for the user name for the FTP server.
FTP Directory To upload the DLA file to a subdirectory, type the directory path here. For example: DLA/uploaded.

(Back to top)

Expiration

This policy reports an error every time that it runs. Configure the policy to run after a specified amount of time. For example, you might use this policy if you want assets in the Pending state to not change states if the assets are pending for over 3 months.

Configuration: Clear Asset Save and Entrance to State. Select Timer, and then enter a number of days, weeks, months, or years. When the policy runs, it reports an error.

(Back to top)

Modify asset owner

When this policy runs, it checks the value of an asset attribute of the User type or a list of user IDs. Then, the policy sets that user or users as the owner of the asset. For example, you can create an attribute called Legal reviewer and have this policy change the owner of the asset when it enters a Legal review state.

Configuration:
Property Value
Attribute name Select the asset attribute to check. You can use attributes of the User type only. Assets that enter the lifecycle that you are configuring must have this attribute.
User IDs Type the user IDs of users to set as the owners of the asset when this policy runs. Use this attribute if you do not want to use a User attribute and want the same owners to be applied for all assets in this lifecycle.
Add or Replace Owner To add the configured users as owners of the asset, select Add. To also remove the current owners, select Replace.

(Back to top)

Modify lifecycle manager

When this policy runs, it checks the value of an asset attribute of the User type. Then, the policy sets that repository user or users as the lifecycle managers for the current state of the asset.

Configuration:
Property Value
Attribute name The name of the attribute that users must always supply a value for.
Add or Replace Lifecycle Manager To add the users that match the value of the selected attribute to the list of lifecycle managers for the asset, select Add. To also remove the current lifecycle managers, select Replace.

(Back to top)

Modify reviewer

When this policy runs, it checks the value of an asset attribute of the User type. Then, the policy sets that repository user or users as reviewers for the current state of the asset. Those users are granted full permissions to modify and vote on the asset. For transitions that you specify, the reviewers must approve the asset.

Configuration:
Property Value
Attribute name The name of the attribute that users must always supply a value for.
Reviewer type To allow the new reviewer to vote on and to edit the asset, select Approver. To allow a reviewer to edit the asset without permission to vote on the asset, select Allow editing.
Add or Replace Reviewer To add the users that match the value of the selected attribute to the list of reviewers, select Add. To also remove the current reviewers, select Replace.
Transitions Type the names of the transitions out of this state that will be modified. This policy adds a condition that the new reviewer must approve the asset. Separate multiple transitions with commas. For example: Approve, Revise.

(Back to top)

Modify reviewers from a group

When this policy runs, it checks the value of an asset attribute for the name of a user group. Then, the policy sets the users in that group as reviewers for the current state of the asset. Those users are granted full permissions to modify and approve or reject the asset. For transitions that you specify, reviewers must approve the asset. For example, you might make an attribute of the list type, where the list entries are the names of user groups. Then, you can use this policy to assign the members of those groups as reviewers.

Configuration:
Property Value
Attribute name Select the asset attribute to check. For the policy to work, the value of the attribute must match the name of a user group in this community. Assets that enter the lifecycle that you are configuring must have this attribute.
Reviewer type To allow the new reviewer to vote on and to edit the asset, select Approver. To allow a reviewer to edit the asset without permission to vote on the asset, select Allow editing.
Add or Replace Reviewer To add the users that match the value of the selected attribute to the list of reviewers, select Add. To also remove the current reviewers, select Replace.
Transitions Type the names of the transitions out of this state that will be modified. This policy adds a condition that the new reviewer must approve the asset. Separate multiple transitions with commas. For example: Approve, Revise.
Minimum Number of Approvals For the transitions that you specify, type the least number of approvals to add as a condition for leaving this state of the lifecycle. For example, if you type 2, at least two members of the user group must approve the asset as a condition for leaving this state.

(Back to top)

Relationship range constraint

This policy reports an error if the asset satisfied a relationship constraint of asset types and no longer does so after the asset changes states, is modified, or is deleted. For example, you might have this policy run on the Delete option if the asset that is being deleted is a mandatory component of another asset.

Configuration: This policy has no options.

(Back to top)

Relationship validation

This policy is like the relationship constraints of asset types. Configure how this asset must be related to other assets for this policy to pass.

Configuration:
Property Value
Operator Select one logical operator: Exactly, At least, At most, or All.
Number of related assets Enter a number to check against the Operator. This field has no effect if you selected All for the Operator.
Related Asset Type Select the type that related assets must be, or select Any Asset Type. If you are configuring multiple relationships, use Any Asset Type.
Relationships Select one or more relationship types that the asset must have. If you select more than one relationship type, the other configuration options apply to each relationship.
Related Asset State Type the state in a lifecycle that the related assets must be in, such as Published. Separate multiple states with commas. For example: Draft,Published.
What if I select multiple items in the Relationship list?: Logically, the policy works as follows: For each relationship that you select, this asset must have operator number of related assets relationships of the Relationship type to assets that are of the Related Asset Type type and that are in the Related Asset State state.

For example: This asset must have exactly 2 relationships of the Child type to assets that are of the Implementation asset type and that are in the Approved state.

If you select the All Operator: All the relationships that this asset has that are of the Child type must be to assets that are of the Implementation asset type and that are in the Approved state.

If these conditions are not met, the policy fails.

(Back to top)

Send email

When this policy runs, it sends an email to lifecycle managers or reviewers for the asset. You might use this policy to automatically remind reviewers that there is an asset that they must review.

Configuration:

Property Value
Email all reviewers Select this property to send an email to the users that are reviewers for this state.
Email pending approvers Select this property to send an email to the approvers for this state that have not yet voted.
Email lifecycle managers Select this property to send an email to the lifecycle managers for the asset.
Email asset owners Select this property to send an email to the owners of the asset.
Email others Type specific addresses to receive the email. To separate multiple addresses, use commas (,).
Subject Type the subject line for the email. You can use the following variables:
  • $(ram.asset.name): The name of the asset
  • $(ram.asset.version): The version number of the asset
  • $(ram.asset.url): The URL to the asset
Body Type the body for the email. You can use simple HTML and the same variables that are available for the Subject property.

(Back to top)

Service validation

This policy validates WSDL, XSD, and XML documents. You might use this policy to ensure that documents are valid, dependencies are resolved, and the WSDI is compliant with WS-I.

The service validation policy is part of the SOA library.

Configuration:
Property Value
Policy display name Display name for the policy.
WSDL Validator Select this property to use WSDL validation.
XML Schema Validator Select this property to use XML schema validation.
XML Validator Select this property to use comma-separated XML file extensions for validation.
WS-I Validator Select this property to use WS-I validation.
WS-I Profile WS-I profile to use for the validation.
WS-I Compliance Level Compliance level for the WS-I validation.
Basic Profile URL File path to the profile file. You can keep the supplied default URL which points to ws-i.org, or you can modify the URL to point to a different location where the file can be accessed (for example, if files must be available through an intranet only).
Basic with Attachment Profile URL File path to the profile file that supports attachments. You can keep the supplied default URL which points to ws-i.org, or you can modify the URL to point to a different location where the file can be accessed (for example, if files must be available through an intranet only).

(Back to top)

Unique asset name

This policy fails if an asset has the same name as another asset in either a community or the repository. This policy does not apply to assets that are different versions of an asset. You can use this policy to make sure that you do not have multiple assets with the same name.

Configuration:
Property Value
Policy display name Display name for the policy.
Search Scope Select this property to check asset names in either the current community or in the entire repository.
On failing the policy Select whether the policy issues a warning or an error if it fails.

(Back to top)

WebSphere Service Registry and Repository state

When this policy runs, it checks the action that you are taking on an asset, such as Approve. The policy also checks the state of the associated object in WebSphere Service Registry and Repository.

Configuration:

Clear Asset Save and Entrance to State. Select the Action item, and then click Configure.
Property Value
Connection For your community, select a connection to WSRR.
Action The action that occurs, such as Approve or Certify.
Remote state The state that the associated object in WebSphere Service Registry and Repository must be in.

(Back to top)


Feedback