Audit Manager
Audit Manager
Audit Manager
Teamcenter 11.2
Audit Manager
PLM00022 • 11.2
Contents
Migrating audit data from legacy Audit Manager to new Audit Manager . . . . . . . . . . . . . . 6-1
Migrating audit configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Migrating audit data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
The details of the new and old Audit Manager applications are as follows:
Auditing Description
application
• Audit logs are stored in the database. Audit logs are grouped together
depending on the type, such as general logs, workflow logs, structure logs,
file access logs, and schedule logs.
• You can create audit configuration objects such as audit definition objects,
events, and event type mappings using Business Modeler IDE.
• View audit logs using the Summary view of the supported Teamcenter
applications.
• Enable Audit Manager by updating preferences as follows:
Audit Manager o TC_audit_manager
Set value to ON.
o TC_audit_manager_version
Set value to 3.
o If Audit Manager does not appear in the rich client, edit the
HiddenPerspectives preference and remove the AuditManager value.
• You can configure audit logs to be stored in files or in the database.
• You can use the rich client-based Audit Manager application for configuring
audit definitions.
• You can create events and event type mappings using Business Modeler
IDE.
• You can query the audit logs, using the Audit Logs dialog box.
• Enable Legacy Audit Manager by updating the preferences as follows:
o TC_audit_manager
Legacy Audit
Manager Set value to ON.
o TC_audit_manager_version
Set value to 2.
o If Audit Manager does not appear in the rich client, edit the
HiddenPerspectives preference and remove the AuditManager value.
Note
Migrating audit data from legacy Audit Manager to new Audit Manager . . . . . . . . . . . . . . . . . . 6-1
Configure Audit There are additional steps you must perform to configure Audit Manager
Manager before you can use it.
• The Summary view of the following Teamcenter applications shows audit logs in the Audit
logs tab.
o My Teamcenter
o ADA License
o Structure Manager
o Multi-Structure Manager
o Schedule Manager
o Workflow Viewer
o Organization
• You can run predefined audit reports or create new reports, using the Report Builder application.
• You can create queries of audit logs, using the Query Builder application. You can run these
queries, using the Teamcenter search functionality.
• You can run predefined audit queries, using the Teamcenter advanced search functionality.
To use audit functionality, you must first define audit logs by creating audit definition objects. You
can then view audit logs, using Teamcenter applications such as My Teamcenter, ADA License,
Structure Manager, Multi-Structure Manager, Manufacturing Process Planner, Schedule Manager,
Workflow Viewer, and Organization.
o ADA License
o Structure Manager
o Multi-Structure Manager
o Schedule Manager
o Workflow Viewer
o Organization
• You can run predefined audit reports or create new reports, using the Report Builder application.
• You can create queries of audit logs, using the Query Builder application.
• You can run predefined audit queries, using the Teamcenter advanced search functionality.
Audit objects
The audit functionality in Teamcenter uses the following objects:
• Fnd0AuditDefProperty
Specifies the logged properties object. This object stores logged properties information.
• Fnd0EventTypeMapping
Specifies the event type mapping object. This object maps an event to an object, following which
you can create audit definitions for the mapped object and event type combination.
• ImanEventType
• Fnd0WorkflowAudit
Specifies workflow audit log object. This object stores process and signoff history audit logs.
• Fnd0LicenseChangeAudit
• Fnd0LicenseExportAudit
• Fnd0FileAccessAudit
• Fnd0OrganizationAudit
• Fnd0StructureAudit
• Fnd0ScheduleAudit
• Fnd0SecurityAudit
• Fnd0GeneralAudit
Stores the audit logs that are not stored in other audit logs.
• Fnd0SecondaryAudit
Stores additional information or secondary information about objects such as attachments and
attachment properties.
• Fnd0AuditLink
Postupgrade steps required for importing custom event types into a template project . . . . . . . . 2-1
Postupgrade, import these custom event type definitions into your custom template project before
deploying any changes to the upgraded database. If not, the next TEM update process or Business
Modeler IDE deployment tries to delete these event types, which may or may not pass based on
whether there are references to it in the database.
Perform the following steps in the Business Modeler IDE immediately after the successful upgrade
to Teamcenter and before deploying any data model changes:
1. Import the custom_audit_configurations.xml file from the TC_DATA\model directory into
your custom template project by choosing File→Import→Business Modeler IDE→Import
template file.
2. In the BMIDE view, right-click the project and choose Reload Data Model. Make sure there are
no model errors reported in Console view.
for the object ID, change this constant to the property that holds the object ID so that the ID of
the business object is captured when the audit log is written.
This constant is placed on the POM_object business object and its children. There is no default
value. Type a value in the Value box to assign an object ID.
This constant is provided by the foundation template file.
• Fnd0ObjectNameToAudit
Specifies the property that holds the object name for the business object type. The object name
property is different for different business object types. For example, on the Workspace business
object type, the value for this constant is object_name and on the User business object type,
the value is user_name. When an audit log is written for an instance of the business object, the
property in this constant is used to obtain the object name for the audit log (and is written to
the name property on the AuditLog business object). For custom objects that have their own
property for the object name, change this constant to the property that holds the object name so
that the name of the business object is captured when the audit log is written.
This constant is placed on the POM_object business object and its children. There is no default
value. Type a value in the Value box to assign an object name.
This constant is provided by the foundation template file.
• Fnd0ObjectRevIDToAudit
Specifies the property that holds the revision ID for the business object type. The revision ID
property differs across business object types. For example, on the ItemRevision business
object type, the value for this constant is item_revision_id. When an audit log is written for an
instance of the business object, the property in this constant is used to obtain the object’s revision
ID for the audit log. For custom objects that have their own property for the revision ID, change
this constant to the property that holds the ID so that the revision ID of the business object is
captured when the audit log is written.
This constant is placed on the POM_object business object and its children. There is no default
value. Type a value in the Value box to assign an object revision ID.
This constant is provided by the foundation template file.
• Fnd0AuditRecordAccessLevel
Controls how access to a workflow audit record is evaluated. This constant is placed on the
Fnd0WorkflowAudit business object. The default value is 1. Click the arrow on the Value box
to select from the following available values:
o 1
Checks workflow audit record based on the read access to the objects referred by the
fnd0Object property (primary object) and the fnd0SecondaryObject property (secondary
object). If the primary and secondary objects are deleted, only the administrator user is
provided with read access to the audit record.
o 2
Checks workflow audit record based on the read access to all attachments for that workflow.
Access to the primary object is not evaluated. If any of the secondary objects are deleted,
only the administrator user is provided with read access.
• Fnd0AuditRecordAccessLevel=2
The access check on the workflow audit records is evaluated based on the read access to the
current list of attachments for that workflow. Access to the primary object is not evaluated.
Value = Fnd0AuditLog
This access rule gives administrators read privileges to audit logs of deleted objects and denies
read privileges to the others.
Note
• Fnd0RetentionPeriod
Specifies the retention period of the audit log archives in days (for example, 90).
The time taken to load audit logs increases as you increase the value of this preference.
Therefore ensure that you test the summary view for the time taken to load audit logs after
updating the value of this preference.
Note
Run-time properties, compound properties, and relation properties are not tracked.
• Fnd0OCC_track_position_orientation_audithandler
Logs the occurrence position and orientation changes of the components in structures.
• Fnd0PROJInfo_audithandler
Logs project names that are assigned to the project. The project names are separated using
commas.
• Fnd0USER_get_additional_log_info
Logs workflow information to audit logs. For example, for the __Assign event, this handler logs
information such as the process name, task type, user comments, and the user ID and user
name the workflow is assigned to.
• Fnd0WriteSignoffDetails
Logs the workflow signoff history.
• Fnd0WriteSecondaryProperties
Logs secondary properties.
D. Click Add to the right of the Availability table and perform the following in the Extension
availability dialog box:
i. In the Business Object Name box, select Fnd0AuditDefinition.
b. Click Add to the right of the Audit Extensions table, and select the P3_CustomAuditLog
extension from the Find an Audit Extension dialog box.
c. To save the changes to the data model, choose BMIDE→Save Data Model.
You might need to right-click in the view and choose Refresh to see the files that
were generated.
b. Open the P3_CustomAuditLog.cxx file in a C/C++ editor and add your custom business
logic. The following is a sample file:
#include <P3_custom/P3_CustomAuditLog.hxx>
int P3_CustomAuditLog
( tag_t targetObjTag,
int /*secondaryObjectCount*/,
tag_t* /*secondaryObjectTags*/,
char** /*secondaryQualifiers*/,
tag_t /*eventType*/,
int paramCount,
char** paramNames,
char** paramValues,
int /*errorCode*/,
const char* /*errorMessage*/,
tag_t primaryAuditBOTag )
{
int ifail = ITK_ok;
//tag_t job_tag = NULLTAG;
char* signoff = NULL;
tag_t signoffTag = NULLTAG;
tag_t auditClassId = NULLTAG;
tag_t signoffClassId = NULLTAG;
char* audit_class_name = NULL;
char* signoff_class_name = NULL;
int signoffDecision = 0;
logical isProp = false;
char* propVal = 0;
if ( paramCount ==0 )
{
return ITK_ok;
}
for ( int i=0; i<paramCount; i++ )
{
if(strcmp(paramNames[i],"signoff") == 0)
{
signoff=paramValues[i];
break;
}
}
if (signoff == 0)
{
return ITK_ok;
}
ifail = POM_class_of_instance( primaryAuditBOTag, &auditClassId );
ifail = POM_name_of_class (auditClassId, &audit_class_name );
//ifail = EPM_ask_job(targetObjTag, &job_tag);
ifail = POM_string_to_tag(signoff, &signoffTag);
ifail = POM_class_of_instance( signoffTag, &signoffClassId );
ifail = POM_name_of_class (signoffClassId, &signoff_class_name );
isProp = false;
ifail = POM_attr_exists("p3_decisioncode", signoff_class_name, &isProp);
if (isProp)
{
ifail = AOM_ask_value_string ( signoffTag, "p3_decisioncode" ,&propVal);
isProp=false;
ifail = POM_attr_exists("p3_decisioncode", audit_class_name, &isProp);
if (isProp)
{
ifail = AOM_set_value_string(primaryAuditBOTag, "p3_decisioncode", propVal);
}
}
if (audit_class_name)
{
MEM_free(audit_class_name);
}
if (signoff_class_name)
{
MEM_free(signoff_class_name);
}
if(propVal)
{
MEM_free(propVal);
}
return ITK_ok;
}
c. Open the P3_CustomAuditLog.hxx file and update it with the header information.
• Open the Extensions\Audit Manager folders, right-click the Audit Definitions folder, and
choose New Audit Definition.
3. Click the Browse box to the right of the Primary Object box to select the type of business
object you want to audit.
4. Click the Browse box to the right of the Event Type box to select the event you want to audit for
the selected business object.
5. Click the Add button to the right of the Audit Extensions box to select the log to use in the
definition.
6. In the Description box, type a description of the purpose for this audit definition.
8. Select the Track Old Values? check box to enable tracking of the old values of properties.
9. Select the Audit on Property Change Only? check box to log the information specified in
this audit definition only if the property values change. This functionality is only enabled if the
Track Old Values? check box is selected.
a. In the Primary Audit Definition Properties dialog box, click the Add button located to
the right of the table.
The Add Audit Definition property dialog box is displayed.
b. In the Add Audit Definition property dialog box, click Browse to the right of the Property
Name box to select the primary property.
c. To change the display name of the property in audit logs, type the new display name in
the Target Property Name box.
d. Use the Target Old Value Property Name box to change the display name of the old
property in the audit logs.
Note
The Target Old Value Property Name box and the Enable Tracking? box are
enabled if you selected the Track Old Values? check box in the Add an Audit
Definition dialog box.
e. Click the arrow in the Enable Tracking? box to select the kind of tracking:
• Track Always
Always tracks old and new values of properties even if there are no changes to the
property value.
• No
Does not track changes to properties.
• Track Different
Tracks old and new values of properties only when the property value changes.
f. Click Finish.
g. Click the Add button in the Primary Audit Definition Properties dialog box to add more
properties as needed.
12. Verify that the audit definition object can create audit logs.
• Open the Extensions\Audit Manager folders, right-click the Event Types folder, and
choose New Event Type.
3. In the Display Name box, type the name that you want the event to have in the user interface.
4. In the Description box, type a description of the new event so that others know what it is used for.
5. Click Finish.
6. Create an event type mapping definition to connect the event to a business object type.
• Open the Extensions\Audit Manager folders, right-click the Event Types Mappings folder,
and choose New Event Type Mapping.
2. Click the Browse box to the right of the Primary Object box to select the type of business
object you want to audit.
3. Click the Browse box to the right of the Event Type box to select the event you want to audit for
the selected business object.
4. Click the Browse box to the right of the Audit Type box to select the type of audit to use for this
mapping. The audit types are represented by that are children of the Fnd0AuditLog business
object.
5. Click the Browse box to the right of the Secondary Audit Type box to select the
Fnd0SecondaryAudit business object. This Secondary Audit object stores information and
properties about the secondary objects that are related to the main object being audited.
6. Select the Subscribable? check box to specify that the event type mapping can be subscribed to.
7. Select the Auditable? check box to specify that the event type mapping can be audited.
8. In the Description box, type a description for this mapping so that others know what it is used for.
9. Click Finish.
• Do not deactivate the EPMTask-Add Attachment audit definition as some workflow queries are
dependent on the Add Attachment event.
• When migrating from legacy Audit Manager to the new Audit Manager, use the date range option
to limit the number of audit records for efficient processing.
o ADA License
o Structure Manager
o Multi-Structure Manager
o Schedule Manager
o Workflow Viewer
o Organization
• Run predefined audit reports or create new reports, using the Report Builder application.
• Run predefined audit queries, using the Teamcenter advanced search functionality.
Related topics
• Audit reports
• Process reports
o ADA License
o Structure Manager
o Multi-Structure Manager
o Schedule Manager
o Workflow Viewer
o Organization
Legacy audit information is only accessible from a button in the Audit Logs tab in the Summary view
when a legacy audit file is present.
The audit logs are grouped in the Summary view as follows:
The legacy audit data here refers to the audit data that is generated when the
TC_audit_manager preference is set to OFF.
Audit reports
The following audit reports are available when you choose the Tools→Reports→Report Builder
Reports menu command in My Teamcenter:
• Audit - Workflow Attachment Report
Displays workflow logs for the specified workflow attachment.
Ensure that audit definitions exist for the objects for which you have created saved queries.
Related topics
• Create a generic query
You need Microsoft Excel installed on your computer to export audit logs to Excel.
The Export to Excel option is not available on UNIX clients.
You can export audit logs to Microsoft Excel or csv formats from the Summary view of an object.
1. Select an object whose audit logs you want to export and click the Summary tab.
In the Summary view, select the Audit Logs tab.
2. To export the audit logs in Microsoft Excel format, click the Export to Excel button.
To export the audit logs in csv format, click the Export to CSV button.
Depending on the export option you select, the Export to Excel or Export to CSV dialog
boxes appear.
3. In the Export to Excel or Export to CSV dialog box, select the audit log type you want to export.
4. Click OK.
Depending on the export format you choose, Teamcenter exports the audit logs in Microsoft Excel or
csv format.
Microsoft Excel opens a temporary file. You can create a permanent file by choosing File→Save
As in Excel to display the Save As dialog box.
If you save a live Excel file, you can open it later in My Teamcenter to reconnect it to the database.
Note
You need Microsoft Excel installed on your computer to export audit logs to Excel.
Values that you cannot change in Teamcenter are unavailable in the cells of the live Excel file.
The export to Excel option is not available on UNIX clients.
• To include audit logs associated with items when you export and import items from one site to
another using high-level data transfer, update the TIEUnconfiguredExportDefault transfer
option set as follows:
o To export audit logs, set the value of the Opt_exp_auditrec option to True. The default
value is False.
o To export workflow audit logs, set the value of the Opt_exp_workflow option to True. The
default value is False.
To include audit logs associated with items when you export and import items from one site
to another using low-level data transfer, update the options in the SiteConsolidationDefault
transfer option set as follows:
o To export audit logs, set the value of the Opt_exp_auditrec option to True. The default
value is True.
o To export workflow audit logs, set the value of the Opt_exp_workflow option to True. The
default value is False.
• Do not deactivate the EPMTask-Add Attachment audit definition as some workflow queries are
dependent on the Add Attachment event.
• When migrating from legacy Audit Manager to the new Audit Manager, use the date range option
to limit the number of audit records for efficient processing.
EventTypeMapping Fnd0EventTypeMapping
Audit definition objects Fnd0AuditDefinition
• Log properties Fnd0AuditDefProperty
• Storage media
• Days kept
The migrate_audit_auditdefinitions utility compares the legacy Audit Manager configuration objects
with the new Audit Manager default configuration and generates a Business Modeler IDE delta
template. You must do the following to this delta template:
• Import the template to a Business Modeler IDE custom project.
Note
Ensure that you have migrated audit configurations from the legacy Audit Manager to the
new Audit Manager before using this utility.
The following table shows where audit logs are stored in the legacy and new Audit Manager:
This utility exports audit data from the legacy Audit Manager as a TC XML file. Import this audit log
into Teamcenter using the bulk loader mode of the tcxml_import utility.
The legacy Audit Manager application is deprecated and will be removed in a future version.
Audit Manager supports auditing on workspace objects such as forms, datasets, items, and item
revisions. In addition, Audit Manager supports auditing on administration objects such as users,
groups, and roles. Specifically, system administrators can:
After system administrators create audit logs in Teamcenter, users can view these logs from various
Teamcenter applications. Users can also audit any workspace object, administration object, and
event type with an audit definition.
Configure Audit There are additional steps you must perform to configure Audit Manager
Manager before you can use it.
1 Audit Definition Objects pane Displays all audit definition objects. An audit
definition defines what information needs to be
captured when an event occurs.
2 Audit Definition pane Displays the audit definition properties for the
selected audit definition object.
Your administrator can use the HiddenPerspectives preference to prevent the display of
some Teamcenter perspectives in the rich client.
If your site has online help installed, you can access application and view help from the rich client
Help menu or by pressing F1.
• Event type
Specifies the type of event belonging to a particular object that must be logged.
• Logged properties
Specifies object properties you select for logging. The value of the property at the time of writing
the audit log is logged to audit logs.
For audit definition objects with event type Modify, the old and new values of persistent
properties are tracked.
• Log handler
A log handler allows you to write data other than those captured by audit logs.
You can create custom log handlers.
• Storage
Specifies where audit logs are stored. Depending on your requirements, you can choose to
store audit logs in the database or on a file.
• Archive media
This option appears when you select database as your storage option. This option specifies the
storage media for archiving audit logs.
• TC_audit_delimiter
Specifies the delimiter that separates fields of audit records. This preference is used only for
audit files in text format.
• TC_audit_file_format
Specifies the format of external audit files (.txt or xml).
• TC_audit_log_dir
Specifies the directory where audit log files are stored.
• TC_audit_track_changed_properties_only
Specifies if audit logs are written when there are no changes to any tracked attribute value.
• TC_audit_display_gmt
Specifies if the logged dates in audit logs are shown in the GMT time zone.
You must restart Teamcenter after you change Audit Manager preferences for the changes to take
effect.
If you do not create storage media for archiving or if you leave the Archive Media list blank
while creating an audit definition object, then all generated audit records remain in the
database until you manually delete them.
Value = AuditLog
To specify access to audit definition objects, modify the following rule or create a new rule under Has
Class (POM_application_object)→Working:
Condition = Has Class
Value = AuditDefinition
Note
Run-time properties, compound properties, and relation properties are not tracked.
event1;event2/event3;event4;event5/event6;event7
event# are valid event types separated by semicolons (;). Separate different groups by slash marks
(/). For example:
GroupsOfEventTypes=
__Check_In;__Check_Out;__Cancel_Check_Out;__Transfer_Check_Out/
__Modify;__Delete/__Assign;__Start
• Group 2 contains:
__Modify;__Delete
• Group 3 contains:
__Assign;__Start
After creating these groups of event types, you can select any of the groups from the General tab of
the Viewing the Audit Logs dialog box. In this example, if you select Group 1, all four event types
are searched in audit logs.
5. Modify the audit definition objects. You can modify the TC_DATA\auditdefinition.dat file to
add the new handler to the audit definition object you want to change. Then, either run the
TC_BIN\define_auditdefs -f=auditdefinition.dat command or interactively log on to the Audit
Manager application in the rich client and modify the audit definition objects to add the new
handler.
In the past, the install_event_types utility was used to create new events. Now you create new
event types using the Business Modeler IDE.
1. Choose one of these methods:
• On the menu bar, choose BMIDE→New Model Element, type Event Type in the Wizards
box, and click Next.
• Open the Extensions\Audit Manager folders, right-click the Event Types folder, and
choose New Event Type.
3. In the Display Name box, type the name that you want the event to have in the user interface.
4. In the Description box, type a description of the new event so that others know what it is used for.
5. Click Finish.
6. Create an event type mapping definition to connect the event to a business object type.
In the past, the event mapping was created using the install_event_types utility. Now event mapping
is created using the Business Modeler IDE.
1. Choose one of these methods:
• On the menu bar, choose BMIDE→New Model Element, type Event Type Mapping in
the Wizards box, and click Next.
• Open the Extensions\Audit Manager folders, right-click the Event Types Mappings folder,
and choose New Event Type Mapping.
2. Click the Browse box to the right of the Primary Object box to select the type of business
object you want to audit.
3. Click the Browse box to the right of the Event Type box to select the event you want to audit for
the selected business object.
4. Click the Browse box to the right of the Audit Type box to select the type of audit to use for this
mapping. The audit types are represented by that are children of the Fnd0AuditLog business
object.
5. Click the Browse box to the right of the Secondary Audit Type box to select the
Fnd0SecondaryAudit business object. This Secondary Audit object stores information and
properties about the secondary objects that are related to the main object being audited.
6. Select the Subscribable? check box to specify that the event type mapping can be subscribed to.
7. Select the Auditable? check box to specify that the event type mapping can be audited.
8. In the Description box, type a description for this mapping so that others know what it is used for.
9. Click Finish.
5. If you select Database as the storage type, the Archive Media list appears.
Select the archive media from the Archive Media list.
Note
Leaving the Archive Media list blank causes all generated audit records to remain in the
database until you manually delete them.
If there are no values in the Archive Media list, you must create a storage media.
c. To remove a property from the Logged Properties list, select the property and click Remove
.
7. Click Create to add the object to the database and add the Audit Definition object to
the Audit Definition Objects tree.
You can also create an audit definition object by using the define_auditdefs command line utility.
c. To remove a property from the Logged Properties list, select the property and click Remove
.
2. Click Delete .
You can view audit logs only if you have read access to the object being audited.
This data is available only if the TC_audit_manager preference is set to ON and the
TC_audit_manager_version preference is set to 2.
• If you select an object, the object ID, name, revision, and object type are displayed in the
Search Criteria section.
• To select a project, select a project you have access to from the Project list.
• If you want to search for a different object, click the Clear button to clear the existing search
criteria and then type the object ID, name, and revision in the Audit Log dialog box.
3. (Optional) Specify additional search criteria, such as event type, user ID, and date created.
4. (Optional) Click the Advanced tab and type criteria to construct a query based on property values.
Note
The Advanced tab does not display any information if there are no logged properties in
the audit definition object.
The logged properties defined in the audit definition object are shown in the Available
Properties list.
c. Select the properties for which you require audit logs from the Available Properties list, and
click the button to move the property to the Selected Search Criteria list.
Note
d. To search for properties based on old or new values, in the Selected Search Criteria list,
enter the old value in the Old Value column and the new value in the New Value column.
e. Click Find.
Audit logs that match your selected criteria appear.
5. Click Find.
The system displays the audit logs that match the search criteria.
Property value changes are shown in the User Data column of the audit log. The User Data
column shows the property name, the old value of the property, and the new value of the property.
The old value of the property is the same as the new value of the property if the property value
does not change.
Note
Only persistent properties of objects are tracked. Run-time, compound, and relational
properties are not tracked by Audit Manager.
2. Type the object ID of the deleted object in the Audit Log dialog box.
3. Click Find.
Teamcenter displays the audit logs of the deleted objects.
• ON
View→Audit→View Audit Logs is available.
• If you select an object, the object ID, name, revision, and object type are displayed in the
Search Criteria section.
3. (Optional) Specify additional search criteria, such as event type, user ID, and date created.
4. (Optional) Click the Advanced tab and type the criteria to construct a query based on property
values.
Note
The Advanced tab does not display any information if there are no logged properties in
the audit definition object.
5. Click Find.
The system displays the audit logs that match the search criteria.
• From the Object Selection section, choose one of the following options:
o Choose the Export Selected Objects option to export only the selected objects from
the audit log.
o Choose the Export All Objects In View option to export all objects from the audit log.
• From the Output Format section, choose one of the following options:
o Choose the Use Excel option to export the audit logs in an Excel file.
Select the Excel export template from the list next to the Use Excel option.
Note
o Choose the Use CSV option to export the audit logs in a CSV file.
• Avoid using object type as the only search criteria. Enter additional criteria along with the object
type.
• Avoid using wide date ranges. If you use a wide date range, select additional search criteria.
• Avoid using only event type. Generally, an audit log has maximum records for the Modify event.
• Avoid search only by error code. By default, all values are 0 and may cause Teamcenter to crash.
Beginning with Teamcenter 10.1, the legacy workflow and reservation auditing functionality is no
longer available. This section documents the functionality available before Teamcenter 10.1.
The workflow and reservation audit functionality gives you the ability to capture workflow, signoff, and
checkout audit logs. The audit logs are stored in a file.
Note
Beginning with Teamcenter 10.1, the legacy workflow and reservation auditing functionality is
no longer available. This section documents the functionality available before Teamcenter 10.1.
Set the following preference to use the workflow and reservation auditing functionality:
• TC_audit_manager
Set the preference value to OFF to enable the auditing functionality.
You must restart Teamcenter after you change Audit Manager preferences for the changes to take
effect.
Note
Beginning with Teamcenter 10.1, the legacy workflow and reservation auditing functionality is
no longer available. This section documents the functionality available before Teamcenter 10.1.
Note
Audit and signoff history reports generated for selected data objects or workflow processes contain
details and additional information about each task.
Note
Beginning with Teamcenter 10.1, the legacy workflow and reservation auditing functionality is
no longer available. This section documents the functionality available before Teamcenter 10.1.
Note
2. Choose View→Audit→File.
The system displays the workflow audit file in the View Audit File dialog box.
Note
Legacy audit files display information about workflow-related events, such as when a task is
started, approved, or completed. Audit files also display information about the delegation of
tasks using the Out of Office Assistant, which appears in the log file as Assign Approver
events.
o EPMTask:__Add_Attachment
o EPMTask:__Remove_Attachment
o ADA_License:__Attach_License
o ADA_License:__Detach_License
o BOMView Revision:__Component_Add
o BOMView Revision:__Component_Remove
o ScheduleTask:__ResourceAssignment_Create
o ScheduleTask:__ResourceAssignment_Modify
o ScheduleTask:__ResourceAssignment_Delete
o ScheduleTask:__TaskDependency_Create
o ScheduleTask:__TaskDependency_Modify
o ScheduleTask:__TaskDependency_Delete
• Fnd0OCC_track_position_orientation_audithandler
This log extension enables the logging of occurrence position and orientation changes of the
components in structures. It is attached to the PSOccurrence:__Modify audit definition.
Note
You must not use this log extension in any audit definition except for audit definitions that
log position and orientation changes of components based on occurrence properties.
• Fnd0CICO_auditloghandler
This log extension applies to checkin and checkout events. It logs the change ID and reason
why the object is checked in or out.
• Fnd0PROJInfo_audithandler
This log extension logs information about objects that are assigned to projects. The project
names are separated by commas.
By default, this extension is not available on any audit definition.
• Fnd0USER_get_additional_log_info
This log extension logs workflow information. For example, for the __Assign event, this log
extension logs information like the process name, task type, user comments, user ID, and the
user name the workflow is assigned to.
This log extension applies to workflow-related events such as __Abort, __Add_attachment,
__Approve, __Assign, __Assign_Approver, __Complete, __Demote, __Fail, __Notify,
__Perform, __Reject, __Stand_In, __Remove_Attachment, __Resume, __Start, __Suspend,
and __Update_Process.
• Fnd0WriteSignoffDetails
This log extension logs workflow signoff history. For example, for the __Add_attachment event,
this log extension logs information like signoff decision, job, sign off, user ID, sign off group,
and sign off role name.
This log extension applies to workflow related events such as __Add_attachment, __Approve,
__Reject, __Stand_In, and __Remove_Attachment.
Fnd0FileAccessAuditSec_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-2
Fnd0LicenseExportAuditSec_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-3
Fnd0ScheduleAuditSec_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-4
Fnd0SecurityAudit_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-5
Fnd0SecurityAudit_ColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-6
Fnd0SecurityAuditSec_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-7
Fnd0StructureAuditSec_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-8
Fnd0WorkflowAuditSec_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-9
TC_audit_disabled_dataset_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-10
TC_audit_buffer_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-11
TC_audit_delimiter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-12
TC_audit_display_gmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-13
TC_audit_file_format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-14
TC_audit_log_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-15
TC_audit_manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-16
TC_audit_manager_version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-17
TC_audit_number_of_logs_to_load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-18
TC_audit_track_changed_properties_only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-19
Fnd0FileAccessAuditSec_ColumnPreferences
DESCRIPTION
Specifies the list of columns to be displayed on secondary audit table in Audit Manager
for objects of type Fnd0FileAccessAudit.
VALID
VALUES
Property names from the Fnd0FileAccessAudit type.
DEFAULT
VALUES
object_type
object_name
DEFAULT
PROTECTION
SCOPE
User preference.
Fnd0LicenseExportAuditSec_ColumnPreferences
DESCRIPTION
Specifies that a list of columns be displayed in the secondary audit table for objects of
type Fnd0LicenseExportAudit.
VALID
VALUES
Property names from the Fnd0SecondaryAudit class.
DEFAULT
VALUES
object_string
object_type
object_name
fnd0PrimaryObjectID
sequence_id
fnd0ObjectDisplayName
fnd0PrimaryObjectRevID
DEFAULT
PROTECTION
SCOPE
User preference.
Fnd0ScheduleAuditSec_ColumnPreferences
DESCRIPTION
Specifies that a list of columns be displayed in the secondary audit table for objects
of type Fnd0ScheduleAudit.
VALID
VALUES
Property names from the Fnd0SecodnaryAudit class.
DEFAULT
VALUES
object_string
object_type
fnd0Object
object_name
fnd0PrimaryObjectID
sequence_id
fnd0ObjectDisplayName
schedule_tag
schedule_tagDisp
fnd0state
fnd0status
cost
currency
user_id
user_name
role_name
discipline_name
group
groupDisp
role
roleDisp
name
DEFAULT
PROTECTION
SCOPE
User preference.
Fnd0SecurityAudit_ColumnPreferences
DESCRIPTION
Specifies the list of columns be displayed in the secondary audit table in Audit Manager
for Fnd0SecurityAudit objects.
VALID
VALUES
Property names from the Fnd0SecurityAudit type.
DEFAULT
VALUES
fnd0LoggedDate
fnd0Event TypeName
object_type
object_name
fnd0UserId
fnd0GroupName
fnd0RoleName
fnd0SecondaryObjectID
fnd0SecondaryObjectType
fnd0SecondaryObjectName
fnd0SecondaryObjDispName
DEFAULT
PROTECTION
SCOPE
User preference.
Fnd0SecurityAudit_ColumnWidthPreferences
DESCRIPTION
Specifies the widths (in pixels) of the columns specified by the
Fnd0SecurityAudit_ColumnPreferences preference.
VALID
VALUES
Positive integer values.
DEFAULT
VALUES
15
15
15
40
15
15
15
15
15
40
15
DEFAULT
PROTECTION
SCOPE
User preference.
Fnd0SecurityAuditSec_ColumnPreferences
DESCRIPTION
Specifies the list of columns be displayed in the secondary audit table in Audit Manager
for objects of type Fnd0SecurityAudit.
VALID
VALUES
Property names from the Fnd0SecurityAudit class.
DEFAULT
VALUES
object_string
object_type
object_name
fnd0PrimaryObjectID
sequence_id
fnd0ObjectDisplayName
DEFAULT
PROTECTION
SCOPE
User preference.
Fnd0StructureAuditSec_ColumnPreferences
DESCRIPTION
Specifies that a list of columns be displayed in the secondary audit table for objects
of type Fnd0StructureAudit.
VALID
VALUES
Property names from the Fnd0SecodnaryAudit class.
DEFAULT
VALUES
object_string
object_type
object_name
fnd0PrimaryObjectID
sequence_id
fnd0ObjectDisplayName
fnd0PrimaryObjectRevID
DEFAULT
PROTECTION
SCOPE
User preference.
Fnd0WorkflowAuditSec_ColumnPreferences
DESCRIPTION
Specifies that a list of columns be displayed in the secondary audit table for objects
of type Fnd0WorkflowAudit.
VALID
VALUES
Property names from the Fnd0SecodnaryAudit class.
DEFAULT
VALUES
object_string
object_type
object_name
fnd0PrimaryObjectID
sequence_id
fnd0ObjectDisplayName
fnd0PrimaryObjectRevID
DEFAULT
PROTECTION
SCOPE
User preference.
TC_audit_disabled_dataset_types
DESCRIPTION
Specifies the types of datasets to be excluded from producing read file events. This
applies only to read file events.
VALID
VALUES
The string name of the dataset type to exclude, for example, MSExcelX.
DEFAULT
VALUES
CLIPS
DEFAULT
PROTECTION
SCOPE
Site preference.
TC_audit_buffer_size
Note
DESCRIPTION
Specifies the size of the buffer that holds the audit records during a session. Once
the buffer size is met, the buffer is written to an external file. This number should be
slightly larger than the number of audited events generated during a typical session.
Thus, flushing the buffer to the external file happens only after exiting the session with
no performance penalty.
VALID
VALUES
A positive integer.
DEFAULT
VALUES
1000
DEFAULT
PROTECTION
SCOPE
Group preference.
TC_audit_delimiter
Note
DESCRIPTION
Specifies the delimiter that separates fields of audit records.
This preference is used only for audit files in text format. When importing the audit file
into Microsoft Excel or Access, you must specify the same delimiter as you defined
in this preference.
VALID
VALUES
Multiple characters. Siemens PLM Software recommends a single character is used.
Though a single-character entry is not enforced, some spreadsheet programs such as
Excel do not allow multiple character delimiters.
DEFAULT
VALUES
^
DEFAULT
PROTECTION
SCOPE
Group preference.
TC_audit_display_gmt
Note
DESCRIPTION
Specifies if the logged dates in audit logs are shown in the GMT time zone.
VALID
VALUES
true Logged dates are in the GMT time zone.
false Logged dates are in the local server time zone.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.
TC_audit_file_format
Note
DESCRIPTION
Specifies the format of external audit files.
VALID
VALUES
0 Text format (.txt).
1 XML format (.xml).
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
Group preference.
TC_audit_log_dir
Note
DESCRIPTION
Specifies the directory where audit log files are stored. If the directory specified by
this preference cannot be created, audit log files are saved to the preference's default
setting.
The TC_LOG environment variable must be defined first before starting a Teamcenter
session.
VALID
VALUES
Single string as a value; must be a valid directory path.
DEFAULT
VALUES
%TC_LOG%\audit
DEFAULT
PROTECTION
SCOPE
Group preference.
TC_audit_manager
DESCRIPTION
Determines auditing behavior.
VALID
VALUES
ON Enables the Audit Manager application.
Enables full auditing functionality, providing access to out-of-the-box audit saved
search and reports, to the Viewing the Audit Logs dialog box, which allows
you to search and view audit information for the selected Teamcenter object.
If a selected object has a legacy audit file attached, such as workflow history,
the user can access this file by using the View Audit File dialog box from the
Viewing the Audit Logs dialog box.
OFF Disables the Audit Manager application; the application is not compatible with
the legacy file-based functionality.
Enables only the legacy View Audit File dialog box, which displays audit
information for the selected object.
DEFAULT
VALUES
ON
DEFAULT
PROTECTION
SCOPE
Site preference.
TC_audit_manager_version
DESCRIPTION
Enables or disables different auditing functionality types.
VALID
VALUES
2 Enables the legacy Audit Manager application.
This legacy application provides access to out-of-the-box auditing reports;
to the Viewing the audit logs dialog box, which allows you to search
audit records, and to the View Audit File dialog box, which displays audit
information for the selected object. If a selected object has a legacy audit file
attached, you can access this file from the Viewing the Audit Logs dialog box.
To enable this legacy audit application, you must also set the value of the
TC_audit_manager preference to ON.
3 Enables the new auditing functionality. You must also set the value of the
TC_audit_manager preference to ON.
This auditing functionality allows you to define audit definitions using the
Business Modeler IDE. You can also view audit logs in the Summary view of
some Teamcenter applications.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
Site preference.
TC_audit_number_of_logs_to_load
DESCRIPTION
Specifies the number of audit logs to load in the Summary view of Teamcenter
applications showing audit logs.
VALID
VALUES
Any integer value.
DEFAULT
VALUES
100
DEFAULT
PROTECTION
SCOPE
User preference.
TC_audit_track_changed_properties_only
Note
DESCRIPTION
Specifies if audit logs are written when there are no changes to any tracked attribute
value.
This preference applies to the Modify event type only.
VALID
VALUES
True Audit logs are written only when a tracked attribute value changes.
False Audit logs are written irrespective of changes in tracked attribute values.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.
• combine_audit_files
• define_auditdefs
• AUDIT_delete_specified_records
• AUDIT_get_records
• AUDIT_get_records_with_specified_col
• AUDIT_initialize_log_query
• AUDIT_insert_record
• AUDIT_log_event
• AUDITMGR_add_audit_properties
• AUDITMGR_create_audit_definition
• AUDITMGR_find_audit_definition
• AUDITMGR_get_archive_media
• AUDITMGR_get_audit_properties
• AUDITMGR_get_auditable_types
• AUDITMGR_get_event_type
• AUDITMGR_get_log_handler
• AUDITMGR_get_max_days_kept
• AUDITMGR_get_object_type
• AUDITMGR_get_storage_type
• AUDITMGR_remove_audit_properties
• AUDITMGR_set_archive_media
• AUDITMGR_set_log_handler
• AUDITMGR_set_max_days_kept
• AUDITMGR_set_storage_type
Note
To access the Integration Toolkit Function Reference, install the Teamcenter developer
references when you install Teamcenter online help, or go to the Global Technical Access
Center (GTAC):
You can view audit logs for changes to structure from Structure Manager, Multi-Structure Manager, or
Manufacturing Process Planner applications.
To view audit logs in these applications, do one of the following:
• Select the BOM line and choose View→Audit→View Audit Logs.
If you click Clear to clear Audit Log dialog box of the existing search criteria and
search for audit logs by typing the same search criteria, you see the audit logs of other
occurrences of the structure.
Teamcenter provides the following audit definitions for viewing changes to structure:
Note
For position and orientation tracking, actual values of position and orientation are not written
to audit logs. For position change, old value is written as Old Position and new value is
written as New Position. For orientation change, old value is written as Old Orientation and
new value is written as New Orientation.
Changes to UG Form are written as changes to UG Dataset.
Property Value
primary object Component object reference
eventTypeName Modify
propertyCount 1
propertyNames NXPartHistory
The signature of the Teamcenter services API to create audit log is as follows:
DataManagementImpl::PostEventResponse DataManagementImpl::postEvent (
const std::vector< PostEventObjectProperties >& input,
const std::string& eventTypeName )
The signature of the Teamcenter services API to get event types for given object types is as follows:
DataManagementImpl::EventTypesResponse DataManagementImpl::getEventTypes
(const std::vector< ObjectType >& input )
You can find the events that are auditable in the Event Type Mapping editor of Business Modeler IDE.
The following events are not auditable by default:
• Read_File
• Write_File
Headquarters
Europe
Granite Park One
Stephenson House
5800 Granite Parkway
Sir William Siemens Square
Suite 600
Frimley, Camberley
Plano, TX 75024
Surrey, GU16 8QD
USA
+44 (0) 1276 413200
+1 972 987 3000
Asia-Pacific
Americas
Suites 4301-4302, 43/F
Granite Park One
AIA Kowloon Tower, Landmark East
5800 Granite Parkway
100 How Ming Street
Suite 600
Kwun Tong, Kowloon
Plano, TX 75024
Hong Kong
USA
+852 2230 3308
+1 314 264 8499