Creating a New Report Profile

This article describes how to add a new report profile using similar base/field criteria of an existing report.

Step-by-step guide

Open the report section of Framework, by either pressing the report button on the toolbar, or by pressing CTRL + R.This will take you to the below screen:

If you wanting to modify or create a new report modeled off a report profile, then use the profiles tab and select the report you are after. Otherwise, click the report tab to get the generic report, and apply your own criteria using the steps below.

After opening the reporting section of Framework, you will need to select a report that will give you the results you are after. You can browse the various categories by using the Category drop-down field.

Below are a few examples of the kinds of reports available within Framework.

• Work Flow Reports - generic information relating to a specific stage (usually modified to suit a screen, such as the Admin Overview screen matching the details of the Admin Overview report).
• Bin Reports - shows a number of jobs that belong in each 'bin'. E.g. a standard bin report might have job totals by minor stage in construction, i.e. how many jobs in Site Start/Base/Frame etc.
• List Reports - listing of all information, non-job related information is typically housed in these reports. E.g. email listing report, client listing reports.

Selecting a Report to Generate

After you have chosen the report that you would like to run, either double click the report, or press the preview button in the bottom right of the screen.

Base Criteria

a) Major/minor workflow stage selection. Select one, many or none. E.g. if I only wanted jobs in construction, I would need only select the construction stage.
b) Job status. Can be particularly important, depending on which kind of job you are trying to show. Standard is Active/On-hold.
c) Division. Used for companies that operate as separate divisions. Selecting one division will only generate jobs in that division.
d) Region. Used for companies that operate as separate regions. Selecting one region will only generate jobs in that region.
e) Region/Division. Used for companies that operate as separate regions or divisions. Selecting one region division will only generate jobs in that region division.

Field Criteria

In this example, we'll add the Administration Complete date where it is not empty.

To do this:

1. Select the Field Criteria tab.
2. Select the field you require (fields are organised into groups - the field you are after will most likely be in it's logical grouping).
   a) For finding fields, think of where the field 'lives' in Framework. E.g. most Admin fields are in Administration, Pre-Admin/Sales are in PreAdministration, Job details in Job and so on.
3. Click the >> button to push this across to required criteria

4. Select the criteria for the field pushed across. If this is a date field, the options relate to the field and either the date that exists in the field, or something about the date itself (e.g. if it's happened within a date range).
   a) A date range can be helpful in cases such as, "show me jobs in the last year that have construction completed". You would then use a 'in a period' to select within a date range for your report.
   b) An entity list criteria can be helpful when we only want to show jobs where a particular member of staff has worked on them. For example, "give me a list of jobs that Josh Jones has worked on as a Construction Supervisor". This is a simple Construction Supervisor is equal to Josh Jones.
   
   

   A combination of date/entity/list fields can be used to narrow down the result set to exactly what you are after.

   E.g. Show me a list of jobs that had a construction complete (actual) date in 2019, where the construction supervisor was Josh Jones and the house type was the Oxley 25.

5. Select OK on the field criteria dialog.
6. This will now show in the 'Required Criteria'.

Groups/Grouping

Similar to the field criteria, we want to select a field then push it across using the >> button.

1. Select the folder from the groups, then find the field.
2. Select the field.
3. Press the >> button.
4. The report grouping will now update.

Advanced/Report Saving

Alter the Title of the report, ensuring to conform to normal naming conventions pre-established within previous profiles.

1. Change the title to reflect the name of this report, e.g. Admin Completes 2019 - by Admin.
2. Add in a description of what it is that this report is going to show.
3. Press the save button to save this report profile, for later use or reuse.

After you are happy with the title / fields, select the save button. When given the below dialog, select 'yes' to create a new profile, and 'no' to overwrite a previous report profile.