Data models

Data models common fields

FieldTypeDescription
_id
StringDatabase id of the document
_id_web
StringShort id of the document (aka web id)
_meta
Object

Meta data about the document

FieldTypeDescription
_meta._created
DateJSON ISO String with date representation of the date when document was created
_meta._lastmodified
DateJSON ISO String with date representation of the date when document was last modified
_meta._rev
IntRevision number (for concurrency update check)
_acl
Object

Access Control List data

FieldTypeDescription
_acl._r
ListList of Users, Groups, Roles with Read-Only access to the document
_acl._w
ListList of Users, Groups, Roles with Read-Write access to the document

NOTE: Due to backward compatibility with the older versions of the elDoc system some data models may have first-level property names used in lower-case


DocForm data model

FieldTypeDescription
_id
StringSee the common fields table
_id_web
StringSee the common fields table
_meta
ObjectSee the common fields table
_acl
ObjectSee the common fields table
state
Int

Indicates document process phase

ValueDescription
0Draft phase
1Approving phase
2Signing phase
3Follow-up phase
4-94Reserved for dynamic process phases
95Repository phase
100Archive phase
step
Int

Indicates document step on the phase where step=0 is always an initiator step

Recognition Document has the following standard steps:

ValueDescription
1Recognition step
2Validation after recognition (if required)
3Conversion step (optional)
4Validation after conversion (if required)
status
Int

Indicates document status

ValueDescription
1Normal
2Suspended
3Cancelled
4Blocked
iteration
IntIndicates document iteration on the phase, starts from 1 for 1st iteration, incremented by 1 on each document sending to re-work
author
StringId of the document author (user account which created the document)
form
StringShort id of the Document Form (SysForm data model)
sysprocessid
StringId of the of the Document Process (SysProcess data model)

RecoData data model

FieldTypeDescription
_id
StringSee the common fields table
_meta
ObjectSee the common fields table
_cfDef
ArrayCustom fields defenition
_cfData
ObjectCustom fields values
refId
StringReferenced DocForm
pageIdxStart
IntStart page indexes (inclusive)
pageIdxEnd
IntEnd page indexes (inclusive)
validated
BooleanProperty shows whether values were validated (either 1: auto based on confidence levels or 2: manually via UI by end-user)
recoForm
Object

RecoForm object which is confirmed by either auto-validation or manual-validation step. Its value represents the RecoForm selected by user during manual-validation step, whereas recoData.recoResult.recoForm always remains unchanged.

FieldTypeDescription
id
String_id of the RecoForm
name
StringName of the RecoForm
form
StringId of the target document form to which this Recognition document (RecoData) will be converted.
recoResult

Object

(Embeddable)

Recognition result identified for the given document

FieldTypeDescription
recoForm
ObjectRecoForm identified automatically by IDP for the selected pages (its value copied to the recoData.recoForm property). Its value remains unchanged during the manual-validation step (in case user selects different RecoForm)
recoFormConfidence
IntConfidence level of the matched recoForm