- 25 Mar 2024
- 4 Minutes to read
- Contributors
- Print
- DarkLight
System Report Configuration
- Updated on 25 Mar 2024
- 4 Minutes to read
- Contributors
- Print
- DarkLight
This topic is related to the following section - System Reports
About System Report Configuration
System Report Configuration provides access to set up the System Reports for use. The project Admin produces queries within the database that they can identify and prioritize within this set of pages to produce Excel worksheets of data. Only the Admin role can access and modify these reports.
System delivered reports are provided and these reports do not allow for Delete (Delete icon displays as gray). These reports may still be edited and saved for changes. Once the report is saved, the system checks against the scripting in the Query field. Should the scripting be invalid, the Status column reflects this by showing a RED X rather than a Check mark. The status determines whether the report is available for display.
View the following page by navigating to Administer >Advanced > System Report Configuration from the Syniti Migrate Homepage.
Within panel System Reports: Configuration fields of this grid are provided as follows:
Field | Description |
---|---|
Index | Sequence of System Reports. Value increases by factor of 10 for each new entry. |
Active | Toggle to set status of the system report.
|
Report Name | The name of the system report. |
Description | The description of the report. |
Status | Provides the validation status for the report. |
Add a System Report
To add a report to the system, click Add icon within the left side panel. This action opens a new page on the Right side panel and advance the Index or priority to the next open value.
Field | Description |
---|---|
Index* | Sequence of System Reports. (Required) |
Report Name* | The name of the system report. (Required) |
Description* | The description of the report. (Required) |
Datasource* | The datasource within Migration in which this report is being stored. (Required) |
Query* | The database query that builds out the report. (Required)
|
Parse | Performs a parsing check against the scripting added to field Query. See details below. (only active once Query is entered) |
Order By | The sort order of these fields within the system report. Each field is comma separated field names only. |
System Report Type | Allows for grouping of system reports by a Report Type that is setup in List Boxes. (ADMIN , GOVERN, MIGRATE, SECURITY, TBD) See Note below. |
Active | Toggle switch that indicates if the report is currently Active or Inactive for use.
|
Security | Toggle switch that indicates if the report is currently Active or Inactive for Security. It applies to a subset of the Syniti security roles.
|
Note
If a report is not available within System Reports when you are logged in, check for any of these reasons: Query is not successful, Report is not set to Active, your security is not active for this report.
Note
System Report Type field groups multiple system reports into a type. The drop-down list is configurable through Administer > Advanced > List Boxes (SYSTEM_REPORT_TYPE) as shown in the image below.
Parse the Query Script
Once the user has added code to the field for Query, the system activates button Parse. This button checks the query to ensure that the scripting is valid and has no issues. Once the button is clicked, a message displays to show that the Source Query is either OK or has an issue.
The save of this report runs through validation of the Query and displays in a dialog box the issues for resolve that prevent this System Report from saving.
Security Setup for the System Report
If the Security toggle is selected as active, a list of the available security roles displays below the Security toggle. Select one or more roles and click the Enabled toggle to mark the role as active for security for this report.
Note
If no security roles are marked as Enabled, the Security toggle reverts back to inactive upon saving the page. To remove a role from Security, flag it as not active.
Make the necessary changes and then click Save icon or select a different row or back out of the page to exit without saving the changes. Once the new row has been saved a window displays with message "Data Saved Successfully"
Remove Security for a System Report
To remove Security from a report, either flag all roles as not active (this flags Security as not active upon save). Or the user may flag Security as not active. A warning message displays and the user may then click OK to proceed and Security changes to not active for that report.
Edit a System Report
To edit an existing report select that row to display the report details in the right side panel. The Details panel defaults to Edit mode to make changes to the fields. System defaulted report configurations are locked for changes to fields Datasource, Query, and Order By, but the remaining fields may be changed.
User defined system report configuration may be modified for every field as shown below.
When finished with edits, click the Save icon to complete.
Delete a System Report
A defaulted list of System Reports are provided. These reports do not provide access for Delete as can be seen by the grayed out Delete Icon. All user defined system reports may be deleted by a click on the Delete icon.