Configure Logging
Overview
The logging functionality, which is set up in Administrator, records events including who did what, when and to whom.
By default, basic logging is enabled at an informational level in all new repositories and is stored in a table that is created for that repository. The log will record when an inquiry object has been edited, but cannot record the details of what changed (for example formats or calculations).
All repositories have a folder called Activity Log that appears in the Administrator. This directory contains one Log Stream called Default, as shown in the following screenshot.
The Logging directory can contain multiple log streams which can be enabled or disabled for different logging scenarios. Log Streams can be treated like any other object within the repository in that they can be created, renamed, deleted, copied, etc.
Important: Certain logging settings should only be used for specific situations and are not enabled continuously.
Be aware that setting the Categories to ‘All’ or setting the Severity to the ‘Debugging’ level can substantially increase the number of log entries recorded, which will impact the performance of any application within Hubble.
Once you have captured the desired information using the logging functionality, it is extremely important that you set the logging back to the default values.
Setting Up and Modifying Logging Configuration
You can edit a Log Stream to configure the status (active or not) as well as when to log activity according to the type of activity, the severity, the specific user and the specific machine.
To edit a Log Stream:
- Log into your repository if you are not logged in already.
- Highlight the Logging node in the tree on the left panel.
- In the right panel, right-click on the Log Stream you wish to edit whether it is the Default Log Stream or one you have already created.
- Click Edit. The Log Stream Configuration dialog will be displayed:
- Configure the Log Stream as needed:
- Name
- Status – active/inactive (It is recommended that you do not delete a Log Stream but disable it in case you to re-enable the logging later.)
- Category – set logging for specific situations.
-
Severity - specify the level of information being recorded by the log stream. It is recommended that these logging settings are only used for specific situations and are not enabled continuously.
> Be aware that setting the Categories to ‘All’ or setting the Severity to the ‘Debugging’ level can substantially increase the number of log entries recorded, which will impact the performance of Hubble.
-
User – optionally, select individual users for logging (user groups cannot be selected). If left blank, it is used for all users.
- Click the “…” button to open the Select User dialog.
- Select a User.
- Click OK to return to the main dialog.
- Machine – optionally, specify a PC name so that only activity originating from that PC is logged.
- Set thresholds for log generation. When the log count surpasses the specified limit, you receive notifications.
As a Hubble administrator, you have the option to configure an alert threshold while setting up the log stream. Importantly, this field is not mandatory, so you can leave it blank if you prefer not to receive notifications.
- When editing a log stream that is used to log activity in Administrator, you must restart the application for the changes to be correctly applied.
Note: Once you have captured the desired information using the logging functionality, it is extremely important that you set the logging back to the default values.
As mentioned above, you should not continuously enable logging, particularly debugging, as it will impact the performance of any application within Hubble. It should only be set to capture specific information and then disabled once this information has been recorded.
Viewing Logged Activity
Administrators are automatically entitled to use the View History dialog. Non-administrators must be granted the Logging capability in order to get access to the dialog.
- Log into your repository if you are not logged in already.
- Highlight the item for which you wish to view the logging activity. (This can be an individual item such as the Documents folder, if logging had been set up for it, or the Default Log Stream under Logging to include all items.)
- Right-click on the item and select View History.
- Use the filters to narrow down the data returned:
- Severities - the required severity level of Errors, Warning, Information or Debug specified in the Log Stream(s).
- Categories - the Categories specified in the Log Stream(s).
- Document - the Document or Document Folder text. The logged events can be further narrowed down by using the associated drop-down control’s options of Equals, BeginsWith, Contains and EndsWith. (For example, Begins With if used in conjunction with Document would return all the logged events associated with all documents, reports and templates stored within the Documents folder.)
- Message - specific text within the Message column. The logged events can be further narrowed down by using the associated drop-down control’s options of Equals, Begins With, Contains and Ends With.
- Sort By - set the order of the logged events. Any of the associated filters can be selected and can be sorted by enabling/disabling the Descending checkbox.
- From Date/To Date - the date ranges of the activity. Either manually type in the dates or use the down arrow to select dates using the calendar. (You can overwrite the From Date that automatically defaults in.)
- User - the specific user making the changes. (Useful when multiple users are accessing the same repository.)
- Profile – a specific Profile. (This is particularly useful when diagnosing whether issues are related to a Profile configuration issue.)
- Code - the specific (numeric) Code for a function that is included within a Categories group. (You can see the specific codes by looking in the Code column or in the Categories dialog, accessed by clicking on the … next to the Categories filter.)
- Repository – the specific repository.
- Log Stream –the specific Log Stream being used.
- Machine – the specific Machine PC/Server.
- Click Run Query to refresh the logged events displayed in the lower half of the dialog.
The View History dialog also allows the users to export the logged events via:
- Copy - copies any highlighted records into the local computer’s clipboard, allowing the user to paste these records into an appropriate program.
- Save - save all displayed Logged Events into a CSV file for later analysis.
In the example shown, the selection of the Document folder has populated Document in the Document Filter. However the pre-population of filters will work with inquiries, templates, report packs, reusable inquiry objects, and profiles.
Deleting Logged Activity
Logged data can be purged via the Delete History functionality. Individual objects within the repository can have their logged events purged or, alternatively, this can be done by individual Log Streams as shown below:
- Log into your repository if you are not logged in already.
- In the left panel, highlight Logging.
- In the right panel, highlight the specific Log Stream for which you wish to delete the logging activity and select Delete History.
- In the Delete History dialog, specify:
- Log Stream – either the selected stream or all streams.
-
Older than – log streams older than the date specified will be deleted. (If left blank, all entries will be deleted.) The default date can be overridden.
- Click Delete. The Hubble Information dialog that appears tells you how many log entries were deleted.
Reusable Inquiry Objects
From Administrator, you can manage Reusable Inquiry Objects (RIO) by creating new folders and defining Permissions to users/groups for the folders and/or the individual RIO items within the folders. (From Hubble , new folders can be created but permissions can only be set for them through Administrator.)
To create a Reusable Inquiry Objects (RIO) folder:
- Log into your repository if you are not logged in already.
- In the left panel, expand the RIO node in the tree structure. You will then see a folder for Global as well as folders for any individual profile that has been set up. The Global folder holds RIO items that can be used in all profiles.
- Right-click on the level you wish to create a folder, whether it is Global or a specific profile, and select New > Folder.
- Provide a name for the folder.
- Assign permissions by right-clicking on a specific folder or an item within a folder and selecting Permissions.
Virtual Views Visibility and Permissions
From Hubble version 26.1, Virtual Views are visible in the Administrator tool under Designer Objects. Administrators can view all Virtual Views in the repository, review their associated reports, and apply permissions to control who can read or edit them in Hubble Reporting DX.
Prerequisites
- You must be logged in as an administrator in the Hubble Administration tool.
- Virtual Views must have been created in Hubble Reporting Designer Express (DX ) before they appear in the Administrator tool.
To view Virtual Views in the Admin tool
- Log in to the Hubble Administration tool.
- In the left panel, expand the Designer Objects node.
-
Select the Virtual Views folder. All Virtual Views created in the repository are listed here, regardless of which profile they were created against.
- To refresh the list after a new Virtual View has been created, click Refresh on the Home ribbon if the right panel is already open on the Virtual Views folder.
Note: Virtual Views are not profile-dependent. All Virtual Views appear under a single folder regardless of the profile used when they were created. Export to RDF format is not supported for Virtual Views. The Cut, Copy, and Remove options are not available from the right-click menu.
To view report associations for a Virtual View
- In the Virtual Views folder, right-click the Virtual View you want to inspect.
Select Properties.
-
The Properties panel displays all reports associated with that Virtual View, including their name and location. Use this to identify report dependencies before making any changes.
To set permissions on a Virtual View
- In the Virtual Views folder, right-click the Virtual View you want to manage.
-
Select Permissions.
- By default, all users are granted Read permission on Virtual Views.
-
To grant Edit permission to a user or group, assign the Edit View capability to the relevant user or group in the DX template. Users without this capability can view but not edit the Virtual View in Hubble Reporting DX.
- Users who have not been granted any permission are denied access when they attempt to view or edit the Virtual View in Hubble Reporting DX.
Note: For information on assigning capabilities to users and groups, see Assign Capabilities.
Usage and Governance Reports
From Hubble version 26.3 onwards, the Administrator tool includes Usage and Governance Reports to help you monitor how your Hubble environment is being used. These reports give administrators a centralized view of user activity and report usage.
- Track user activity and licensing by viewing which users are actively using Hubble Web, Desktop, and Scheduler applications, analyzing login patterns, and seeing which modules are being used, such as General Ledger, Accounts Payable, and Accounts Receivable. This helps you identify inactive accounts, optimize license allocations, and target training to the teams that need it most.
- Manage your report portfolio by understanding which reports are actively used versus those that are outdated or redundant. This makes it easier to clean up your repository and maintain an organized reporting environment.
- Monitor data dependencies to see which reports depend on shared data structures (virtual views) and their ERP data sources. This visibility helps you manage changes safely and maintain data governance standards.
Note: Usage and Governance Reports are available only in Platform mode.
Prerequisites
- You must be logged in as an administrator in the Hubble Administration tool.
- Only users with Administrator privileges can see and open Usage and Governance Reports. Standard users do not see this option.
To access Usage and Governance Reports
- Log in to the Hubble Administration tool.
- In the left panel, expand the repository connection, then select the repository.
-
In the object list, select Usage & Governance Reports to see the three available reports: Report Usage Analytics, Reports Using Virtual Views, and User Activity by Module. Select a report to open it.
To enable or disable Usage and Governance Reports
-
In the object list, right-click the Usage & Governance Reports node.
- Select Enable Activity Logging or Disable Activity Logging. This is a single command; its label reflects the current state, so only one of the two options is available at a time.
-
In the confirmation dialog, read the message: "This will start/stop activity logging for Hubble Usage & Governance Reports for all users. Do you want to continue?" Select Yes to apply the change or No to cancel.
Activity logging is On by default for new installations and for upgrades from an earlier version. If an administrator turns logging Off, the Off state carries forward through later upgrades.
State |
Effect |
|---|---|
Turned Off |
Activity logging stops immediately. No new activity data is written. Existing data is preserved and is not deleted. |
Turned back On |
Activity logging resumes from that point. Data is not backfilled for the period logging was Off. |
Note: Enabling or disabling Usage and Governance Reports has no effect on the existing Hubble user activity log, and the existing user activity log has no effect on this feature.
To view the enable and disable history
- In the object list, right-click the Usage & Governance Reports node.
-
Select View History.
The View History: Usage & Governance Reports window opens, showing a From and To date filter and a grid with three columns: Date/Time, User, and Message. Each row records when an administrator enabled or disabled activity logging.
Note: This View History window is not the same as the View History dialog for the repository's Activity Log folder, described earlier in this topic under Viewing Logged Activity. That dialog offers many filters, including Severities, Categories, and Document. The View History window for Usage and Governance Reports offers only a From and To date filter.
To run the User Activity by Module report
-
Use the Date Range, Username, Module, and Application filters to narrow the result set, then select Run.
Use the Group by list to change how results are grouped. Select Collapse All or Expand All to control how much detail displays at once.
Note: The Date Range picker only lets you select dates within the last 18 months.
- Select Expand All, or select the disclosure arrow beside a module name, to show per-user detail, including role, profile, login count, module access count, machine, and the date of last access. The small arrows next to column headers, such as Module Name, sort the results and are separate from the expand and collapse controls.
Note: If no role is assigned to a login, the Role column displays "No role assigned."
Note: In EBS environments, the Role column displays as Responsibility.
To run the Report Usage Analytics report
-
Use the Date Range, Username, Report Name, and Application filters to narrow the result set, then select Run.
Use the Group by list to group results by report name, username, or application.
Note: The Date Range picker only lets you select dates within the last 18 months.
-
When grouped by report name, expand a report to view each run, including the user, application, machine, role, profile, duration, and rows returned.
Note: In EBS environments, the Role column displays as Responsibility.
To run the Reports Using Virtual Views report
-
Use the Date Range, Virtual View, Report Name, Owner, and Database Family filters to narrow the result set, then select Run.
Use the Group by list to group results by virtual view, database family, or owner.
Note: The Date Range picker only lets you select dates within the last 18 months.
- Expand a virtual view to see each report built on it, including the report name and the date it was last accessed.
Results include the virtual view, report name, owner, database family, and last accessed date.
Note: Only virtual views that have at least one associated report appear in this report. A virtual view with no associated reports is not listed.
To export a report
- From any Usage and Governance Reports screen, select CSV or Excel to save the current result set.
Note: Export includes only the rows displayed for the applied filters. For example, if a Username filter is applied, only the filtered records shown are exported.
Note: A very large result set can take longer to load on any of the three reports. Narrow the date range before you run the query if the report covers a long period.
To purge data manually
Usage and Governance Reports has no retention-period setting and no automatic purge. An administrator purges data using database scripts, run manually against the repository database. Purge is intentionally manual, since some administrators do not have permission to delete production logs directly.
Purge scripts are provided for five database engines: Microsoft SQL Server, Oracle, IBM DB2, PostgreSQL, and VectorWise. The scripts are common to all ERPs and are installed in the UsageAndGovernanceReports_Scripts folder.
- Obtain the purge script for the database engine used by the repository, from the UsageAndGovernanceReports_Scripts folder.
- Run the script against the repository database, specifying the number of days of data to retain.
Note: The UsageAndGovernanceReports_Scripts folder is available only in Platform mode.
Note: The purge script does not delete the enable and disable audit entries. These entries are preserved regardless of how much data is purged, so the enable and disable history remains available after a purge.