Installing or Upgrading DirX Audit

This chapter covers three basic scenarios that can occur if you want to prepare the DirX Audit History Database and the DirX Identity domain for the DirX Audit History Synchronization jobs. You can:

  • Install DirX Audit from scratch

  • Upgrade DirX Audit using the legacy History Database synchronization workflows running on DirX Identity

  • Upgrade DirX Audit using the DirX Audit History Synchronization jobs

Performing a New DirX Audit Installation

A clean installation of DirX Audit automatically prepares the DirX Audit History Database for the DirX Audit History Synchronization jobs. You can read more about DirX Audit installation in the DirX Audit Installation Guide. After DirX Audit is installed, perform the following steps to prepare and configure the DirX Audit History Synchronization jobs:

  • Prepare DirX Identity for DirX Audit History Synchronization. You must configure some parameters of the DirX Identity store for auditing. For more information on DirX Identity configuration, see the section "Preparing the DirX Identity Store".

  • Configure and customize the DirX Audit History Synchronization jobs. If you do not want to customize the synchronization process, the only required steps are to set up an LDAP connection to your DirX Identity domain and then use the DirX Audit Tenant Configuration Wizard to schedule the DirX Audit History Synchronization jobs for entry types. To schedule the jobs, see the section "Scheduled History Synchronization Jobs Configuration" in the DirX Audit Installation Guide. To customize the jobs, see the section "Configuring and Customizing DirX Audit History Synchronization Jobs" in this guide.

Upgrading DirX Audit Using the Legacy History Database Synchronization Workflows Running on DirX Identity

DirX Audit 7.1 and older uses DirX Audit History Database workflows running on DirX Identity to synchronize DirX Identity domain entries to the DirX Audit History Database. The DirX Audit History Synchronization jobs completely replace this functionality in DirX Audit 7.2. To upgrade to the new DirX Audit History Synchronization jobs, perform the following steps:

  • Prepare the DirX Audit History Database for DirX Audit History Synchronization jobs. You can read more about this step in the section "Preparing the DirX Audit History Database".

  • Prepare DirX Identity for the DirX Audit History Synchronization jobs. You can read more about this step in the section "Preparing the DirX Identity Store".

  • Back up the legacy DirX Audit History Database synchronization workflows customization. We recommend that you check the legacy DirX Audit History Database synchronization workflows configuration objects like channels, workflows, and schedules in DirX Identity and back up all customizations; for example, custom entry types, LDAP schema extensions or custom attributes mapping to the DirX Audit History Database.

  • Remove the legacy configuration objects from DirX Identity. You can perform this step in DirX Identity Manager’s Connectivity view. To remove the legacy DirX Audit History Database synchronization workflows and connected directories:

    • Delete the corresponding objects in the scenario of the Global View.

    • Delete the workflows in the Expert View. Consider both the full and delta workflows.

    • Delete the connected directory for the DirX Audit History Database in the Expert View. Disable the Check references to avoid broken links option before confirming the deletion.

    • Delete the folder for the History Database channels in the Expert View beneath the connected directory representing the DirX Identity domain.

  • Apply any customizations to the DirX Audit History Synchronization jobs. Modify the tenant configuration.cfg file to accomplish this task. See the section "Configuring and Customizing the DirX Audit History Synchronization Jobs" for details.

  • Configure the DirX Audit History Synchronization jobs. Use the Tenant Configuration Wizard to accomplish this task. See the section "Scheduled History Synchronization Jobs Configuration" in the DirX Audit Installation Guide for details.

DirX Audit History Synchronization represents all large binary attributes as Base64 string values. On the other hand, the legacy DirX Audit History Database workflows in some special cases store binary values as strings without encoding them. In such cases, DirX Audit History Synchronization terminates the time validity of the large attribute and inserts its new Base64-encoded value.

Upgrading DirX Audit Using the DirX Audit History Synchronization Jobs

This scenario assumes that you already use DirX Audit 7.2 or newer with DirX Audit History Synchronization jobs and your DirX Audit History Database and DirX Identity domain are correctly set up. During DirX Audit tenant configuration, an automatic procedure runs and migrates your configuration and customization of DirX Audit History Synchronization jobs. You can read more about the migration process in the DirX Audit Migration Guide.