circle-info
Welcome to the new Logpoint documentation portal! Can’t find what you’re looking for?
Logpoint Documentationarrow-up-right
search

Reports

Reports provide scheduled or on-demand summaries of your security data, helping you analyze trends, demonstrate compliance, and share insights with stakeholders. You can generate reports based on searches, dashboards, or predefined templates, and deliver them automatically to selected recipients. Reports help transform raw log data into structured, actionable information for investigation, auditing, and compliance purposes.

Except for ad hoc reports, all reports can be zipped and emailed. The reports generated contain the first 1000 logs. If your report has more than 1000 logs, use Search Templates in Settings >> Knowledge Base.

hashtag
Creating Reports

In Logpoint, reports can be created in 3 different ways:

  • From a Search Query

  • From Dashboards

  • From a Report Template

chevron-rightCreating a Report from a Search Queryhashtag

  1. Go to Search and enter a Search Query.

  2. Click the More dropdown and click Report.

  3. Enter a Name and an Email.

  4. Click Submit.

chevron-rightCreating a Report from Dashboardshashtag

  1. Go to Dashboard from the navigation bar and click REPORT.

  2. Enter a Name and an Email.

  3. Click Submit.

hashtag
Creating a Report from a Report Template

Creating a report from a report template allows you to specify the format and the design of the report. You can select a query from Query Selection, schedule the generation of a report from Scheduling, choose a layout template and table from Choosing a Layout, and personalize components like charts and tables from Report Design.

To generate a report using a report template:

chevron-rightQuery Selectionhashtag

  1. Go to Reports in the navigation bar.

  2. Click Report Templates.

  3. Click ADD.

  4. Enter a name for the Report Template by clicking the write icon.

  5. Enter a valid query in Add Query or click SELECT QUERY to select queries from the lists. If you select Live Searches from the ADVANCED QUERY PICKER, the title of the live search, created from the Dashboard is automatically entered in the header.

circle-info

If you are using a timechart process command with grouping parameters and it has more than ten values, the report is generated with an error message. The error is displayed so that it does not affect the rendering properties of the graph in the report.

  1. Click ADD.

  2. Enter a header in Panel Header.

  3. Select a Limit for the number of logs. Limit is visible only for non-aggregate commands.

  4. Select one of the COMPONENT OPTIONS. If you select Chart, select the Chart type from the dropdown.

  5. Click Ok.

chevron-rightSchedulinghashtag

  1. In SCHEDULING, click ADD.

  2. Select how often to generate the report. If you select Monthly, Logpoint creates a link titled Monthly (Last 30 days) on 1st day, 0th hour. Click the link to open the MONTHLY SCHEDULING.

    1. Select a TIME RANGE, Day, and Hour.

  3. Select a TIME ZONE. The scheduling time and the report results are generated in the selected timezone.

  4. Select a REPO.

  5. Select the EXPORT FORMAT in which to generate the report.

  6. Enter the Email Address and Subject, and select Send email to send the report as an email.

  7. Select the Send compressed report on email to get a compressed report on your email. If you select the HTML format, the report is compressed regardless of the option you select.

  8. To encrypt your report, select Set Password and enter a password. Reports in formats PDF, XLS, DOCX, and CSV are password protected. Password length can be between 5-255 characters.

  9. If Data Privacy Module is enabled in the system, the Data privacy module tab is visible. Select the Generate report with original data to generate decrypted values in the report. Select the Show raw logs to get access to the raw logs in the generated report.

When the Data Privacy Module is enabled, and you select Generate report with the original data, a request message is sent to the users with the Can Grant Access permission. To view requests, go to Settings >> Configurations >> Data Privacy Module >> Pending Request. The scheduled reports are generated only if the request is approved.

chevron-rightChoosing a Layouthashtag

  1. Click Layout.

  2. Select a Layout Template.

  3. Enable Include Table of Contents to add a table of contents to the report.

  4. Select a COMPONENT PLACEMENT.

    1. If you select Use Default, Logpoint positions the components in the report automatically.

    2. If you select Personalize, you can choose the placement of the report components. This will open Report Design.

chevron-rightReport Designhashtag

The REPORT DESIGN is divided into two sections: STRUCTURE and LAYOUT PREVIEW. All the queries created earlier are listed under STRUCTURE, and the layout of your report can be previewed in the LAYOUT PREVIEW.

  1. In STRUCTURE, click ADD.

  2. Select the component to add to the template.

    1. If you select a PANELS, enter the Position, Area 1 width, and Count. Area 1 width does not appear for Simple Panel.

    2. If you choose a HEADERS, enter the Position, Text, Font, and Color. You can also add a Page Break to the template. In this case, enter a Position.

  3. To add components, click the Add button. You can either add the results of a query or a paragraph.

    1. To add a query, select a query listed under Queries. The Queries field is displayed with only the queries that have not been added to the Layout Preview.

    2. To add a paragraph, click ADD. Enter the Text, Font, and Color.

  4. You can add as many Panels, Headers, and Paragraphs. However, you can add a single query only once. Click the Edit icon to edit and click the Delete icon to delete.

  5. Click Ok.

hashtag
Report Templates

Report Template stores predefined report templates, including filters, visualization preferences, and layout settings. You can save multiple templates to create, schedule, or email automated reports. The created, used, cloned, and shared report templates are automatically shared with the users in the Logpoint Administrator user group.

Types of Report Templates

  • My report templates: A personalized space where Logpoint users can create, customize, and manage their own reports tailored to their specific needs.

  • Used report templates: Reports that Logpoint users have accessed and interacted.

  • Shared report templates: Reports that are accessible to multiple Logpoint users.

  • Vendor report templates: The pre-built reports provided by Logpoint

hashtag
Running a Report Template

Running a report template means generating a report inrefers to generating a report based on a predefined format. Logpoint automatically runs a report template based on the defined scheduling rules, but you can also run it manually. When you run a report manually, it does not change the report’s automatically scheduled time. To send the report as an email attachment, you must configure SMTP.

chevron-rightRun a Template Manuallyhashtag

  1. Go to Reports from the navigation bar and click Report Templates.

  2. Click the Run This Report icon in Actions.

  3. Select the Repos from which the report will extract the log.

  4. Select the Time Zone and Time Range to specify the time period for the report.

  5. Select the report format to be generated in Export Type.

  6. Enter the Email address(es), to send the report as an attachment.

  7. Enter the Password to encrypt the report. Reports in PDF, XLS, DOCX, and CSV formats are password-protected.

  8. Click Submit.

If Data Privacy is enabled, details are under DATA PRIVACY MODULE.

  • Select Generate report with the original data to decrypt the fields in the report. If Data Privacy is enabled, when you select it, a request message is sent to the users with the Can Grant Access permission to validate and authorize the decryption of these fields. To view the request, go to Settings >> Configurations >> Data Privacy Module >> Pending Request. The report can be viewed or downloaded only after the request is approved.

  • Select Show raw logs to access the raw logs in the report.

hashtag
Sharing a Report Template

You can share a report template with all Logpoint users and give them read, edit, or full permissions. Any changes made in the report templates are visible to all the shared users. A user with full permission can also share and delete a shared report template. The report templates are automatically shared with the users in the Logpoint Administrator user group and cannot be unshared.

chevron-rightShare a Report Templatehashtag

  1. Go to Report >> Report Templates.

  2. Click the Share/Unshare icon in Actions.

  3. To share multiple report templates, select all the templates to share in the list. Click the MORE dropdown and select Share Selected To Users.

  4. To share all the report templates, click the MORE dropdown and select Share All To Users.

  5. Select the user groups to share the report templates.

  6. Select the Read, Edit, or Full permissions for the users. Go to the Permission Group for details on user permissions.

  7. Click Submit

You can unshare a report template by removing the permissions for all the user groups using the same procedure.

Each parameter in a shared report template is categorized into Global parameters and Personalized parameters.

  1. Global parameters can be changed only by users with edit or full permissions. Changes in the global parameters are reflected for all users using the shared report template. The following parameters are global:

    1. The name and the report layout of the report template.

    2. The queries, query order, and query render type of the report template.

  2. You can make changes to a report specifically for yourself through Personalized parameters. You can change:

    • Scheduling

    • Data privacy configurations if data privacy is enabled

    • Repo selection

    • Email and memory usage for scheduled reports

    • Password

All users with access to a report template can change Personalized parameters, but the changes made are only applicable to the user who made them.

hashtag
Deleting a Shared Report Template’s Owner

To delete the owner of a shared report template, you must delete the shared template or transfer the template’s ownership to another user. You must transfer ownership to delete a user whose report template is shared. The transferred template is listed on Report Templates in the owner’s Logpoint.

chevron-rightDeleting a Shared Report Template’s Ownerhashtag

  1. Go to Settings >> User Accounts and click Users.

  2. Deactivate the user by clicking the De-Activate User icon in Actions.

  3. Click Manage De-Activated Users.

  4. Click the Delete icon in Actions.

  5. Click Yes.

  6. To transfer ownership, select a user from the dropdown, then click Submit.

  7. To delete the user and user’s template without transferring their ownership, click Delete.

hashtag
Importing and Exporting Report Templates

Import allows you to import report templates from a stored location to Logpoint. Once you import, it is displayed under MY REPORT TEMPLATES. The imported report templates are automatically shared with the users in the Logpoint Administrator user group.

Use export to export a report template and share it with other users, back it up, or migrate it to another Logpoint. When a report template is exported, the password set in the template is not exported. You need to set a password again for the exported template.

chevron-rightExporting Report Templateshashtag

  1. Go to Report >> Report Templates and select the report templates to export.

  2. Click EXPORT.

  3. Save the exported package.

chevron-rightImporting Report Templateshashtag

  1. Go to Report >> Report Templates.

  2. Click IMPORT and browse for the required report templates.

  3. Click Upload.

hashtag
Cloning and Deleting Report Template

When a report template is cloned, the password set in the template is not cloned. You need to set a password again for the cloned template. The cloned report templates are automatically shared with the users in the Logpoint Administrator user group.

chevron-rightCloning a Report Templatehashtag

  1. Go to Report >> Report Templates.

  2. Click the Clone Report icon under Actions.

  3. To clone multiple Report Templates, select the templates to clone. Click the MORE dropdown and select Clone Selected Report Templates.

  4. To clone all the Report Templates, click the MORE dropdown and select Clone All Report Templates.

  5. Enter a new Name for the cloned template.

  6. Select Replace Existing? to replace an existing template with the same name.

  7. Click Clone.

chevron-rightDeleting a Report Templatehashtag

  1. Go to Report >> Report Templates.

  2. Click the Delete icon under Actions.

  3. To delete multiple Report Templates, select the templates to delete. Click the MORE dropdown and select Delete Selected Report Templates.

  4. To delete all the Report Templates, click the MORE dropdown and select Delete All Report Templates.

  5. Click Yes.

hashtag
Layout Templates

A layout template is used to edit the appearance of your reports. You can create as many layout templates and specify different layouts for different reports. You can import new layout templates into Logpoint or create your own templates.

chevron-rightImporting a layout templatehashtag

  1. Go to Report >> Layout Templates.

  2. Click IMPORT.

  3. Browse to the layout template.

  4. Click Upload.

chevron-rightCreating a layout templatehashtag

  1. Go to Report >> Layout Templates.

  2. Click ADD.

  3. Enter a Name for the template.

  4. Select a Font from the dropdown. Select Noto Sans CJK for the Chinese, Japanese, and Korean letters.

  5. Browse the Background Image, Cover Page Image, and Data Page Image to be displayed in the report. The Name, Background Image, Cover Page Image, and Data Page Image are mandatory fields.

    The maximum width and height allowed for each of the images are given below:

    1. Background image = 595 * 842 pixel (width * height)

    2. Cover Page Image = 300 * 128 pixel (width * height)

    3. Data Page Image = 160 * 59 pixel (width * height)

  6. Select the Footer Background Color, Footer Text Color, and enter the Footer Text.

  7. Click Submit.

hashtag
Report Jobs

Report Jobs lists the reports currently being generated with their generation time, current status, and remarks. After a report is successfully generated, it is sent to your inbox. It also lists the reports that have failed to generate with the reasons for their failure. The reason for the failure is displayed under Remarks.

hashtag
Generated Reports

Generated reports allow you to manage your reports from generated reports, which contain Inbox, Approved, Archived, Flagged, and Shared.

Inbox lists all the successfully generated reports. You can approve, archive, flag, share, or delete a report from the inbox, which is moved into the Approved, Archived, Flagged, or Shared pages or deleted from Logpoint. Important reports must be archived to save the inbox from getting crowded.

chevron-rightArchive Reporthashtag

  1. Go to Report >> Inbox.

  2. Select the reports to archive.

  3. Click ARCHIVE.

chevron-rightFlag Reporthashtag

  1. Go to Report >> Inbox.

  2. Select the reports to flag.

  3. Click FLAG.

chevron-rightShare Reporthashtag

Other users in Logpoint can view the shared reports. If the shared report is password-protected, you need to input the password to access the shared report. You can also share a report by clicking the Share icon in Actions.

  1. Go to Report >> Inbox.

  2. Select the reports to share.

  3. Click SHARE.

chevron-rightApprove Reporthashtag

When a generated report is verified, you can push that particular report to Approve. It helps you organize the reports. You can also approve a report by clicking the Approve icon in Actions.

  1. Go to Report >> Inbox.

  2. Select the reports to approve.

  3. Click APPROVE.

chevron-rightDelete Reporthashtag

  1. Go to Report >> Inbox.

  2. Select the reports to delete.

  3. Click DELETE.

chevron-rightComment on Reporthashtag

  1. Go to Report >> Inbox.

  2. Select the Activities icon in Actions.

  3. Enter a Comment and click Submit.

chevron-rightCleanup Reportshashtag

Using Cleanup, you can either delete the reports generated before a certain date or delete reports within a specific date range. Go to Cleanup Jobs to see the status of all the initiated cleanups.

  1. Go to Report >> Inbox.

  2. Click CLEANUP.

  3. Select Older than to delete all the reports generated before the provided date.

  4. Select a Date range to delete all reports within a specific time frame. All reports generated from the start date to the end date are deleted.

Last updated

Was this helpful?