Registry Payroll Check (sys-report-rprchck)


Provides for independent check positioning, and for controlling the order in which payroll checks are printed. In addition, you may specify the default GL Bank Account and or GL Entity.

Testing Your Registry Entries
The system does not verify the validity of registry entries. Be sure to test your registry entries after completing them to verify that they are functioning correctly.

Important Fields



The first format enables you to specify positioning by branch id and (optionally) user. If this entry is specific to a user, the branch must be specified if a user belongs to a branch. If branches are not implemented, two dashes (not separated by a space) must precede the user id.

The second format enables you to specify positioning by security id.

The third format applies to all users unless another registry entry was created for their security or branch/user id or by GL Account or GL Account and Entity.

Both regular printing and MICR check printing handle multiple bank accounts using the following registry formats.  


If you print to multiple GL Account and Entity combinations, create a registry for each: if you specify an entity when printing check, the registry id MUST include the entity:

sys-report-rprchck-GLACCTID   (if a GL Entity will not be specified)

This registry will be used for the GL Account specified when printing a PR Check if a GL Entity is not selected. Note that in this case the GL Account Id is NOT followed by a dash.

Skip Print of EFT Checks

Setting Key: SkipPrintEFTChecks   Setting Value: true

When implemented, this option allows for the display of PR EFT Checks, but the actual print of PR EFT Checks is skipped. PR EFT Checks which will be skipped will use a new numbering sequence beginning with 9000000000 for each GL Bank & GL Entity combination.

Print Direct Deposit Stub if Employee Email is Not Set Up and EFT's are Normally Skipped

Setting Key: SkipPrintEFTChecksIfEmailAddressSetup  Setting Value: true

This registry setting will skip printing the PR Check if the Employee's email address is set up and print a 'voided' check if the Employee's email address is blank.

Important: the following Registry settings for must also be enabled for the above registry setting to take effect:

Setting Key: SkipPrintEFTChecks   Setting Value: true

Setting Key: AutoSaveBySection   Setting Value: true

Print Reports after Posting Checks

Setting Key: PostReports   Setting Value: reportid1,reportid2,etc...

This registry launches the specified reports for user input.  If any of these reports should be auto-attached or auto-emailed, the appropriate registry must be made on a report by report basis.

Autosave PR Checks and Attach to Employee and Check Records

This release includes an enhancement that supports the auto-saving of Checks (including EFT's) as attachments to the  Employee and Check records when the Check is successfully posted. If the check is flagged as Reuse or Void during in the post, the check document will NOT be retained as a attachment. The following entries are required to enable this functionality.

In Version 8.2, the Document Description for saved PR Checks included the GL Account, Entity and Check #. The Document Description includes the PR Period Id, Check Date & Check # for Version 9.1 and above.

Setting Key: autosavewhenprinted   Setting Value: true

Setting Key: autosavebysection       Setting Value: true

Setting Key: autosavefiletype       Setting Value: PDF

Note: this functionality results in a PIN number being required to open a Pay Check. The PIN number consists of the last six digits of the employee's SSN or SIN.

Setting Key: autosavedirectory     Setting Value: path

Where path is replaced by full path to the directory that you want your reports stored in.

Setting Key: autosavefilename    Setting Value: PRCheck~^sectionkeyvalue^

The above option defines the filename of the saved check or stub file.

COPY Graphic on Saved Checks (if checks are autosaved as PDF's)

Setting Key: bitmap   Setting Value: path

We recommend that the auto-attached version of the check indicates that it is a copy, not the original. If the report is auto-saved as a pdf when it is first printed, it does not invoke the copystampbitmap functionality as when you bring up a dbr report. For this reason, the following graphics should be created to ensure that the attached PDF document is noted as a copy.

1.    1. The bitmap this registry references either includes the logo you want on the real check, or all white if the printed check doesn’t need it (just a placeholder), or is absent. 

2.    2. Create a .jpg (or have Data-Basics do this for you)  that corresponds in name to the bitmap referenced in this registry.  It should include whatever logo, COPY text, etc. you want to appear on the saved PDF.  Within the graphic, you may wish to place the text COPY in the check position of the report; using a font size of at least 80 points and 50% gray (so that text on the report will show through the report).

Password-Protecting PDF Checks

An updated XmlToPdf.jar file (dated 1/16/2014 and the following registry entry(ies) are required to implement this behavior.  This functionality is currently only enabled for Payroll Checks and Report Employee Timesheet.

When enabled, the generated PDF will be password-protected, with the password composed of the last 6 digits of the employee's SSN (US) or SIN (Canadian). The following option is required to enable password protection:

Setting Value: SectionPasswordProtect     Setting Value: true    (default is false)

Optional settings values are as following:

Setting Key: SectionOwnerPassword   Setting Value: ownerpassword

A default Owner password (for Data-Basics Support only) will be used unless one is set through this registry entry.

Option to Control Check/Stub order

Setting Key: SectionOrder Setting Value: option

Where option is replaced by

check,stub,stub or
stub,stub,check or

By default, PR laser checks are printed with the check in the middle, and a stub on the top and bottom for US installations. Canadian Installations default to check,stub,stub. If you want the check to print on the top of page, enter the first option (check,stub,stub). To print the stubs at the top, use the second option (stub,stub,check).

Option to Control the Position of the Check Sections

Setting Key: SectionPositions Setting Value: PositionList

PositionList is a comma separated list of line numbers. Each line number controls the position of the top print line in a section. This is the first line in the section with actual text to be printed. Do not include blank filler lines, which may appear above this first print line.

The first number in the PositionList controls the position of the top section.

The second number in the PositionList controls the position of the check body.

The third number in the PositionList controls the position of the bottom section.

The default positioning (used if no Registry entry is found) uses the following Section Positions list:


The smaller the line number, the closer to the top of the page the section will print. Typically, changing the position from the default by one line should correct most problems.


Setting Key: SectionPositions Setting Value: 3,27,55

This example would be used if the bottom stub of your Payroll checks were printing a little too far down on the form.

Option to Control the Order in Which Checks are Printed

Setting Key: OrderBy Setting Value: empfield1,empfield2 ...

where empfield1,empfield2 and so on are replaced with the fields by which you wish to order your payroll checks. By default, checks are ordered by Branch Id and then Employee Id.


Setting Key: OrderBy Setting Value: emplye_nme_lst,emplye_id

This entry will sort payroll checks by the employee’s last name and then Id.

Option to Set Default GL Bank Account and / or GL Entity

Setting Key: DefaultGLBankAccount Setting Value: GLAccountId  or
Setting Key: GLBankAccount Setting Value: GLAccountId

Setting Key: DefaultGLBankEntity Setting Value: GLEntityId  or
Setting Key: GLBankEntity Setting Value: GLEntityId

The GLBankAccount and DefaultGLBankAccount options provide a means of defaulting the bank account. Use of GLBankAccount and DefaultGLBankAccount should be thought of as mutually exclusive even though the Registry viewer won't prevent it. Do not use both!

Intercompany Processing Note: If the DefaultGLBankAccount option is set, the GL Bank Account specified in the registry defaults when the user selects the Company (or it defaults if only one Company has been specified in the database). The Account will be cleared if the user selects a different Company for which the registry is not set.

The rules for Entity defaulting and validation are similar to the above description for GL Accounts.

Option to Disable the GL Entity Field (non-Intercompany installations only)

Setting Key: disabledFieldsParent    Setting Value:

This option is designed to prevent the GL Entity from being inadvertently entered for non-Intercompany SAMPro installations. It should only be enabled if the GL Entity should NEVER be entered when printing this type of check.

Canadian Checks:

Setting Key: PrintIndicators Setting Value: true

If present in sys-report-rapchck or sys-report-rprchck AND a Canadian customization, print the Date Field Indicators below the date field. The default is false – assumes indicators are pre-printed on the checks.

Setting Key: PrintDollarSign Setting Value: true

If present in sys-report-rapchck or sys-report-rprchck AND a canadian customization, print the dollar sign preceding the amount. Default is false (most checks seem to have the $ preprinted on checks).

Paid Time Off in Dollars rather than Hours

Setting Key: ShowPTOAvailableAs Setting Value: hours or dollars  (default = hours)

This registry setting changes the ‘PTO Available’ that appears on the Recap portion of the check stub from hours to a dollar amount for PTO Pay Types whose Check Label field includes a dollar sign. 

Related Option: Controlling Negative Accrual of PTO 

Id: sys-compute-payroll

Setting Key: PTOAccruedHoursExceeded Setting Value: option  (default is warning)
Setting Key: PTOAccruedEarningsExceeded Setting Value: option (default is ignore)

These options enable you to control how the system will handle it when Compute Payroll encounters a negative PTO situation either in terms of Hours or Dollars.

The error option will result in an error being written to payroll history; you will not be able to print a pay check (or direct deposit advice) for that employee until the problem is corrected and Compute Payroll rerun.

The warning option will result in a warning being written to payroll history that will appear on the Payroll Worksheet, but will not prevent the employee from being paid.

The ignore option enables the payroll to be paid, and does not record any message of this situation to payroll history.

Setting Up the Pay Type to work with the above registry options

Pay Type:

Check Label
If the sys-report-rprchck registry ShowPTOAvailableAs=dollars is implemented, the Check Label field MUST include a dollar sign ($) to define which PTO Pay Types will be displayed as a dollar amount on the ‘PTO Available’ section of the Recap portion of the check stub.  


Suppose that you want your employee’s available sick time to appear as dollars, management sick time to appear as hours, and all vacation time to appear as hours.

Emp. Sick Time Pay Type Check Label: Sick $

Mgr. Sick Time Pay Type Check Label: Sick Hours

Vacation Time Pay Type Check Label: Vac. Hours

MICR printing for PR Checks

The system supports the MICR printing of checks:

This may be done by printing on a Troy printers with security features with MICR ink, and signature printing.

Alternately, checks may be printed to a regular laser printer with a MICR ink toner cartridge.

IMPORTANT REQUIREMENTS: For non-Troy printers AND some recent Troy Printers such as the TROY M203dw MICR Printer:

The GnuMICR.ttf font must be installed on all computers that may be used to print checks.

A v.cus file specifying that the GnuMICR.ttf font is to be used for MICR printing must be installed on the client's system OR the following registry enabled.

Registry to Specify MICR Font

Some recent versions of Troy printer drivers (and other drivers used to print MICR checks) require that a specific MICR font is specified in the SAMPro check reports. In previous versions this required a customization file to specify the font and font size. In this release, the MICR font may be specified in the registries for Payroll, Accounts Payable and PR Miscellaneous Deductions checks. The true type GnuMICR font is currently recommended for most applications.

Important: The MICR font must be installed in Windows on all computers checks will be run from.

Id: sys-report-rprchck

Setting Key: FontForMICR   Setting Value: GnuMICR

The Setting Value is case sensitive - be sure that matches the filename of the true type font file. Note that the file extension is NOT included in the Setting Value.

Setting Key: PointSizeForMICR   Setting Value: 10  (point size for font default is 10)

Registry to Trigger MICR Printing

Setting Key: UseMICR Setting Value: yes

(Actually any value beginning with ‘y’, ‘Y’, ‘t’, or ‘T’ will do)

To print the company name ‘XYZ Incorporated’ (for example) below the underline, use

Setting Key: CompanyName Setting Value: XYZ Incorporated

where XYZ Incorporated is replaced by your firm’s name as it should appear on the check. If this entry is absent, the standard company name string will be used.

When a Troy printer containing a signature device is used, you must configure the printer to map the ‘Times New Roman’ font to the proper Troy signature font. A Troy printer is not required to test this mod. However the MICR line and the signature will not properly print otherwise.

MICR Support for Multiple Bank Accounts / Entities

MICR check printing handles multiple bank accounts / entities in Version 7.3 and up. The UseMICR option has been extended to PR check registry entries of the following forms:

Registry Id:

sys-report-rprchck-GLACCTID-GLENTTYID or


Setting Key: UseMICR Setting Option: yes

The PR Check Entry Fields GL Account and GL Entity are used to look up the registry; if not found the default (sys-report-rprchck) is used. In this way you can assign different MICR values to each GL Account/Entity combination.

Specifying Bitmaps for Multiple Bank Accounts / Entities:  
In Version 9.0 and above, the PR Check registry format sys-report-rprchck-GLACCOUNTID-GLENTITY also supports the bitmap option (if enabled). In previous versions, only the MICR options are supported.

Print Bank Name/Address on MICR Checks

Setting Key:  BankDescription1  Setting Value: bank name
Setting Key:  BankDescription2  Setting Value: bank address line 1
Setting Key:  BankDescription3  Setting Value: bank address line 2
Setting Key:  BankDescription4  Setting Value: bank address line 3 or other text

If the bank's name and address is not pre-printed on your check stock, these registry settings may be used specify the bank's name, address, and any other pertinent information on the check.

Specify Routing and Account Numbers on MICR Checks

Setting Key:  FractionalRoutingArea  Setting Value: as specified by your bank

Setting Key: RoutingNumber  Setting Value: as specified by your bank

Setting Key: AccountNumber   Setting Value: as specified by your bank

Escape String for Troy Printer

Setting Key:  SignatureEscapeString  Setting Value: per printer documentation

If using a Troy printer, this registry enables the signature card printing.

Double Signature Support for MICR PR Checks

 A v.cus supporting a double-line form is also required for this functionality. To force a double signature line on a Payroll check for amounts exceeding $10,000 (for example) use

Id: sys-report-rprchck  

Setting Key: DoubleSignatureAmount Setting Value: 10000