Registry Document Attachment & Scanning (sys-document-archive)


You may attach documents, reports or scanned images to SAM Pro records. When a document is attached, a copy of it will be placed in the directory specified in this registry entry and identified by its internal SAM Pro record number and original filename extension.

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.

Setting Values are Uppercase-Lowercase Sensitive:
The Setting Value is case-sensitive: be sure that you enter the value exactly as specified in the documentation. If the documentation specifies a value of true, do NOT enter True or TRUE.


When a user accesses an attached file from SAM Pro, a copy if it will be placed in the user’s temporary directory – that copy may be edited, printed, etc., but the original file attached to SAM Pro will not be affected. If it is necessary, a revised file must be attached to the appropriate SAM Pro record.

To enable scanning, the document archiving directory must be set. In addition, a directory for storing the scanned documents should be set.

Important Note on Redisplaying Saved Reports - In V8.1 and up, the bitmap path is saved in the dbr file itself, so that the registry is not required to display the bitmap when the report is redisplayed. If the saved report is from an earlier release where the bitmap path was not saved, the applicable registry entry will be used. This functionality also applies to the code SAM Pro uses to generate the XML file used by the xmltopdf.jar file so that .PDF’s are also generated correctly.

Related Registry Entries:

See the sys-ffv-global-settings option to create a temporary local directory to be used for report saving in case of network interrupts.

See Registry - Document Attachments to Additional Tables for specifying additional tables references on a viewer-by-viewer basis.

See Registry Start Document Archive Maintenance for defaults for this function. It enables existing documents to be transferred to subfolders. This function also enables the conversion of DBR reports to PDF’s for use with the Java-bases DBAnalytics and CRMAnywhere.

The registry setting described in Global Settings: PDF's and DBR's allows the DBR and the PDF versions of saved reports to co-exist: SAM Pro users access reports via the DB Reports viewer, while DBAnalytics/FMAnywhere users view the PDF from within the browser.

Important Fields:

Id: sys-document-archive-branchid-userid

(or sys-document-archive--userid if branches are not implemented)



The first format enables you to specify archiving/scanning parameters by branch id and/or user. A branch must be specified if a user belongs to a branch. If branches are not implement, two dashes (not separated by a space) must precede the user id.

The second format enables you specify parameters by security id.

The third format would apply to all users unless another registry entry was created for their security or branch/user id.

Directory Locations

Setting Key: directory Setting Value: aDirectoryPathName
This entry is required, and defines the directory where all document archives are stored.

Setting Key: scandirectory SettingValue: ScanDirectoryPathName
This is the local directory where the scan is stored.

Scan Parameters For Acquire

Setting Key: defaultscanparms Setting Value: parameters

This optional entry enables you to set the parameters used by the acquire.exe program used for scanning. If the entry is not implemented, the default parameters are /Hide /Scan: the document will be scanned without bringing up the scanner driver box. Run Acquire.exe from the command prompt for a list of all parameters available. If you wish to specify other parameters, be sure to also include Data-Basics’ defaults:

Setting Key: defaultscanparms Setting Value: /scan /hide /rgb

Multiple Page PDF Scanning in SAMPro for Acquire

Recent versions of SAM Pro support multiple-page PDF scanning at least some sheet-feed scanners. Thus far, this functionality has been tested on the Xerox DocuMate 515, the Xerox DocuMate 150, and the Dell v515W.

1. To accomplish this, a Twain driver compatible with the user’s operating system must first be downloaded and installed on the user’s computer.

2. Next, the following registry option should be set in sys-ffv-global-settings:

Setting Key: StoreDocumentsAsPDF Setting Value: true

3. If all users will be employing a sheet feed scanner, your sys-document-archive registry should include the following parameter setting in addition to the other required settings:

Setting Key: defaultscanparms Setting Value: /SCAN /FEEDER /PDF+

4. If some of your employee have sheet feed scanners, and others do not, you will need to make multiple Document Archive registry entries.


Assume most employees have sheet feed scanners, but user MARYANN has an older flatbed model. In this case, the base registry entry sys-document-archive would be as shown in step to. To support user MARYANN, the above entry would be cloned as sys-document-archive--MARYANN (or sys-document-archive-Branch1-MARYANN if branches are used) and the defaultscanparms option Disabled.

Scan Settings for NAPS2

See Scan With NAPS2  for the registry settings and setup needed for this functionality.

Control Setting of Read-Only Attribute on Archived Files

The read-only file attribute is now set on archived documents (this does not apply to report-type documents that get auto-created while running SAMPRO). The following registry option provides SAMPRO users with some control over how the read-only attribute is applied.
Setting Key: SetReadOnly
Setting Values: All - (Set readOnly on all archive documents) (default)
              None - do not set read only flag on archive documents.
              (lists of Extensions delimited by commas)
              ie pdf,dbr,txt - any extension on this list will be set to
                              read only.

Subfolders Option for Document Archiving

Setting Key: UseSubdirectories Setting Value: true

Implementing this option results in the archived document being put into the appropriate YYYY-MM subfolder.

See Also:
Attachments  Scanning Documents