Audit Log

The audit log is a record of events that happen to your assets. Click the Audit tab to display audit log entries for the selected view.

Audit Log Events

Events are actions performed on an owner. For example, a file can be checked in or removed from version control. Such events are recorded in the audit log. Most items can be:

  • Added
  • Branched
  • Comment Edited
  • Created
  • Deleted
  • Locked
  • Lock Broken
  • Modified
  • Moved From
  • Moved to
  • Shared
  • Unlocked
  • Converted
  • Edited
  • Item Overwritten (as foreign archive files become native files)
  • Vault
  • Created
  • Modified
  • Deleted
  • Frozen
  • Unfrozen
  • Attached
  • Moved
  • Detached
  • Modified

Back to top

Filtering Audit Log Entries

When you click the Audit tab, it displays audit log entries for the selected view in the upper pane of the project view window. The Audit menu item also becomes available on the menu bar. The list of audit records depends on your selection from the folder tree and whether the All Descendants button is selected from the toolbar or Audit menu. If you select this tab and the upper pane is empty, your administrator has disabled the audit log.

Filtering allows you to specify what fields are displayed in the audit entries that appear in the upper pane and how those fields are grouped and sorted.

Note: You can customize the default filters or create new ones. You can also limit the number of audit log entries displayed by creating a query that selects audit log entries by specific property values.

To filter audit log entries, do the following:

  1. Click the Filter list on the tool bar.
  2. Select one of the following default filters:
    <By Class and Event> Displays audit entries sorted by their value in the Class Name 1 field (type of item) and Event (type of action) field.
    By Transaction and Event Groups audit log entries by descending Transaction ID and then by Event type. This filter provides a reverse-chronological list of updates in the view by transaction.
    Events Groups audit log entries by Event type, then by Target 1 Class ID, and then by Created Time.
    Show All Displays all entries. This is the default option.

Back to top

Searching for Log Entries

All entries shown in the Audit list:

  • Are associated with the folder selected from the StarTeam folder tree.
  • Match the filter selected from the Filter list.
  • Match the depth specified by the All Descendant button.

To search for information in the audit logs, do one of the following:

  1. Click on Audit > Find
  2. Click on Audit > Find Next
  3. Click on Audit > Find Previous

Back to top

Sorting Audit Log Entries

The sort usually takes place in descending or ascending numeric or alphanumeric order depending on the data.

To sort entries in the audit log, do the following:

  1. Click on an audit column header to perform a sort based on the value in that column.
  2. To change the sort order from ascending to descending or vice versa, click the header a second time.

Back to top

Sending Log Entries Through E-mail

You can send an audit list item as an e-mail, although the attachments in the item will not be sent.

To e-mail an item from an audit log, do the following:

  1. Select the item you want to send by clicking on it.

  2. Click Audit > Send To.

    The Send To dialog box opens allowing you to send the selected item in the Audit list as an e-mail.

Back to top

Audit Fields

The following table lists all the audit fields in alphabetical order.

Class Name 1

Values: text

Internal Identifier: Class Name 1 (contains spaces)

The name of the class of items, such as Label, Promotion State, Folder, File, Change Request, Topic, Task, or Trace.

Class Name 2

Values: text

Internal Identifier: Class Name 2 (contains spaces)

The name of the class of items, such as Folder, File, Change Request, Label, Topic, Task, or Trace.

Class Name 3

Values: text

Internal Identifier: Class Name 3 (contains spaces)

The name of the class of items, such as Folder, File, Change Request, Label, Topic, Task, or Trace.

Created By

Values: list of users, <None>

Internal Identifier: CreatedUserID

Always empty because the audit entry is created by the system.

Created Time

Values: date/time

Internal Identifier: CreatedTime

The time at which this entry was created.

Deleted By

Values: list of users, <None>

Internal Identifier: DeletedUserID

The name of the user who deleted an audit entry. Because deleted entries do not appear in the list, this information is unavailable to users.

Deleted Time

Values: date/time

Internal Identifier: DeletedTime

The time at which an audit entry was deleted. Because deleted entries do not appear in the list, this information is unavailable to users.

Event

Values: Added, Branched, Comment Edited, Created, Deleted, Edited, Item Overwritten, Label Attached, Label Created, Label Deleted, Label Detached, Label Frozen, Label Modified, Label Moved, Label Unfrozen, Lock Broken, Locked, Modified, Moved From, Moved To, Promotion Model Modified, Promotion State Modified, Shared, Unlocked, Vault Converted

Internal Identifier: EventID

The name of the operation being recorded.

Folder

Values: text

Internal Identifier: Folder

The name of the folder that stores the audit entry.

Folder Path

Values: text

Internal Identifier: Folder Path (contains spaces)

The path to the folder that stores the audit entry.

Folder VMID (Advanced)

Values: number

Internal Identifier: FolderVMID

The ID assigned to the folder that stores the item.

Item 1

Values: text

Internal Identifier: Item 1 (contains spaces)

Indicates what class 1 item received the audited operation. This can be the name of a file or task, the number of a change request or requirement, or the title of a topic.

Item 1 Info

Values: text

Internal Identifier: Info

Provides the revision number in dot notation for the class 1 item, if it is revisionable. For example, a label can be a class 1 item and it does not have revisions.

Item 2

Values: text

Internal Identifier: Item 2 (contains spaces)

Indicates what class 2 item received the audited operation. For example, if a label was attached to a file, the class 1 item is the label and the class 2 item is the file.

Item 2 Info

Values: text

Internal Identifier: Info2

Provides the revision number in dot notation for the class 2 item, if it is revisionable. For example, a label can be a class 2 item and it does not have revisions.
Item 3

Values: text

Internal Identifier: Item 3 (contains spaces)

Indicates what class 3 item received the audited operation. For example, if a label was moved from one revision to a file to another, the class 1 item is the label, the class 2 item is the revision of the file that was initially , and the class 3 item is the final revision of the file.

Item 3 Info

Values: text

Internal Identifier: Info3

Provides the revision number in dot notation for the class 3 item, if it is revisionable. For example, a label can be a class 1 item and it does not have revisions.

Modified By

Values: list of users, <None>

Internal Identifier: ModifiedUserID

Does not apply to audit entries.

Modified Time

Values: date/time

Internal Identifier: ModifiedTime

Does not apply to audit entries.

Object ID

Values: number

Internal Identifier: ID

Each audit entry is assigned an object ID when it is added to a view.

Project

Values: list of projects in this server configuration, <None>

Internal Identifier: ProjectID

The name of the project in which an audit entry was recorded.

Target 1 Class ID (Advanced)

Values: number

Internal Identifier: Target 1 Class ID (contains spaces)

The ID number assigned to class 1 items or a -1 if there is no ID.

Target 1 Object ID (Advanced)

Values: number

Internal Identifier: Target 1 Object ID (contains spaces)

The object ID for the class 1 item that received the audited operation or a -1 if there is no ID.

Target 1 Revision Time

Values: date/time

Internal Identifier: Target 1 Revision Time (contains spaces)

The time at which the last revision was made to the class 1 item that received the audit operation.

Target 2 Class ID (Advanced)

Values: number

Internal Identifier: Target 2 Class ID (contains spaces)

The ID number assigned to class 2 items or a -1 if there is no ID.

Target 2 Object ID (Advanced)

Values: number

Internal Identifier: Target 2 Object ID (contains spaces)

The object ID for the class 2 item that received the audited operation or a -1 if there is no ID.

Target 2 Revision Time

Values: number

Internal Identifier: Target 2 Revision Time (contains spaces)

The time at which the last revision was made to the class 2 item that received the audit operation.

Target 3 Class ID (Advanced)

Values: number

Internal Identifier: Target 3 Class ID (contains spaces)

The ID number assigned to class 3 items or a -1 if there is no ID.

Target 3 Object ID (Advanced)

Values: number

Internal Identifier: Target 3 Object ID (contains spaces)

The object ID for the class 3 item that received the audited operation or a -1 if there is no ID.

Target 3 Revision Time

Values: date/time

Internal Identifier: Target 3 Revision Time (contains spaces)

The time at which the last revision was made to the class 3 item that received the audit operation.

Transaction ID (Advanced)

Values: number

Internal Identifier: TransactionID

Uniquely identifies the database transaction that contained the update represented by the audit record. (A database transaction can contain multiple updates.) Note that audit records created before the database was upgraded to a StarTeam release that records a Transaction ID will have a Transaction ID of -1.

User

Values: list of users, <None>

Internal Identifier: UserID

The name of the user who performed the recorded operation.

View

Values: list of views, <None>

Internal Identifier: ViewID

The name of the view in which an audit entry was recorded.

Back to top