Skip to main content

Reportilize Admin Guide

Raise a support ticket
IMPORTING DASHBOARDS

If upgrading from v2.2x or below, dashboards will need to be imported into Reportilize to allow for setting changes within v2.3.x

GENERAL​

The general configuration provides all the general config of the application.

Click on the General Tab and the following page will load.

image.png

EXPORTING SETTINGS​

The following settings can be exported from Reportilize.

  • Dashboards (Dashboards.json)
  • Dashboard Groups (DashboardGroup.json)
  • Appearance (Apperance.json)
  • General Settings (GeneralSettings.json)
  • Email Settings (EmailSettings.json)
  • Display Settings (DisplaySettings.json)
  • Maintenance Settings (MaintenanceSettings.json)
  • Document Store Growth (DocumentStoreGrowth.json)
  • Statistics Data

To export Reportilize settings, click the Export Settings button. The JSON files will automatically download.

2021-11-15_11-31-54.jpg

If not all the files automatically download, ensure that your browsers accept multiple files for download.

IMPORT SETTINGS​

To import new settings into Reportilize, complete the following.

File name conventions

The file name of the json file being imported must match the file names of the JSON files used within Reportilize. Changing the file names will result in a failed upload.

  1. Click on the Import Settings Button

    2021-05-19_8-42-53.jpg

  2. Select the settings file you want to upload

  3. Click on the Open button and the files will be automatically imported

DOWNLOAD LOGS​

Clicking on the Download Logs button will download all server logs into a zip file locally.

2022-01-12_10-09-52.jpg

ADMIN WHITELIST​

The ability to whitelist selected locations to have administrator access to Reportilize.

2022-01-12_10-02-25.jpg

DATASET ID​

The Dataset ID of the Content Manager database Reportilize is connected to.

image.png

WORKGROUP SERVER NAME​

The workgroup server name of the Content Manager database Reportilize is connected to. Dataset connection can be made with either the workgroup server name or URL.

image.png

WORKGROUP SERVER URL​

The workgroup server URL of the Content Manager database Reportilize is connected to. Dataset connection can be made with either the workgroup server name or URL.

image.png

TEMP PATH​

The temporary path on the server that is used by Reportilize.

2022-01-12_10-09-10.jpg

APPEARANCE​

Click on the Appearance Tab, the page will load as follows.

image.png

TITLE CONFIGURATION​

NAMEDESCRIPTION
TitleThe main title of the Home page
SubtitleThe subtitle of the Home page
Background HeightThe sizing of the home page background image

COLOURS​

NAMEDESCRIPTION
Primary Background ColourThe header and footer colour
Primary Font ColourThe primary font colour
Main and Subtitle Font ColourThe home page titling font colour
  1. Click Pick Colour - the Colour Picker will appear

    2021-06-10_16-03-14.jpg

  2. Select the colour desired

  3. Click on the Pick Colour button again to close it

  4. Click on the Save button

    2021-08-27_9-24-07.jpg

BACKGROUND​

The homepage background image can be changed to the desired image.

  1. Drag and Drop the desired image into the background section

    image.png

  2. Alternatively, you can click on the drag and drop area and select your image from the browser window.

  3. Click on the Upload button to save your changes.

    image.png

The header logo can be changed to the desired image.

  1. Drag and Drop the desired image into the Logo section

    image.png

  2. Alternatively, you can click on the drag and drop area and select your image from the browser window.

  3. Click on the Upload button to save your changes.

    image.png

EMAIL​

The email configuration provides all configuration for sending email notifications.

image.png

MAIL SETTINGS​

MAIL HOST​

The mail host service.

2022-01-12_10-16-41.jpg

MAIL PORT​

The port specified for the host service.

2022-01-12_10-17-12.jpg

SEND FROM​

The email addresses the dashboard and maintenance reports will be sent from.

2022-01-12_10-17-43.jpg

CONTACTS​

Adding Multiple Contacts

You can add multiple email addresses by adding ';' between each email address.

LICENSE EXPIRY CONTACTS​

The email addresses of users that will be contacted when the FYB Reportilize license is due to expire.

2022-01-12_10-18-52.jpg

EVENT MONITORING CONTACTS​

The email addresses of users that will be contacted when Content Manager event processing is blocked or fails.

2022-01-12_10-21-11.jpg

STATISTICS CONTACTS​

The email addresses of users that will be contacted when the monthly Reportilize statistical data report is generated. The statistics report generated will give a breakdown of the monthly usage of Reportilize and display the most popular dashboards used that month.

2022-01-12_10-22-30.jpg

ERROR CONTACTS​

The email addresses of users that will be contacted when Reportilize experiences an error processing scheduled tasks such as performing monthly maintenance or sending emails to specific contacts.

image.png

LICENSE​

The license configuration provides all configuration for licensing of Reportilize.

image.png

For instructions for uploading a new license see the Reportilize License Guide

DASHBOARD​

Click on the Dashboard Tab. The page will load as shown below.

2022-01-12_10-42-53.jpg

This is where you can create, edit, and delete dashboards.

CREATING A NEW DASHBOARD​

To create a new dashboard, click on the New Dashboard button

image.png

The configuration screen will load as follows.

image.png

TITLING​

Enter a name and description for the dashboard.

image.png

Select from a Record or Location saved search, using the toggles. Enter the name of the saved search group intended to be used for the dashboard.

image.png

Note

The saved search group must already be configured within Content Manager.

All saved searches contained in the saved search group will be displayed on the dashboard.

Singular Searches will always display as number cards on the dashboard.

Grouped Searches will always display as charts on the dashboard.

image.png

To select which searches to display on the dashboard:

  1. Enter the parent group name in the Saved Search Group field

  2. Click on the Confirm button

  3. A list of all saved searches will appear

    image.png

ADDING A SAVED SEARCH TO THE DASHBOARD​

To add a saved search to the dashboard, click the toggle button on the left-hand side of the desired saved search.

An active saved search will be toggled on - This will display in the dashboard.

image.png

An inactive saved search will be toggled off - This will not display in the dashboard.

image.png

CHART TYPE​

Grouped searches will display data in a chart. This chart can be defined in the dropdown box that is displayed on the right-hand side of the valid search. The following charts can be selected for use:

image.png

If unchecked, the filter will display on the dashboard.

image.png

REMOVE FILTER BY GROUP​

Option to remove the 'Filter By Group' option from the dashboard created. If checked, the filter will not appear on the dashboard

image.png

OVERVIEW METADATA​

The table columns of the overview page are customisable to display specific metadata from the records retrieved.

image.png

To add a column to the table, use the search bar to find a record field. Enable the checkbox of the associated field. The field will appear in the table on the right-hand side.

image.png

To change the order of the columns, click the sorting arrows on the associated field to move the field up or down.

image.png

To delete a column, click on the bin icon on the associated field to delete it from the table.

image.png

Alternatively, unchecking the fields checkbox will also remove the field from the table.

RESULTS PER PAGE​

To prevent extensive loading time for searches that contain lots of records, the overview page must be limited to run efficiently.

image.png

The default limit is set to 20. It is recommended not exceeding 500 records per page to help with load times.

REPORTING TEMPLATE​

A report template will be unique for each dashboard and what you want to capture from it.

To create a reporting template the following criteria must be met:

  • The template must be in the format of a Word Document (.docx) or Excel Spreadsheet (.xlsx)
  • The template must have no restrictions (i.e., read-only)
  • Report Templates must be stored in Content Manager and must be of the same record type that was declared during the installation process (Template RecType URI).

To populate a template, specific placeholders can be added into the template that Reportilize will be able to identify and populate with a value.

Placeholders for Reporting Data

All placeholders will be uppercase with all spaces replaced with underscores, surrounded in curled brackets e.g. {PLACEHOLDER_NAME}

Placeholders are generated in the following format:

PLACEHOLDER TYPEPLACEHOLDER FORMATEXAMPLEOUTPUT
Single Search Name{SEARCH_NAME}{CHECKED_OUT_RECORDS_NAME}Checked Out Records
Single Search Value{SEARCH_VALUE}{CHECKED_OUT_RECORDS_VALUE}6598
Grouped Search Nameimage.png{RECORDS_REGISTERED_ALL_YEARS_NAME}Records Registered - All Years
Grouped Search Value{PARENTSEARCH_CHILDSEARCH_VALUE}{RECORDS_REGISTERED_ALL_YEARS_VALUE}1589

Placeholders can be inputted into any section of a word document.

image.png

Additional Generic Placeholders can be used within the template including.

PlaceholderValue
{BUILD_NUMBER}The build number of Content Manager Installed.
{DATE}Today's date in format dd/mm/yyyy
{ORGANISATION}The organisation name attached to the service account.
{VERSION}Value outputs : Content Manager
{MONTH_YEAR}Month and Year in format example (December 2020)
{CREATOR}Value outputs: FYB Reportilize
{NEXT_MAINTENANCE_DATE}Calculated Date of the next scheduled report.
{NAME}Dashboard Name
{DESCRIPTION}Dashboard Description
Excel Templates

If a template is created in Excel, placeholders can be used to create dynamic charts within the spreadsheet. The placeholders will be automatically populated by Reportilize, and will render the pre-set-up charts. This functionality can also be completed for pre-set formulas that have placeholders used.

GENERATE REPORT TO PDF​

Report Templates can be generated into a PDF document when this option is enabled.

image.png

PDF Limitations

Only templates created in Word (.doc / .docx) are supported for PDF conversion.

If this option is disabled, the report will be generated in its standard format (i.e., Word)

GENERATE TR5 FILES​

During the scheduled reporting, all saved searches within the dashboard can be generated into individual TR5 files that will be attached to the scheduled email with the original report.

image.png

FINALISE RECORDS IN SAVED SEARCHES​

During the scheduled reporting, any selected saved searches within the dropdown will have all returned records finalised.

image.png

ATTENTION!

Warning this will finalise all records found in the selected search.

SCHEDULER DATE​

Defines when the first run of the report should start. This cannot be a date from the past.

image.png

SCHEDULER FREQUENCY​

Defines the frequency the reporting scheduler will run for this dashboard. This is the frequency of when a Dashboard Report will be either sent via email or saved into Content Manager.

You can choose to complete both or just one of the saving options for a generated report.

image.png

info

Note that reports will be emailed or sent to Content Manager at roughly 7AM the day of the scheduled run.

EMAIL SUBJECT​

Defines the subject / titling of the email.

image.png

Hovering over the ? next to the field will display all placeholders that can be used within the email body and subject.

image.png

EMAIL BODY​

Defines the body / contents of the email. Customisable emails can be sent to personalise the reporting features. Hovering over the ? next to the field will display all placeholders that can be used within the email body and subject.

image.png

Placeholders must be surrounded by { } and in capital letters.

image.png

SEND REPORT TO​

Defines the recipient(s) of the emailed report. To include multiple separate use a ';' to separate each address.

image.png

To Save a dashboard click on the Save button. This will redirect you back to the Admin page.

2021-08-27_9-24-07.jpg

To cancel all changes, click on the Cancel button. This will redirect you back to the Admin page.

2021-06-10_15-56-40.jpg

SAVE REPORT TO CM​

Toggling this checkbox will allow Reportilize to store any reports generated for this dashboard into Content Manager under the specified folder.

image.png

REPORT FOLDER​

Search for a folder that will be used as the container for the SAVE REPORT TO CM feature.

image.png

EDITING A DASHBOARD​

To edit a dashboard, click on the pencil icon for the desired dashboard.

image.png

The dashboard will load as follows.

image.png

Complete the changes as needed and click on the Save button.

2021-08-27_9-24-07.jpg

To cancel all changes, click on the Cancel button.

2021-06-10_15-56-40.jpg

DELETING A DASHBOARD​

To delete a dashboard, click on the rubbish bin icon for the desired dashboard. The dashboard will be deleted and removed from view.

image.png

GROUPS​

Dashboard groups allow for multiple dashboards to be grouped together with added access restrictions to who can view these dashboards.

2022-01-12_10-47-27.jpg

A dashboard group will be accessible from the home page.

image.png

Administrators can bypass access restrictions to the dashboards. General users will be unable to view the contents of a dashboard group they do not have access to.

CREATING A GROUP​

To create a new group, click on the New Group button.

image.png

The group configuration will display as follows.

2022-01-12_10-51-40.jpg

NAME​

Defines the name title of the Dashboard Group.

DESCRIPTION​

Defines the description of the Dashboard Group.

DASHBOARDS WITHIN A GROUP​

Clicking on the dropdown provides a list of dashboards that can be selected. Multiple dashboards can be selected for a group.

image.png

ACCESS TO DASHBOARD​

A dashboard group can have restricted access to lock a dashboard group to specific locations. If this field is left blank, anyone is free to view this group.

image.png

To save a group, click on the Save button.

2021-08-27_9-24-07.jpg

To cancel all changes, click on the Cancel button.

2021-06-10_15-56-40.jpg

EDITING A GROUP​

To edit a group, click on the pencil icon for the desired group.

image.png

The group will load as follows.

image.png

Complete the changes as needed and click on the Save button.

To cancel all changes, click on the Cancel button.

DELETING A GROUP​

To delete a group, click on the rubbish bin icon for the desired group. The group will be deleted and removed from view.

image.png

MAINTENANCE​

All settings for the assistance with completing the monthly maintenance for Reportilize.

image.png

SERVER LOCAL DATA FILE PATH​

2022-01-12_11-01-12.jpg

The path where Content Manager's local data and log files are kept. This path must be on the same server FYB Reportilize is installed on.

DOCUMENT STORE FILE PATH​

2022-01-12_11-01-37.jpg

The path where Content Manager's Document Store is installed on. This path can be a file share path if the Document Store is installed on a different server to Content Manager.

EVENT PROCESSOR EMAILS​

An email alert for notifying of any currently blocked, suspended, or errored processing queues within Enterprise Studio. Email notifications will only run if this setting is enabled.

image.png

The Event Processor Email Subject is customisable and can be modified to desired needs.

Hover over the ? icon, to help with adding placeholders within the email subject.

image.png

EVENT VIEWER EMAILS​

An email alert for notifying of any errors produced by Content Manager within Event Viewer. An attachment of the event log is added to the email.

image.png

The Event Viewer Email Subject is customisable and can be modified to desired needs.

Hover over the ? icon, to help with adding placeholders within the email subject.

image.png

Once all changes are made, click on the Save button.

2021-04-26_12-26-16.jpg

DISPLAY​

All settings are for the Reportilize display

image.png

DISABLE CUSTOM DASHBOARD CARD FROM HOMEPAGE​

Toggling on this setting will remove the Custom Dashboards quick access card from the home page

image.png