Documentation Center

Setting Up Audit Trail Aggregation - Client

Audit trail aggregation lets you gather all of the audit trails being generated on multiple client systems onto a single server so that you can compile, style, and analyze the audit trail data.

Before you begin

Before you set up the client, set up the aggregation server. See Setting Up Audit Trail Aggregation - Server

About this task

For the purposes of this procedure, "client" is the SDL LiveContent Reach computer where you configure audit trails and "server" is the aggregation server computer.

Procedure

  1. On the client, log on to SDL LiveContent Reach as a user with the Manage Application permission.
  2. If you are in a SDL LiveContent Reach tool, click Home in the breadcrumb trail.
    The Review and Collaboration landing page appears.
  3. In the Administration Tools pane, click Manage Application.
    The Manage Application page appears.
  4. In the left pane, click Global Config.
  5. Add or configure the following configuration items:
    NameValue
    audit.aggregation.enableSetting to cause the application to record audit trails. If set to no no audit trails will be recorded for user sessions, and therefore aggregation will not send any audit trails.
    audit.aggregation.keyA unique string. This must match the same configuration value on the server.
    audit.aggregation.urlURL of the server, in the following format: http://server_host_id:server_port_#/LiveContent/ where server_host_id is the server host name and server_port_# is the port on which the server SDL LiveContent Reach instance is running. For example, http://neptune:4444/LiveContent/
    audit.aggregation.ageFrequency with which audit trails are aggregated. If you are in a SDL LiveContent Reach tool, click Home in the breadcrumb trail. In the Administration Tools pane, click Manage Application > Global Config, and then click one of the following frequencies from the audit.aggregation.age drop-down list:
    • 6 Hours
    • 12 Hours
    • Day
    • Week
    • Month
    • Year

    If you are in a SDL LiveContent Reach tool, click Home in the breadcrumb trail. In the Administration Tools pane, click Manage Application > Audit, and then click Aggregate Audits to initiate the audit.

    If you set up garbage collection, once an audit trail record has been aggregated, it is deleted the next time garbage collection runs.

    host.idHost ID of the client.

    This is a unique key that identifies the client. If you have already set up forms aggregation, you do not need to add this configuration item again.

    audit.enableSet to Yes to enable gathering audit trails on the server.
  6. Click Save.
  7. Edit LiveContent_home/conf.xml.
  8. Adjust the following values to set the timing of aggregation:
    OptionDescription
    periodFrequency, in milliseconds, that the aggregation occurs.
    delayDelay, in milliseconds, before aggregation occurs after restarting the SDL LiveContent Reach service.
  9. Restart the application or service.
    1. If you are using a third-party web application server, restart the application server's service. For example, if you are using Apache Tomcat, restart the Apache Tomcat service
    2. If you are using the bundled web application server, restart the SDL LiveContent Reach database.
      • On Windows, restart the LiveContent XML Database service.
      • On Linux, log in as the root user, and type the following at a command prompt:

        /etc/init.d/SDL_LiveContent restart

  10. Validate that audit aggregation is occurring by viewing the log on the client at LiveContent_home/logs/wrapper.log
    The success and failure messages appear like one of the following:
    Audit Aggregation: status=FAIL message=required URL not
    defined
    Audit Aggregation: status=DISABLED
    Audit Aggregation: status=SUCCESS selected=2 stored=2 marked=2
    serverURL=http://neptune:4444/LiveContent/