> For the complete documentation index, see [llms.txt](https://community-test.logicnets.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://community-test.logicnets.com/release-9/design-considerations-and-frameworks/frameworks/reporting-framework/standard-reporting.md).

# Standard Reporting

## Description

LogicNets client installations include the Standard Reporting package, which provides reports that give access to basic user session information such as sessions over time, sessions by application (for when client installations use multiple packages), and usage (minutes) per user. It also provides on-screen and download access to the application logging records for more detailed review.

The Standard Reporting application is based on the LogicNets Reporting framework. This means you can expand the reports to include custom reports. If you have purchased the optional [Chart Authoring module](/release-9/logicnets-software-component-details/content-authoring-software-parts/logicnets-chart-authoring-module-ln-cha.md) (Highcharts), the installation includes additional chart views of the session information.

For access to the Release 7.4 version of Standard Reporting see [here](/release-9/design-considerations-and-frameworks/frameworks/reporting-framework/standard-reporting-package-release-7-4.md). Additionally, LogicNets updated the Standard Reporting application package as part of Release 8.1, and the enhancements include the following:

* LogicNets decoupled the user's choices for filtering and the process of retrieving the data, which speeds data and report return.
* Date formatting now follows the system configuration localization settings for the account.
* For accounts that include Highcharts, enhanced chart labeling shows date range, package selection, and organization (if relevant).
* LogicNets included enhanced data storage and archiving possibilities:
  * Changelog data pruning, which is described in [System Settings - General](/release-9/platform-documentation/system-administration/system-settings/system-settings-general-tab.md).
  * Changelog storage options, which are described in [Moving changelog Data to Enterprise Database](/release-9/platform-documentation/system-administration/system-settings/move-changelog-data-to-enterprise-database-with-a-cron-job.md).

## General Information

For the sections below, see the referenced numbers in the screenshot at the top of this page. LogicNets breaks the Standard Reporting screen into two sections: search filters on the left (1) and the chart on the right (6).

To interact with the Reporting application, do the following:

* Make one or more selections (1 to 5) in the search filters on the left side of the screen, choosing the report, package, organization (if shown), and date filters.
* Click ***Update*** (A). The system updates the chart on the right based on the selected filters.

Note: When the system starts the application, it inspects source data for use of organization, user role, user specialty, etc. and removes these parameters when the system does not find that data.

### Filters

See 1, 2, 3, and 4 and 5 above. The reporting package comes with a set of predefined filters for selecting a subset of reporting data, including the following:

1. Report type. See below for report type descriptions.
2. Package filter. This allows you report by application, which can be useful in implementations with multiple "protocols" mapped in LogicNets, as you could review usage stats for each one individually or overall.
3. Date range filter (key in the dates or use the date picker). Dates are formatted per the installation defaults (see System Configuration)
4. Organization filter. This allows you to filter by organization if it is included in you logging.
5. Scale. This defaults to a linear (vertical) scale, but sometimes a logarthmic scale is better depending on the dataset.

### Update Button

See A in graphic above. This button is active when there is a change in any of the filters. You may change one or more filters prior to updating the chart. This mechanism is in place for performance reasons, in case of large installations that may take several seconds to retrieve the relevant data.

### Chart Area

See B above. The chart area displays the relevant information from the filters provided. If the filters retrieve no data, the system displays the chart or table in the frame but it will not contain records.

### Chart Scope

See C above. The system displays below the chart meta data associated with the chart, including the package, organization (when relevant), and installation.

### Output Formats (see 8)

See D above. LogicNets displays reports on the screen, but you can download the tables. With the Chart Authoring module, you can view reports as graphics and export them as PDF, image files, or CSV format by clicking on the "hamburger" icon in the top right of the chart.

![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-3490f39ab3ade0cbdc7ed5a88ff6b91242ce2a5a%2Ff8a0023f-8ea4-46d8-b2b6-5d7d8bf5dc7d.png?alt=media)

## Report Types

### Always Available

* Session Overview

  ![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-b6c57eec01e02692600f181234ff5df01464e42b%2F3e271e8c-e27b-4670-adf1-34753e176b76.png?alt=media)
* Session Logs

  ![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-4b2ec50b3d8185e953b28fca6ed13e9f13a8763f%2F037c5faa-7734-4e2f-b707-ea882c303dd4.png?alt=media)

### Available with Chart Authoring Module

* Sessions per Day, per Hour, per Month, per Package, per User

  ![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-05eac99a2c02df2c1a419e8dbd2729408fbc7f9e%2F4f852abe-97bd-406c-be60-68293cc17aef.png?alt=media)
* Total and Average Usage per User (minutes)

  ![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-12e0f7db8d01bc301d5cf2f78ec44624d84da1ef%2F3d87b3d0-0f59-4ecc-ba16-46686708191b.jpg?alt=media)
* Users per Package, per Role, per Specialty

  ![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-2dd09c1fa00a596d3740705e47884deacb37f2a7%2Fc0a4bfa5-07ce-42ee-b855-f13706cca241.png?alt=media)

  Logging for Role, Specialty, Organization: Note that per-role and per-specialty reports and organization filters are only available if your applications add this meta data to the logging during runtime. To include this information in the logging files, use the [Add Answer to Log](/release-9/platform-documentation/process-node-parts/add-answer-to-change-log.md) part in your model. For automatic data inclusion note the logging keys below. You can also customize the tables, views, and fields; see *Advanced Business Reporting* below.

  * You can log role as *application.userRole.*
  * You can log specialty as *application.userSpecialty.*
  * You can log organization as *application.http\_headers.accountId.*

## Data Scope, Archive, and Security

The following features are available as part of Release 8.1+ to improve data security, and archiving and to optimize data analytics performance.

1. Set up an automated process to periodically copy data to an alternate database outside of the LogicNets installation.
2. Define the data removal timeframe and automatically remove records no longer required for current reporting. You can define this to keep a rolling 12, 18, or 24 months of data, for instance.

By default, the Reporting package recaps application logs for the environment on which it is installed. If your solution involves multiple installations that require aggregating logging data, see [Moving changelog Data to Enterprise Database](/release-9/platform-documentation/system-administration/system-settings/move-changelog-data-to-enterprise-database-with-a-cron-job.md).

Over time, the underlying data table and views contain an increasing amount of data. To ensure the system runs smoothly over multiple years of logging, see Changelog Data Pruning information in [System Settings - General](/release-9/platform-documentation/system-administration/system-settings/system-settings-general-tab.md).

## Advanced Business Reporting

Instead of the LogicNets Standard Reporting, some clients have used the LogicNets Assessment Framework with underlying business tables to create detailed reports. Since the Assessment Framework executes custom modeled logic it is suitable for detailed business reporting where a wide range of filters might be required.

Customization can happen at three levels of complexity with the reporting framework in v8.4+:

1. EASY customization: specific canned reports can be hidden from view if deemed not useful for your organization (ie remove reports from the filter identified as 1 in the screenshot at top)
2. MORE COMPLEX customization: additional canned reports can be defined using the existing filters (date, organization, etc.) - (ie add reports under the dropdown identified as 1 in the screenshot at top)

   This level of customization requires creating a new source table that extracts new "events" you can define/log at key trigger points in your logicnets.
3. MOST COMPLEX customization: the Reporting Framework itself can be modified to add/remove filters (filters are identified as 1 thru 5 in the screenshot at top) in addition to the customization above options above.

   This implies that an entirely new Reporting application can be built with custom charts and appropriate custom filters.

Speak to your LogicNets Project Manager about the best approach for building your reporting suite.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://community-test.logicnets.com/release-9/design-considerations-and-frameworks/frameworks/reporting-framework/standard-reporting.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.