Description
Currently in the Report Module, reports can be created and assigned to users via their Security Permission Roles. Users can then view these reports via the Report Module lists, and a schedule can be created to dispatch the report to selected users automatically.
In the 11.37 release, a new feature has been added to the Report Module, to provide an Agency with the ability to assign a Report as a Tile (or section) to the Dashboard and or primary records within Recruitment Manager.
Via the Report Module > Properties screen, a user can select the record(s) the report needs to display in, the width (single tile or double) and if the item will load open or closed.
Once configured, when users load the page the report is to display in, the report will display as the last section on the page.
Where Reports need to display with pass parameters, for example a report to be displayed in the Client Record, showing data about the Clients job's, within the Report Designer tool, filters are added to pass the required entity information. See configuration below for details.
Where you create a report using FastTrack's standard views, Data Groups are applied where a user tries to open the report - so they will only see data that belongs to their Data Group. If you create a report using custom SQL queries, Data Groups are not automatically applied. From v11.37, you be able to apply pass parameters to filter data in accordance with the logged in user's Data Group.
Benefits
This enhancement provides Agencies with the ability to display report data in a particular record, which will render to display data relevant to the record.
Configuration
To configure a report to display in the Dashboard and or a Record, find the report in the Report Module, and from the actions list, select 'Report Properties'.
The table below describes the actions available to configure your report to display in a particular record.
Item | Description |
Display In | Lists all the areas of Recruitment Manager that the report can display in. Where more than one area is required for display, use the Add button to create another row and select the next Display in item. |
Width | This can be single or double. Where it is single, this displays as ½ the width of the record. So two 'Single' items will may one section width. This can be used for smaller tiles ie; items that don't need to display across the width of the record (page). |
Height | This denotes the height of the tile. This can be changed at any time if required ie; you feel the report needs more height to display in a useful manner. |
Load | This determines if the report loads as an open tile (section) or it is closed by default. If closed the user can select the arrow at the header to display the report. The number of items that will automatically display by default as open is limited to 3 per page. This is to try to maintain the efficiency of the page load. For example, if 20 complicated reports loaded automatically on load of the page, this would greatly slow down the efficiency of page load. |
Add | Add a new Display In item. |
Delete | Remove a Display In item |
Adding Pass Parameters to Custom Reports
Where a Report is required for display with data filtered, for example a report is required to display in the Dashboard, filtered to the logged in user's Data Groups - pass parameters need to be added to your custom SQL query in the Stimulsoft report tool. Existing FT Standard Reports can also have pass parameters added, by copying to one of your report folders, then editing the report to apply the pass parameters.
To achieve this the following Reserve Words can be utilised:
Record | Limit Result To | Reserve Word |
Dashboard | Logged in user | LoggedInUserID |
Candidate | Candidate | EntityId, LoggedInUserID |
Parent | Parent | EntityId, LoggedInUserID |
Client | Client | EntityId, LoggedInUserID |
Cost Centre | Cost Centre | EntityId, LoggedInUserID |
Contact | Contact | EntityId, LoggedInUserID |
Temp Job | Temp Job | EntityId, LoggedInUserID |
Perm Job | Perm Job | EntityId, LoggedInUserID |
Contact Job | Contact Job | EntityId, LoggedInUserID |
To create and manage reports using the Stimulsoft tool, users need permission to Maintenance > Security > Report Designer. To open the tool, click Reports in the left hand menu, then Edit or Add to open or create a report.
Parameters (reserve words) can only be added to Custom Reports (custom SQL query). Below is an example of a pass parameter setup for a Job Order report to filter the Job data specific to the logged in user, where the user is the Job Owner:
Adding Hotlinks to Reports
The Stimulsoft report design supports the ability to embed hotlinks within Custom Reports (custom SQL query), which will support opening entity records. There are three elements required to build a hotlink, the url, the parameter and the report field. For example to add a link to the Client Record from a report you would need to add: @ClientURL/@Client/{JER.ClientId}
Below is a list of parameters and the related report field required:
Parameter | Report Field Required |
@Candidate | CandidateId |
@TempJob | JobOrderId |
@ContractJob | JobOrderId |
@PermJob | JobOrderId |
@Parent | ParentCompanyId |
@Client | ClientId |
@Contact | ClientContactId |
@CostCentre | CostCentreId |
@Leave | LeaveRequestId |
@user | UserId |
@Timesheet | dbtemtempid |
This string is added to the hyperlink property associated with the field in the report as per the example shown below:
When using hotlinks or pass parameters, you need to test your report in view mode and not via the editor preview.
If you wish to create a report using pass parameters and or hotlinks and you do not have a user that is familiar with report writing, please contact your Account Manager or Professional Services.