Report Instance

All reports have default filters that you can see when accessing any of the standard reports from the Run hiperlink under the report name. However, you might find useful to add or remove specific filters and save these filters so you can run the report without the need of modifying them everytime. This is done with the Save New Filters button, and what this does is to save a new custom instance of the report which replaces the default one with the default filters.

The report will appear on your Reports list with a yellow star. This means this instance is only available to you. Other users can still see the original with default filters.

If you want this new instance to become available to all other users, so it replaces the original default one, by removing the yellow star, this report instance will appear on their reports list.

Once the new instance is appearing on the Report list the report will now have 3 options: Run | Customise | Tile.

Default reports (not custom instance) only have the Run option.

Reports with default filters
Report instance available to all users that have access to this report.

Tile will create a shortcut access on your home page, that will open this report instance. Very handy for reports that are run periodically.

Run

  • For default reports this will open the screen where the parameters can be selected and the report executed with the View button

  • For custom instances of the report will execute the report using the saved custom parameters.

Customise opens the screen where you can provide parameters for the report to be run, either as static or dynamic inputs, plus other functionality described below.

Fields

  • Instance - Name of the instance as displayed on the Report List.

  • Favourite -  If marked as 'Favourite' then is only listed for the creator and can be saved as a new instance (with custom filters as an option). A yellow star will appear next to the Report title in the list of reports, so you can easily identify it.

Filters

  • Static filters work like filter predicates where fields may be added or removed as required.

  • Additionally dynamic inputs allow parameter inputs to be specified in context:

Filter Control

Dynamic Input Token

Filter Control

Dynamic Input Token

Date

  • Today

    • Start of this week

    • End of this week

    • Start of last week

    • End of last week

    • One week ago

    • Two weeks ago

    • Start of this period

    • End of this period

Person

  • Me

Profit Centre

  • My Profit Centre

Year Period

  • This period

    • Last period

    • Two periods ago

    • Three periods ago

    • Next period

Buttons

  • Delete - will delete the report instance, not the report itself. It deletes it for all users if it is an instance that was made available to everyone by removing the yellow star. This would make the default report with its default filters replace this report instance being deleted.
    The report can only be removed from appearing in the reports list by an Administrator and this is done from Reports maintenance screen or with Report Groups.

  • Options - on clik it displays two options:

    • Print Report Filter (this is usefull to understand exactly what is included in the results).

    • Print Report troubleshooting parameters - this info is handy for a person investigating a report when is not working. Include this info when raising an issue with the support team.

  • Reset - resets the parameters to the default ones for this report instance.

  • View - Runs the report with the current parameter values and displays the result in the Report Viewer.

  • Save New Filters - Saves the given inputs as a new report instance.

  • Save - Saves any changes to the current report instance.

  • Close - Abandons the process and closes the popup.