Table of Keywords
PTC RV&S maintains several keywords that can be used in working files. Keywords are case-sensitive.
Your administrator may also create custom keywords. For information on using custom keywords contact your administrator.
The following table lists the available built-in keywords and a description of each keyword’s expanded value:
|
Keyword
|
Expands To
|
||
|---|---|---|---|
|
$Author$
|
The name of the user who checked in the revision.
|
||
|
$Date$
|
The checkin date and time of the revision (as assigned at checkin). The time is shown in Greenwich Mean Time (GMT/ or Coordinated Universal Time).
|
||
|
$Header$
|
The file name of the archive, as well as the revision number, date and time, author, state, and the user who has an exclusive lock (if any).
|
||
|
$Id$
|
The same as $Header$, except that only the file name of the archive is displayed, not the full path.
|
||
|
$Locker$
|
The user ID of the user who has an exclusive lock on the revision, and the date and time that it was locked (empty if no exclusive lock).
|
||
|
$Log$
|
The revision description supplied during checkin, preceded by the archive’s member name, revision number, author, and revision date.
Repeated checkout operations append revision descriptions, rather than replacing existing ones.
|
||
|
$Name$
|
The revision label (or labels) attached to a revision.
|
||
|
$ProjectLabel$
|
The label (or labels) associated with the checkpoint of the build project the Sandbox is based on.
The $ProjectLabel$ keyword can only be used when the Sandbox corresponds to a build project that has a label. If there are multiple labels associated with the selected build project checkpoint, the $ProjectLabel$ keyword uses a space-separated list of labels in alphabetical order.
|
||
|
$ProjectName$
|
The fully qualified name of the project of which the archive is a member.
|
||
|
$ProjectRevision$
|
The revision number of the project that the archive is related. For use in build Sandboxes only.
|
||
|
$ProjectSetting attribute$
|
The current value of the attribute defined in PTC RV&S. For example, if the project contains set OS=unix, the keyword $ProjectSetting OS$ is expanded to $ProjectSetting OS: unix$
|
||
|
$Revision$
|
The revision number.
|
||
|
$SandboxSetting attribute$
|
The current value of the attribute defined in PTC RV&S. For example, if the Sandbox contains set OS=unix, the keyword $SandboxSetting OS$ is expanded to $SandboxSetting OS: unix$
|
||
|
$Setting attribute$
|
The current value of the attribute defined in PTC RV&S. For example, if the member contains set OS=nt, the keyword $Setting OS$ is expanded to $Setting: nt$.
|
||
|
$State$
|
The state setting of the revision. States are defined by your administrator.
|
||
|
$Source$
|
The file name of a checked in file along with the extension is added to the content of the file.
For example, when PTC RV&S encounters this string, it automatically adds the value of the keyword $Source$ to the beginning of the file in the format $Source: Specdoc.xml$, where Specdoc.xml is the file name.
|
