Maarch Framework 2.1/Technical Handbook/Data model

De Maarch // Wiki.

Sommaire 1 arboxes 2 arcontainers 3 authors 4 baskets 5 docservers 6 doctypes 7 ext_docserver 8 fulltext 9 groupbasket 10 groupsecurity 11 history 12 res_x 13 resgroup_content 14 resgroups 15 security 16 usergroup_content 17 usergroups 18 users

arboxes

• ARBOX_ID  varchar(32) Archive box identifier
• TITLE  varchar(255) Title
• SUBJECT  varchar(255) Subject 
• DESCRIPTION  text Description 
• ARCONTAINER_ID  varchar(32) Id of the container where the archive box is stored 
• STATUS  varchar(3) Status 
• CREATION_DATE  datetime Creation date and time 
• RETENTION_TIME  datetime Previsional retention time 
• CUSTOM_T1  varchar(3) Custom fields... 
• CUSTOM_N1  int(255) Put here your own business informations 
• CUSTOM_F1  float
• CUSTOM_D1  datetime
• CUSTOM_T2  varchar(3)
• CUSTOM_N2  int(255)
• CUSTOM_F2  float
• CUSTOM_D2  datetime
• CUSTOM_T3  varchar(50)
• CUSTOM_N3  int(255)
• CUSTOM_F3  float
• CUSTOM_D3  datetime
• CUSTOM_T4  varchar(50)
• CUSTOM_N4  int(255)
• CUSTOM_F4  float
• CUSTOM_D4  datetime
• CUSTOM_T5  varchar(255)
• CUSTOM_N5  int(255)
• CUSTOM_F5  float
• CUSTOM_D5  datetime
• CUSTOM_T6  varchar(255)
• CUSTOM_T7  varchar(255)
• CUSTOM_T8  varchar(255)
• CUSTOM_T9  varchar(255)
• CUSTOM_T10  varchar(255)

arcontainers

• ARCONTAINER_ID  varchar(32) Container identifier 
• TITLE  varchar(255) Title 
• SUBJECT  text Subject 
• DESCRIPTION  text Description 
• STATUS  varchar(3) Status 
• STORAGE_ID  varchar(32) Storage identifier. There is no storage table. Just mention a location (company, warehouse, town, ...) 
• ADDRESS  varchar(255) Adress in the storage location (ex: x,y,z) 
• CREATION_DATE  datetime Creation date and time 
• RETENTION_TIME  datetime Previsional retention time 
• CUSTOM_T1  varchar(50) Custom fields... 
• CUSTOM_N1  int(255) Put here your own business informations 
• CUSTOM_F1  float
• CUSTOM_D1  datetime
• CUSTOM_T2  varchar(3)
• CUSTOM_N2  int(255)
• CUSTOM_F2  float
• CUSTOM_D2  datetime
• CUSTOM_T3  varchar(255)
• CUSTOM_N3  int(255)
• CUSTOM_F3  float
• CUSTOM_D3  datetime
• CUSTOM_T4  varchar(255)
• CUSTOM_N4  int(255)
• CUSTOM_F4  float
• CUSTOM_D4  datetime
• CUSTOM_T5  varchar(255)
• CUSTOM_N5  int(255)
• CUSTOM_F5  float
• CUSTOM_D5  datetime
• CUSTOM_T6  varchar(255)
• CUSTOM_T7  varchar(255)
• CUSTOM_T8  varchar(255)
• CUSTOM_T9  varchar(255)
• CUSTOM_T10  varchar(255)

authors

• AUTHOR_ID  varchar(32) Author identifier 
• FIRSTNAME  varchar(255) Firstname 
• LASTNAME  varchar(255) Lastname 
• ENABLED  char(1) Enabled flag (Y/N) 
• CUSTOM_T1  text Custom fields... 
• CUSTOM_T2  varchar(255) Put here your own business informations 
• CUSTOM_T3  varchar(255)
• CUSTOM_T4  varchar(255)
• CUSTOM_T5  varchar(255)
• CUSTOM_T6  varchar(255)
• CUSTOM_T7  varchar(255)
• CUSTOM_T8  varchar(255)
• CUSTOM_T9  varchar(255)
• CUSTOM_T10  varchar(255)
• CUSTOM_D1  datetime
• CUSTOM_N1  double

baskets

• RES_TABLE  varchar(32) Resource table 
• BASKET_ID  varchar(32) Basket Id 
• BASKET_DESC  varchar(255) Description 
• BASKET_CLAUSE  text Where clause to display the basket 

docservers

• DOCSERVER_ID  varchar(32) Document server identifier 
• DEVICE_TYPE  varchar(32) Example : DVD, CD, HDD, etc. Reserved word : EXT - External storage system 
• DEVICE_LABEL  varchar(255) Device label (ex: DVD label) 
• IS_READONLY  char(1) Readonly flag (Y/N) 
• ENABLED  char(1) Enabled flag (Y/N) 
• SIZE_LIMIT  bigint(8) Size limit in bytes (0 : no size limit) 
• ACTUAL_SIZE  bigint(8) Actual remaining space in bytes 
• PATH_TEMPLATE  varchar(255) Path template (not used yet - path schema is calculated by ingestion modules) 
• EXT_DOCSERVER_INFO  varchar(255) Complementary information to access external storage (ex: Ascent document server) 
• CHAIN_BEFORE  varchar(32) Chained removable medias : previous media 
• CHAIN_AFTER  varchar(32) Chained removable medias : next media 
• CREATION_DATE  datetime Creation date and time 
• CLOSING_DATE  datetime Closing date and time 

doctypes

• RES_TABLE  varchar(8)
• TYPE_ID  varchar(50) Resource type identifier 
• DESCRIPTION  varchar(255) Description 
• CUSTOM_T1  varchar(255) Custom fields... 
• CUSTOM_T2  varchar(255) Put here your own business informations 
• CUSTOM_T3  varchar(255)
• ENABLED  char(1) Enabled flag (Y/N) 

ext_docserver

• DOC_ID  varchar(255) Logical adress in external storage 
• PATH  varchar(255) External application path (here for Ascent Capture release) 

fulltext

• RES_TABLE  varchar(32) Resource table 
• RES_ID  bigint(8) Resource Id 
• TEXT_TYPE  varchar(8) Type of free text : CONtent; ANNonation; ? 
• FULLTEXT_CONTENT  longtext Full text to index 

groupbasket

• GROUP_ID  varchar(32) Group identifier 
• RES_TABLE  varchar(32) Resource table 
• BASKET_ID  varchar(32) Basket Id 
• SEQUENCE  int(11) Display sequence of the basket in the interface basket list

groupsecurity

• GROUP_ID  varchar(32) Group identifier 
• RESGROUP_ID  varchar(32) Resource group id 
• CAN_VIEW  char(1) Can view group (Y/N) 
• CAN_ADD  char(1) Can add resource in the group (Y/N) 
• CAN_DELETE  char(1) Can delete resource in the group (Y/N) 

history

• ID  bigint(8) History system id (auto-increment) 
• TABLE_NAME  varchar(32) Table concerned 
• RECORD_ID  varchar(255) Record concerned in the table 
• EVENT_TYPE  varchar(32) Event type - Ex: "INSERT, DELETE, LOGIN, PROPOSAL, FAVORITE, ..." 
• USER_ID  varchar(50) User identifier 
• EVENT_DATE  datetime Event date and time 
• INFO  text Complementary information 

res_x

• RES_ID  bigint(8) Resource system identifier 
• TITLE  varchar(255) Title (DC) 
• SUBJECT  text Subject (DC) 
• DESCRIPTION  text Description (DC) 
• PUBLISHER  varchar(255) Publisher (DC) 
• CONTRIBUTOR  varchar(255) Contributor (DC) 
• TYPE_ID  varchar(50) Resource type (DC) 
• FORMAT  varchar(50) Format (DC) 
• TYPIST  varchar(50) Typist : user identifier that created the record in Maarch 
• CREATION_DATE  datetime Resource creation time in Maarch 
• AUTHOR  varchar(255) Author (DC) - Multivalued 
• AUTHOR_NAME  text Author name(s) - copied from authors table - 
• IDENTIFIER  varchar(255) Unique identifier for the resource (DC) 
• SOURCE  varchar(255) Source (DC) 
• DOC_LANGUAGE  varchar(50) Language (DC) 
• RELATION  varchar(255) Relation (DC) 
• COVERAGE  varchar(255) Coverage (DC) 
• DOC_DATE  datetime Date (DC) 
• RIGHTS  varchar(20) Rights (DC) - not used in security schema 
• DOCSERVER_ID  varchar(32) Document server containing the image 
• ARBOX_ID  varchar(32) Archive box containing the paper copy 
• PATH  varchar(255) Path in Maarch document server 
• FILENAME  varchar(255) Filename in Maarch document server 
• OFFSET  varchar(255) Emplacement of the document in the image file (used for COLD compression) 
• LOGICAL_ADR  varchar(255) Logical adress in an external storage 
• FINGERPRINT  varchar(255) MD5 fingerprint 
• FILESIZE  bigint(20) File size in Maarch document server 
• IS_PAPER  char(1) Paper only resource (Y/N) 
• PAGE_COUNT  int(11) Page count 
• SCAN_DATE  datetime Scan date 
• SCAN_USER  varchar(50) Scan user 
• SCAN_LOCATION  varchar(255) Scan location 
• SCAN_WKSTATION  varchar(255) Scanning workstation identifier 
• SCAN_BATCH  varchar(50) Scan batch identifier 
• BURN_BATCH  varchar(50) CD/DVD copy identifier 
• SCAN_POSTMARK  varchar(50) Scan postmarking string 
• ENVELOP_ID  bigint(20) Envelop containg the documents (grouping) 
• STATUS  varchar(3) Status 
• DESTINATION  varchar(50) Destination (basket) 
• APPROVER  varchar(50) Approver 
• VALIDATION_DATE  datetime Validation date and time 
• WORK_BATCH  varchar(32) Work batch (videocoding batch) 
• ORIGIN  varchar(50) Origin (paper, fax, email, etc.) 
• IS_INGOING  char(1) Ingoing or outgoing (Y/N) 
• PRIORITY  smallint(6) Priority 
• CUSTOM_T1  text
• CUSTOM_N1  bigint(20)
• CUSTOM_F1  float
• CUSTOM_D1  datetime
• CUSTOM_T2  varchar(255)
• CUSTOM_N2  bigint(20)
• CUSTOM_F2  float
• CUSTOM_D2  datetime
• CUSTOM_T3  varchar(255)
• CUSTOM_N3  bigint(20)
• CUSTOM_F3  float
• CUSTOM_D3  datetime
• CUSTOM_T4  varchar(255)
• CUSTOM_N4  bigint(20)
• CUSTOM_F4  float
• CUSTOM_D4  datetime
• CUSTOM_T5  varchar(255)
• CUSTOM_N5  bigint(20)
• CUSTOM_F5  float
• CUSTOM_D5  datetime
• CUSTOM_T6  varchar(255)
• CUSTOM_T7  varchar(255)
• CUSTOM_T8  varchar(255)
• CUSTOM_T9  varchar(255)
• CUSTOM_T10  varchar(255)
• CUSTOM_T11  varchar(255)
• CUSTOM_T12  varchar(255)
• CUSTOM_T13  varchar(255)
• CUSTOM_T14  varchar(255)
• CUSTOM_T15  varchar(255)

resgroup_content

• RES_TABLE  varchar(8) Resource table 
• RES_ID  bigint(8) Resource Id 
• RESGROUP_ID  varchar(32) Resource group id 
• SEQUENCE  int(11) Order number in the group 

resgroups

• RESGROUP_ID  varchar(32) Resource group id 
• RESGROUP_DESC  varchar(255) Description 
• CREATED_BY  varchar(255) User creator of the group 
• CREATION_DATE  datetime Creation date and time 

security

• GROUP_ID  varchar(32) Group identifier 
• RES_TABLE  varchar(32) Resource table 
• WHERE_CLAUSE  text SQL where clause to restrict access for that table 
• CAN_INSERT  char(1) User can insert new records in the resource table 
• CAN_UPDATE  char(1) User can update existing records in the resource table 

usergroup_content

• USER_ID  varchar(32) User identifier 
• GROUP_ID  varchar(32) Group identifier 
• PRIMARY  char(1) Primary group for the user 
• ROLE  varchar(255) Role in the group (freetext) 

usergroups

• GROUP_ID  varchar(32) User group identifier 
• GROUP_DESC  varchar(255) Description 
• ADMINISTRATOR  char(1) Administrator flag (Y/N) 

users

• USER_ID  varchar(32) User identifier 
• PASSWORD  varchar(255) Crypted password (if standalone security) 
• FIRSTNAME  varchar(255) Firstname 
• LASTNAME  varchar(255) Lastname 
• GROUP_ID  varchar(32) Group identifier of the user 
• PHONE  varchar(15) Phone 
• MAIL  varchar(255) Mail 
• DEPARTMENT  varchar(50) Departement, service, unit, etc. 
• SECURITY_LEVEL  varchar(50) Security level 
• COOKIE_KEY  varchar(255) System field 
• COOKIE_DATE  datetime System field 
• ENABLED  char(1) Enabled flag (Y/N)