One Identity Safeguard for Privileged Sessions 6.0 LTS - Administration Guide

Configuring custom reports

To configure a report, create a chapter and assign any of the existing subchapters to it. The following sources (statistics or other queries) are available as reporting subchapters:

• The indexed contents of audit trails, as described in Indexing audit trails.

• The statistics of an audit trail search, as described in Displaying statistics on search results.

• Custom queries of the connection database, as described in Creating statistics from custom database queries. The list of tables and fields you can query are described in Database tables available for custom queries.

To configure One Identity Safeguard for Privileged Sessions (SPS) to create custom reports, complete the following steps with a user that has read & write/perform access to the Reporting > Content subchapters privilege.

For more information on configuring user rights, see Managing user rights and usergroups.

To configure SPS to create custom reports

1. Login to the SPS web interface, and navigate to Reporting > Configuration.

   Figure 262: Reporting > Configuration — Configuring custom reports

   

2. Click and enter a name for the custom report.

3. Select Table of contents > Add Chapter, enter a name for the chapter, then click OK. Repeat this step to create further chapters if needed.

4. If you want to have the logo of your organization on the cover page of the report (instead of the One Identity logo), select Choose new logo > Browse, select your logo file, then click Upload. You can upload GIF, JPEG, and PNG images. SPS will automatically resize the image to fit on the cover page.

5. Select Add Subchapter to add various reports and statistics to the chapter. The available reports will be displayed in a pop-up window.

   • Subchapters created from indexed contents of audit trails are listed under Misc.

   • Subchapters created from custom statistics are listed under Search statistics.

   • Subchapters created from custom database queries are listed under Advanced statistics.

   • Subchapters created from search queries are listed under Search-based subchapters.

   Figure 263: Reporting > Configuration > Add Subchapter — Adding subchapters to reports

   

   NOTE: When creating a subchapter that searches for keywords in HTTP, only the timestamp of the results will be visible in the report, without data.

6. Use the arrows to change the order of the subchapters if needed.

7. Select how often shall SPS create the report from the Generate this report every field. Weekly reports are created on Mondays, while monthly reports on the first day of the month. If you want to generate the report only manually, leave this field empty.

8. By default, members of the report group can access the custom reports via the SPS web interface. To change this, enter the name of a different group into the Reports are accessible by the following groups field, or click to grant access to other groups.

   NOTE: Members of the listed groups will be able to access only these custom reports even if their groups does not have read access to the Reporting > Reports page. However, only those reports will be listed, to which their group has access to.

9. By default, SPS sends out the reports in e-mail to the address set in the Basic Settings > Management > Mail settings > Send reports to field.

   NOTE: If this address is not set, the report is sent to the SPS administrator's e-mail address.

   • To disable e-mail sending, unselect the Send reports in e-mail option.

   • To e-mail the reports to a different address, select Recipient > Custom address, and enter the e-mail address where the reports should be sent. Click to list multiple e-mail addresses if needed.

10. Click .

Creating reports from audit trail content

One Identity Safeguard for Privileged Sessions (SPS) can index the contents of audit trails using its own indexer service or external indexers. Indexing extracts the text from the audit trails and segments it to tokens. A token is a segment of the text that does not contain whitespace: for example words, dates (2009-03-14), MAC or IP addresses, and so on. The indexer returns the extracted tokens to SPS, which builds a comprehensive index from the tokens of the processed audit trails.

Once indexed, the contents of the audit trails can be searched from the web interface. SPS can extract the commands typed and the texts seen by the user in terminal sessions, and text from graphical protocols like RDP, Citrix ICA, and VNC. Window titles are also detected.

SPS has an internal indexer, which runs on the SPS appliance. In addition to the internal indexer, external indexers can run on Linux hosts.

Processing and indexing audit trails requires significant computing resources. If you have to audit lots of connections, or have a large number of custom reports configured, consider using an external indexer to decrease the load on SPS. For sizing recommendations, ask your One Identity partner or contact our Support Team.

SPS also creates statistics of the occurrences of the search keywords, as well as screenshots from the audit trail. These statistics and screenshots can be included in custom reports as subchapters.

Prerequisites for the indexer service

If you are indexing the audit trails with the indexer service, make sure to enable indexing for the connections you want to include in the report. Otherwise, reporting on audit trail content will not work. For details, see Configuring the internal indexer.

To configure SPS to create reports from the contents of audit trails

1. Login to the SPS web interface, and navigate to Reporting > Content subchapters.

   Figure 264: Reporting > Content subchapters — Configuring audit-trail reports

   

2. Click and enter a name for the subchapter.

3. Enter the search keywords (or parts of the words) into the Search word(s) field. Note the following points.

   • Your search expression must be shorter than 255 characters.

   • The search is not case sensitive.

   • Wildcards and regular expressions are not supported.

   • To search for an exact phrase or expression, enclose the keywords in double quotes, for example "program files".

4. Configure filters to select the audit trails to index. The following filters are available:

   • Protocol: Process only audit trails of the specified traffic type (for example SSH).

   • Connection: Process only audit trails of the specified connection policy.

   • Channel policy: Process only audit trails of the specified channel policy.

   • Username: Process only audit trails where the specified username was used in the connection. Available only for protocols where the username is known (for example SSH).

   • Source: Process only audit trails where the specified client IP address or port was used.

   • Server: Process only audit trails where the specified server IP address or port was used.

   NOTE: If you do not configure any filters, every available audit trail will be processed. Audit trails are created only for channels where the Record audit trail option is enabled for the particular channel in the channel policy.

5. Click .

6. Navigate to Reporting > Configuration, and add the new subchapter to an existing report, or create a new report. Subchapters created from searching the contents of audit trails are listed under Misc. For details, see Configuring custom reports.

   Figure 265: Reporting > Configuration > Add Subchapter — Adding subchapters to reports

   

Creating report subchapters from search queries

You can turn any search query or statistics into a subchapter to add to your reports. This is an easy and flexible way of creating reports to monitor traffic, track certain parameters, or get alerted about particular events. The Search interface allows you to:

• Create search-based report subchapters from search results.
• Create search-based report subchapters from scratch.

Creating search-based report subchapters from search results

The following describes how to create a search-based report subchapter from search results.

To create a search-based report subchapter from search results

1. Navigate to Search, and perform a query of your choice.
2. Click Search. Search results are displayed.
3. Click . The Create reporting subchapter page is displayed, with the query field populated with your query.

   

4. In the name field, add a name to your report.
5. In Report type, select the type that fits your query. You can choose from the following types:
   • Sessions list: Displays a list of sessions.

     Set the number of sessions to show in the report as required.

   • Statistics: Visualizes the distribution of sessions based on the selected metadata.

     Select a Statistic presentation for your report, such as Pie chart, List, Bar chart. Select the field (the metadata) to create your statistics on.

   • Timeline: Visualizes the distribution of sessions within a day/week/month, depending on the time range chosen for the report under Reporting > Configuration > Generate this report every > Day/Week/Month.
6. Click Save.
7. Click . Alternatively, navigate to Reporting > Configuration.
8. Configure a custom report from scratch, or add the subchapter to an existing report. For details, see Configuring custom reports.

   When adding the subchapter you created, look for it under Search-based subchapters.