About extending audit references

If the AuditRequired flag is enabled in the entity XML, audit records are added to the YFS_AUDIT table. The default for this flag is Y, for item and organization tables. However, the audit flag and audit references can be overridden by the extension XML file.

About this task

Note: All the records pertaining to the cached tables as well as the tables for which the value of AuditRequired flag is set to Y are logged into YFS_AUDIT table.

If you want to switch off the generation of audit references for some specific entities, change the value of the AuditRequired flag to N for such entities.

Note: You can add new audit references in the extension XML file. When new references are added, they take precedence over the existing audit references, which are entirely overridden.

You can add up to six audit references only.

Only item and organization header-level audit records are inserted in the YFS_AUDIT_HEADER table. The audit references refer to the columns of the entity being audited.

The audits can be generated for the hang-off and custom tables, by modifying the entity table name and audit reference column names.

Note: Auditing is not supported for hang-off tables with more than one parent.

To generate audit references for entities:

Procedure

Edit the your_custom_filename.xml file in the <runtime_sandbox>/repository/entity/extensions directory to enable audit record generation for desired entities. The following example explains the elements to be added to the database schema:

<DBSchema>
   <Entities>
     <Entity TableName="YFS_ITEM" AuditRequired="Y" >
        .
        .
        <AuditReferences>
            <Reference ColumnName="ItemId" />
            .
            .
        </AuditReferences>
        .
        .
     </Entity>
   </Entities> 
</DBSchema>

Attribute	Description
Entity
TableName	The table name to be audited.
AuditRequired	If this flag is set to Y the audit references are entered in the YFS_AUDIT table. Note: This attribute must not be passed when you are creating a hang-off for order related tables. In this case, the audits are automatically inserted into the related order audit tables.
Entity/AuditReferences/Reference
ColumnName	The column name in this entity which has audit references. This name must be valid for the entity.

Create a new Reference tag for each audit reference you want to add.
The hang-off of an order table audits can be viewed with the associated order audits.