auditdetails Element

 

Content

auditdetails Element

Description

Example

Properties

Description

The auditdetails Element shows details of Audit data relevant to any SDC for which Auditing is enabled. This Element can also show Audit data for detail tables of an SDC, as well as XML stored in CLOBs.

The AuditView Page Type typically contains multiple instances of this Element. Each instance can display:

Columns from these SDI detail tables:
• SDIAddress • SDIDataItemLimits
SDIApproval SDIDataItemSpec
SDIApprovalStep SDIFormRule
SDIAttachment SDIDataRelation
SDIAttribute • SDISpec
SDIDataApproval SDIWorkItem
SDIData SDIWorkItemRelation
SDIDataItem   
Detail table relationships (one level only)
Many-to-many table relationships (one level only)
Reverse foreign-key link relationships (one level only)

The createby, createdt, modby, and moddt columns in detail and many-to-many tables are populated when a record is added or updated in the Audit table for the SDC.

NOTE:   The SDIWorkItemRelation table is supported in LabVantage 8.4.1 and higher LabVantage 8.4.x Maintenance Releases.

Example

See the Data Entry Audit Page.

auditdetails Element Properties

Property Name Description
Table Identifier of the Audit table from which the data is retrieved. Audit tables must be specified with their a_ prefix (see Concepts of Auditing).

If this Element is the topmost Element in the above hierarchy (meaning the SDC), the Audit table identifier is determined from the SDCId property of the Page Type.

If this Element is a child Element in the hierarchy, it must show only the detail Audit data. Child Elements cannot represent SDC Audit data.

title title displayed on the Element (defaults to the table identifier if no value is specified).
Data Row title title displayed for every row in the Element. For example, if a Sample has 2 different Data Sets, this title is displayed for each DataSet. The same specified data row title will be repeated.

You can use variables as in the following example using Data Sets (values of the columns from the Data Set SDC are within the brackets):

{{Parameter List}}: <b>[paramlistid]</b> {{Version}}: <b>[paramlistversionid]</b> {{Variant}}: <b>[variantid]</b> {{Dataset}}: <b>[dataset]</b> ([count])

The {{and}} tag translates the text to the User's language.

This substitution using variables can be done for Sample, Specification, DataSet, DataApproval, DataItem, Product, DataItemSpec and DataItemLimits SDCs. To substitute values using variables, you need:

The key columns of the table from which data is retrieved.
The count variable representing the number of Audit rows.
Parent Element Identifier of the parent Element.

If Data Items are displayed in each SDI, this property specifies the identifier of the Element that displays the SDI data.

If Data Items are displayed in each Data Set, this property specifies the identifier of the Element that displays the Data Sets.

If you leave this property blank, this Element becomes the top Element in the hierarchy. A page can have only one top Element.

Show The "Show" property is available at both the Element level (this property) and the individual Column level (in the Columns collection).

Here at the Element level, the property defaults to Yes for backward-compatibility. Setting Show to No for the top element will not result in any change, as the top Element is the starting point of the page and cannot be marked as Hidden. All child elements will also be hidden. No data will be retrieved for the hidden elements.

At the column level, the property defaults to Yes. The hidden column will not be displayed in both normal Audit or Dynamic Audit sections. The column will be retrieved from the database, but not rendered. Make certain the hidden column points to a valid database column.

Initially Expanded Yes expands the Element when the page loads. When expanded, the Element shows all data rows, and the Audit data and child Elements (of the current Element) are collapsed.
Order Sort order in which Audit data are displayed: in chronological or reverse chronological order.
Show User Name "Yes" displays the User's full name as the value for the "Modified By" column.
Columns Audit columns displayed for the selected Audit table:
Property Name Description
IdentifierUnique identifier for this item, rendered as an ID attribute in the HTML tag.
ColumnIdentifier of the column. Only columns of the selected table are available for presentation.
titletitle displayed for the column. If this is not specified, the column label is retrieved from the "Label" in the Columns tab of the SDC Maintenance page (see SDCs → SDC Table Maintenace → Columns).
Show The "Show" property is available at both the Element level (see above) and the individual Column level (this property).

Here at the column level, the property defaults to Yes. The hidden column will not be displayed in both normal Audit or Dynamic Audit sections. The column will be retrieved from the database, but not rendered. Make certain the hidden column points to a valid database column.

At the Element level, the property defaults to Yes for backward-compatibility. Setting Show to No for the top element will not result in any change, as the top Element is the starting point of the page and cannot be marked as Hidden. All child elements will also be hidden. No data will be retrieved for the hidden elements.

WidthNumerical value used to proportionally adjust the horizontal widths of all columns. By default, all columns are evenly proportioned.
AlignmentAlignment of the data within the cell (left, center or right).
Display ValueValue used to decipher Audit codes. For example, if the Data Set Approval Status is stored in the database as "U" for "Pending", "P" for "Pass" and "F" for "Fail", these values can be deciphered by setting this property with values U=Pending, P=Pass, and F=Fail. Whenever the value "U" is found in this column, "Pending" is shown (or "Pass" for "P" and "Fail" for "F").
Tracelog Columns Columns from the Tracelog table:
Property Name Description
IdentifierUnique identifier for this item, rendered as an ID attribute in the HTML tag.
ColumnIdentifier of the column in the Tracelog table (may not be always populated in the Tracelog table).
titletitle displayed for the column (defaults to the column identifier).
WidthNumerical value used to proportionally adjust the horizontal widths of all columns. By default, all columns are evenly proportioned.
AlignmentAlignment of the data within the cell (left, center or right).
Display ValueFunctionality is the same as Display Value in the Columns property above.
Advanced Configuration When enabled, filters columns by the specified SQL clauses and "Key Column Id" if "Display All Table Columns" (below) is "Yes".
Property Name Description
Enable?Enables this filter.
Additional Select Clause
Additional From Clause
Additional Where Clause
Additional OrderBy Clause
SQL clauses by which to filter the column specified by Key Column Id (below).
Key Columns Column containing data to be filtered.
Property Name Description
Key Column IdIdentifier of the column.
Display All Table Columns "Yes" shows all SDI columns in alphabetical order of the columnid, and retrieves the column label from the "Label" in the Columns tab of the SDC Maintenance page (see SDCs → SDC Table Maintenace → Columns). Also set this to "Yes" if filtering using "Advanced Configuration" (above).