Export the audit trail

You can export the audit trail Mechanism that provides a record of the actions performed in the WFO applications. to a comma-separated values (CSV) file.

Before you export the audit trail, you must specify the search criteria for querying and filtering the audit trail records in the Audit Viewer Tool that displays the list of audited actions that have occurred in the system. user interface.

The exported file will contain only the audit trail data that was specified in the user interface, with the exception of the Text Search field.

You cannot export the data specified in the Text Search field to the CSV file. You also have the option to include or exclude the Details Name and Details Value data in the CSV file.

Procedure 

  1. Go to System Monitoring > Audit Viewer > Audit Viewer.

  2. In the Actor (User Name), type the Username for the user who performed the action you are auditing.

  3. In the Module drop-down list box, select the module in which the actions you are auditing took place.

  4. In the Action drop-down list box, select the audit-able action. The actions available depend on the Module that is selected.

  5. In the Object Name field, type the name of the object in the module upon which the action was performed.

  6. Required. In the Time of Event field, click the calendar icons and specify the date range when the audited event or action occurred.

    • When the range exceeds 30 days, system performance may be affected.

    • The range cannot exceed 180 days (6 months).

      To search for more than six months of data, perform multiple searches and export the results to a single XLS file.

      For example, to retrieve the last two years of audit logs, you can perform four queries of six months each

  7. In the Impact Time Frame field, click the calendar icons and specify a date range for the action.

  8. Complete the Details fields (optional).

    1. In the Name field, select an audit property key from the drop down list.

      This field is an optional field that is available if either the Module or Action fields are populated. The Name is the name of a property key in a database table. The values that are available in the Name field depend on the combination of items that are selected in the Module and Action fields.

      This field works in combination with the Value field below to return specific audit entries.

      For example, assume you want to return audit entries that show the log in and log out activity Core component of both schedules and time records in Workforce Management (WFM). When an employee performs any kind of work, activities specify the scheduled work and capture employee adherence to their schedule. from the web portal Home page or main UI access point for all WFO applications. or from mobile applications.

      To return the log in entries for the web portal, you would select Security as the Module, and Sign in as the Action. Then you would select Platform in the Name field and Web in the Value field, and click Search.

      To return the log out entries for the web portal, you would specify the same Audit Viewer search criteria, except you would select Sign out as the Action.

      To return the log in entries for mobile applications, you would select Security as the Module, and Sign in as the Action. Then you would select Platform in the Name field and Mobile in the Value field, and click Search.

      To return the log out entries for mobile applications, you would specify the same Audit Viewer search criteria, except you would select Sign out as the Action.

      Using this field can slow the Audit Viewer performance when returning audit entries.

    2. In the Value field, select a value associated with the option selected in the Name field.

      This field is an optional field that is available if either the Module or Action fields are populated and works in combination with the Name field. The values that are available depend on the key selected in the Name field.

      For example, assume Security is selected as the Module, Sign in is selected as the Action, and Platform is selected as the Name. In this scenario, the Value field has four options: All, Web, Mobile, and Desktop. The All value will return sign in audit entries from the Web, Mobile, and Desktop platforms.

      When this field is used, a maximum of 5000 audit records (or rows) are returned.

  9. To export the audit trail that you have configured above, click Export. The audit trail is exported to a CSV file.

Related topics 

Viewing the audit trail