Data Models common fields

Field Type Description

_id

String

Database id of the entry

_id_web

String

Short id of the entry (aka web id)

_id_ext

String

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

_id_kf

String

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

_meta

Object

Meta data about the entry

Field	Type	Description
_meta._created	Date	JSON ISO String with date representation of the date when document was created
_meta._lastmodified	Date	JSON ISO String with date representation of the date when document was last modified
_meta._rev	Int	Revision number (for concurrency update check)

_acl

Object

Access Control List data

Field	Type	Description
_acl._r	List	List of Users, Groups, Roles with Read-Only access to the document
_acl._w	List	List 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

The DocForm data model represents a workflow form (document) in the system.

Field Type Description

_id String See the common fields table

_id_web String See the common fields table

_meta Object See the common fields table

_acl Object See the common fields table

_templates Object List of document templates

_tags

Array

Assigned tags to the document

state

Integer

Indicates document process phase

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

step

Integer

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

Recognition Document has the following standard steps:

Value	Description
1	Recognition step
2	Validation after recognition (if required)
3	Conversion step (optional)
4	Validation after conversion (if required)

status

Integer

Indicates document status

Value	Description
1	Normal
2	Suspended
3	Cancelled
4	Blocked

iteration Integer Indicates document iteration on the phase, starts from 1 for 1st iteration, incremented by 1 on each document sending to re-work

author String Id of the document author (user account which created the document)

authordoneby String Id of the actual account which acted on behalf of the stated author

form String Short id of the Document Form (equals to the _id_web of the respective SysForm data model, e.g.: fd1, fd12, frd1)

formsystype Integer Document form system type: 0 - static, 1 - dynamic

sysprocessid String Id of the of the document process definition data model (_id of the SysProcess data model)

sfdata Object Standard Fields definition data

cfdata Object Custom 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

refdocs String/Array List of references to other document ids

doctitle_en String Name of the document form

docnum String Document number

doctopic String Document subject

description String Document description

datecreated Date Date document was created

datedue Date Date due

dateincome Date Date document was moved to the current phase

datearchived Date Date document was archived

RecoData Data Model

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

Field Type Description

_id String See the common fields table

_meta Object See the common fields table

_cfDef Array Custom fields definition

_cfData Object Custom fields values

refId String Referenced DocForm

pageIdxStart Integer Start page indexes (inclusive)

pageIdxEnd Integer End page indexes (inclusive)

validated Boolean Property 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.

Field	Type	Description
id	String	_id of the RecoForm
name	String	Name of the RecoForm
form	String	Id of the target document form to which this Recognition document (RecoData) will be converted.

recoResult

Object

(Embeddable)

Recognition result identified for the given document

Field	Type	Description
recoForm	Object	RecoForm 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	Int	Confidence level of the matched recoForm

DocResponse Data Model

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

Field	Type	Description
`_id`	String	See the common fields table
`_meta`	Object	See the common fields table
`_ref`	String	Id of the DocForm model to which this DocResponse belongs to
`author`	String	Id of the action author (user account which created the document)
`authordoneby`	String	Id of the actual account which acted on behalf of the stated author
`state`	Integer	Indicates document process phase
`step`	Integer	Indicates document step on the phase where step=0 is always an initiator step
`iteration`	Integer	Indicates document iteration on the phase, starts from 1 for 1st iteration, incremented by 1 on each document sending to re-work
`status`	Integer	Indicates document status
`taskstatus`	Integer	Action status
`resolid`	String	Resolution id
`resolto`	String	Id of the account to which resolution was given
`refdocs`	String/array	List of references to other document ids
`content`	String	Action description

CRM Org Data Model

The CRM Org data model represents a CRM organization in the system.

Field	Type	Description
`_id`	String	See the common fields table
`_id_web`	String	See the common fields table
`_id_ext`	String	See the common fields table
`_meta`	Object	See the common fields table
`name`	String	Name of the company
`nameExt`	Array	Other names and related associations like TM, etc.
`govId`	String	Company Id assigned by local government authorities
`author`	String	Id of the author (user account which created the entry)
`owner`	String	Id of the responsible user
`_cfDef`	Array	Custom fields definition
`_cfData`	Object	Custom fields values
`areaId`	String	Company area
`typeId`	String	Company type
`_tags`	Array	Not in use / not shown on UI currently
`notes`	String	Notes about the entry

ListValue Data Model

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

Field	Type	Description
`_id`	String	See the common fields table
`_id_kf`	String	See the common fields table
`_id_ext`	String	See the common fields table
`_meta`	Object	See the common fields table
`_acl`	Object	See the common fields table
`status`	Integer	Status of the record (0 - Normal, 10 - Deleted)
`type`	Integer	System type of the record
`author`	String	Id of the record author (user account which created the document)
`value`	Object	Map with per-language values (key: language code, value - value for the givel language)

CustomField Data Model

The CustomField data model is commonly used across the system for storing definitions of custom fields.

Field	Type	Description
`type`	String	Type of Custom Field. Possible values: string, numberInteger, number, dateTime, date, checkbox, crmOrg, listValue, docRef, table, sign, namePckr, reco, recoTable, recoOmr, recoImage
`subType`	String	Sub-type of the field
`enabled`	Boolean	Defines if this field is enabled on the UI or not
`required`	Boolean	Defines if this field is required to be filled or not
`prefix`	String	Datastore field name prefix, defaults to "cf"
`fieldName`	String	Datastore field name (optional - reserved for future usage)
`tags`	Array	Assigned tags to the field
`name`	Object	Field name to be used on the UI, stored as lang:value pairs
`fields`	Array	Array of CustomField models. Embedded fields to be used for representing table columns, etc.
`_properties`	Object	Key-value object for storing custom properties assigned to the field Supported values: `dsblRowAdd` - (Boolean) Disables row add button on tables when set to TRUE (Experimental - can be replaced without further notice) `dsblRowRmv` - (Boolean) Disables row remove button on tables when set to TRUE (Experimental - can be replaced without further notice)