Based on experience, we've learned that users' preferences and needs for reporting vary considerably. For example, one previous product, offered approximately 600 standard reports and included two different built-in report-writing programs for users. Given this, we still received frequent requests for custom reports, few users made use of the report writing functions, and the large number of reports made finding the "right" report cumbersome for many users.

For the Spruce product, we took a different approach to reporting by offering a select set of reports considered necessary for basic operation. Because all data is maintained by a SQL database, a wide variety of data mining and custom reporting is possible when needed. To assist users, there are many reporting tools available from third party providers and reference materials available for learning basic SQL syntax or using the various reporting tools. One reporting tool, Crystal Reports® software may optionally be included in sales contracts. It is also possible to obtain software that provides the ability to use, but not modify, Crystal Reports report files. In some cases, these applications are free of charge.

If a company needs additional reporting options, they can either (1) make use of the many free Crystal Reports® and ActiveReports® templates available from the "software downloads" section of our Customer Portal, (2) create queries that pull data from the SQL database, or (3) write their own reports using reporting software that can be used along with SQL data (such as Crystal Reports software). All options require computer skills and an understanding of the database structure.

We hope that the basic report set, over 50 standard reports, be as useful as possible. Many included reports offer variations that are essentially distinct reports as well. If the standard set of reports doesn't meet preferences or needs, please check our support portal for templates (over 200 additional reports) for something useful, or consider the other options presented here. Free report viewers are also available which allow you to link and run report templates, but don't allow changes to the reports or the ability to create new reports.

Why doesn't the application offer its own reporting tool?

The reality is, that regardless of the tool, there is always going to be a technical aspect to report writing. Designing reports is not for everybody, and it is always going to require thought, time, and effort. Reporting needs to provide methods for calculations, selection conditions, sorting, totals and sub-totals, page-breaks, and anything else that users would need or want. These functions are already provided for by Crystal Reports, ActiveReports, and other reporting software. Any tool that we would design would not be any better or less complex than what's out there currently. The Help documentation offers a walk-through and tips in the topic Data Structure and Reporting.

What if I need reports, but don't have time to write them myself?

If your company needs additional reporting options that are not provided in the application or as existing templates on our web site, there are some choices. We have personnel who can do report writing as a billable service using Crystal Reports. Companies can also seek out third party providers familiar with SQL and/or reporting software that integrates with the SQL database. We also offer a SQL Inquiry utility that can be used to gather information based on conditions you specify; however, this is used for document selection and does not produce a report.

Timing and Reports

Most reports use data that is calendar or date-based. This allows a great deal of flexibility because reports can be run for any range of dates. In fact, historical data was designed to not be maintained as lump sum totals specifically for this reason. However, it is important to point out that just because historical data is calendar date-based, it doesn't mean that report data can't change. Modifications to data records which are linked with the history (such as items, vendors, and customers) can have an effect on reporting. For example, a stock valuation run for a particular product group could change if an item within the group is modified to another product group after running the report. The valuation for the item isn't lost, but it would no longer appear under the original group.

When it's important for report to represent a specific time period accurately, it's a good idea to generate and save any needed report as a file (PDF) at the actual end of that period (year, month, etc.). This provides a snapshot in time and helps to ensure that later changes to your data records won't change where or how figures might be represented on reports. Reports can be scheduled to run for specific times and dates, so it's not necessary to be physically be present in order to process reports for a specific date-time.

Reporting Elements

Every report in the application has similar elements such as tools for print & file creation, headings, totals, sorting, selection, and filters. The choices within these elements vary by report; however, basic function is consistently applied. Users who learn to run one report should easily gain an understanding of these elements that can be applied to running all the reports found in the application.

Here's a visual break down of a typical report screen with labels:

Title and Headings

The report's title and headings display near the top of the report settings window. The report's headings reflect the data that will be printed on the report, so they are an easy way to get a quick idea about what a report is going to show. In some cases, reports also provide styles, or variations, which have radio buttons that can be used to change the report format. When done, the headings adjust to reflect the selected format(s).

Selection

Selection is often required and provides criteria that limits which data is to be included when the report is created. As one example, dates are a common selection choice. For example, an open orders summary might be run using a date range to limit the report to a particular time period. For specific information about other selection criteria offered, please see the documentation for the report in question.

Branch

Some reports offer branch selection and you can apply branch selection in a number of different ways. For example, invoices can have several branches associated with them. A given invoice might have an entry branch, sales branch, and materials branch that are each different locations. Reports each use branch selections differently based on the type of data being referenced, and for some businesses, branch selection may not apply.

Selected branches are indicated by the checked status of the check box controls next to the branch ID. The Context Marker provides the ability to select the current branch, or select/clear all branch selections. In addition, this can be used to perform branch selection based on a Branch List. Branch lists can be created from the Maintenance area's Database menu. If you choose a branch list, the branches belonging to that list will be selected.

Once a branch list has bee selected, the list name is listed (in parentheses) and the list of branches is disabled. To allow changes, deselect the same list from the Context Marker menu .

Additional Options

A few reports offer additional options for use along with branch selection. These either alter the report format based on how you want branch records presented (consolidation) or allow selection when more than one branch may be indicated within the data being reported (quantity vs. sales branch, for example). For additional information about these "extra" options, click here.

Filter On

In some ways, filters are similar to selection tools. They both can be used to limit data. Filters set a condition that must be met before data is included on the report. The following example shows filter choices for an A/P (accounts payable) report that lists invoices. The radio buttons can be used to select which invoices will be included within the selections already designated. In this case, the report is using the status of the invoice to determine whether it is either included or excluded. Filter options aren't available on all reports and vary for each report.

Sort By

Some reports offer sorting options that may be used in addition to, or in place of, the report's default sorting. Sorting determines the order that information appears on the report, but also can determine how subtotals (when enabled) are done. Typically, subtotals are provided for any sort by selections when subtotals are indicated in the "Totals" panel. If sorting is not available for a report, the panel will be disabled and neither offer nor allow selection.

Two (2) sorting selections may be available; however, both are not always provided. When both are enabled for a report, the top selection is considered the "primary" sort and the bottom is considered a "secondary" sort. Usually, all sort selections are optional. Options for sorting vary by report.

Sort Direction

The menu marker can be used to select the sorting direction, either ascending (the default) or descending. Almost always, data is sorted alphanumerically. This may even be done in some cases when the data being sorted appears to be numeric in value. Date values and some truly numeric values are sorted based on value rather than alphanumerically in certain cases. When alphanumeric data is sorted in ascending order, it is sorted from the left-most character to the right-most character based on the ASCII value. The length in characters typically has no effect on sorting in these cases. Most (not all) symbols and special characters are listed before numerals, numerals typically appear before letters, and upper-case letters are listed before lower-case. When sorted (alphanumerically) in descending order, this ordering is reversed. Sometimes, particularly in the case of items, a "report" or "sorting" key is used in place of item numbers. This allows a company to control sorting while not having to alter their item SKUs. The sorting (report) key isn't always shown (listed) on the report or in other areas where it affects sorting.

Below is a table listing item numbers in ascending vs. descending order. In most cases, items are sorted using their "report sequence" not the item number. Report sequence allows grouping of items in a logical order vs. the alpha-numeric order of the SKU and are commonly used when item numbers represent dimensions or other attributes. For example, you might have two item SKUs of "248" and "2410." The "248" represents an 8 foot (8') length and the "2410" a ten foot (10') length. If these two (2) items were sorted by item SKU, the longer length would appear before the shorter length due to alpha-numeric sorting; however, if you assigned a "report key" to the items of "020408" and "020410" respectively, they would instead be sorted by length. Note the use of leading zeros for each dimension (height, width, and length in this case).

Ascending	Descending
020408SYP	ZITEM
248	BRICK
808957	808957
BRICK	248
ZITEM	020408SYP

Totals Selections

Some reports provide the ability to produce totals, and sometimes, this includes subtotals as well. The "Totals" panel, used with reporting, allows users to select the types of totals they want (when applicable). When totals are offered, the term "grand totals" refers to an overall total appearing at the end of the report. Subtotals are sometimes available, but are usually done based upon your selections in the "Sort By" panel. Subtotals may not be done in cases where no "Sort By" selections have been made; however, this can depend on the report. The totals panel is disabled (appears grayed out) whenever totals are not an option or when the use of totals require additional selections prior to use (such as a "sort by" selection). Totals do not apply to all reports; furthermore, some reports provide totals regardless of selections and do not allow overrides using the "totals" panel.

You are allowed to select one of the following three (3) options when applicable: subtotals, grand total, and none. The "print totals only" check box is available with the first two (2) choices only.

Subtotals

Subtotals indicate that the report should include totals based on the change of certain data. Typically, this "break" for totals is determined by your selections in the "Sort By" panel. Some reports may automatically provide a subtotal level. When the "subtotals" selection is chosen, the report will also include a grand total.

Grand Total

Grand total indicates that the report should include a grand total (ending total) printed on the last page below the last details (when "print totals only" is not checked). Subtotals would not be included when this option is selected.

None

This selection indicates that no totals are to be included when the report is viewed, printed, or processed as a file. If you choose "none," the "print totals only" check box is disabled and the check (if any) is cleared.

Print Totals Only

This check box indicates whether all details should be suppressed when the report is viewed, printed, or processed as a file. In this case, only the grand totals and/or subtotals would be included.

Print and Output Options

Most reports share the same common print control. This allows the report to be either printed or saved as a file. When printing, a user can select either 1 or 2 printers and can also set the number of copies for each. When saving as a file, you can select from a number of different types (PDF, Microsoft Excel®, HTML, and TIFF). Neither printing nor saving as a file are required. These would only be done if you wanted to save a copy of the report and data for a given point in time. Certain types of activity and changes can affect data, including what is commonly viewed as "history," so anytime a "snapshot" at a particular point in time is desired, having a saved or printed copy is suggested. Reports are often also used for inquiry purposes. In many of these cases, viewing a report is sufficient. Printing and saving are optional unless you have a reason to do them.

The Process (F12) function is used to either print the report or generate a report file. We suggest using the Preview (F8) function prior to printing or saving to ensure that the report results match what you want to print or save. You can also use the Viewer to print a report and allows you to choose to print only selected pages from a report.

1st Printer and # Copies

The drop down control next to the label "1st Printer" provides a listing of available printers. An available printer is a printer that is either installed on your local machine or a server accessible printer if you are connected via Remote Desktop services (aka. Terminal Services). The default selection is the backroom printer assigned to the current station (if any). The listing of printers may contain devices that are specialty types, such as label printers, etc. that are not suitable for printing reports. This printer is only used if the "Print Report" check box is checked and the number of copies is greater than zero (> 0). The application does not print the report until you choose Process (F12).

2nd Printer and # Copies

The drop down control next to the label "2nd Printer" also provides a listing of available printers (see above). This allows you to print a report at two (2) separate locations if desired. Even if a selection is made, the second printer is only used if the "Print Report" check box is checked and the number of copies is greater than zero (> 0). The application does not print the report until you choose Process (F12).

Print Report

This check box determines whether printing is to be done if the user chooses Process (F12). The default selection is checked (true).

Save In

This is a text area with a Browse button that allows you to select a location where a report is to be saved as a file. Choose the Browse button to select an accessible file location. This might be on a local machine or a shared network location of some sort.
The application does not save your report as a file until you choose the Process (F12) function and only if you select the Output to File check box. Directory and file permissions can prevent you from saving files in some locations. It's best to choose a location you'll remember such as your "Documents" or "Desktop" locations.

Filename

This area allows you to set the file name you want to save the file with. The extension will automatically be set based on your selection from the "Type" drop down control. Saving (as a file) is not done until the user chooses Process (F12) and is only done if the "Output to File" is checked.

Output to File

This check box determines whether the report will be saved as a file when the user chooses Process (F12). The default selection is not checked (false).

Type

This determines the output format of the report when saved as a file. Choices currently include: PDF (Portable Document Format, .PDF), Microsoft Excel (Spreadsheet, .XLS), Hypertext Markup Language (Web Page, .HTM), or Tagged Image File Format (Fax, .TIF). The 97-2003 version of Microsoft Excel is used since it is forward compatible with newer versions. Free Adobe Acrobat Reader® software is required to access PDF format files. Any browser can be used to open HTML (HTM) files. TIF files is an older image format commonly used with faxing.

Functions

A number of functions are available with reports.

Preview (F8), allows you to preview the report before printing or saving it to a file.

Process (F12), allows you to print, save the report to a file, or transmit it, based on the report settings. These options are available with all reports.
Others, such as those related to saving and scheduling, are available with many but not all reports.

Select (F5)

Use the Select (F5) function to choose and load previously saved report settings. You can save report settings using the Save (F6) function, when applicable (report saving and selection is not provided for all reports).

The "Select Report Settings" dialog box offers a drop down control for report selection. Only public and the user's own private saved reports will be included in the listing. After selection, the report's associated description is displayed below. Click or choose "Accept" to continue and load the selected settings.

Deleting Saved Reports

To delete a saved report, choose the Menu Marker to display a context menu and choose the Delete option to delete the previously saved report settings. The Menu Marker only appears after report selection and if you have permission to delete the report. You can only delete a private report that you created or a public report. User security can restrict the ability to view or access Menu Marker functions. In addition, deletion may be restricted if the report settings are currently used with report scheduling.

Save (F6)

This function is provided for saving the current report settings (selection, filter on, totals, branch, etc.) for future use or scheduling. The ability to save report settings is not provided for all reports. Additionally, users may have to make a change in the report form before this function becomes available (since there is usually no need to save the default or initial settings).

Once all desired settings have been made and you have previewed the report to make sure it's what you need, choose Save (F6) to save your settings for future use or scheduling. Saved reports can be deleted (with certain restrictions) using the Menu Marker found on the Select Report Settings form (accessed by the Select (F5) function). See the "Deleting Saved Reports" section for more details.

Report Name

This defaults to the name of the current report, but can be modified. The "name" will be used for selection in the future.

Description

The description also defaults to the current report's name, but can be modified. This might be used for longer or more descriptive information about the report.

Save As

The "private" and "public" options determine whether your report settings will be available for use by others in your company.

• Private : Private report settings are only visible to the user who created them.

• Public : Public report settings can be accessed by any user with permission to use the current report.

Schedule (F7)

The Schedule (F7) function is used to process a saved report (using previously saved "settings") as a file based upon a defined schedule (once, daily, weekly, etc.). Reports must be saved prior to scheduling so that settings for selection, totals, sort by, etc. are determined in advance. Scheduled reports are processed by application services and are saved as files on the server, not the user's local machine. A built in delay between reports of two (2) minutes (120 seconds) is used by services for processing scheduled reports. So if multiple reports are scheduled for the exact same time of day, it would be normal for there to be a difference in process times. Files with the same name and save location (directory) will be overwritten. The default directories (on the server) for scheduled reports and scheduled user reports are determined by parameters.

Note: this function will only be available (enabled) AFTER and IF a report has been saved and the saved settings have been selected. Some reports do not support saving and scheduling.

Frequency

It's possible to schedule a report to run once or on a more regular basis. Options include the following: once, daily, weekly, monthly, and yearly. The daily and weekly options change the file names used to prevent overwriting report files (continue reading for more information). For additional details regard frequency selections, click here

Start Time

The time of day (Eastern Standard Time) that the scheduler should process this report.

First Occurrence

The current or future date that the scheduled report should begin on. This might be a one time occurrence or it may repeat based on your "timing" selections in this form.

Save Filename

This is the file name that will be used. In certain cases, such as daily processing, the file name is used to indicate a day of the week.

Daily and Weekly Files and Naming Conventions

If a report is scheduled for daily or weekly processing and is being saved as a PDF format, the file name of the report will be automatically adjusted to reflect the day the file is created for. For example, if the report's file name is normally saved as mydailyreport.pdf, is scheduled daily, and run on a Monday, the file name is going to be mydailyreport(1).pdf. This prevents overwriting that would occur should the same file names be used daily. Weekdays are assigned numbers representing the day of the week. Sunday is day zero (0) and Saturday is day 6 (six).

myreport[0].PDF (Sunday's Report)

myreport[1].PDF (Monday's Report)

myreport[2].PDF (Tuesday's Report)

myreport[3].PDF (Wednesday's Report)

myreport[4].PDF (Thursday's Report)

myreport[5].PDF (Friday's Report)

myreport[6].PDF (Saturday's Report)

Copy Pathname

The "Copy Pathname" is optional and allows you to designate a secondary save location for the report. This allows two (2) copies to be retained. The same file name logic as described above is applied.

Type

This determines the output format of the report when saved as a file. Choices currently include: PDF (Portable Document Format, .PDF), Microsoft Excel (Spreadsheet, .XLS), Hypertext Markup Language (Web Page, .HTM), or Tagged Image File Format (Fax, .TIF). The 97-2003 version of Microsoft Excel is used since it is forward compatible with newer versions. Free Adobe Acrobat Reader® software is required to access PDF format files. Any browser can be used to open HTML (HTM) files. TIF files is an older image format commonly used with faxing.

Add Time-Stamp to File Name

This feature basically makes the report file name unique and prevents any overwriting of the file by a future schedule run (such as in cases where you want to save a monthly copy but not overwrite each month).

Save for User

If a user is selected, the report will be saved in the "users" report directory within a folder matching the user's name.

Notify User

If checked, the user will be notified each time the scheduler processes this report.

How are reports saved and where do I find them?

The path names entered determine the primary, and optional copy, save location(s) of the file on the server within either (1) the report or (2) user report directories specified in Parameters.

"User" reports are created under a folder matching the user's name in the designated "User Reports" directory. For example, if your user name is BOBG and you schedule a report using the "Save for User" option and the "user report" directory in parameters is "C:\SavedReports\Users\," the following path would be used for BOBG's reports:

C:\SavedReports\Users\BOBG\

This directory could then be shared with the user's Client machine either as a shared network location or drive. It is not possible to specify a drive or network location as the path name. Doing so will simply create a directory on the server matching the name you entered.

The client must have any necessary software installed in order to open the file format you specify. For example, a PDF (Portable Document File) file requires Adobe Acrobat Reader software and an Excel (XLS or XLSX) spreadsheet requires Microsoft Office Excel or other software capable of opening the file.

Preview (F8)

The Preview (F8) function can be used to display a report in the Viewer form. Viewing a report is strongly suggested before choosing to either print or process a report as a file since this can be used to both see the printed length in pages and also to check the report format based on the options you have selected. In addition, reports can be printed directly from the viewer itself which also allows for the added benefit of printing only selected page or pages and well as additional options your printer may offer.

Each time preview is selected, the report will be generated which requires a retrieval of data. In some cases, and based on the criteria selected, you may be warned about the quantity of data being retrieved. Often, receiving a message such as this indicates that your report's selection criteria are too broad.

When should I save or print a copy of a report?

Despite the fact that most reports can be run at any time and usually for any period, the data used for reporting is rarely static. Anytime you want or need to retain a "snap shot" at a particular point in time, the only reliable way to do so is by saving the report as a file (PDF, etc.) or printing a hard copy for your records. Later changes such as merging, renaming or renumbering, deletions, and other changes can all affect whether data appears on reports or where it appears in some cases. For example, if you ran a sales analysis for inventory group 11 at the end of the year, and then modified one item in that group to now belong to 62, future reports would no longer show the same total for group 11 or 62. For the most part, changes such as those described here only affect data when viewed in parts rather than as a whole. Using our previous example, viewing total entire sales for all inventory wouldn't be affected by a change to one item's group at a later time.

Using the Viewer

The same viewer is used for both reports and documents. The primary different between viewing a document and a report is that reports don't have document links. Some reports offer dynamic links to documents (within the report) which indirectly provide access to links for those documents. The same viewer window is shared by reports and documents. When more than one report and/or document is viewed (without closing the viewer in between), the prior reports (or documents) can still be viewed by toggling the current document using the "PrevDoc" and "NextDoc" buttons. This is not true when viewing more than one version of the same report or document, however. Although you can change the page size and quantity of pages visible in the viewer (side by side or tiled, for example), you cannot view different documents (or reports) at the same time or side-by-side. The only way to do this would be to open a second viewer from another application session or to save one or more reports/documents prior to viewing and open them as PDF (Portable Document Format) or some other type of file.

For additional information about tools available in the viewer, please click here.

Cancel (F9)

The Cancel (F9) function reloads the current form, clearing any changes.

Process (F12)

The Process (F12) function prints and/or saves the report as a file based on your selections in the Print Options panel.