User reports can be created at the System or Company Level depending on the user's security rights. New user reports are added by clicking on the [New User Report] button. To create a new user report from an existing user report or edit an existing user report, click on the pencil icon.
A system level report may be filtered by company, but generically will run against all companies unless otherwise specified.
Company level reports will automatically be filtered for the company it is created under. A User Report Type that will be used for company-level reports will require a path to the Company data source (table).
Creating a new report using the [Copy] button
When creating a new user report by copying an existing report, open the record and press the [Copy] button.
A confirmation pop-up window appears. Press [OK] to continue and to view the newly created user report.
When the copy feature is used, the copied user report will have "(Copy)" appearing at the end of the report name. All configured information and settings from all tabs are copied to the new user report. If the report that is being copied from is "locked" the new report will be not be locked allowing edits to be made.
Creating a new report using the [New User Report] button
If creating a new user report from scratch, click on the [New User Report] button. Prior to creating a user report, you need to determine the User Report Type. The Report Type covers the data elements you want included in your report and you can either select an available Report Type or create a new one to meet your reporting needs.
Upon initiating the creation of a new report, the User Report Details page is displayed. This page offers three options for creating a new report. Click on the Create New Report By drop down list and select from:
Defining a New Report
Copying A System Report
Copying A Company Report
Note: Use the above copy options are useful when creating a new company report by copying a system report or vice versa, or creating a new company report by copying another company level report.
When "Defining a New Report", enter the new report name and select the Report Type from the type-ahead drop down list. The user report type determines which data fields are available for use during the creation of a report and each user report requires a User Report Type. Press [Save] to create the report. Once the report has been saved, it can be added to the "My Favorites" report category.
The available fields are:
Name(*): Create a report name. Consider describing what the main purpose is e.g. Email Template / Merge Document / Cost Estimate / Prerequisite Report etc.
Description: The user report name is not a unique field. Input what the report is going to be used for and any key fields within report to help others avoid duplicating in future and making it easy to identify the correct report.
Report Type(*): Select the User Report Type name from the type-ahead search drop down list that the user has access to. This field will not appear when selecting <Copying A System Report> or <Copying A Company Report> for the Create New Report By field.
Report Category: Select the category name from the type-ahead search drop down list; if unspecified the report will go to found under the uncategorized category which is the last category on the Published Report tab. If a category is not found, add a new report category using the Lookup Maintenance screen and later assigned the report to it.
Report Execution Data Sensitivity: Used only if the nature of the data within the report is sensitive and is not intended to be viewed by all internal Equus Platform users. Select the data sensitivity name from the drop down list.
Report Timeout Seconds(*): Automatically shows the default value of 120 seconds. Specifies how long the report will run in seconds before it makes the user report fail if it encounters an issue.
Cache for Cost Estimates and Compensation Calculations: Tick to switch on the caching setting in order to reduce the the time it takes to run reports when running via Cost Estimates, Compensation Calculations, Assignment Packages and as batches.
Payroll Export: Tick to specify if it will be used for a Payroll Export.
Payroll Output Type: If the report is specified as a payroll export, select the output type as <Export> or <Excel>.
External User Type Access section - By default, internal users will have access to all user reports. The External User Type Access can limit the availability of the User Reports to a particular set of users e.g. External Client, External Employee, External Payroll, etc. In most cases, only an External Client would have the ability to run user reports at all.
Prerequisite User Reports section - click [New] to add other user reports that into the user report being created, click on [New] to add the cascading / prerequisite user reports.
Once the report has been saved, Data Fields can be added to the user report. Filters may also be added to.