Modify

Description

Modifies an asset in a Rational Asset Manager repository

Parameters

Attribute Description Required
action The name of the lifecycle action that the asset takes after all other modifications are committed. Action names might not be unique, but they usually are. Typically, action names are easier to read than IDs. If necessary, you can use actionId to specify the ID of the action instead of the name. The action name is not case sensitive. No
actionId The ID of the lifecycle action that the asset takes after all other modifications are committed. The action ID is case sensitive. No
failOnError If false, the build continues execution when an error occurs. Otherwise, the build fails. No. Default is true.
guidProperty The property that contains the GUID of the modified asset after this task has completed. The guidProperty is helpful if you do not know the GUID of the asset to modify and search to find the asset. No
server The ID of the server that connects to Rational Asset Manager Yes
vote The vote choice to be applied to the lifecycle of the asset. The vote must be either "approve" or "reject." The vote is not case sensitive. If the user who is specified for this task is not a reviewer for the asset, an exception is thrown and the build fails. No

Parameters specified as nested elements

asset

You can specify a single asset to be modified.

search

When you specify a search, the first asset that is returned from that query is modified. You can sort the search results to ensure that the asset that you want is listed first.

If the search returns no results, an asset is created and submitted to the repository.

Examples

Modify the name of an asset

<modify server="ramServer">
   <asset guid="{0000-1111-2222-3333}" version="1.0">
      <name>My Modified Asset</name>
   </asset>
</modify>

Modify an asset that is returned from a search, or if no asset is returned, create an asset

<modify server="ramServer">
   <search name="myAsset" version="1.0" />
   <asset>
      <name>My Asset</name>
      <version>1.1</version>
      <shortDescription>This is my asset</shortDescription>
      <community>My Community</community>
      <assetType>My Asset Type</assetType>
   </asset>
</modify>

Perform an action on an asset, such as moving it to a different state in its lifecycle

<modify server="ramServer" action="publish">
   <asset guid="{0000-1111-2222-3333}" version="1.0" />
</modify>
<modify server="ramServer" actionId="simpleAssetWorkflow.action.publish">
   <asset guid="{0000-1111-2222-3333}" version="1.0" />
</modify>

Vote on the lifecycle of an asset and include a comment

<modify server="ramServer" vote="approve">
   <asset guid="{0000-1111-2222-3333}" version="1.0" />
   <comment>I approve this asset.</comment>
</modify>