Customizing Reports

From High5Wiki
Jump to: navigation, search
Reports Center

Purpose of this document is the further explain the different options under the Customize Reports section of SME. Most reports can be run from their respective modules. While other details reports, like the Aging and Tax Reports are actually ran from the Reports Module.

Document Center Overview Main Screen
The main function of the document center is that of a central repository which will allow you to keep track of external documents you deem important, as well as any reports templates you want to create for SME.

Option Found on the Main Screen (Details and Settings)

Short Name

Short Name is internal name of the document for SME.


In some reports it is possible to generate a title on the fly. Which will be explained in detail later in this document.

File Name

This is the physical name of the file.


General description of what the file is used for.

Is Restricted

Checking this makes it so only an administrator can view this report.

File Name

This is the physical name of the file.

Is External

Used to determine if this is an SME report builder report, or an external report or document.

Duplicate Report

This creates a new entry in the Docs table, with all same information as above. (Used for making a custom aging report).

Report Designer

Used to Launch Report Designer.

The Availability tab allows you to allow you to choose where a report will be located when you want to print the report, as well as its location under the Reports Module.

Reports Specifiers
The Report Specifiers tab function is your main options in setting up Reports for SME to use. This includes filters, Main table, as well other options as explained below.

Master Table This is the main table from which data will be pulled from. Also note that all filters
applied are against the master table.

Another thing to note about master table, is that certain tables, such as Service Orders,
Install Orders, Invoices, and Proposals will bring in all the other related tables.

Date Specifier This option is to be used when you want to apply filter on reports by a date range. Now
this can be either a single date range, or Beginning and Ending Date range. Date field
will be determined by what you pick as your master table. Note: Running the report with
filters is done though the Reports Module.
Status Specifier Just like the Date Specifier the status specifier acts as a filter true or false
fields. Example of this would be the Active vs Inactive Customer.
Alternative Column Format Currently not in use.
Email Option Available This will give you the option to email report both in the Reports Module as well as
report specific module when active.
Show on Module Print Menu When enabled it will, and you have the security clearance you will see the report under
the Print button found in any module. Note to determine which module a report will be
printed in is set by the Availability tab.
This is a Service and Install
Currently not used
Allow Queries for this Report This allows you to setup your own query. This is always against the Master Table. This
also needs to be run in the Reports Module.
Allow Indexes Change In report where you are using grouping. You will be able to change what is the original
index to something else. Visible in Reports Module.
Allow Save Query This will allow you to save a query after its run. Note that you can run the query once,
then uncheck it so that the query always exist.Done in Reports Module.
Allow on Print Package This will enable the report to show on Print Package for the module it is in.
Index Name The default index used when Printing a report that is using groups.

Details Specifiers
The purpose of the detail specifier tab is to setup the pipes to other tables. This is done by connecting the Primary Key of the Master table, with the Foreign Key of Detail Table. As well as connect Details Detail table to the Detail table. Note: In report designer each table you choose will show up under the Data Pipes.

Details -> Master

Details Table This is where you set the table you will be adding to addition to the master table.
Details Index This is the Foreign Key inside the Details table that relates back to the master table.
Master Table Linking Field This is the Index from the Master table you are using.

Details Detail-> Details Link

Details Table This is the table that will be linked to the Details Table
Details Index This Foreign Key found within the Details Detail table
Detail Linking Field This is the field in the Details table that will be link from the Details Index.

Specified Links
Once accept your link the new link will show up in the Specified links in the following format. Details Table, Details Detail Table, Details Index, Master Index, Details Detail Index, Detail Linking Field.

Hints to Linking Reports
One thing to know about linking reports is that you can bring in as many reports as possible. You are not limited one Details and Details Detail. Each entry will show up in the Specified Links.

Try to use the highest level table as the master table in relation to what you are looking for in your data. If your report is based off Service Orders, the master table should then be ServiceOrders. Also to note any filters applied to a report before processing is based off the Master table.

All tables have a UID attribute. This is the primary key for that table. Many tables have one than more foreign key. All Foreign key will have the word UID in there name. Example of this is that CustUID can be found in the ServiceOrders, thus you can connect Customers with ServiceOrders. When linking tables you will always want do this by UIDs.

The Master Table by default is the whole of the Report Document. Any reports with multiple entries in details table will need placed in a sub report. Good example of this with ServiceOrder and ServiceOrderMaterials. To see all your materials you will need to place your materials in a sub report.

Few tables can be linked in the details detail table. If you are unable to access any drop down, it is because this table is not a secondary table.

To set up a report where you can change the title all you will need to do is make sure that label used in SME is pulling from the SystemsDefaults> ReportTitle. SME will always use the Default time unless it is changed in the Reports Module.

See ReportBuilder for information on the Report Builder tool. You can also download a pdf called "Learn Report Builder" from here: