Setting up document capture

On the Reports page (menu Reports), users see one card per configured capture type. With a card they upload a file or create a document without a file, for example a reclassification document. What this looks like for users is described in Upload.

Reports page with two cards: one with file upload and the selection fields Organization Unit and Classification, one without a file

Each card is an entry in the table conf.IrReport. There is no user interface for editing; the entries are maintained with SQL.

Note

Only users with the Reports permission (Pages.Reports) see the page. If there is no entry, the page shows “No Reports configured!”.

Columns of conf.IrReport

Column	Meaning
Id	GUID of the entry.
TenantId	Tenant.
Name	Title of the card. Can be a localization key, then it is shown translated.
Description	Description on the card, also localizable.
ExternalIdPrefix	Optional. Prefix for the document number; invoiceR appends a sequential number.
ProcessId	Process in which the new document is created (conf.Processes).
NodeId	Workflow step in which the first task starts (conf.Nodes).
ClassificationId	Optional. Default classification; otherwise the process classification applies.
ShowClassificationSelector	The user selects the Classification.
ShowOrganizationUnitSelector	The user selects the Organization Unit.
DefaultIrOrganizationUnitId	Organization unit if the user selects none and is not assigned to one.
ShowAssignUserSelector	The user selects the Assignment User for the first task.
ShowAssignRoleSelector	The user selects the Assignment Role for the first task.
ShowDocumentUpload	The card shows the file upload field. Without this option a document without a file is created.
StartTaskAsBlocked	1: the task starts blocked, the user checks and completes the document first. 0: the document runs straight through the workflow.
DocumentRecogniserId	Optional. Text recognition service the uploaded file is sent to (conf.DocumentRecognisers).
ConfirmCreationTitle, ConfirmCreationMessage	Optional. Title and text of a confirmation prompt before the document is created.

Example

A card with which users upload an invoice, select the organization unit themselves and check the document before it starts:

INSERT INTO conf.IrReport
  (Id, TenantId, Name, Description, ProcessId, NodeId,
   ShowDocumentUpload, ShowOrganizationUnitSelector, ShowClassificationSelector,
   ShowAssignUserSelector, ShowAssignRoleSelector, StartTaskAsBlocked)
VALUES
  (NEWID(), 1, N'Upload invoice', N'Capture and check a PDF invoice',
   '<process-id>', '<node-id>',
   1, 1, 0,
   0, 0, 1);

You find the IDs for process and workflow step in conf.Processes and conf.Nodes.