DocumentVersion
The following rules are applied to WorkZone FESD Web Services’s implementation of the DocumentVersion object:
- Only one DocumentVersion may be created for a Document.
- Documents with no versions have NULL value in the field external_doc_id.
- CreateDocumentVersion method returns ERR_PERMISSION_DENIED if called for a Document with 1 version.
Mapping of the FESD attributes to the WorkZone FESD Web Services database fields and notes on WorkZone FESD Web Services implementation are presented in the table below.
| FESD Parameter | WorkZone FESD Web Services Table | WorkZone FESD Web Services Field | WorkZone FESD Web Services Implementation Notes |
|---|---|---|---|
| userIdentifier | N/A | N/A | Is recorded to Use_log.identification field. |
| documentVersionIdentifier | Record | fesd_id_key | Parameter type is GUID. |
| uniqueIdentifier | Record | fesd_id_key | Parameter type is GUID instead of int(10) specified by FESD standard. |
| documentIdentifier | Record | document_version_key | Parameter type is GUID. |
| documentReference | Record | document_version_key | The same as documentIdentifier. For UpdateDocumentVersion method, should be equal to GUID of Version’s document; otherwise, ERR_NOT_FOUND is returned. |
| documentVersionNumber | Record | version_no | |
| renditionTypeCode | N/A | N/A | Not implemented by OpenWSI. |
| activeIndicator | N/A | N/A | Not implemented by OpenWSI. |
| archiveFormatCode | Record | document_type | Parameter type is char(32) instead of char(10) specified by FESD standard. |
| creatorReference | Record | create_user | Parameter type is GUID instead of int(10) specified by FESD standard. For output, it is retrieved as fesd_id_key from a row found in Users table by user_name = value of the field. |
| archiveReference | N/A | N/A | Not implemented by OpenWSI. Ignored at input. |
| documentContents | Record | external_doc_id | Value of field Record.external_doc_id points to the location of document contents in the archive database. |