...
...
hidden | true |
---|---|
id | REFACTURE |
Page Properties | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Resources & Remarks
Modification History
|
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<schema xmlns="http://optimal-systems.org/ns/dmscloud/schema/v5.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://optimal-systems.org/ns/dmscloud/schema/v5.0/ dmsCloud-schema.xsd"> <propertyStringDefinition> <id>from</id> <propertyType>string</propertyType> <cardinality>single</cardinality> <required>true</required> </propertyStringDefinition> <propertyStringDefinition> <id>to</id> <propertyType>string</propertyType> <cardinality>multi</cardinality> <required>true</required> </propertyStringDefinition> <propertyStringDefinition> <id>subject</id> <propertyType>string</propertyType> <cardinality>single</cardinality> <required>true</required> <defaultValue>hello</defaultValue> <maxLength>20</maxLength> <minLength>4</minLength> </propertyStringDefinition> <propertyDateTimeDefinition> <id>received</id> <propertyType>datetime</propertyType> <cardinality>single</cardinality> <required>true</required> </propertyDateTimeDefinition> <typeDocumentDefinition> <id>email</id> <baseId>system:document</baseId> <propertyReference>from</propertyReference> <propertyReference>to</propertyReference> <propertyReference>received</propertyReference> <contentStreamAllowed>required</contentStreamAllowed> </typeDocumentDefinition> </schema> |
...
An exception are column names in Table Property Definitions, where prefixes are prohibited as of version 2020 Winter.
...
Attribute | Type | Required | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
id | String | yes | The type ID of the property. It uniquely identifies the property in the schema. | ||||||
localNamespace | URI | no | By using namespaces, it is possible to form groups of properties and object types. | ||||||
description | String | no | Describes the property. | ||||||
propertyType
| Enum | yes | Specifies the type of this property. The following types are supported:
| ||||||
cardinality
| Enum | yes | Defines whether the property can have a maximum of one or an arbitrary number of values. Possible values are single and multi. | ||||||
required | Boolean | yes | If true, the object must have at least one value of this property. If a property is required and has no This attribute can be overwritten in the property references of object type definitions. Hence, the same property can be required in one object type and not required in another object type. | ||||||
queryable
| Boolean | no | Specifies whether or not the property may appear in the WHERE clause of a query statement. Default is true. false is only allowed for table properties. | ||||||
classification | String | no | Declares the classifications this property belongs to. There is no validation or use in the system itself. For example, string properties can be classified as 'email' or 'url' and a client can use this classification to present the property's content in an appropriate manner. This tag can be used several times and the corresponding values are delivered in an array. Note: Make sure to validate the strings you set for the classification tags, so that your application will not fail if the string does not match the expected syntax. | ||||||
defaultValue | depending on thepropertyType | no | The value that the system sets for the property if no value is provided during object creation. If the |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<schema xmlns="http://optimal-systems.org/ns/dmscloud/schema/v5.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://optimal-systems.org/ns/dmscloud/schema/v5.0/ dmsCloud-schema.xsd"> <propertyTableDefinition> <id>aTableProperty</id> <propertyType>table</propertyType> <cardinality>single</cardinality> <required>false</required> <propertyStringDefinition> <id>col0</id> <propertyType>string</propertyType> <cardinality>single</cardinality> <required>false</required> </propertyStringDefinition> <propertyIntegerDefinition> <id>col1</id> <propertyType>integer</propertyType> <cardinality>single</cardinality> <required>false</required> </propertyIntegerDefinition> <propertyDateTimeDefinition> <id>col2</id> <propertyType>datetime</propertyType> <cardinality>single</cardinality> <required>false</required> </propertyDateTimeDefinition> <propertyDecimalDefinition> <id>col3</id> <propertyType>decimal</propertyType> <cardinality>single</cardinality> <required>false</required> </propertyDecimalDefinition> </propertyTableDefinition> </schema> |
...
As of version 2021 Summer, yuuvis® Momentum offers a property type for the storage of structured data in JSON format. Thus, it is possible to store interleaved data structures in a queryable way without defining each single sub-property in the schema. An example definition is shown in the code block below. The schema validation checks if the ID follows the convention. Only the value single
is allowed as cardinality
.
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<propertyStructuredDataDefinition> <id>customerdetails</id> <propertyType>structureddata</propertyType> <cardinality>single</cardinality> <required>false</required> </propertyStructuredDataDefinition> |
...
There are different groups of object type definitions:
Info |
---|
In a schema, all object type definitions must appear in this order. First all document object type definitions, then all folder object type definitions and so on. |
...
Attribut | Type | Required | Description | ||
---|---|---|---|---|---|
contentStreamAllowed | Enum | yes | Specifies whether objects of this type must, must not, or may have content. Possible values are:
Note: The attribute is also available for secondary object type definitions. If a secondary object type with a specified | ||
secondaryObjectTypeId | String | no | References to secondary object types (if there are several secondary object types, they are listed one below the other). Determines which secondary object types an instance of this object type receives upon creation (
|
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<schema xmlns="http://optimal-systems.org/ns/dmscloud/schema/v5.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://optimal-systems.org/ns/dmscloud/schema/v5.0/ dmsCloud-schema.xsd"> <propertyStringDefinition> <id>str1</id> <propertyType>string</propertyType> <cardinality>single</cardinality> <required>true</required> </propertyStringDefinition> <typeDocumentDefinition> <id>documentType1</id> <baseId>system:document</baseId> <propertyReference>str1</propertyReference> <contentStreamAllowed>required</contentStreamAllowed> <secondaryObjectTypeId>secondaryA</secondaryObjectTypeId> </typeDocumentDefinition> <typeFolderDefinition> <id>dossier</id> <baseId>system:folder</baseId> <propertyReference>title</propertyReference> <propertyReference>type</propertyReference> <propertyReference>description</propertyReference> </typeFolderDefinition> </schema> |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "objects": [ { "properties": { "system:objectTypeId": { "value": "dossier" }, "title": { "value": "My E-mail Folder #1" }, "type": { "value": "E-mails" }, "description": { "value": "This folder holds all the e-mails authored by me" } } } ] } |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "objects": [ { "properties": { "system:objectTypeId": { "value": "documentType1" }, "system:parentId": { "value": "<the Folder object ID from the import response" }, "str1": { "value": "Some important business documents" }, "description": { "value": "This folder holds all the e-mails authored by me" } } } ] } |
...
Attribute | Type | Required | Description | ||
---|---|---|---|---|---|
secondaryObjectTypeId | String | no | References to secondary object types (if there are several secondary object types, they are listed one below the other). Determines which secondary object types an instance of this object type receives upon creation (
|
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<schema xmlns="http://optimal-systems.org/ns/dmscloud/schema/v5.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://optimal-systems.org/ns/dmscloud/schema/v5.0/ dmsCloud-schema.xsd"> <propertyStringDefinition> <id>appSot:dateOfReceipt</id> <propertyType>date</propertyType> <cardinality>single</cardinality> <required>true</required> </propertyStringDefinition> <propertyStringDefinition> <id>appSot:comment</id> <propertyType>date</propertyType> <cardinality>single</cardinality> <required>true</required> </propertyStringDefinition> <propertyStringDefinition> <id>appSot:invoiceNo</id> <propertyType>string</propertyType> <cardinality>single</cardinality> <required>true</required> </propertyStringDefinition> <propertyStringDefinition> <id>appSot:paymentTerm</id> <propertyType>string</propertyType> <cardinality>single</cardinality> <required>true</required> </propertyStringDefinition> <typeDocumentDefinition> <id>appSot:document</id> <baseId>system:document</baseId> <propertyReference>appSot:dateOfReceipt</propertyReference> <contentStreamAllowed>required</contentStreamAllowed> <secondaryObjectTypeId>appSot:basicInfo</secondaryObjectTypeId> </typeDocumentDefinition> <typeSecondaryDefinition> <id>appSot:basicInfo</id> <baseId>system:secondary</baseId> <propertyReference>appSot:comment</propertyReference> </typeSecondaryDefinition> <typeSecondaryDefinition> <id>appSot:invoice</id> <baseId>system:secondary</baseId> <propertyReference>appSot:invoiceNo</propertyReference> <propertyReference>appSot:paymentTerm</propertyReference> </typeSecondaryDefinition> </schema> |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "objects": [ { "properties": { "system:objectId": { "value": "7bce6618-2b0e-4abf-af26-e4137e6b0461" }, "system:baseTypeId": { "value": "system:document" }, "system:objectTypeId": { "value": "appSot:document" }, "system:secondaryObjectTypeIds": { "value": [ " appSot:basicInfo" ] }, <...> " appSot:dateOfReceipt": { "value": "2020-02-20T02:02:20.220Z" }, "appSot:comment": { "value": "Yearly invoice - payment 1 out of 12 monthly payments." } }, "contentStreams": [ <...> ] } ] } |
...
Attribute | Type | Required | Description |
---|---|---|---|
| Enum | no | Can substantiate the For the final document, content will be For the final document, content will be Conflict situation leading to invalid documents: any combination of at least once
If |
...
Property | Type | Description | Set by |
---|---|---|---|
system:objectId | string | Identifies the object in the database. | system |
system:baseTypeId | string | Identifies the object type the object instantiates. Secondary object types are not allowed. | system |
system:objectTypeId | string | Required during an import and cannot be changed lateron. Identifies the object's type. | user |
| JSON list of strings | Contains the secondaryObjectTypeId for each secondary object type associated with the document object type in the schema. | user |
system:createdBy | string | userId of the user that has initially created the object. | system |
system:creationDate | string | Date of the object's creation in format yyyy-MM-ddTHH:mm:ss.fffZ. | system |
system:lastModifiedBy | string | userId of the user that sent the last successful POST request on the object. | system |
system:lastModificationDate | string | Date of the last successful POST request on the object as a string in format yyyy-MM-ddTHH:mm:ss.fffZ. | system |
| string |
During an import or update operation, the object can be assigned to an existing folder by referencing its | user |
system:parentObjectTypeId | string | Identifies the folder object type of the parent folder that is specified by Available for document object types and as of version 2020 Winter, also for folder object types. | system |
system:versionNumber | integer | Integer object version number. Corresponds to the number of POST requests on the object starting with the initial creation. | system |
system:tenant | string | Identifies the tenant the object belongs to. | system |
system:traceId | string | The traceid of the import operation or last update operation.Unique process number of any operation. If not specified in the request, a random string value will be set. | system |
| JSON table of strings and integers | Contains the properties of the tags assigned to the object. >> Tagging | user |
| string | Only available for documents. Secondary object type The binary content of the object cannot be changed or deleted before this date, but metadata updates are allowed. In an update request, the | user |
| string | Only available for documents. Secondary object type This date defines the start of the retention time. It has to be earlier in time than the | user |
| string | Only available for documents. Secondary object type If | user |
Anchor | ||||
---|---|---|---|---|
|
Content Stream Properties
...
Property | Type | Description | In an Import/Update Request | In a Response | ||||||
---|---|---|---|---|---|---|---|---|---|---|
contentStreamId | String | Points to existing content within a repository. | Required only for pointing to existing content. If not specified, the system generates a UID. | displayed | ||||||
length | Integer | Length of the binary content, determined by the system. | -displayed | displayed (if system could determine the value) | ||||||
mimeType | String | Mime type of the content file. | Determined by the content analysis, but can be overwritten by user specification in the import body. | displayed | fileName | String | Name of the content file. | Can be set in the request body. If not specified, During an import, fileName will be determined from the content dispositionThe CONTENTANALYZER service can be configured to determine (scenario A) or not determine (scenario B) the If | Scenario A: The CONTENTANALYZER determines In an import request, the automatically determined Scenario B: In an import request via POST /api/dms/objects, In a content update via POST /api/dms/objects/{objectId}/contents/file, | displayed |
fileName | String | Name of the content file. | If In a content update via POST /api/dms/objects/{objectId}/contents/file, In an import request via POST /api/dms/objects, | displayed | ||||||
digest | String | SHA-256, automatically determined from the binary content. | - | displayed | ||||||
repositoryId | String | ID of the repository that will be used for storage of the binary data. | Required only for pointing to existing content. If not specified, the default repository defined in the repository service configuration will be set. | displayed | ||||||
archivePath | String | Additional and optional path structure of the stored object. | Required only for pointing to existing content if reconstruction is not possible with metadata information | displayed only if it was set | ||||||
range | String | Applies to Compound Documents only. Defines a certain segment from compound documents that should be provided for content retrievals. | Optional in the request body and only available for compound documents. | displayed only if it was set | ||||||
ci d | String | Assign the corresponding multipart content. | Required in the import request body. Not needed later on and therefore not stored in the system. | - |
...
The app schema endpoints are:
- POST /api/system/apps/{app}/schema - Introduces provided schema as app within tenant schema, overwrites previous app schema
- GET /api/system/apps/{app}/schema - Retrieves the specified app portion of the tenant schema
- POST /api/system/apps/{app}/schema/validate - Validates a schema based on app schema rules
When uploading an app schema, all properties that do not specify a prefix will have that prefix generated as app<app name> where <app name> is equal to the path parameter {app}.
...
- GET /api/admin/schema - Retrieve the tenant's schema
- POST /api/admin/schema - Update the tenant's schema
- POST /api/admin/schema/validate - Validate the tenant's schema
Each object type ID and property type ID has the prefix t
en
+ <tenant name>
. Thus, the same object type name can occur in multiple tenant schemata.
...
Info | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||
Read on
|
...