The DocTypes Element - Front Office Scanning - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Premier - external - Standard - Essential - Premier - Standard - Essential

This setting specifies the OnBase Document Type that the Document Type button is being configured for. This setting is required.

Set the name setting to the name of the OnBase Document Type that the Document Type button is being configured for.

You can configure multiple OnBase Document Types for a single Document Type button. Set the name setting to the names of all desired OnBase Document Types with a single comma between each name (e.g., name="MED - ID Card,MED - Insurance Card,MED - Intake Form").

For Document Type names that include commas, use a double-comma (,,) to represent each comma in the Document Type name. For example, the Document Type name Intake Form, Clinical would be specified as name="Intake Form,, Clinical".

This setting allows a user to automatically assign a Document Type to a document when the user scans/creates the document.

• If onestep is set to false, or if no value is present, a user clicks the input button to scan/create a document and then clicks a Document Type button to assign the document to the proper Document Type.

• If onestep is set to true, the user clicks the input button to scan/create a document, and, once the document is scanned/created, the document is automatically assigned to the Document Type associated with the Document Type button that corresponds to the input button (i.e., the user does not have to click a Document Type button to assign the document to a Document Type).

This setting functions similarly to the onestep setting in the ScanOptions element, except this setting can be configured on the individual input button level instead of a global level. For more information, see The ScanOptions Element.

In order to use the functionality offered by this setting, additional configuration is required. For more information, see Configuring Input Buttons.

This setting allows a user to automatically assign a Document Type to an E-Form document when the user creates the E-Form document.

• If onestepform is set to false, or if no value is present, a user clicks the input button to create an E-Form document and then clicks a Document Type button to assign the document to the proper Document Type.

• If onestepform is set to true, the user clicks the input button to create an E-Form document, and the E-Form document is created and automatically assigned to the Document Type associated with the Document Type button that corresponds to the input button (i.e., the user does not have to click a Document Type button to assign the document to a Document Type).

This setting functions similarly to the onestep setting in the DocType sub-element, except the onestepform setting is used specifically for E-Forms.

In order to use the functionality offered by this setting, additional configuration is required. For more information, see Configuring Input Buttons.

This setting allows you to configure an input button so that only the corresponding Document Type button can be used to assign a Document Type to the document scanned/created by that input button.

• If onlycorresponding is set to true, then the user can only use the corresponding Document Type button next to the input button used to scan/create the document.

• If onlycorresponding is set to false, or if no value is present, then the user can use any Document Type button to assign a Document Type to the document.

This setting specifies a unique identifier for the Document Type button so that it can be filtered based upon Keyword Values in the selected Data Set. This is identifier is known as the filterid.

Enter a numeric value for the filterid.

If the parameters of the filter are met (i.e., if the selected Data Set contains a Keyword Value that matches the value setting in the Keyword sub-element of the Filter element):

• Document Type buttons associated with DocType elements also containing the filter ID are displayed.

• Document Type buttons associated with DocType elements not containing the filter ID are not displayed.

This setting identifies a Data Set Keyword Merge to associate with the Document Type button by specifying a merge ID for the Document Type button.

Enter the merge ID from the MergeItem sub-element that corresponds to the Data Set Keyword Merge that you would like to associate with the Document Type button.

Once a merge ID is assigned to a DocType element, the Data Set Keyword Merge associated with that merge ID is set for the Document Type button (i.e., Keyword Values are stamped onto a document when it is assigned to a Document Type via the Document Type button).

This setting identifies one or more Signature Merge Items to associate with the Document Type button by specifying signature IDs for the Document Type button.

Enter the signature IDs from the SignatureItem sub-elements that correspond to the Signature Merges that you would like to associate with the Document Type button.

Each signature ID corresponds to one captured signature; multiple signature IDs can be specified for this setting by separating them by commas (i.e., signatureid="1,2,3,4").

Once one or more signature IDs are assigned to a DocType element, the Signature Merges associated with those signature IDs are set for the Document Type button (i.e., captured signatures are stamped onto a document when it is assigned to a Document Type via the Document Type button).

The setting allows you to specify the text used to label the Document Type button.

Set the displayname setting to contain the text that you would like to be displayed on the Document Type button. The text is limited to one line for each Document Type button.

If no value is configured for the displayname setting, the Document Type's name is used by default.

This setting allows you to specify a graphic to be displayed on the Document Type button.

Set the bitmap setting to contain the path to the image to be displayed on the Document Type button.

This setting allows you to warn a user when he or she attempts to upload a document that has not been assigned a Document Type.

• If warnIfNotPresent is set to true, then a warning message is displayed when uploading a document that has not been assigned a Document Type.

• If warnIfNotPresent is set to false, or if no value is present, then no warning message is displayed for attempting to upload a document without a Document Type.

This setting allows you to specify the text used to label the input button associated with the Document Type button.

Set the displayscanner setting to contain the text that you would like to be displayed on the input button associated with the Document Type button.

If no value is configured for the displayscanner setting:

• If the input button is configured to scan documents, it is labeled Scan using: <Scanner Name>. If no scanner name is specified, it is labeled Scan using: Default TWAIN.

• If the input button is configured to create a document from an image template or create an E-Form, it is labeled Template Form.

This setting allows you to configure a default scanner or piece of TOPAZ hardware to use when scanning/creating a document associated with this Document Type (i.e., when clicking the input button associated with this Document Type button).

Set the scanner setting to the name of the scanner or TOPAZ hardware.

Alternatively, to allow signatures to be created using a mouse pointer on workstations or a stylus on tablets, set the scanner setting to touchscreen.

This setting allows you to capture still images from a webcam.

• If camera is set to true, then images are acquired from an attached webcam.

• If camera is set to false, or if no value is present, then webcam support is disabled.

This setting allows you to specify the name of the webcam to be used for acquiring still images when the desired webcam is not the default streaming video device (e.g., cameradevice="Logitech WebCam C525").

This setting allows you to adjust the number of seconds the Front Office Scanning client waits before capturing a still image from a webcam. You can set this delay interval between one and ten seconds (e.g., shutterdelay="5"). The default interval is two seconds.

This setting is used to control how information is passed from the scanner to the Front Office Scanning client.

By default, it is set to true. This allows the scanner to transfer data to the Front Office Scanning client using native transfer mode.

Set this setting to false to allow the scanner to transfer data to the Front Office Scanning client using buffered transfer mode.

While not the preferred method of transferring data, native transfer mode is required for some older TWAIN devices.

This setting is used to control how the scanner formats data when transferring it to the Front Office Scanning client in native transfer mode.

By default, the hardwarecompress setting is set to true. This allows the scanner to compress data before transferring it to the Front Office Scanning client.

If the hardwarecompress setting is set to true, but the scanner is not capable of compressing data, then the setting is ignored (i.e., it is treated as if it is set to false).

Setting the hardwarecompress setting to false prevents the scanner from compressing data; uncompressed data is passed from the scanner to the Front Office Scanning client.

This setting is used to set the width of the line created by the drawing tool when marking up a template document or the width of the pen stroke used when signing a document via a signature device.

The default value is 8; a thinner pen stroke can be configured by setting the penwidth setting to a value between 1 and 7, and a wider pen stroke can be used by setting the penwidth setting to 9 or larger.

Setting the penwidth setting to 8 will leave the width of the drawing tool at the pre-determined width based on the image's resolution.

This setting determines if a document must be associated with this Document Type in order to upload documents associated with the selected Data Set to OnBase.

• If the required setting is set to true, then a document is required for this Document Type before documents associated with the selected Data Set can be uploaded to OnBase.

  The label on a required Document Type button is displayed in red instead of black.

• If the required setting is set to false, or if no value is present, then a document is not required for this Document Type.

This setting enables users to assign multiple documents to one Document Type from the same Data Set.

• If multipledocs is set to true, then the Document Type button is not disabled once a user uses it to assign a document to a Document Type. It can be reused to assign another document to the Document Type from the same selected Data Set.

• If multipledocs is set to false, or if no value is present, then the Document Type button is disabled once a user uses it to assign a document to a Document Type. A user can assign only one document to the Document Type per Data Set.

This setting gives users the ability to copy an existing document being viewed in the Front Office Scanning client and create a new document. This document can be assigned to the same or another Document Type.

• If copy is set to true, the Document Type buttons are enabled when an existing document is displayed in the Working window. This allows the user to click a Document Type button, creating a new document that is a copy of the existing document.

• If copy is set to the false, or if no value is present, the Document Type buttons are disabled when the Document is viewed. Users are unable to create a new document from the document being displayed.

This setting allows you to specify how documents assigned to the Document Type associated with this Document Type button are displayed, by default, in the Working window.

• If imagescale is set to fitwidth, then documents in the Working window are displayed as Fit to Width by default.

• If imagescale is set to fitheight, then documents in the Working window are displayed as Fit to Height by default.

• If imagescale is set to fitimage, then documents in the Working window are displayed as Fit in Window by default.

• If imagescale is set to fullsize, then documents in the Working window are displayed as their actual size.

For more information on these display options, see The Front Office Scanning Toolbar.

This setting takes precedence over the imagescale setting in the ScanOptions element. That setting sets the default behavior for how all pages are displayed in the Working window.

This setting allows you to configure the Front Office Scanning client to display only the most recent document (by date) from the Document Type associated with this DocType element in the Related Documents window.

• If filtersingledoctype is set to true, then only the most recent document from this Document Type that matches the selected Data Set is displayed in the Related Documents window.

  CAUTION:

  The Front Office Scanning client looks only at the date the documents were uploaded to OnBase, not the time. If multiple matching documents were uploaded on the same date, the most recent document (based on the time it was stored) may not be returned.

• If filtersingledoctype is set to false, or if no value is present, all documents stored in OnBase that are related to the selected Data Set are displayed in the Related Documents window.

This setting allows you to specify a date range for the existing documents from the Document Type associated with this DocType element that are displayed in the Related Documents window.

Set the daterangedays setting to the number of days from the current date OnBase should search for matching documents.

If daterangedays is set to 0, only documents from the current date are returned.

For more information on the functionality offered by this setting, see Configuring Front Office Scanning to Allow Document Retrieval.

This setting enables the Front Office Scanning client to ignore the error message that is displayed when no documents are loaded into the scanner's ADF.

• When skipadfcheck is set to true, the error message is ignored.

• When skipadfcheck is set to false, or if no value is present, an error message is displayed when no documents are loaded into the scanner's ADF.

This setting allows you to enable autofeed mode for your scanner (if it is not automatically enabled) when scanning is initiated by clicking the input button associated with this Document Type button.

• If autofeed is set to true, autofeed mode is enabled for your scanner.

• If autofeed is set to false, autofeed mode is not enabled for your scanner.

This setting determines if the TWAIN driver user interface is displayed at the time of scanning when scanning is initiated by clicking the input button associated with this Document Type button.

• If showui is set to true, then the TWAIN driver user interface is displayed when a document is scanned.

• If showui is set to false, or no value is present, then the TWAIN driver user interface is not displayed when a document is scanned.

This setting determines if duplex or simplex scanning is used when scanning is initiated by clicking the input button associated with this Document Type button.

• If duplex is set to true, this input button scans documents using duplex scanning.

• If duplex is set to false, this input button scans documents using simplex scanning.

This setting enables a copy of the document to be printed as soon as the input button associated with the Document Type button is clicked.

• If preprint is set to true, then the document is printed when the input button is clicked.

  If a default printer is specified in the Printer element, the document is automatically printed. If a default printer is not specified, the Print dialog box is displayed.

• If preprint is set to false, or if the setting is not present, then the document is not automatically printed when the input button is clicked.

This setting enables a copy of the document to be printed as soon as the document is assigned to a Document Type (i.e., as soon as the Document Type button is clicked).

• If autoprint is set to true, then the document is printed when the Document Type button is clicked.

  If a default printer is specified in the Printer element, the document is automatically printed. If a default printer is not specified, the Print dialog box is displayed.

• If autoprint is set to false, or if the setting is not present, then the document is not automatically printed when the Document Type button is clicked.

This setting allows you to upload documents to OnBase as a batch associated with a Document Imaging scan queue instead of ad hoc importing them into OnBase.

• Set the scanqueueid setting to the Queue # of the scan queue you would like to route the document(s) to. The Queue # can be found in the Scan Queue Configuration dialog box by clicking Import | Scan Queues in the OnBase Configuration module.

• If no value is specified for the scanqueueid setting, or if the setting is not present, then documents uploaded from the Front Office Scanning client are ad hoc imported into OnBase.

This setting allows you to specify the indexing status of documents uploaded as a batch associated with a Document Imaging scan queue.

• If unindexed is set to true, the batch is marked as unindexed and is routed to the Awaiting Index batch status queue, although, depending on the configuration of the scan queue, the batch may be routed to one or more batch status queues prior to the Awaiting Indexing batch status queue.

• If unindexed is set to false, then the batch will be marked as indexed and bypasses the indexing batch status queues.

This setting controls the brightness level of the scanner when scanning is initiated by clicking the input button associated with this Document Type button.

Set the brightness setting to a value between -1000 and 1000. The value is scaled by the scanner to fit within its supported range.

This setting controls the contrast level of the scanner when scanning is initiated by clicking the input button associated with this Document Type button.

Set the contrast setting to a value between -1000 and 1000. The value is scaled by the scanner to fit within its supported range.

This setting controls the angle to which the scanner will rotate pages when scanning is initiated by clicking the input button associated with this Document Type button.

Acceptable values for the orientation setting are 0, 90, 180, or 270.

This setting controls the how much the scanner automatically rotates pages when scanning is initiated by clicking the input button associated with this Document Type button.

The value entered for the rotation setting works in addition to the value specified for orientation setting and allows you to rotate images using smaller degree units.

Acceptable values for the rotation setting are between - 360 and 360.

This setting controls the how much the scanner automatically rotates the reverse side of pages when duplex scanning is initiated by clicking the input button associated with this Document Type button.

The backrotation setting is used when the back of an page scanned in duplex needs to be rotated in the differently than the front of the page.

Acceptable values for the backrotation setting are between - 360 and 360.

If the Backrotation setting is not configured for a document scanned in duplex, the rotation setting controls how the reverse side of the image is rotated.

This setting is used to determine the color of the document that is scanned or converted to an image when scanning documents or when converting E-Forms to images.

• If pixeltype is set to BW, the resulting images will be black and white.

• If pixeltype is set to GRAY, the resulting images will be grayscale.

• If pixeltype is set to RGB, the resulting images will be color.

This setting sets the number of bits per pixel for each color plane (specified by the pixeltype setting) when scanning is initiated by clicking the input button associated with this Document Type button.

Acceptable values for the bitdepth setting are 1, 4, or 8.

This setting allows you to specify the width (in pixels) of the image that is created when an E-Form is converted to an image document using this Document Type button.

By default, the Front Office Scanning client allows the web browser to automatically determine the size of the image that should be created from the E-Form.

When a value is specified for the ForceRenderWidth setting, Front Office Scanning will automatically create an image of the specified size when the E-Form is converted for this Document Type.

This setting sets the horizontal resolution for documents scanned/created by clicking the input button associated with this Document Type button.

Set the xresolution setting to a value greater than zero. A typical document's resolution is 200 DPI.

If a value is specified for the yresolution setting, but not for the xresolution setting, the yresolution value is used for the xresolution setting as well.

This setting is used when scanning documents or when converting E-Forms to images.

This setting sets the vertical resolution for documents scanned/created by clicking the input button associated with this Document Type button.

Set the yresolution setting to a value greater than zero. A typical document's resolution is 200 DPI.

If a value is specified for the xresolution setting, but not for the yresolution setting, the xresolution value is used for the yresolution setting as well.

This setting is used when scanning documents or when converting E-Forms to images.

This setting sets the threshold level of the scanner.

Set the threshold setting to a value between 0 and 255. The value is scaled by the scanner to fit within its supported range.

This setting can be used for scanning documents or when converting E-Forms to images if the resulting images are configured to be bi-tonal (i.e., the pixeltype setting is set to bw).

This setting allows you to specify the minimum file size an image must be in order not to be considered blank.

Set the blankthreshold setting to the number of bytes a page must be in order not to be considered blank. By default, this setting is set to 0, which indicates that no images are discarded.

• If the file size of the page is equal to or greater than the blankthreshold value, it is recognized as a valid page.

• If the file size of the page is less than the blankthreshold value, it is discarded.

This setting sets the size of the page being scanned for the Front Office Scanning client.

Acceptable values are Legal, Letter, Card, A3, A4, A5, A6 and B5.

This setting allows you to configure an input button to create a document from an image template or to create an E-Form instead of scanning a document. This setting is required if you are creating a document from an image template or creating an E-Form.

Set the template setting to the path to the image template or the HTML form used to create the E-Form. If the image template or HTML form is being retrieved from OnBase, set the template setting to the name of the OnBase Document Type that the document is associated with.

By default, the Front Office Scanning client is configured to obtain image templates and the HTML forms used to create E-Forms from a local path. This setting allows you to configure the Front Office Scanning client to obtain image templates and HTML forms from other sources.

• If the templatesource setting is set to printmon, the Front Office Scanning client uses images captured by the Hyland Virtual Print Driver as an image template forms.

• If the templatesource setting is set to onbase, the Front Office Scanning client obtains the image template or HTML form used to create an E-Form from OnBase.

The functionality offered by these settings requires additional configuration. See Configuring an Input Button to Create Documents from Image Templates or Configuring an Input Button to Create an E-Form.

This setting is only used when creating a document from a multi-page image template. It allows you to specify which page of the image template to display first

Set the displaypage setting to contain the page number of the image template page that is to be displayed first.

To display the last page of the template form, set the displaypage setting to 0.

If no value is set for the displaypage setting, or if the setting is not present, the first page of the image template is displayed by default.

This setting configures the Front Office Scanning client to automatically discard images once they are scanned/created in the Front Office Scanning client (e.g., once they are scanned or once the image template or E-Form is displayed in the Working window).

• If autodiscard is set to true, documents are automatically discarded once it is scanned/created.

• If autodiscard is set to false, documents remain in the Working window once they are scanned/created.

This setting configures the Front Office Scanning client to automatically assign a document created from an image template to the associated Document Type without displaying the image template for markups and without requiring the user to click the Document Type button.

• If skipmarkup is set to true, when the input button is clicked the image template is briefly displayed in the Working window, but is cleared without being displayed for markups and is automatically assigned to the associated Document Type without requiring users to click the Document Type button.

• If skipmarkup is set to false, or if no value is present, image templates are displayed for markups and are assigned to a Document Type by clicking a Document Type button.

This setting configures the Front Office Scanning client to import referral documents from a network location. Upon import, the documents are linked with the referral in an Electronic Medical Records system.

The value of the referrallocation attribute must provide the path to the network location where referral documents are stored. The following variables can be included in the path:

• %fosuser%: Represents the current user's Front Office Scanning user name.

• %winuser%: Represents the Windows user name of the user running Front Office Scanning.

For example:

referrallocation="\\server\referral\%winuser%"