Atlas Knowledge Base
Dashboard
Report Parameters Pane

Report Parameters Pane

Report Parameters Pane

1171
1172
1180
1188
1509
1558
1559
1561
1766
1843
1903

Report Parameters Panes

Module:    Reference

Overview

Use this chapter to learn about setting up and printing reports in SBN. In order for SBN to print reports correctly you must

  • Install Report Services

  • Set a print directory in each terminal

  • Set up report parameters in four system administration programs:

q    Report Default Parameters (program #1561)

q    Report Priorities (program #1509)

q    Printer Profile Updates (program #1559)

q    Report Messages (program #1766)

  • Define the report parameters in the individual report

  • Use the Report Queue

The format of the Created On (or Printed On) Date that appears in the top left corner of each report conforms to the regional settings of the Windows machine running the Report Service.

The Lower Pane of Report Parameters

Every report in SBN contains the same lower pane with fields for selected parameters.

The following sections explain

  • The parameters in the lower pane

  • The report cover page

The following graphic shows the lower pane of a report.

Field Descriptions - Report Parameters

The following table describes the fields used in the lower pane of a report.

Field

Description

Comment

Type a description of the job that appears in the Report Queue (program #1558).

Wide

This box displays a check mark if the report requires wide paper, landscape printing, or condensed print.

Queue No

Displays the queue number assigned from the Report Queue.

Report Name
(No label)

Displays the program name of the report, if applicable.

Delay Job Until

Select a date and time to use as the minimum start time for processing the report.

Note: The report may remain held after this time if the priority requires the report to print at a certain time.

Priority

Defaults to the priority of the report defined in Report Default Parameters. You can override the default by selecting a priority from the drop-down menu.

Note: You can set up the conditions in which a user may edit this field in Required Fields (program #1843).

Hold Period

If the priority defined for the report causes SBN to hold the report, these fields display the beginning and ending of the hold time.

Delay Print Until

Select a date and time to use as the minimum start time for printing the report.

Status

Displays the current status of the job. This is a read-only field.

Status Description
(No label)

Displays the description of the status of the job. This is a read-only field.

Use Defined Printer

If you have no report defined in the Reports tab of the Client Options window, this box appears grayed out.

Select this check box to use the defined printer regardless of the printer selected in Printer Queue. This box defaults with a check mark if:

l    You have a default printer defined in the Reports tab of the Client Options window.

l    The Use Defined Printer check box is selected in Report Default Parameters.

You may select a different printer by leaving this check box blank and selecting a different printer in Printer Queue.

Note: If you leave this box blank, SBN uses the printer that defaults or that you select in Printer Queue to print the report.

Ready to Print

This box displays a check mark when the report is ready to print.

Exclude Cover Page

If the report is equipped with a cover page, select this check box to remove the cover page from the print job.

Size

Displays the actual size of the report in pages.

Job Start

Displays the date and time the report began processing.

Job End

Displays the date and time the report finished processing.

Printer Queue

Defaults to the printer queue defined for the report in Report Default Parameters.

You can override the default by selecting a different printer queue from the menu. (This menu originates from program #1559.)

Note: The menu displays only those printers flagged as In Use for the printer profile associated with the report in Report Default Parameters (program #1561).

Print Hold Size

Defaults to the print hold size defined for the report in Report Default Parameters. You can override the default by typing the maximum number of pages to print automatically. If the number of report pages exceeds the hold size, SBN

l    Holds the report in the Report Queue

l    Does not print the report

l    Does not migrate the report to the Done Queue

Note: SBN holds a report with a hold size of 0 (zero) in the Report Queue and NEVER prints the report.

Note: SBN will only email or fax reports

l    Defined with a hold size > 0

l    With a print size that is less than or equal to the hold size

Copies

Defaults to the number of copies of the report to print defined in Report Default Parameters. You can override the default.

Email Status

Displays the current status of the report email if an email address is entered in the Email field.

Email

When option fe009 is on, you may select a valid email address to which SBN emails the report.  Processing the report with a value in this field hands the report off to your email system.

If the report size is larger than the hold size, SBN sends the report to the Report Queue and keeps the report on hold until you release it.

Note: The email function does not support wide reports.

Note: If the report equals 0 pages, excluding cover page, the email will state: �No Data Received.�

Note: SBN will only email or fax reports

l    Defined with a hold size > 0

l    With a print size that is less than or equal to the hold size

Output File

Designate a file path for the Output File Report location. The user can designate the file path, but not the file name. If the file path is left blank, then the path given in the following property of SBNReport.exe.config is used as the base path: Configuration/Reports/PDFPath.

Email Start

Displays the date and time the report email began processing.

Email Subject

You may type a subject that appears in the subject line of the email.

Fax

When option fe007 is on and Fax Gateway has been installed on your server, you can type a fax number to which SBN faxes the report. Processing the report with a value in this field hands the report off to the Fax system.

If the report size is larger than the hold size, SBN sends the report to the Report Queue and keeps the report on hold until you release it.

Note: If the report equals 0 pages, excluding cover page, the fax will state: �No Data Received.�

Note: SBN will only email or fax reports

l    Defined with a hold size > 0

l    With a print size that is less than or equal to the hold size

Email End

Displays the date and time the report email finished processing.

Attachment Type

You may select the format from the drop-down menu to which SBN converts the report when it exports with the email. When you select TXT2, SBN embeds the text of the report into the body of the email.

Note: If you leave this field blank, the report scheduler will use the PDF format.

Zip Attachment

Select this check box to convert the report attachment to a .zip file.

Run in Export Mode

Select this check box to run the report in Export mode. In Export mode, SBN generates the report as a text file in the report directory.

Note: Only a few reports including Month End Balances (Report #1171), Month End Revenue (Report #1172), Balance Listing (Report #1180), GL Payment (Report #1188), and Deferred Revenue Summary (Report #1903) include this check box.

Print Status

Displays the current print status of the report.

Fax Status

Displays the current fax status of the report if a fax number is entered in the Fax field.

Print Start

Displays the date and time the report began printing.

Fax Start

Displays the date and time the report began faxing.

Serial

Displays the number of the SBN report service that runs the report. (1, 2, 3, and so on.) Define the value of this field in Report Default Parameters (program #1561).

Note: You may set up a high output report to run on one instance of the report service and let other reports run on another report service.

Report Group

Displays the report group for the report that determines the number of reports that can be run simultaneously. Define the value of this field in Report Default Parameters (program #1561).

Run On Secondary

Select this check box to run the report on the secondary report server. Define the default for this check box in Report Default Parameters (program #1561).

Print End

Displays the date and time the report finished printing.

Fax End

Displays the date and time the report finished faxing.

The Cover Page of a Report

The cover page of a report displays details about the report.

Field Descriptions - Cover Page

The following table describes the fields used on the cover page of a report.

Field

Description

Title

Title of the report.

Program Name

Report program name and number.

Queue No.

Printer queue number.

Created By

Name of person who created report.

Prio

Priority number of report.

Exclude Time

Hold time of report, if applicable.

Job Loaded

Date and time report was submitted.

Job Scheduled

Date and time report will run if on hold.

Job Started

Date and time report job started.

Print Scheduled

Date and time report will print if on hold.

Comment

Comment from report parameters.

Print Queue

Printer queue selected on the report parameters.

Parameters

Actual parameters selected for the specific report.

Modifications and Updates to Report Parameters Pane

The following table lists modifications and updates to the Report Parameters Pane document.

Mod Number

Date

Description

n/a

8/14/14

Images updated.



Was this helpful?