Report Designer User Guide - Revision history

Dina at 13:38, 8 July 2020

2020-07-08T13:38:36Z

← Older revision		Revision as of 13:38, 8 July 2020
Line 1:		Line 1:
	{{usermanuals}}		{{usermanuals}}
	==Introduction==		==Introduction==
	~~CommitCRM~~ reports can be customized in two ways:		RangerMSP reports can be customized in two ways:
	#'''Edit the header''' - You can set or modify a header (text and image) for all reports at once. See more details in [[Report Designer User Guide#Editing Report Header\|Editing Report Header]].		#'''Edit the header''' - You can set or modify a header (text and image) for all reports at once. See more details in [[Report Designer User Guide#Editing Report Header\|Editing Report Header]].
	#'''Design reports data and layout''' – You can customize the layout and data of any report to fit your needs using the Report Designer. You should first copy the report to you ''Custom'' reports, and then Click ''Design'' to open the Report Designer.		#'''Design reports data and layout''' – You can customize the layout and data of any report to fit your needs using the Report Designer. You should first copy the report to you ''Custom'' reports, and then Click ''Design'' to open the Report Designer.
Line 12:		Line 12:

	==Reports Preferences==		==Reports Preferences==
	The Reports Preferences window allows you to adjust global options available in the system. Any of the settings configured in this window will only take effect once ~~CommitCRM~~ has been restarted on that computer.		The Reports Preferences window allows you to adjust global options available in the system. Any of the settings configured in this window will only take effect once RangerMSP has been restarted on that computer.
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
Line 36:		Line 36:

	===Reports Textual Header===		===Reports Textual Header===
	The Textual Header contains your company details. The header gets its default content from the company information you’ve entered when the system was set up right after the installation. The text you set in this window will be automatically used in all ~~CommitCRM~~ reports that have the header section enabled.		The Textual Header contains your company details. The header gets its default content from the company information you’ve entered when the system was set up right after the installation. The text you set in this window will be automatically used in all RangerMSP reports that have the header section enabled.

	To edit the textual header:		To edit the textual header:
Line 59:		Line 59:

	===Reports Image Header===		===Reports Image Header===
	Starting with ~~CommitCRM~~ 6.0, the Image Header can contain an image, usually used for displaying your company logo. The image you choose in this window will be automatically displayed in all ~~CommitCRM~~ reports that have the header section enabled.		Starting with RangerMSP 6.0, the Image Header can contain an image, usually used for displaying your company logo. The image you choose in this window will be automatically displayed in all RangerMSP reports that have the header section enabled.

	To add an Image File to the Header:		To add an Image File to the Header:
Line 84:		Line 84:

	==Loading The Report Designer==		==Loading The Report Designer==
	The report Designer can be accessed by copying an existing report that is similar to the report you want to generate and then designing it. It is very important to identify an existing report which can serve as the basis for the customized report you wish to generate. You must take into consideration when choosing the report both its layout and its data structure. Every report has predefined data source relations and fields that can be selected. To customize ~~CommitCRM~~ reports, open the Reports window, select the report you want to customize, select Copy from the toolbar and enter your new report name. The copied report will be selected. Select the Design button from the toolbar, and the report designer will open.<br>		The report Designer can be accessed by copying an existing report that is similar to the report you want to generate and then designing it. It is very important to identify an existing report which can serve as the basis for the customized report you wish to generate. You must take into consideration when choosing the report both its layout and its data structure. Every report has predefined data source relations and fields that can be selected. To customize RangerMSP reports, open the Reports window, select the report you want to customize, select Copy from the toolbar and enter your new report name. The copied report will be selected. Select the Design button from the toolbar, and the report designer will open.<br>
	:*Open ~~CommitCRM~~, and go to the '''Reports Screen'''.		:*Open RangerMSP, and go to the '''Reports Screen'''.
	:*Select the base report that you will be editing to your own needs.		:*Select the base report that you will be editing to your own needs.
	::*The base report can be selected from System based or Custom based reports.		::*The base report can be selected from System based or Custom based reports.
Line 157:		Line 157:
	====Data Components====		====Data Components====
	[[File:Data.png\|center]]<br><!-- replace -->		[[File:Data.png\|center]]<br><!-- replace -->
	The data components are the items used to insert data from the ~~CommitCRM~~ Database into your report. These fields cross reference and list the data in the reports that you will later use to present to your customers, and use in the office to organize the workflow not just for you, but your whole business. These reports include technician service summary quotations, charge lists, account history printouts, Charts, lists, and much more. <br>		The data components are the items used to insert data from the RangerMSP Database into your report. These fields cross reference and list the data in the reports that you will later use to present to your customers, and use in the office to organize the workflow not just for you, but your whole business. These reports include technician service summary quotations, charge lists, account history printouts, Charts, lists, and much more. <br>
	'''The items in the toolbar are as follows'''(By order of Left to Right):		'''The items in the toolbar are as follows'''(By order of Left to Right):
	{\| class="wikitable"		{\| class="wikitable"
Line 183:		Line 183:
	\|-		\|-
	\| '''DBChart '''		\| '''DBChart '''
	\| This tool allows you to insert a chart into your report that calculates all the entries in report and displays the results in an easily readable report. Customers love these things… This is an advanced option and may be difficult to fine tune. We suggest using them as they are in reports that already have them, or to [[Import_and_Export_FAQ#~~Can_I_export_data_from_CommitCRM~~.3F\|export your data]] to Excel and use Excel’s charting tools, for more powerful features. Alternatively, if you're an advanced user, you can configure the [[API_Developers_Guide\|~~CommitCRM~~ ODBC Connector]] to serve as an information conduit from the ~~CommitCRM~~ database right into your Excel Charts.		\| This tool allows you to insert a chart into your report that calculates all the entries in report and displays the results in an easily readable report. Customers love these things… This is an advanced option and may be difficult to fine tune. We suggest using them as they are in reports that already have them, or to [[Import_and_Export_FAQ#Can_I_export_data_from_RangerMSP.3F\|export your data]] to Excel and use Excel’s charting tools, for more powerful features. Alternatively, if you're an advanced user, you can configure the [[API_Developers_Guide\|RangerMSP ODBC Connector]] to serve as an information conduit from the RangerMSP database right into your Excel Charts.
	\|-		\|-
	\| '''DB2DBarCode'''		\| '''DB2DBarCode'''
Line 213:		Line 213:
	\|-		\|-
	\|		\|
	\| '''Note:''' Each Sub Report uses their own data sources and should be used carefully, it's generally recommended to use already-existing sub reports when available. '''Creating new sub reports should be consulted with the ~~CommitCRM~~ support team to assure best results'''.		\| '''Note:''' Each Sub Report uses their own data sources and should be used carefully, it's generally recommended to use already-existing sub reports when available. '''Creating new sub reports should be consulted with the RangerMSP support team to assure best results'''.
	\|}		\|}

Line 447:		Line 447:
	<br>		<br>
	====Data Source====		====Data Source====
	The ''Data'' menu option provides access to the Data Source available for this report. Different report types come with different available fields. Database field is a field of information stored in the ~~CommitCRM~~ database. These represent information in the database, which you’d like to have displayed in your reports. The available database fields list varies according to the report type.		The ''Data'' menu option provides access to the Data Source available for this report. Different report types come with different available fields. Database field is a field of information stored in the RangerMSP database. These represent information in the database, which you’d like to have displayed in your reports. The available database fields list varies according to the report type.

	Each report has a pre-defined list of available fields according to the report pre-defined design. In most cases, the main category fields are available (e.g. Ticket fields for a Ticket report, Charge fields for a Charge report, Account fields for all reports, etc.), and you may have some select fields from other categories as well (e.g. some based Account fields in a ticket report).		Each report has a pre-defined list of available fields according to the report pre-defined design. In most cases, the main category fields are available (e.g. Ticket fields for a Ticket report, Charge fields for a Charge report, Account fields for all reports, etc.), and you may have some select fields from other categories as well (e.g. some based Account fields in a ticket report).

	Changing the Data Source can change the report behavior, and these settings should only be changed after consulting with the ~~CommitCRM~~ support staff.		Changing the Data Source can change the report behavior, and these settings should only be changed after consulting with the RangerMSP support staff.

	<br>		<br>
Line 491:		Line 491:
	[[File:Subreport1.png\|Center]]<br><br>		[[File:Subreport1.png\|Center]]<br><br>
	[[File:Subreport2.png\|Center\|640 px]]<br>		[[File:Subreport2.png\|Center\|640 px]]<br>
	The sub-reports tool allows you to generate a separated report within your main report, which is ideal for designing a separate part within the report. E.g. if you’re creating a ticket report, and you’d like to have that ticket’s charge report inside, then you’d generate a sub-report for the charge section. The sub-reports function is an advanced function, we recommend to make use of it only in reports which already have these sections within them. Adding your own sub reports can be tricky and should be consulted with the ~~CommitCRM~~ Support team first.		The sub-reports tool allows you to generate a separated report within your main report, which is ideal for designing a separate part within the report. E.g. if you’re creating a ticket report, and you’d like to have that ticket’s charge report inside, then you’d generate a sub-report for the charge section. The sub-reports function is an advanced function, we recommend to make use of it only in reports which already have these sections within them. Adding your own sub reports can be tricky and should be consulted with the RangerMSP Support team first.

	<br>		<br>
Line 510:		Line 510:

	====Technician Service Forms with Charges====		====Technician Service Forms with Charges====
	These reports come predefined with the ability to display information from 3 different data sources (Tickets, Charges and Assets) and consolidate all of them in a single report. By copying the Technician Service Form with Charges, you’ll be able to use it as a template to create any report you like that has access to the main data sources in ~~CommitCRM~~. However, when referring to Charge information, the report must always be saved in the Charges section of the Reports screen, or the information will come up empty.		These reports come predefined with the ability to display information from 3 different data sources (Tickets, Charges and Assets) and consolidate all of them in a single report. By copying the Technician Service Form with Charges, you’ll be able to use it as a template to create any report you like that has access to the main data sources in RangerMSP. However, when referring to Charge information, the report must always be saved in the Charges section of the Reports screen, or the information will come up empty.

	<br>		<br>
Line 535:		Line 535:

	==Frequently Asked Questions==		==Frequently Asked Questions==
	The Report Designers FAQ page also includes lots of useful tips and workflows that would greatly ease the transition into customizing of your ~~CommitCRM~~ reports. For more information see [[Reports_FAQ\|Reports FAQ]].		The Report Designers FAQ page also includes lots of useful tips and workflows that would greatly ease the transition into customizing of your RangerMSP reports. For more information see [[Reports_FAQ\|Reports FAQ]].

	<br>		<br>
Line 542:		Line 542:
	*[[Generating_Reports_User_Guide\|Generating Reports User Guide]]		*[[Generating_Reports_User_Guide\|Generating Reports User Guide]]
	*[[Reports_FAQ\|Reports FAQ]]		*[[Reports_FAQ\|Reports FAQ]]
	*[[Web_Interface#Generating_and_Printing_Reports_Using_the_Web_Interface\|Generating and Printing Reports Using the ~~CommitCRM~~ Web Interface]]		*[[Web_Interface#Generating_and_Printing_Reports_Using_the_Web_Interface\|Generating and Printing Reports Using the RangerMSP Web Interface]]
	*[[Field_Customization\|Field and Tab Customization]]		*[[Field_Customization\|Field and Tab Customization]]


	[[Category:User Manuals]]		[[Category:User Manuals]]

Dina at 10:02, 19 June 2020

2020-06-19T10:02:20Z

← Older revision		Revision as of 10:02, 19 June 2020
Line 6:		Line 6:

	In this document, you will find information about how to use the '''Report Designer''' to customize your reports to fill the needs of your business. You will find here detailed information about the Report Designer toolbars, data groups, headers and footers, and the rest of the tools the Report Designer has to offer you.		In this document, you will find information about how to use the '''Report Designer''' to customize your reports to fill the needs of your business. You will find here detailed information about the Report Designer toolbars, data groups, headers and footers, and the rest of the tools the Report Designer has to offer you.

	Make sure to watch the '''[http://www.commitcrm.com/videos/commit_report_designer_tutorial_video.htm CommitCRM Report Designer Tutorial]''' which will guide you through a basic report design process and show you how you can change the report layout and add new fields to the report.

	<br>		<br>
Line 105:		Line 103:
	In this view, you are free to manipulate the position or size of any of the text labels or the data components. In the Default view shipped with the designer, you’ll notice there is a single tab (multiple tabs in some reports), the lower part of the screenshot above, your layout in the middle. Also, you’ll see several visible toolbars in a grouped configuration, there are also a number of hidden toolbars, with twelve toolbars available in total. These toolbars are as follows.		In this view, you are free to manipulate the position or size of any of the text labels or the data components. In the Default view shipped with the designer, you’ll notice there is a single tab (multiple tabs in some reports), the lower part of the screenshot above, your layout in the middle. Also, you’ll see several visible toolbars in a grouped configuration, there are also a number of hidden toolbars, with twelve toolbars available in total. These toolbars are as follows.

	~~For a video illustrating the finer points of customizing CommitCRM reports, '''[http://www.commitcrm.com/videos/commit_report_designer_tutorial_video.htm Please click here]'''.~~

	<br>		<br>
Line 547:		Line 544:
	*[[Web_Interface#Generating_and_Printing_Reports_Using_the_Web_Interface\|Generating and Printing Reports Using the CommitCRM Web Interface]]		*[[Web_Interface#Generating_and_Printing_Reports_Using_the_Web_Interface\|Generating and Printing Reports Using the CommitCRM Web Interface]]
	*[[Field_Customization\|Field and Tab Customization]]		*[[Field_Customization\|Field and Tab Customization]]
	*[http://www.commitcrm.com/videos/commit_report_designer_tutorial_video.htm Report Designer Tutorial Video]

	[[Category:User Manuals]]		[[Category:User Manuals]]

Dina at 18:27, 21 March 2020

2020-03-21T18:27:24Z

← Older revision		Revision as of 18:27, 21 March 2020
Line 186:		Line 186:
	\|-		\|-
	\| '''DBChart '''		\| '''DBChart '''
	\| This tool allows you to insert a chart into your report that calculates all the entries in report and displays the results in an easily readable report. Customers love these things… This is an advanced option and may be difficult to fine tune. We suggest using them as they are in reports that already have them, or to [[Import_and_Export_FAQ#Can_I_export_data_from_CommitCRM.3F\|export your data]] to Excel and use Excel’s charting tools, for more powerful features. Alternatively, if you're an advanced user, you can configure the [[~~Commit_API_Developers_Guide~~\|CommitCRM ODBC Connector]] to serve as an information conduit from the CommitCRM database right into your Excel Charts.		\| This tool allows you to insert a chart into your report that calculates all the entries in report and displays the results in an easily readable report. Customers love these things… This is an advanced option and may be difficult to fine tune. We suggest using them as they are in reports that already have them, or to [[Import_and_Export_FAQ#Can_I_export_data_from_CommitCRM.3F\|export your data]] to Excel and use Excel’s charting tools, for more powerful features. Alternatively, if you're an advanced user, you can configure the [[API_Developers_Guide\|CommitCRM ODBC Connector]] to serve as an information conduit from the CommitCRM database right into your Excel Charts.
	\|-		\|-
	\| '''DB2DBarCode'''		\| '''DB2DBarCode'''

Robert: /* Groups */

2014-03-05T14:36:47Z

Groups

← Older revision		Revision as of 14:36, 5 March 2014
Line 459:		Line 459:
	====Groups====		====Groups====
	Groups are containers used to divide the sections of a report. Some sections can be static, their components never grow. Some groups can have lists taken from the database, and run with it for many pages. These groups are inserted from the groups window, located in the reports menu. (Please see screenshots).<br>		Groups are containers used to divide the sections of a report. Some sections can be static, their components never grow. Some groups can have lists taken from the database, and run with it for many pages. These groups are inserted from the groups window, located in the reports menu. (Please see screenshots).<br>
	:::::::::::[[File:Groups.~~jpg~~]][[File:Groups_window.png]]<br><br> <!-- replace -->		:::::::::::[[File:Groups.png]][[File:Groups_window.png]]<br><br> <!-- replace -->
	In this window, you can see a list of existing groups (if any), and you can select the field to group them by from the dropdown menu above the list.		In this window, you can see a list of existing groups (if any), and you can select the field to group them by from the dropdown menu above the list.
	Once you’ve selected your group, you can insert 1 or more of those groups. These groups get placed in your report, and can be set to dynamic or static height, by right clicking a group separator. Each group will divide the report in to separate sections (Header, Footer, Summary, Detail, etc.). some sections show up on every page, and some groups only show up on the first or last pages, so you should take this into consideration when inserting components, so you know where the best place to place it is, so that it shows up as many times as you need.		Once you’ve selected your group, you can insert 1 or more of those groups. These groups get placed in your report, and can be set to dynamic or static height, by right clicking a group separator. Each group will divide the report in to separate sections (Header, Footer, Summary, Detail, etc.). some sections show up on every page, and some groups only show up on the first or last pages, so you should take this into consideration when inserting components, so you know where the best place to place it is, so that it shows up as many times as you need.

Robert: /* Align or Space */

2014-03-05T14:34:18Z

Align or Space

← Older revision		Revision as of 14:34, 5 March 2014
Line 355:		Line 355:

	====Align or Space====		====Align or Space====
	[[File:~~Allign~~.png\|center]]		[[File:Align.png\|center]]
	These tasks are used to reposition the selected component/s with a stipulation. This makes organizing the report much easier to keep orderly.		These tasks are used to reposition the selected component/s with a stipulation. This makes organizing the report much easier to keep orderly.
	'''The items in the toolbar are as follows''' (By order of Left to Right):		'''The items in the toolbar are as follows''' (By order of Left to Right):

Robert: /* Hidden ToolBars */

2014-03-05T14:32:59Z

Hidden ToolBars

← Older revision		Revision as of 14:32, 5 March 2014
Line 288:		Line 288:
	The hidden toolbars must be opened to be used. There are 2 ways to open them. The first way is from '''View menu > Toolbars''', and the second method is to right-click an existing toolbar and select from the context menu that shows up.		The hidden toolbars must be opened to be used. There are 2 ways to open them. The first way is from '''View menu > Toolbars''', and the second method is to right-click an existing toolbar and select from the context menu that shows up.
	The menus hidden by default are as follows:		The menus hidden by default are as follows:
	<br>[[File:Menu.~~jpg~~\|center]] <!-- replace -->		<br>[[File:Menu.png\|center]] <!-- replace -->

	<br>		<br>

Robert at 15:02, 7 February 2014

2014-02-07T15:02:22Z

Show changes

Robert: moved Report Designer User Guide - old to Report Designer User Guide over redirect

2014-02-07T14:58:57Z

moved Report Designer User Guide - old to Report Designer User Guide over redirect

← Older revision	Revision as of 14:58, 7 February 2014
(No difference)

Robert: moved Report Designer User Guide to Report Designer User Guide - old

2014-02-07T14:57:08Z

moved Report Designer User Guide to Report Designer User Guide - old

← Older revision	Revision as of 14:57, 7 February 2014
(No difference)

Robert at 11:02, 1 September 2013

2013-09-01T11:02:38Z

← Older revision		Revision as of 11:02, 1 September 2013
Line 201:		Line 201:
	\|-		\|-
	\|		\|
	\| '''Note:''' Each Sub Report uses their own data sources and should be used carefully, it's generally recommended to use already-existing sub reports when available. '''Creating new sub reports should be consulted with the ~~Commit~~ support team to assure best results'''.		\| '''Note:''' Each Sub Report uses their own data sources and should be used carefully, it's generally recommended to use already-existing sub reports when available. '''Creating new sub reports should be consulted with the CommitCRM support team to assure best results'''.
	\|}		\|}

Line 497:		Line 497:
	*[[Generating_Reports_User_Guide\|Generating Reports User Guide]]		*[[Generating_Reports_User_Guide\|Generating Reports User Guide]]
	*[[Reports_FAQ\|Reports FAQ]]		*[[Reports_FAQ\|Reports FAQ]]
	*[[Web_Interface#Generating_and_Printing_Reports_Using_the_Web_Interface\|~~Genetating~~ and Printing Reports Using the ~~Commit~~ Web Interface]]		*[[Web_Interface#Generating_and_Printing_Reports_Using_the_Web_Interface\|Generating and Printing Reports Using the CommitCRM Web Interface]]
	*[[Field_Customization\|Field and Tab Customization]]		*[[Field_Customization\|Field and Tab Customization]]
	*[http://www.commitcrm.com/videos/commit_report_designer_tutorial_video.htm Report Designer Tutorial Video]		*[http://www.commitcrm.com/videos/commit_report_designer_tutorial_video.htm Report Designer Tutorial Video]

	[[Category:User Manuals]]		[[Category:User Manuals]]