LogoLogo
Illumina KnowledgeIllumina SupportSign In
Clarity LIMS v6.3 & Lablink v2.5
  • Home
Clarity LIMS v6.3 & Lablink v2.5
  • Release Notes Clarity LIMS v6.3
    • Release Notes Clarity LIMS v6.3.1
    • Release Notes Clarity LIMS v6.3.0
  • Technical Overview
    • Technical Requirements
  • Installation
    • Installation Procedure
    • Guide to Secret Management
    • Install/Upgrade Secret Management for Integration Modules
    • Change the Clarity LIMS Hostname
    • Update Server Passwords and Database Connection Details
  • On-Premise Deployments
    • Pre-installation Requirements
      • Install a Purchased SSL/TLS Certificate
      • Configure Your HashiCorp Vault
    • On Premise to On Premise Upgrade Procedures
    • On Premise to On Premise In-place Upgrade Procedures
    • On Premise to Hosted Upgrade Procedures
    • Hosted to On Premise Upgrade Procedures
  • Administration
    • Database Cleanup Procedure
    • Backup and Restore Procedure
    • Receiving and Decrypting Cloud Backup Data
    • LDAP Integration
      • Using the LDAP Checker Tool
    • Illumina Connected Software Platform Integration
    • Clarity LIMS Log Files
    • Customize the Term Used for Projects
    • Enforcing Unique Sample Names Within a Project
    • Container Name Uniqueness
    • Configure Electronic Signatures
    • Creating Enrypted Passwords
    • Config Slicer Tool
      • Managing Configurations with Config Slicer
      • Upgrading a configuration package/manifest file for compatibility with Config Slicer v3.0.x
      • Config Slicer Use Cases
      • Troubleshooting Config Slicer
    • Audit Trail
      • Enabling, Validating and Disabling Audit Trail
    • System Settings
    • Automation Worker Nodes
      • Troubleshooting Automation Worker
  • Clarity LIMS v6.3 Reference Guide
    • Dashboards
      • Overview Dashboard
      • Projects Dashboard
    • Projects and Samples
      • Projects
      • Samples Accessioning
        • Sample List for Batch Import
        • Guidelines and Tips for Batch Sample Import
      • Assign and Process Samples
    • Lab View
      • Requeue and Rework Samples
      • Storing Sample Aliquots for Later Use
      • Modifying Completed Step Details
      • Alert Notifications
    • Configuration
      • Lab Work
        • Steps and Master Steps
          • Step Milestones
          • Derived Sample Naming Convention Tokens
        • Protocols
        • Workflows
      • Consumables
        • Reagents
          • Reagent Kit Lot Manifest for Batch Import
        • Controls
        • Instruments
        • Labels
        • Containers
      • Custom Fields
      • User Management
        • Manage User Access
        • User Roles
        • Configured Role-Based Permissions
        • User and Profile Page
      • Automations
        • Automation Trigger Configuration
        • Copy Custom Fields from Step Input to Output
        • Template Files Associated With Automations
    • Automated Quality Control
      • Configure a QC System
    • Search
      • Basic Search
      • Advanced Search
    • Genealogy View
    • System Performance
      • Queue Performance and Usability
      • Demultiplexing API Endpoint Performance
    • Terms and Definitions
  • LabLink v2.5 Reference Guide
    • Project
      • Email Notifications for Notes
    • Resource Materials & Contact Us
    • Users
    • Configuration
    • Publishing Files and Progress
Powered by GitBook
On this page
  • Enabling Audit Trail
  • Validating Audit Trail
  • Disabling Audit Trail

Was this helpful?

Export as PDF
  1. Administration
  2. Audit Trail

Enabling, Validating and Disabling Audit Trail

BaseSpace Clarity LIMS provides Audit Trail, a robust data-tracking system that allows you track:

  • All user activity - i.e. who did what and when.

  • Every action that is written to the database.

Audit Trail has two capture systems, Event Log and Detail Log.

  • Event Log records familiar BaseSpace Clarity LIMS user actions, and presents this information in a format that is easy to read and understand.

  • Detail Log records exacting information about the changes resulting from the actions recorded in the Event Log. This includes both the updated values and the previous values.

Note:

As of BaseSpace Clarity LIMS v6, Audit Trail is enabled by default.

When Audit Trail is enabled, you may experience a small performance hit due to the overhead of writing these entries to the database. It is therefore recommended that you periodically archive the Audit Trail database so that it does not become too large.

Enabling Audit Trail

All of the following steps are performed on the BaseSpace Clarity LIMS server.

With the exception of steps 1 and 8, all are performed as the glsjboss user.

  1. Stop Tomcat - as the glsjboss user:

    service clarity_tomcat stop
  2. Access the property tool:

    cd /opt/gls/clarity/tools/propertytool
  3. Enable Audit Trail:

    java -jar omxprops-ConfigTool.jar set -y -f 192.168.57.10 clarity.audit.enabled 'true'
  4. Confirm the setting:

    java -jar omxprops-ConfigTool.jar get clarity.audit.enabled
  5. Migrate the database:

    cd /opt/gls/clarity/config
    yes | bash update_claritylims_tenant.sh
  6. Start Tomcat - as the glsjboss user:

    service clarity_tomcat start  

Validating Audit Trail

  1. Log in to BaseSpace Clarity LIMS and make a change – for example, add a project, create a sample, add a custom field, etc. The exact change is not important. There must simply be a change to the activity or the configuration data since Audit Trail was last enabled.

  2. Use psql (postgres) or SQL*Plus (Oracle) to query the main BaseSpace Clarity LIMS database (clarityDB) to verify whether rows are being written to the following two tables:

    • auditeventlog

    • auditchangelog

Disabling Audit Trail

All of the following steps are performed on the BaseSpace Clarity LIMS server.

With the exception of steps 1 and 8, all are performed as the glsjboss user.

  1. Stop Tomcat - as the glsjboss user:

    service clarity_tomcat stop
  2. Access the property tool:

    cd /opt/gls/clarity/tools/propertytool
  3. Disable Audit Trail:

    java -jar omxprops-ConfigTool.jar set -y -f 192.168.57.10 clarity.audit.enabled 'false'
  4. Confirm the setting:

    java -jar omxprops-ConfigTool.jar get clarity.audit.enabled
  5. Migrate the database:

    cd /opt/gls/clarity/config
    yes | bash update_claritylims_tenant.sh
  6. Start Tomcat - as the glsjboss user:

    service clarity_tomcat start  
PreviousAudit TrailNextSystem Settings

Last updated 6 months ago

Was this helpful?

For instructions, see the

Backup and Restore Procedure