Chat now with support
Chat with Support

Change Auditor 7.2 - User Guide

Change Auditor Overview Agent Deployment Change Auditor Client Overview Overview Page Searches Search Results and Event Details Custom Searches and Search Properties Enable Alert Notifications Administration Tasks Agent Configurations Coordinator Configuration Purging and Archiving your Change Auditor Database Disable Private Alerts and Reports Generate and Schedule Reports SQL Reporting Services Configuration Change Auditor User Interface Authorization Client Authentication Certificate authentication for client coordinator communication Integrating with On Demand Audit Enable/Disable Event Auditing Account Exclusion Registry Auditing Service Auditing Agent Statistics and Logs Coordinator Statistics and Logs Change Auditor Commands Change Auditor Email Tags

Schedule reports for distribution

To enable, design, and schedule reports for distribution use the following components:

•
Report Layouts page (Administration Tasks tab) to create global templates that define the header and footer information for reports. See Create global report template.
•
Layout tab (Search Properties tabs) to specify the data (columns) to be retrieved from the database and displayed for the selected search. In addition, you can specify the column order, sort criteria and order, and data grouping to be used for displaying the retrieved data. The settings on this tab are also used to display the search results in the client. See Define report content and layout.
•
Report tab (Search Properties tabs) to enable reporting for a selected search query, specify the global template to be used or choose to design a custom report using the report designer, and schedule the distribution of the report. See Enable and schedule reporting.

Create global report template

The report templates defined on the Report Layouts page on the Administration Tasks tab define the header and footer information to include the search results report. You can use the default report template or create a custom report template using the Report Layout page.

* 
NOTE: Use the report templates on the Administration Tasks tab to define the header and footer information for a search results report. To design a custom report layout for an individual search, including content and data layout, click Design Report on the Report tab (Search Properties tab) to start the Report Designer.
Report Layouts page (Administration Tasks tab)

The Report Layouts page is displayed when Report Layouts is selected from the Configuration task list in the navigation pane of the Administration Tasks tab. From this page you can add, edit, or delete global report templates.

The Report Layouts page contains all the report templates that have been previously defined. Initially, this list contains the Default template, which is used for all search results reports unless changed on the Report tab of a search’s Search Properties tabs.

To add a global report template:
1
Open the Administration Tasks tab and click Configuration.
2
Select Report Layouts in the Configuration task list to open the Report Layouts page.
3
Click Add to display the New Report Layout dialog. Enter a descriptive name for the new report template and click OK.
The report designer is displayed.
4
Use the controls in the toolbar to the left of the report grid to define the header and footer information to include. For example:
•
To add a page header, click the Page Header button. Click the report grid and the header pane is added to the top of the page. Use the arrow controls or Height setting in the Properties pane to resize the header pane.
•
To add the report title to the page header pane, click the Text button. Move the pencil cursor in the heading pane where you want to place the report title and click. Open the System Variable tab in the Text Editor, locate the ReportName variable. Double-click the variable to add it to the text pane. Click OK to save your selection and close the Text Editor.
•
Back on the report grid, you can resize the {ReportName} text box to prevent the report titles from being truncated. You can also use the settings in the Properties pane to modify the font, size, color, and so forth.
•
To add a page footer (for example, page number), click the Page Footer button. Click the report grid and the page footer pane is added to the bottom of the page. Use the arrow controls or Height setting in the Properties pane to resize the footer pane.
•
To add the page number to the page footer pane, click the Text button. Move the pencil cursor in the footer pane where you want to place the page number and click. Open the System Variables tab in the Text Editor, locate the page number variable to use (for example, PageNofM). Double-click the variable to add it to the text pane. Click OK to save your selection and close the Text Editor.
* 
NOTE: This is an example of how to use the report designer to add a simple header and footer. However, there are many more capabilities with the report designer which uses StimulReport.Net components. For a detailed description and functionality of each component available for designing reports, click F1 to view the Stimulsoft online help (www.stimulsoft.com).
5
The new report template is added to the Report Layouts page (Administration Tasks tab) and is available in the Layout drop-down menu on the Report tab (Search Properties tabs).

Define report content and layout

For each search, built-in or custom, the data displayed in both the client and in the associated report (when reporting is enabled) is predefined. However, you can use the Layout tab of the Search Properties tabs to customize the content (columns) to display for each individual search. See Layout tab in Custom Searches and Search Properties for a detailed description of the Layout tab.

Enable and schedule reporting

When reporting is enabled, a report containing the search results of an individual search, built-in, or custom, can be sent as an attachment through email to the designated recipients or written to a shared folder. Use the Report tab, which is one of the Search Properties tabs, to enable reporting for the selected search, define the format, and how and when to distribute the report.

To email reports, you need to enable SMTP for alerting and reporting and specify the Mail Server to use in the SMTP Configuration pane on the Coordinator Configuration page. The same SMTP configuration is used for both alert notifications and reporting. See SMTP Configuration for more information.

To send reports to a shared folder, you need to enable shared folders for reports and specify the credentials that will be used to write to a shared folder. See Shared Folder Configuration for details.

Starting with version 6.9, Change Auditor calculates the Next Run of the reports, archive, and purge jobs based on the master time zone. For new deployments, the maser time zone is set to the time zone of the server where the first coordinator is installed. During an upgrade, the master time zone is set to UTC. You can manually change the master time zone, using the set-CAScheduleMaserTimeZone and get-CAScheduleMasterTimeZone commands. See the Change Audit PowerSell Command User Guide for details. Quest recommends that you set the master time zone to the time zone where most the users are located.

* 
NOTE: Because Daylight Saving Time changes on different dates worldwide, Change Auditors schedules follow the time change of that specific time zone.
Report tab (Search Properties tabs)

The Report tab displays the current report configuration for the selected search definition. From the Report tab you can perform the following tasks:

•
Enable and disable reporting for the current search
•
Specify the format for the report attachment (PDF, Html, Word, Text, Excel, CSV)
•
Select the recipients who are to receive the report through email
•
Select the shared folder where you want to write a report
•
Define a schedule for sending the report
•
Select the template for the report’s headers and footers or design a custom report layout using the report designer

Use the controls on the Report tab as described in the following table:

 
* 
NOTE: All dates and times are based on the client’s current local date and time. The format used to display the date and time is determined by the local computer’s regional and language setting.
Table 1. Report tab: Field and Control descriptions
Field and Control
Description

Report Enabled

Select to enable reporting for the current search definition.

NOTE: This option becomes available only after a valid address is entered in the Report Configuration section of this tab. Use an e-mail address to send a report to mailbox and a network address to send a report to a shared folder.
Report Configuration

Layout

Specifies the report template to use for the report’s headers and footers.

The Default report template is defined for you. To define more templates, use the Report Layouts page on the Administration Tasks tab.

NOTE: This setting is disabled if you click Design Report to define a custom report layout for the selected search.

Report

Specifies if the report is generated and sent on a weekly (default) or monthly schedule.

NOTE: When Monthly is selected, specify the schedule to generate the report. For example, 1 for every month (default), 2 for every other month, 6 for every six months or twice a year.

Every

When a Weekly report is selected, specify the schedule to use to generate the report. For example, 1 for every week (default), 2 for every other week, 3 for every third week, and 4 for every fourth week.

On Days

When a Weekly report is selected, define the days of the week to generate the report. The default is Monday through Friday.

On Day of Month

When a Monthly report is selected, specifies on which day of month to generate the report:

•
First (default)
•
Last
•
Day #

Run Time

Specifies the time to generate the report.

 

Reset

Use to reset the settings back to the factory defaults.

Send to a mailbox

Use to select the options to share reports through email.

Enter the email address of one or more persons who are to receive the report.

You can also use the browse button to locate and select the users who are to receive the report. Selecting this button displays one of the following dialogs:

•
The Select Active Directory Objects dialog (directory object picker) where you can use the Browse or Search page to locate Active Directory users. This dialog is displayed when no Exchange host is specified in the SMTP Configuration pane of the Coordinator Configuration page.
•
The Search Users dialog allowing you to locate and select an Exchange user (Exchange tab) or an Active Directory user (Active Directory tab). This dialog is displayed when an Exchange host is defined in the SMTP Configuration pane of the Coordinator Configuration page.

Click Expand Properties (right arrow) to the left of the To field to enter additional recipients and/or change the subject. When expanded, you can enter the following information:

•
To: Enter or use the browse button to specify the email address of users who are to receive the report.
•
Reply: Enter or use the browse button to specify the email address to which reply emails are to be sent.
•
Cc: Enter or use the browse button to specify the email address of users who are to receive a copy of the report email.
•
Bcc: Enter or use the browse button to specify the email address of users who are to receive a blind copy of the report email.

Click Collapse Properties (down arrow) to hide these additional properties and show the other settings available on the Report Configuration pane.

NOTE: You can enter an individual email address or distribution list in any of the email address fields. Separate multiple email addresses with a semicolon.

Send to a shared folder

Use to select a shared folder to write reports to. You must enter a network path; a local address will not be accepted.

The To field is automatically populated with the default shared folder path. However, you can specify a different path.

The credentials from the Shared Folder Configuration are used to write reports to the shared folder. (The credentials are specified under the coordinator configuration Shared Folder Configuration option. See Shared Folder Configuration for details.) Ensure that the account has permissions to write to the shared folder.

If you change the shared folder, the new path does not display in the search grid until you refresh the searches tree (click F5 while on the searches tree).

Do not send empty reports

When selected, a report will not be sent to email or a shard folder if it does not contain any results.

Send empty report email notification

Select this to receive an email notification for a report that ran but did not contain any results.

NOTE: This is only available if you have selected the Send to a mailbox and the Do not send empty reports options

Attach

The report is sent as an email attachment. Select the appropriate Attach option to define the format to be used for the report:

•
PDF (default)
•
Html
•
Word
•
Text
•
Excel
•
CSV

Columns

Defines how the report content is to fill the page:

•
Fit to Page (default)
•
Fixed Width nn.nn Inches/Column
NOTE: These settings are disabled if you click Design Report to define a custom report layout for the selected search.

Time Zone

Specifies the time zone to be used for the time stamp in the name of the report attachment. By default, the time zone of the computer where the Change Auditor client resides is used.

Last Run

This read-only field specifies the last time (date and time) the report ran.

Next Run

This read-only field specifies the next time (date and time) when the report is scheduled to run.

To enable/schedule reporting:
* 
NOTE: To distribute reports through email (SMTP) or to a shared folder you must first enable the corresponding configuration on the Coordinator Configuration page of the Administration Tasks tab. See Configure email alert notifications/reports and Shared Folder Configuration.
1
Open the Searches page.
2
Expand the Private or Shared folders in the explorer view to locate the search to which reporting is to be enabled. Select the search from the Search list in the right pane.
3
Open the Report tab.
a
To share a report through email, select Send to a mailbox, enter a valid email address in the To field and then select the Report Enabled check box.
b
To send a report to a folder, select Send to a shared folder, enter a valid network path in the To field and then select the Report Enabled check box.
4
Specify the report configuration settings:
•
Layout: Select the report template to be used.
•
Report: Specify when the report is to be generated/sent (i.e., on a weekly or monthly schedule).
•
Run Time: Specify the time (based on the client’s current local date and time) at which the report is to be run.
•
Attach: Select the report format to be used.
•
Columns: Define how the report content is to fill the page.
•
Time Zone: Select the time zone to be used for the time stamp in the name of the report attachment. By default, the time zone of the computer where the Change Auditor client resides is used.
* 
NOTE: See Table 1 for a detailed description of the report configuration settings.
5
Click Save.
When reporting is enabled, the following details are added to the search entry in the Searches list:
•
Report column displays ‘Enabled’
•
Report To, Report Cc and Report Bcc columns display the email address of specified recipients or a shared folder path.
To disable a scheduled report:
1
Open the Searches page.
2
Expand the Private or Shared folders in the explorer view to locate the search whose reporting is to be disabled. Select the search from the Search list in the right pane.
3
Use one of the following methods to disable reporting for the selected search:
•
Right-click the search and select Report | Disable Report.
•
Open the Report tab and clear the Report Enabled check box. Click Save.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating