The purpose of the document queue is to serve as a placeholder for Multimedia documents that are to be added to a record at a later time. For example, a lineup of applicants are waiting to apply for permits or licenses, as the forms are filled out there may not be sufficient time to go through the process of scanning their required support documents for the application. As their record is completed, the scanning or importing attachment process for their multimedia documents are sent to the scanning queue. The will be attached at a later time. When the attachment process is ready to be completed, the Multimedia Scanning Queue presents the list of documents. Each document is selected on the list, and the scanning/import is performed. As each item on the list is processed, it is removed from the queue.
NOTE: The driver for the scanner being used must be Windows Image Acquisition (WIA compliant) |
Functionalities
The Multimedia Scanning Queue is a custom control that allows users to “build up”, or “Queue up” a list of required documents for any Govern module. Although the title reads as Workflow Multimedia Scanning Queue, in actuality the feature is not dependent on the Multimedia function and can be used without the Multimedia control.
The Multimedia Scanning Queue action generates a multimedia document for the scanning queue that is related to a workflow. This action is performed according to the parameters defined in the Govern New Administration (GNA).
NOTE: This is not a generic action, and can only be invoked in the context of a workflow. This action is only functional when the category’s entry key type is a P_ID, or an NA_ID. USER_ID or DEPT_ID are not used. |
The Multimedia function may be configured to work in together with the Multimedia Scanning Queue in Govern. This function can be used to control individual scans, or to control scanners that perform bulk scanning duties; the condition is that the installed driver for the scanner is WIA compliant.
The Multimedia scanning queue is a grid that displays a list that will require documents to be attached to them.
Example
As an example in a Workflow that results in the generation of a license, users can create a principal form workflow permit type. In addition to the principal form, the form will consist of two custom entities, the Multimedia entity, and the Multimedia Scanning Queue entity.
NOTE: Placing the Multimedia and Multimedia Scanning Queue custom entities together on the same form is not a requirement for functioning. As mentioned earlier, the Multimedia Scanning Queue entity can function independently of the Multimedia custom entity. |
Configuration
OpenForms Designer (OFD)
As stated, Multimedia, and Multimedia Scanning Queue are both custom entities. When configuring the Multimedia entity, you would need to choose a parent entity, and set the selected multimedia type, e.g. in OFD configuration, the value of SelectedMultimediaType = Workflow, in the case of the Multimedia Scanning Queue, the configuration of a Parent Entity, or Property is not required.
OFD Properties
Properties |
|
|
Value |
Custom Entity |
|
|
|
ID |
|
|
|
|
Element ID |
|
Generated by system |
Misc |
|
|
|
|
Action |
|
MsGovern.OpenForms.CustomControls.dll
MultimediaScanningQueue_Control |
|
Name |
|
|
|
Parent Entity |
|
– Not Required – |
|
Properties |
|
|
|
|
Tab sequence number |
– Not Required – |
|
|
Text |
Multimedia Scanning Queue
(User defined name) |
Extension Selector
This is displayed when the ellipsis button [ … ] at the end of the Action parameter is selected
Assembly |
Class |
MsGovern.OpenForms.CustomControls.dll |
MultimediaScanningQueue_Control |
Govern New Administration (GNA)
In the Department Maintenance form when defining Multimedia codes, note that one of two data types can be used for scanned requests. The data types that can be scanned are as follows:
- I (Image) – Image files that are stored within the database.
- P (Picture Link in the database) – Links to files that are external to the database.
NOTE: Picture (P) data types are associated with the External Document (Permanent Path) option. |
User Interface
When correctly configured, the Multimedia Scanning Queue form is presented with three (3) main groups. On the tab is a Refresh button
Queue group – parameters (center)
Queue grid Columns
Multimedia Type – Select one of two options Name, or Parcel. The initial default value is dependent upon whether the profile is based on a NA_ID, i.e. Name, or a P_ID, i.e. Parcel. This value can be changed to view the items in the queue.
Queue grid Columns
This grid is populated as a result of a query and will display a list of the multimedia documents that are to be scanned in the queue. There are two (2) queries that are used to populate the Queue grid. Which query used is determined by the value selected in the Multimedia Type parameter located above the grid. Consequently the columns displayed will be dependent on a selection of the Parcel (P_ID) or Name (NA_ID).
How to refresh the Queue grid
Users may refresh the grid containing queued items at any time. This can be done with a click on the refresh button that is displayed on the immediate right of the tab label.
Multimedia Type – Parcel
Entry Date – This column will display the entry date of the record
Document Type – The Document Type is the multimedia code that was assigned to the record when it is being queued. These codes are created in the Department Maintenance form under the Multimedia Codes tab.
Parcel Info – A certificate number is displayed in this column. If a certificate number is not present, then the application number is displayed.
Workflow # – When appropriate, this column will display the Workflow number associated with the record.
Multimedia Type – Name
Entry Date – This column will display the entry date specified for the queued record
Document Type – The Document Type is the multimedia code that was assigned to the record when it is being queued. These codes are created in the Department Maintenance form under the Multimedia Codes tab.
Name – This parameter displays the content of free_line_1 from the NA_NAMES table name (NA_ID) associated with the record.
Workflow # – When appropriate, this column will display the Workflow number associated with the record.
Details group
Info Type – This is the document type assigned to the requested file.
Details – Displays parcel or name information
Request Date – If available, this is the set date requested for the document
Document Type – The requested document type is indicated in this field. This is description of the document.
Image Type – This is the classification of the image.
Preview
Document Type – Description of the document.
File Type – This is the type of file, e.g. .jpg, .png, .bmp, .doc, .pdf, and so on.
Actions group
Import – Click to display the file selection window; navigate to and select the file that is to be imported.
Scan – To scan directly from Govern click this button. When the scan is complete the image will be displayed in the Preview group. No interim UI is displayed.
Save – A click on Save will save the file with the record. When the save is complete, the record will be removed from the scan queue.
Scan Settings subgroup
There is a combo-box that displays the WIA compliant scanner that is configured on the system.
Scan with the integrated UI – When this option is selected, the interface will default to the scanner manufacturers interface. When selected, all options in this form will be disabled.
Adding to the Queue
Items are added to the queue either directly through the Multimedia form, or as a result of actions that are associated with an activity. When the item has been added to the queue as a request, they can then be selected one at a time from the list. The required multimedia file is then acquired to be added to the request through a file import, or an import as a result of a scanner acquisition. When the imported document as been saved, i.e. associated with the queue request, the file is removed from the queue.
Documentation
101-std-frm-010 Workflow Multimedia Scanning Queue.pdf
See Also
Workflow Management ACTION – Generate Multimedia Image Queue
Multimedia
Workflow Management Product Map