Data models


Data models common fields

FieldTypeDescription

_id

StringDatabase id of the entry

_id_web

StringShort id of the entry (aka web id)

_id_ext

StringField for storing external system Id of the entry, usually used with the data which is imported / synced with the external source

_id_kf

StringForeign key field which stores _id value of the parent record (commonly in the same collection)

_meta

Object

Meta data about the entry

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

DocForm data model represents documents in the system

FieldTypeDescription
_idStringSee the common fields table
_id_webStringSee the common fields table
_metaObjectSee the common fields table
_aclObjectSee the common fields table
_templatesObjectList of document templates
stateInteger

Indicates document process phase

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

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)
statusInteger

Indicates document status

ValueDescription
1Normal
2Suspended
3Cancelled
4Blocked
iterationIntegerIndicates document iteration on the phase, starts from 1 for 1st iteration, incremented by 1 on each document sending to re-work
authorStringId of the document author (user account which created the document)
authordonebyStringId of the actual account which acted on behalf of the stated author
formStringShort id of the Document Form (equals to the _id_web of the respective SysForm data model, e.g.: fd1, fd12, frd1)
formsystypeIntegerDocument form system type: 0 - static, 1 - dynamic
sysprocessidStringId of the of the document process definition data model (_id of the SysProcess data model)
sfdataObjectStandard Fields definition data
cfdataObjectCustom Fields definition data
cfXXX-Custom Field value (where XXX is index of the field in the cfdata.customFields array starting with 0). Data type defined by Custom Fields definition data 
refdocsString/ArrayList of references to other document ids 
doctitle_enStringName of the document form
docnumStringDocument number
doctopicStringDocument subject
descriptionStringDocument description
datecreatedDateDate document was created
datedueDateDate due
dateincomeDateDate document was moved to the current phase
datearchivedDateDate document was archived

RecoData data model

RecoData data model represents recognition data retrieved during IDP cycle. RecoData models are accessed as embedded fields of the respective DocForm data model (of the Recognition Document form only).

FieldTypeDescription
_idStringSee the common fields table
_metaObjectSee the common fields table
_cfDefArrayCustom fields definition
_cfDataObjectCustom fields values
refIdStringReferenced DocForm
pageIdxStartIntegerStart page indexes (inclusive)
pageIdxEndIntegerEnd page indexes (inclusive)
validatedBooleanProperty shows whether values were validated (either 1: auto based on confidence levels or 2: manually via UI by end-user)
recoFormObject

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

DocResponse data model

DocResponse data model represents document actions of the document process participants.

FieldTypeDescription
_idStringSee the common fields table
_metaObjectSee the common fields table
_refStringId of the DocForm model to which this DocResponse belongs to
authorStringId of the action author (user account which created the document)
authordonebyStringId of the actual account which acted on behalf of the stated author
stateIntegerIndicates document process phase
stepIntegerIndicates document step on the phase where step=0 is always an initiator step
iterationIntegerIndicates document iteration on the phase, starts from 1 for 1st iteration, incremented by 1 on each document sending to re-work
statusIntegerIndicates document status
taskstatusIntegerAction status
resolidStringResolution id
resoltoStringId of the account to which resolution was given
refdocsString/arrayList of references to other document ids 
contentStringAction description

CRM Org data model

CRM Org data model represents CRM organization in the system.

FieldTypeDescription
_idStringSee the common fields table
_id_webStringSee the common fields table
_id_extStringSee the common fields table
_metaObjectSee the common fields table
nameStringName of the company
nameExtArrayOther names and related associations like TM, etc.
govIdStringCompany Id assigned by local government authorities
authorStringId of the author (user account which created the entry)
ownerStringId of the responsible user
_cfDefArrayCustom fields definition
_cfDataObjectCustom fields values
areaIdStringCompany area
typeIdStringCompany type
_tagsArrayNot in use / not shown on UI currently
notesStringNotes about the entry

ListValue data model

ListValue data model represents multi-language directories of values which can be selected in the system

FieldTypeDescription

_id

StringSee the common fields table
_id_kfStringSee the common fields table
_id_extStringSee the common fields table

_meta

ObjectSee the common fields table
_aclObjectSee the common fields table
statusIntegerStatus of the record (0 - Normal, 10 - Deleted)
typeIntegerSystem type of the record
authorStringId of the record author (user account which created the document)
valueObjectMap with per-language values (key: language code, value - value for the givel language)