OpenGroupware Coils Wiki
Status: Beta
Brought to you by:
whitemice
Menu
▾
▴
Document
Document
Properties
| Name | Type | Description |
|---|---|---|
| object_id | Integer (objectId) | |
| appointment_id | Integer (objectId) | |
| project_id | Integer (objectId) | |
| company_id | Integer (objectId) | |
| folder_id | Integer (objectId) | |
| version | Integer | |
| version_count | Integer | |
| abstract | String(255) | |
| status | String(50) | |
| state | String(50) | |
| name | String(255) | |
| creator_id | Integer (objectId) | |
| created | DateTime | |
| owner_id | Integer (objectId) | |
| modified | DateTime | |
| extension | String(255) | |
| file_size | Integer |
The following [Document] "name" values are prohibited. Attempting to create a document with one of these name values will result in an exception.
- Any name consisting of entirely of some combination of the following characters:
- "*"
- "."
- Space
- Tab
- "?"
- "_"
Access
Omphalos
The Omphalos entity name is "File".
| Attribute | Legacy | Level | Data Type | Write | Description |
|---|---|---|---|---|---|
| creation | YES | 0 | datetime | NO | |
| creatorObjectId | YES | 0 | integer (objectId) | NO | |
| fileSize | YES | 0 | integer | NO | |
| fileType | YES | 0 | string | YES | |
| filename | YES | 0 | string | YES | |
| folderObjectId | YES | 0 | integer (objectId) | NO | |
| lastModified | YES | 0 | datetime | NO | |
| objectId | YES | 0 | integer (objectId) | NO | |
| ownerObjectId | YES | 0 | integer (objectId) | NO | |
| projectObjectId | YES | 0 | integer (objectId) | NO | |
| status | YES | 0 | string | NO | |
| title | YES | 0 | string | YES | |
| mimetype | NO | 0 | string | NO | |
| version | YES | 0 | integer (sequence) | NO |
Flags
| Flag | ACL Char. | Description |
|---|---|---|
| READONLY | ||
| WRITE | w | |
| OWNER | n/a | |
| IPPPRINTABLE | n/a | |
| DAMAGED | n/a | The server is suspect concerning the content of the document; the MIME-type, the encoding, etc... This most commonly is set when the server receives a document via e-mail and decoding the attachment results in some type of exception. |
Example
Legacy
{'_ACCESS': [],
'_LOGS': [{'action': '00_created',
'actionDate': <DateTime '20131119T20:03:35' at 7fee1ae5dfc8>,
'actorObjectId': 10100,
'entityName': 'logEntry',
'entityObjectId': 112645079,
'message': 'Document#112645079 "ogo112635155.py" created by "adam"',
'objectId': 112645139}],
'_OBJECTLINKS': [{'direction': 'to',
'entityName': 'objectLink',
'label': 'ogo112635155.py',
'objectId': 112645119,
'sourceEntityName': 'Task',
'sourceObjectId': '112635155',
'targetEntityName': 'File',
'targetObjectId': '112645079',
'type': 'generic'}],
'_PROPERTIES': {'{http://www.opengroupware.us/mswebdav}contentType': {'attribute': 'contentType',
'entityName': 'objectProperty',
'label': '',
'namespace': 'http://www.opengroupware.us/mswebdav',
'parentObjectId': 112645079,
'propertyName': '{http://www.opengroupware.us/mswebdav}contentType',
'type': '',
'value': 'text/x-python',
'valueType': 'unknown',
'values': ''},
'{http://www.opengroupware.us/mswebdav}isTransient': {'attribute': 'isTransient',
'entityName': 'objectProperty',
'label': '',
'namespace': 'http://www.opengroupware.us/mswebdav',
'parentObjectId': 112645079,
'propertyName': '{http://www.opengroupware.us/mswebdav}isTransient',
'type': '',
'value': 'NO',
'valueType': 'unknown',
'values': ''}},
'attachment': '/var/lib/opengroupware.org/documents/11360/112645000/112645079.py',
'creation': <DateTime '20131119T20:03:35' at 7fee1ae5def0>,
'creatorObjectId': 10100,
'entityName': 'File',
'fileSize': 1768,
'fileType': 'py',
'filename': 'ogo112635155',
'folderObjectId': 112645069,
'lastModified': <DateTime '20131119T20:03:35' at 7fee1ae5dea8>,
'objectId': 112645079,
'ownerObjectId': 10100,
'projectObjectId': 11360,
'status': '',
'title': 'ogo112635155.py',
'version': 1}
Coils
{'FLAGS': ['WRITE', 'OWNER'],
'_ACCESS': [],
'_LOGS': [{'action': '00_created',
'actionDate': <DateTime '20131007T19:34:40' at 7f275ef61f38>,
'actorObjectId': 10100,
'entityName': 'logEntry',
'entityObjectId': 112645079,
'message': 'Document#112645079 "ogo112635155.py" created by "adam"',
'objectId': 112645139}],
'_OBJECTLINKS': [{'direction': 'to',
'entityName': 'objectLink',
'label': 'ogo112635155.py',
'objectId': 112645119,
'sourceEntityName': 'Task',
'sourceObjectId': 112635155,
'targetEntityName': 'Document',
'targetObjectId': 112645079,
'type': 'generic'}],
'_PROPERTIES': {'{http://www.opengroupware.us/mswebdav}contentType': {'attribute': 'contentType',
'entityName': 'objectProperty',
'label': '',
'namespace': 'http://www.opengroupware.us/mswebdav',
'parentObjectId': 112645079,
'propertyName': '{http://www.opengroupware.us/mswebdav}contentType',
'type': '',
'value': 'text/x-python',
'valueType': 'string',
'values': ''},
'{http://www.opengroupware.us/mswebdav}isTransient': {'attribute': 'isTransient',
'entityName': 'objectProperty',
'label': '',
'namespace': 'http://www.opengroupware.us/mswebdav',
'parentObjectId': 112645079,
'propertyName': '{http://www.opengroupware.us/mswebdav}isTransient',
'type': '',
'value': 'NO',
'valueType': 'string',
'values': ''}},
'creation': <DateTime '20131007T19:34:40' at 7f275ef61ef0>,
'creatorObjectId': 10100,
'entityName': 'File',
'fileSize': 1768,
'fileType': 'py',
'filename': 'ogo112635155',
'folderObjectId': 112645069,
'lastModified': <DateTime '20131007T19:34:40' at 7f275ef640e0>,
'mimetype': 'text/x-python',
'objectId': 112645079,
'ownerObjectId': 10100,
'projectObjectId': 11360,
'status': 'inserted',
'title': 'ogo112635155.py',
'version': 1}
zOGI
Logic
The following Logic commands are implemented in the "coils.logic.blob" bundle.
| Command | Parameters | Description |
|---|---|---|
| document::delete | id \ object | |
| document::move | document, to_filename, to_folder | |
| document::new | folder, project, appointment, contact \ enterprise, name, annotation, handle | |
| folder:::delete | id \ object | |
| folder::new | folder, values |
Related
Tickets: #246
Tickets: #312
Wiki: AttachFS
Wiki: Document
Wiki: LogicCommand
Wiki: Model
Wiki: Project
