Audit Pruning allows you to delete the retrieved SharePoint audit data from the DocAve Auditor database after a specified amount of time. By creating profiles in Audit Pruning, you can automate the deletion of outdated audit data. When creating an Audit Pruning profile, you can:
• Configure the time range for pruning audit data. The audit data generated within the specified time range will be automatically pruned.
• Specify where, at the Web application or site collection level of SharePoint on-premises or at the site collection level of SharePoint Online, to delete audit data.
• Choose to delete the data or simply move it to another location.
• Set up a schedule in the profile to prune data or run it manually, providing you with more flexibility in the execution of Audit Pruning profiles.
For any profiles you run in Audit Pruning, or any future profiles scheduled to run, you can click Job Monitor on the ribbon of the Audit Pruning page or Profile Manager page to see its progress or check details about the job. For more information about using Job Monitor, refer to the DocAve 6 Job Monitor User Guide.
To access functions in Audit Pruning, in the Settings tab of Report Center, click Audit Pruning on the ribbon to return to the Audit Pruning interface.
Creating a Pruning Profile
Before creating a pruning profile, you can configure export locations, which are used by Report Center to store the pruned auditing data. For details on how to configure export locations for Report Center, see the Configuring Export Locations section of the DocAve 6 Control Panel Reference Guide.
To create a pruning profile, complete the following steps:
1. In the Audit Pruning page in the Scope pane, click on the appropriate SharePoint object name and expand the data tree down to the desired object level, or enter a URL/name in the search text box above the tree. Check the checkboxes next to the nodes you want to view.
2. Click New on the ribbon. A pruning profile creation work space will appear next to the Scope pane.
3. Enter a Profile Name for this new pruning profile. Enter an optional Description for future reference.
4. Specify the auditing data you want to prune in under What time range would you like to cover in this pruning profile:
• To prune data older than a certain amount of time, select All data older than: and then enter an integer in the text box, and select Hour(s), Day(s), Week(s) or Month(s) from the drop-down menu.
52
DocAve 6: Report Center
• To prune data before a certain date, select All data before: and then click the calendar icon. A calendar will appear at your cursor. Select the desired date and time of day, then click OK.
• To prune data between two dates, select All data between, then select the desired date range.
5. Choose what to do with the pruned data in How would you like to deal with the audit data specified above?:
• Select Delete Data to delete the specified auditing data.
• Select Move data to move the specified auditing data to an export location. You must designate an export location in order to have the data moved; Click the Export Location drop-down menu, select a predefined export location or click New Export Location to create a new export location. If you choose New Export Location in the Export Location drop-down menu, a child window will appears for you to configure the new export location. For the detailed instructions on configuring a new export location, refer to the Creating an Export Location section in this user guide.
6. Configure whether or not to run this profile at a scheduled time or manually from Profile Manager:
• No Schedule – Select this to run this profile manually from Plan Manager.
• Configure the schedule myself – Select this option to configure the specific time you want this profile to run. A schedule configuration area appears. You can customize the schedule with the following options:
o Start time – Select the date and time for this profile to run.
o Interval – Enter an integer into the text box and select
by Hour(s), Day(s), Week(s), or Month(s). This profile will run repeatedly based on this schedule. Click Calendar View to see the schedule in a calendar.
o Schedule ending – Designate when to stop running this profile. Select No end date for this profile to run repeatedly until you stop it manually. Select End after ___ occurrence(s) to stop running this profile after the number of occurrences you designate in the text box. Select End by to specify the exact date and time for this profile to stop being run.
7. Would you like to receive e-mail notifications on the status of the pruning job? – Send notifications according to the configurations of this plan. Select an existing e-mail notification profile from the drop-down menu or click New E-mail Notification to create a new one. Refer to the User Notification Settings section in the DocAve 6 Control Panel Reference Guide for more information.
8. When creating an Audit Pruning Profile, you can customize which user to include or exclude, as well as which audit actions to include, when pruning auditing data. Click Advanced Data Selection to access the User Filter and Action Filter.
• Would you like to filter any user activity? – By default, Include all users are selected. To specify which users to include, select User(s) to include, then enter the usernames in the text box in the following format: AD User: domain\username and separate each
DocAve 6: Report Center
53username with a semicolon (;). To specify which users to exclude, select User(s) to exclude, then enter the usernames in the text box in the following format: AD User:
domain\username and separate each username with a semicolon (;).
• Which audit action would you like to prune? – Check the checkbox for the audit actions that you want to prune.
9. Click Save and Run Now to save the profile and run it immediately, Save to save the profile, or Cancel to return to the Audit Pruning page without saving these configurations.
Using Profile Manager
Profile Manager provides you with a central location to view and edit audit pruning profiles and the previously run jobs for the profiles. In the Audit Pruning page in Report Center, click Profile Manager on the ribbon. You will see a list of profiles in the Profile Manager viewing pane. To change the number of profiles displayed per page, select the desired number from the show rows drop-down menu in the lower right-hand corner. To sort the profiles, click on a column heading such as Profile Name, Action to Take, or Last Pruned Time.
On the bottom message bar, you will see the selection status of the profiles. Click Clear Selection on the message bar to deselect all of the selected checkboxes.
Operations in Profile Manager
Once you have configured Profile Manager to display the plans of your choice, you can perform the following actions on your profiles:
• View Details – Select a profile, and then click View Details on the ribbon to open the View Details page to see configurations of the selected profile. You can click Edit in View Detail interface to make changes to the profile. When you are finished reviewing the profile, click Close to return to the Profile Manager page.
• View Jobs - Select a profile and click View Jobs to see the jobs that have run for this profile. The View Jobs interface appears, displaying all of the previously run jobs for the selected profile. You can perform the following operations on the jobs:
o Delete – Select the jobs you want to delete and click Delete on the ribbon to delete the jobs. A pop-up window appears to confirm that you want to proceed.
Click OK to delete the jobs or click Cancel.
o Restore – Select a job of the Move type and click Restore on the ribbon to restore the data moved to an export location by this job.
*Note: The data deleted by the jobs of the Delete type cannot be restored.
• Edit – Select a profile then click Edit on the ribbon to open the profile editing page. Here you can make changes to the configurations of the selected profile.
o To save your configurations of the profiles, click Save and make a selection from the drop-down list:
54
DocAve 6: Report Center
Click Save to save any changes made to the profile, and return to the Profile Manager page.
Click Save As to save the profile along with any changes made as a new profile. A pop-up window appears for you to input a name for the new profile. Click OK to save the new profile and return to the Profile Manager page.
Click Save and Run Now to save any changes made to the profile, and run a job of this profile immediately.
o If you do not want to save the changes to the profile, click Cancel to close the profile editing page without saving any changes.
• Delete – Select a profile and click Delete on the ribbon to delete the profile. A pop-up window appears to confirm that you want to proceed with deleting the selected profile.
Click OK to delete the profile or click Cancel to return to the Profile Manager page without deleting the profile.
• Run Now – Select a profile and click Run Now to run the selected profile immediately.
• Job Monitor – You can keep track of running reports and scheduled reports. To access the jobs of each module, click Job Monitor on the ribbon. For more information about using Job Monitor, refer to the DocAve 6 Job Monitor User Guide.
When you are finished viewing and editing your plans, click Back to return to the Audit Controller page.
To exit the Audit Controller page, click Back on the ribbon of the Audit Controller interface to return to the Settings page.