Specific Keywords

The following keywords can only be used within the limits specified in the table titles below.

$BEGIN_SECTION/$END_SECTION Keywords and $BEGIN_TRACES/$END_TRACES Keywords

Keyword Description
<<Type>> The requirement type
<<Hierarchy>> The requirement hierarchy number
<<ID_Number>> The unique ID number
<<Status>> The requirement status
<<Priority>> The requirement priority
<<Description>>

The requirement description

Note: This keyword should not be used on the same line with any other keywords as it extracts from an HTML block in the Requirement Description.

<<Tag>> The requirement type tag
<<Name>> The requirement name
<<Version>> The project version number
<<Owner>> The requirement owner
<<Owner_Firstname>> This keyword prints the first name of the owner of the requirement.
<<Owner_Lastname>> This keyword prints the last name of the owner of the requirement.
<<Validation>> The validation procedure
<<UDA Name>> Any user-defined attribute; you must enter these exactly as they appear in Caliber
<<Calculated Field Name>> Result of a $Calculate command
<<References>>

The drive, directory and the file link for all the document references assigned to a requirement.

Use this inside $BEGIN_list and $END_list syntax for a cleaner output document.

<<Responsibilities>>

The list of all users responsible for the requirement

Use this inside $BEGIN_list and $END_list syntax for a cleaner output document.

<<Responsibilities_Lastname_Firstname>>

This keyword prints the last name followed by first name of the users in the responsibilities list for a requirement; found on the Responsibilities tab.

This works only inside $BEGIN_list and $END_list syntax.

<<Responsibilities_Firstname_Lastname>>

This keyword prints the first name followed by last name of the users in the responsibilities list for a requirement; found on the Responsibilities tab.

This works only inside $BEGIN_list and $END_list syntax.

<<Created_By>> The userid of the user who created the requirement
<<Created_On>> The date/time that the requirement was created.
<<Requirement_Last_Modified_Date>>

This keyword prints the Last Modified Date of requirement.

This keyword can also be used in $BEGIN_ROW/$END_ROW.

The graphic below shows how some of the $Begin_Section/$End_Section keywords relate to the fields in Caliber.

$BEGIN_SIGNATURES/$END_SIGNATURES Keywords

You can only use these keywords within the $BEGIN_SIGNATURES/END_SIGNATURES command loop. The <<Signatures>> keyword used alone produces a pre-formatted list of baseline signatures formatted as:

<<Signature_Date>> <<Signature_Time>><<First_Name>><<Last_Name>><<Meaning>>
Keyword Description
<<Title>> the signatory’s title
<<First_Name>> the signatory’s first name
<<Last_Name>> the signatory’s last name
<<User_ID>> the signatory’s user ID
<<Meaning>> the signature meaning
<<Comments>> the signatory’s comments
<<Signature_Date>> the date the baseline was signed
<<Signature_Time>> the time the baseline was signed

$BEGIN_LIST/$END_LIST Keywords

The following keywords are used to generate lists of information.

Keyword Description
<<References>> Used within a $Begin_List/$End_List command; extracts the document reference list for a requirement, found on the References tab.
<<Responsibilities>>

This keyword extracts the responsibilities list for a requirement; found on the Responsibilities tab.

Use this inside $BEGIN_list and $END_list syntax for a cleaner output document.

<<Responsibilities_Lastname_Firstname>>

This keyword prints the last name followed by first name of the users in the responsibilities list for a requirement; found on the Responsibilities tab.

Use this inside $BEGIN_list and $END_list syntax for a cleaner output document.

<<Responsibilities_Firstname_Lastname>>

This keyword prints the first name followed by last name of the users in the responsibilities list for a requirement; found on the Responsibilities tab.

This works only inside $BEGIN_list and $END_list syntax.

Multiple Selection User- Defined Attributes Any multiple selection user-defined attribute can be used in a $Begin_List/$End_List command.

$BEGIN_HISTORY/$END_HISTORY Keywords

The <<History>> keyword extracts all history data for a requirement.

$BEGIN_HISTORY/$END_HISTORY scans each entry in the revision list and extracts data for the keywords specified in the template.

These keywords can only be used within the $BEGIN_HISTORY/$END_HISTORY command loop.

Keyword Description
<<Major_Version>> Major version number
<<Minor_Version>> Minor version number
<<Datestamp>> Date of the change
<<Timestamp>> Time of the change
<<Userid>> Logon ID of user who made the change
<<User_Name>> First and last name of user who made the change
<<Comment>> Reason for the change

$BEGIN_CHANGES/$END_CHANGES Keywords

$BEGIN_CHANGES/$END_CHANGES scans each entry in the changes list and extracts data for the keywords specified in the template.

These keywords can only be used within the $BEGIN_CHANGES/$END_CHANGES command loop.

Keyword Description
<<Field_Changed>> Attribute - what changed
<<From_Value>> Old attribute value
<<To_Value>> Current attribute value

$BEGIN_TRACES/$END_TRACES Keywords

The <<Traces>>keyword extracts all trace data for a requirement.

The following keywords are used to extract and format specific data. You can only use these within a $BEGIN_TRACES/$END_TRACES command.

Keyword Description
<<Delivery_StoryID>> Story ID or WorkItem ID
<<Delivery_StoryName>> Story Name or WorkItem Name
<<Delivery_Status>> Story Status or WorkItem Status
<<Delivery_Owner>> Owner of this Story or WorkItem
<<Delivery_Project>> The project Story or WorkItem belongs
<<Delivery_Iteration>> The iteration Story or WorkItem belongs
<<Delivery_IterationEndDate>> The iteration ending date
<<Delivery_Blocked>> Indicates if the current story blocked
<<Delivery_PlanEst>> The amount of effort estimated to complete the scheduled item
<<Delivery_TaskEst>> The amount of effort estimated to complete a task
<<Delivery_ToDo>> The amount of remaining effort required to complete a task
<<Delivery_Rank>> The importance factor for the story or workitem
<<Trace_Objecttype>> Type of object trace
<<Trace_ReqTag>> Tag number of trace to or from object
<<Trace_Project>> The project in which the requirement being linked to or from is located
<<Trace_Name>> Name of trace to or from object
<<Trace_Direction>> Indicates the direction of the trace
<<Trace_DirectImplied>> Indicates whether the trace is a direct or implied trace. Reporting on large numbers of implied traces may cause performance degradation.
<<Trace_Suspect>> Indicates whether the trace is suspect
<<Trace_TestStatus>> Indicates pass/fail status (Indicates test pass/fail status for HP Quality Center and Silk Central Test Manager traces )
<<Trace_Type>> The requirement type of the traced requirement
<<Trace_Tag>> The requirement tag of the traced requirement
<<Trace_Status>> The status of the traced requirement
<<Trace_Priority>> The priority of the traced requirement
<<Trace_Version>> The version of the traced requirement
<<Trace_Owner>> The owner of the traced requirement
<<Trace_Created_By>> The person who created the traced requirement
<<Trace_Created_On>> The date the traced requirement was created
<<Trace_Description>> The description of the traced requirement

$BEGIN_DISCUSSIONS/$END_DISCUSSIONS Keywords

The <<Discussions>> keyword extracts the list of all requirement discussions. Data includes the requirement tag, discussion subject, the user who initiated the discussion and the discussion date.

Note: You do not have to use the <<Discussions>> keyword within a $BEGIN_DISCUSSIONS/$END_DISCUSSIONS command loop.

The following keywords are used to extract and format specific data. You can only use them within a $BEGIN_DISCUSSIONS/$END_DISCUSSIONS command.

Keyword Description
<<Discussion_Req_Tag>> The requirement identifier; includes the type tag and id
<<Subject>> The subject of the discussion
<<From>> User who initiated the discussion
<<Is_Read>> Indicates if current user has read the discussion
<<Discussion_Date>> Date the discussion was saved
<<Body>> The message text of the discussion

$BEGIN_PROJECT_DISCUSSIONS/$END_PROJECT _DISCUSSIONS Keywords

The <<Project_Discussions>> keyword extracts the list of all project discussions. Data includes the discussion subject, the user who initiated the discussion and the discussion date.

Note: You do not have to use the <<Project_Discussions>> keyword within a $BEGIN_PROJECT_DISCUSSIONS/$END_PROJECT _DISCUSSIONS command loop. The keywords below are used to extract and format specific data. You can only use them within a $BEGIN_PROJECT_DISCUSSIONS/$END_PROJECT _DISCUSSIONS command loop.
Keyword Description
<<Subject>> The subject of the discussion
<<From>> User who initiated the discussion
<<Is_Read>> Indicates if current user has read the discussion
<<Discussion_Date>> Date the discussion was saved
<<Body>> The message text of the discussion

$BEGIN_GLOSSARY/$END_GLOSSARY Keywords

The <<Glossary>> keyword extracts a pre-formatted list of glossary information. This keyword outputs all glossaries assigned to the selected project in their specified order. Data includes glossary terms and their definitions.

Note: You should not use the <<Glossary>> keyword within a $BEGIN_SECTION/ $END_SECTION command loop.
Note: You do not have to use the <<Glossary>> keyword within a $BEGIN_GLOSSARY/$END_GLOSSARY command loop.

The following keywords are used to extract and format specific data. You can only use them within a $BEGIN_GLOSSARY/$END_GLOSSARY command.

Keyword Description
<<Glossary_Name>> The name of the glossary
<<Term>> The term
<<Definition>> The term’s definition