Prev Next

Audit Settings

The Audit Settings window allows you to enable or disable auditing but in addition there are a number of options that you can use to manage what is recorded by the Auditing facility.  These can be altered during different sessions of auditing, for example you may only want to record limited information about requirements during a phase of the project. Subsequently  you may required detailed information about all element types  and you could make adjustment to the settings to specify this. The important options are summarized below:

  • Define whether bulk operations should be included in the audit
  • Administer your audit records such as saving and clearing logs
  • Specify the detail of the recorded audit by specifying the audit level
  • Specify the type of objects you wish to be included in the audit

Access

Ribbon

Configure > Model > Audit : Audit Settings

Configure Settings

Option

Action

See also

Enable Auditing

Select this checkbox to turn the Auditing facility on.

Audit XMI Import

Select this checkbox to record changes arising from XMI importing in the audit.

As Version Control uses XMI, you must select this option to record changes from checking out Packages.

Version Control

Audit XMI Export

Select this checkbox to record changes arising from XMI exporting in the audit.

As Version Control uses XMI, you must select this option to record changes from checking out Packages.

Audit Reverse Engineering

Select this checkbox to record changes arising from reverse engineering in the audit.

Use Database Timestamp

Select this checkbox to use the database server's timestamp instead of each user's local timestamp; this improves security.

This option is not available for project files.

Clear Logs

Click on this button to permanently delete all log data from the current project; use the Save Logs button first, to save the audit records outside the project.

The system prompts you to specify whether to clear items logged over a specific period of time.

  • Click on the No button to clear all log items currently held in the database
  • Click on the Yes button to display the 'Time Filter' dialog, on which you select a standard time period or define your own

This function can be accessed through the Automation Interface.

Save Logs

Click on this button to save a copy of the logged audit items currently held in the project. These items remain in the project; you can use the Clear Logs button to remove them.

The system prompts you to specify whether to save items logged over a specific period of time.

  • Click on the No button to save all log items currently held in the database
  • Click on the Yes button to display the 'Time Filter' dialog, on which you select a standard time period or define your own

This function can be accessed through the Automation Interface.

Audit View Controls Repository Class

Load Logs

Click on this button to load a previously saved set of logs back into the project. A browser displays through which you select the log file to reload.

If the same record exists in both project and log file, that record is not reloaded.

Core

Select this radio button to record changes to elements (including attributes and operations), Packages, connectors and some model-level information.

Standard

Select this radio button to record the same changes as for the Core option, plus changes to some of the 'housekeeping' data for diagrams - Name, Author, Version, Stereotype, Notes and Date Modified.

You can check for changes to diagram content and structure using the Baseline facility for reviewing visual changes to diagrams.

Visual Diagram Changes

Extended

Select this radio button to record the same changes as for the 'Standard' option, plus changes to project security.

Debug

Select this radio button to record the same changes as for the 'Extended' option plus changes to any database tables. Some of the auditing information will not be visible unless the Audit View mode is set to 'Raw'.

Audit View Controls

Maintenance

Select this radio button to audit changes to maintenance elements only; that is:

  • Package (element)
  • Requirement
  • Feature
  • Use Case
  • Actor
  • Note
  • Issue and
  • Change

Core Structural

Select this radio button to audit changes to maintenance elements plus certain structural elements; that is:

  • Package (structure)
  • Class
  • Interface
  • Signal
  • Node
  • Component
  • Artifact
  • Part
  • Port and
  • Device

All

Select this radio button to audit changes to all types of element.

Custom

Select this radio button to audit changes to element types that you specify.

The Customize button is made available; click on this button to display a list of element types, and select the checkbox against each element type to include in the audit (or click on the Select All button to select every element type).

Click on the OK button to save the selection.

Notes

  • As the number of records increases, the performance of the Audit View reduces; it is recommended that audit records that are not regularly required are saved to file, then cleared from the project, to help ensure high performance
  • Connectors are audited when they are connected to an element that is included in the Audit Options
  • If security is enabled, you must have Audit View permission to turn Auditing on, and Audit Settings permission to change the audit settings