Report Template - Revision history

Nick: /* Emailing Reports */

2023-03-29T06:54:30Z

Emailing Reports

← Older revision		Revision as of 06:54, 29 March 2023
Line 60:		Line 60:
	== Emailing Reports ==		== Emailing Reports ==

	* Ensure the email settings for your user account are filled in (Human Resources → User Accounts → Select User → Email Settings)		* If you have Email report templates set up, see [[Email Templates]], otherwise
			*Ensure the email settings for your user account are filled in (Human Resources → User Accounts → Select User → Email Settings)

	* Click the [[File:Email report.png\|frameless]] button in the top left corner		* Click the [[File:Email report.png\|frameless]] button in the top left corner
	* This will open up the default email app (you can select which one to use), along with a copy of the report as a PDF already attached		* This will open up the default email app (you can select which one to use), along with a copy of the report as a PDF already attached

Nick: /* Emailing Reports */

2023-02-23T08:44:21Z

Emailing Reports

← Older revision		Revision as of 08:44, 23 February 2023
Line 62:		Line 62:
	* Ensure the email settings for your user account are filled in (Human Resources → User Accounts → Select User → Email Settings)		* Ensure the email settings for your user account are filled in (Human Resources → User Accounts → Select User → Email Settings)

	* Click the [[File:Email report.png\|frameless]] button in the top left corner		* Click the [[File:Email report.png\|frameless]] button in the top left corner
	* This will open up the default email app (you can select which one to use), along with a copy of the report as a PDF already attached		* This will open up the default email app (you can select which one to use), along with a copy of the report as a PDF already attached

Nick: /* Emailing Reports */

2023-02-22T08:14:45Z

Emailing Reports

← Older revision		Revision as of 08:14, 22 February 2023
Line 62:		Line 62:
	* Ensure the email settings for your user account are filled in (Human Resources → User Accounts → Select User → Email Settings)		* Ensure the email settings for your user account are filled in (Human Resources → User Accounts → Select User → Email Settings)

	* Click the [[File:Email report.png\|frameless]] button in the top left corner]		* Click the [[File:Email report.png\|frameless]] button in the top left corner
	* This will open up the default email app (you can select which one to use), along with a copy of the report as a PDF already attached		* This will open up the default email app (you can select which one to use), along with a copy of the report as a PDF already attached

Nick at 08:14, 22 February 2023

2023-02-22T08:14:32Z

← Older revision		Revision as of 08:14, 22 February 2023
Line 57:		Line 57:

	Generating the report will open the report preview window, from which you view, print, or save to PDF. Additionally, if you have the "Design Reports" [[Security Token]], then there will also be a pencil icon, which you can click to edit the report in the designer, allowing for a quick backwards and forwards between the design and preview modes. Additionally, since generating the report allows means there is now data to print from, it is often easier to design a report by first printing it to give it some data to work with, and then designing from the preview window, allowing you to see the changes that you make by clicking "Preview".		Generating the report will open the report preview window, from which you view, print, or save to PDF. Additionally, if you have the "Design Reports" [[Security Token]], then there will also be a pencil icon, which you can click to edit the report in the designer, allowing for a quick backwards and forwards between the design and preview modes. Additionally, since generating the report allows means there is now data to print from, it is often easier to design a report by first printing it to give it some data to work with, and then designing from the preview window, allowing you to see the changes that you make by clicking "Preview".

			== Emailing Reports ==

			* Ensure the email settings for your user account are filled in (Human Resources → User Accounts → Select User → Email Settings)

			* Click the [[File:Email report.png\|frameless]] button in the top left corner]
			* This will open up the default email app (you can select which one to use), along with a copy of the report as a PDF already attached

Nick at 09:11, 2 February 2023

2023-02-02T09:11:17Z

← Older revision		Revision as of 09:11, 2 February 2023
Line 3:		Line 3:
	== Creating a Report ==		== Creating a Report ==
	[[File:Report Manager Button.png\|thumb\|310x310px\|The button to open the Report Manager]]		[[File:Report Manager Button.png\|thumb\|310x310px\|The button to open the Report Manager]]
	To create a report, you will need the "Design Reports" [[Security Token]].		To create a report, you will need the "Design Reports" [[Security Tokens\|Security Token]]. Then, simply navigate to any screen on PRS, and click "Setup -> Reports", as displayed in the picture. This will open up a new grid, from which you can create new report templates. Each report template in this grid acts as a "template" for the report; it tells PRS how to display the data. To create a new report, simply click the "+" button down the bottom, and fill in the required fields.
	Then, simply navigate to any screen on PRS, and click "Setup -> Reports", as displayed in the picture. This will open up a new grid, from which you can create new report templates. Each report template in this grid acts as a "template" for the report; it tells PRS how to display the data. To create a new report, simply click the "+" button down the bottom, and fill in the required fields.

	=== Fields ===		=== Fields ===

Kenric: /* Creating a Report */

2023-01-10T01:07:31Z

Creating a Report

← Older revision		Revision as of 01:07, 10 January 2023
Line 4:		Line 4:
	[[File:Report Manager Button.png\|thumb\|310x310px\|The button to open the Report Manager]]		[[File:Report Manager Button.png\|thumb\|310x310px\|The button to open the Report Manager]]
	To create a report, you will need the "Design Reports" [[Security Token]].		To create a report, you will need the "Design Reports" [[Security Token]].
	Then, simply navigate to any screen on PRS, and click ~~the little arrow in the ribbon bar at the top~~, as displayed in the picture. This will open up a new grid, from which you can create new report templates. Each report template in this grid acts as a "template" for the report; it tells PRS how to display the data. To create a new report, simply click the "+" button down the bottom, and fill in the required fields.		Then, simply navigate to any screen on PRS, and click "Setup -> Reports", as displayed in the picture. This will open up a new grid, from which you can create new report templates. Each report template in this grid acts as a "template" for the report; it tells PRS how to display the data. To create a new report, simply click the "+" button down the bottom, and fill in the required fields.

	=== Fields ===		=== Fields ===

Kenric: /* Using Data */

2022-12-16T02:05:30Z

Using Data

← Older revision		Revision as of 02:05, 16 December 2022
Line 2:		Line 2:

	== Creating a Report ==		== Creating a Report ==
			[[File:Report Manager Button.png\|thumb\|310x310px\|The button to open the Report Manager]]
	To create a report, you will need the "Design Reports" [[Security Token]].		To create a report, you will need the "Design Reports" [[Security Token]].
	Then, simply navigate to any screen on PRS, and click the little arrow in the ribbon bar at the top, as displayed in the picture. This will open up a new grid, from which you can create new report templates. Each report template in this grid acts as a "template" for the report; it tells PRS how to display the data. To create a new report, simply click the "+" button down the bottom, and fill in the required fields.		Then, simply navigate to any screen on PRS, and click the little arrow in the ribbon bar at the top, as displayed in the picture. This will open up a new grid, from which you can create new report templates. Each report template in this grid acts as a "template" for the report; it tells PRS how to display the data. To create a new report, simply click the "+" button down the bottom, and fill in the required fields.
Line 31:		Line 31:

	The report can be previewed from the designer. Click on "File -> Preview..." This will preview the current report as you've designed it. Note that this does not save the report, so don't forget to return to the designer and hit the save button to ensure your changes are committed. Also, if you loaded the report from the PRS ribbon, instead of the report manager (see [[#Printing Reports\|Printing Reports]]), then this preview will use the data that was loaded when printing the report.		The report can be previewed from the designer. Click on "File -> Preview..." This will preview the current report as you've designed it. Note that this does not save the report, so don't forget to return to the designer and hit the save button to ensure your changes are committed. Also, if you loaded the report from the PRS ribbon, instead of the report manager (see [[#Printing Reports\|Printing Reports]]), then this preview will use the data that was loaded when printing the report.
			[[File:Choose data.png\|thumb\|Choose Report Data]]

	=== Selecting Data ===		=== Selecting Data ===
Line 45:		Line 46:

	=== Using Data ===		=== Using Data ===
			[[File:Data window.png\|thumb\|216x216px\|Data window]]
	On the right-hand side of the designer is a "Data" window (if this is not present, click on "View -> Data"). From here you can get data to be displayed in the report. Expand the "Data Sources" menu and you will see a list of the tables you have loaded. Expand any one of them, and then you will see a collection of fields you can select from. To use a field, click and drag from this window over onto the report. For many types of data, this will automatically create a label filled with a placeholder that tells the report engine that you intend to use a data field here. (The syntax for this placeholder is the table name, followed by a dot, followed by the field name, and surrounded in square brackets - e.g., [Kanban.Title]		On the right-hand side of the designer is a "Data" window (if this is not present, click on "View -> Data"). From here you can get data to be displayed in the report. Expand the "Data Sources" menu and you will see a list of the tables you have loaded. Expand any one of them, and then you will see a collection of fields you can select from. To use a field, click and drag from this window over onto the report. For many types of data, this will automatically create a label filled with a placeholder that tells the report engine that you intend to use a data field here. (The syntax for this placeholder is the table name, followed by a dot, followed by the field name, and surrounded in square brackets - e.g., [Kanban.Title]
			[[File:Data selection arrow.png\|left\|thumb\|110x110px\|Data selection arrow]]
	Also, some data is automatically recognised as an image. For example, if you expand the "CompanyLogo" table, and drag the "Data" field onto the report, it will render as an image using the logo of your company (set in the [[Company Information]] screen). Additionally, dates are recognised as dates, and check boxes (such as the "Private" field for tasks) are rendered as check boxes.		Also, some data is automatically recognised as an image. For example, if you expand the "CompanyLogo" table, and drag the "Data" field onto the report, it will render as an image using the logo of your company (set in the [[Company Information]] screen). Additionally, dates are recognised as dates, and check boxes (such as the "Private" field for tasks) are rendered as check boxes.

Kenric: /* Report Design */

2022-12-16T01:50:18Z

Report Design

← Older revision		Revision as of 01:50, 16 December 2022
Line 38:		Line 38:
	Each table has a number of columns which map to the individual properties of an object, so "Kanban" has columns for its "Number", its "Title", and many others. Each row of the table is a specific object.		Each table has a number of columns which map to the individual properties of an object, so "Kanban" has columns for its "Number", its "Title", and many others. Each row of the table is a specific object.

	It is important to tell PRS what data you need - there exists a vast number of tables that PRS knows how to load, but you will not want PRS to load all this data, since that can take a while. To choose the data you want to report on, navigate to "Data -> Choose Report Data...". This will bring up a menu from which you can select a number of tables to load data for. Several of these are loaded by default, such as the "CompanyInformation" table, "CompanyLogo" table and the table related to the specific data - generating a report for tasks will automatically load the "Kanban" table. Other tables that ''can'' be loaded (but are not by default) are those that are related to the main object. So, since tasks can have associated equipment items, there is also a "Kanban_Equipment" table. The "Kanban_" prefix represents the fact that this is, in a way, a "child table" of "Kanban" - there is a link between the tables. The report designer knows about these relationships between the tables, so the associated relationships can be modelled using the report designer's concepts of Detail Bands (see the [https://www.fast-report.com/public_download/docs/FRNet/online/en/UserManual/en-US/DataBand/MasterDetailRelations.html documentation]). In order to tell PRS to also load the equipment associated with the tasks, check the little box next to "Kanban_Equipment", so that it displays a tick. Then, next time you preview the report, PRS will also load the data required.		It is important to tell PRS what data you need - there exists a vast number of tables that PRS knows how to load, but you will not want PRS to load all this data, since that can take a while. To choose the data you want to report on, navigate to "Data -> Choose Report Data...". This will bring up a menu from which you can select a number of tables to load data for. Several of these are loaded by default, such as the "CompanyInformation" table, "CompanyLogo" table and the table related to the specific data - generating a report for tasks will automatically load the "Kanban" table. Other tables that ''can'' be loaded (but are not by default) are those that are related to the main object. So, since tasks can have associated equipment items, there is also a "Kanban_Equipment" table. The "Kanban_" prefix represents the fact that this is, in a way, a "child table" of "Kanban" - there is a link between the tables. The report designer knows about these relationships between the tables, so the associated relationships can be modelled using the report designer's concepts of Detail Bands (see the [https://www.fast-report.com/public_download/docs/FRNet/online/en/UserManual/en-US/DataBand/MasterDetailRelations.html documentation]). In order to tell PRS to also load the equipment associated with the tasks, check the little box next to "Kanban_Equipment", so that it displays a tick. Then, next time you preview the report (by closing and re-opening the report), PRS will also load the data required.

	Note that the "Kanban_Equipment" table does not load every piece of equipment in PRS - it only loads the equipment items that are related to the tasks that you selected - if only one task was selected to generate the report, then the "Kanban_Equipment" table will have at most ''one'' equipment item, since only one piece of equipment is able to be attached to a task.		Note that the "Kanban_Equipment" table does not load every piece of equipment in PRS - it only loads the equipment items that are related to the tasks that you selected - if only one task was selected to generate the report, then the "Kanban_Equipment" table will have at most ''one'' equipment item, since only one piece of equipment is able to be attached to a task.

	You can also select particular columns from the data selection window, but at this stage this does not cause less data to be loaded - it just prevents it being displayed in the various windows in the report designer and thus removes from view unnecessary fields that clutter up the screen.		You can also select particular columns from the data selection window, but at this stage this does not cause less data to be loaded - it just prevents it being displayed in the various windows in the report designer and thus removes from view unnecessary fields that clutter up the screen.

			=== Using Data ===

			On the right-hand side of the designer is a "Data" window (if this is not present, click on "View -> Data"). From here you can get data to be displayed in the report. Expand the "Data Sources" menu and you will see a list of the tables you have loaded. Expand any one of them, and then you will see a collection of fields you can select from. To use a field, click and drag from this window over onto the report. For many types of data, this will automatically create a label filled with a placeholder that tells the report engine that you intend to use a data field here. (The syntax for this placeholder is the table name, followed by a dot, followed by the field name, and surrounded in square brackets - e.g., [Kanban.Title]

			Also, some data is automatically recognised as an image. For example, if you expand the "CompanyLogo" table, and drag the "Data" field onto the report, it will render as an image using the logo of your company (set in the [[Company Information]] screen). Additionally, dates are recognised as dates, and check boxes (such as the "Private" field for tasks) are rendered as check boxes.

			The data fields can also be set by clicking the little arrow that appears in the top-right of report objects when hovering over them, as shown in the image. If you click on that, you can select a data field for the object (note that the associated data band must be set, see [https://www.fast-report.com/public_download/docs/FRNet/online/en/UserManual/en-US/DataBand/SimpleListReport/PrintDataRows.html the documentation]).

	== Printing Reports ==		== Printing Reports ==

Kenric: /* Report Design */

2022-12-16T01:38:41Z

Report Design

← Older revision		Revision as of 01:38, 16 December 2022
Line 24:		Line 24:
	Reports can be designed from two places in PRS - first, from the Report Manager, where you create new reports (See [[#Creating a Report\|Creating a Report]]). On the right hand-side of this grid, there is a pencil icon, which, if clicked, brings up the report designer.		Reports can be designed from two places in PRS - first, from the Report Manager, where you create new reports (See [[#Creating a Report\|Creating a Report]]). On the right hand-side of this grid, there is a pencil icon, which, if clicked, brings up the report designer.

	The other place that reports can be designed from is the preview window, brought up by clicking on the report in the ribbon (See [[~~Generating~~ Reports]]). From the preview window, click the pencil icon in the top right, and this opens the designer. If designed this way, there is also data pre-loaded into the report, since you have previewed the report. This means that you can design the report and then preview with data already loaded, assisting you to design based on how the end product will look with data.		The other place that reports can be designed from is the preview window, brought up by clicking on the report in the ribbon (See [[#Printing Reports\|Printing Reports]]). From the preview window, click the pencil icon in the top right, and this opens the designer. If designed this way, there is also data pre-loaded into the report, since you have previewed the report. This means that you can design the report and then preview with data already loaded, assisting you to design based on how the end product will look with data.

	PRS uses the [https://www.fast-report.com/en/ FastReport] engine and designer for its reporting system, and so details on how to use the report designer can be found on their [https://www.fast-report.com/public_download/docs/FRNet/online/en/UserManual/en-US/Fundamentals.html online documentation]. That being said, there are several important points that can be mentioned here as well.		PRS uses the [https://www.fast-report.com/en/ FastReport] engine and designer for its reporting system, and so details on how to use the report designer can be found on their [https://www.fast-report.com/public_download/docs/FRNet/online/en/UserManual/en-US/Fundamentals.html online documentation]. That being said, there are several important points that can be mentioned here as well.

Kenric: /* Report Design */

2022-12-16T01:38:23Z

Report Design

← Older revision		Revision as of 01:38, 16 December 2022
Line 22:		Line 22:
	== Report Design ==		== Report Design ==

	Reports can be designed from two places in PRS - first, from the Report Manager, where you create new reports (See [[Creating ~~Reports~~]]). On the right hand-side of this grid, there is a pencil icon, which, if clicked, brings up the report designer.		Reports can be designed from two places in PRS - first, from the Report Manager, where you create new reports (See [[#Creating a Report\|Creating a Report]]). On the right hand-side of this grid, there is a pencil icon, which, if clicked, brings up the report designer.

	The other place that reports can be designed from is the preview window, brought up by clicking on the report in the ribbon (See [[Generating Reports]]). From the preview window, click the pencil icon in the top right, and this opens the designer. If designed this way, there is also data pre-loaded into the report, since you have previewed the report. This means that you can design the report and then preview with data already loaded, assisting you to design based on how the end product will look with data.		The other place that reports can be designed from is the preview window, brought up by clicking on the report in the ribbon (See [[Generating Reports]]). From the preview window, click the pencil icon in the top right, and this opens the designer. If designed this way, there is also data pre-loaded into the report, since you have previewed the report. This means that you can design the report and then preview with data already loaded, assisting you to design based on how the end product will look with data.