You are not logged in. Click here to log in.

codebeamer Application Lifecycle Management (ALM)

Search In Project

Search inClear

Tags:  not added yet

Entity Metadata


Entity metadata is a simple facility in codeBeamer to manage generic metadata in global scope or around codeBeamer entities, like projects, documents, issues, and such. Using metadata, you can create, update, delete and query textual key-value pairs.

Primary uses:

  1. global scope: storing custom data for the whole codeBeamer instance. For example, the root path of the Subversion instance running externally.
  2. entity scope: storing custom data for one entity. For example, Facebook URLs for your projects.

Configuring Metadata Types

To specify metadata types, uncomment and edit the <metadata> entities in the $CODEBEAMER_HOME/tomcat/webapps/cb/WEB-INF/classes/general.xml configuration file. When you have finished, you will need to restart codeBeamer to pick up the changes.

The definitions are simple:

<metadata key="" displayName="SAP Document Number" entityType="5" />
  1. key: must be a unique identifier. We recommend using Fully Qualified Names (FQN), similar to Internet addresses or fully qualified Java class names.
  2. displayName: primarily shown in the user interface.
  3. entityType: type of the entity you want this to apply.

User Interface

After you have configured some metadata types and restarted codeBeamer, new entries will appear in the Properties screen of documents, directories and wiki pages. (Currently, the user interface of this feature is limited only to these types.)


Learning the Internal API

Start reading the javadocs from the EntityMetadataManager class.

Tip: Storing Structured Data

As the value component of the key-value pairs is a string, you can use the CLOB pattern to serialize larger information to a string. For example, a simple, but powerful approach can be serializing your Java objects to XML with Xstream.