Page Properties

hidden	true
id	REFACTURE

Product Version
Report Note	presentable, review (move stuff into tutorials)
Assignee

Resources & Remarks

There is already good text available in the tutorial section - it needs to be split into concept article and tutorial.
The app schemata article, originally located in the Tutorials section, has been moved into this article. The REST endpoint overview around the application schemata topic should probably be moved back into the tutorials and linked here.
v2.2 - Inga: "floating" secondary object type infos added
Antje: add Content Stream Properties as a new section in the hidden part.
Antje: move Content Stream Properties to the public section "System Properties"
Antje: contentStreamAllowed attribute added for SOTs

Modification History

Name	Date	Product Version	Action
Antje	08 FEB 2021	2020 Winter	New page properties macro.
Agnieszka	02 JUNE 2021	2021 Summer	rLANG (partial)

...

Code Block

language	xml
title	A valid example schema	collapse	true

<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>

...

Code Block

language	xml
title	An example schema with a table property	collapse	true

<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>

...

Code Block

language	xml
title	Schema containing a folder object type	collapse	true

<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

language	text
title	Metadata for a folder object according to schema above
collapse	true

{
	"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

language	text
title	Metadata of a document destined for the folder
collapse	true

{
	"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"
			}
		}
	}
	]
}

...

Code Block

language	xml
title	Schema containing secondary object types	collapse	true

<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

language	text
title	Metadata of appSot:document	collapse	true

{
    "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

contentStreamAllowed
(As of product version 2020 Autumn)

Enum

no

Can substantiate the contentStreamAllowed attribute of document type definitions. Possible values are analogous to document object type definitions: required, notallowed, allowed.

For the final document, content will be allowed if only allowed values occur in the document type definition and included secondary object type definitions for this attribute.

For the final document, content will be required (notallowed) if the value is required (notallowed) in at least one object type definition – either document type definition or included secondary object type definition.

Conflict situation leading to invalid documents: any combination of at least once required and at least once notallowed in included secondary object type definitions or the document object type definition itself.

If the conflict occurs between the document object type definition and a secondary object type definition, the whole schema is invalid.
If the conflict occurs between secondary object type definitions with at least one of them referenced as static, the schema is valid but the document validation will fail (instantiated documents will be invalid).
If the conflict occurs exclusively between secondary object type definitions referenced as floating, a document cannot have conflicting secondary object types at the same time. If a secondary object type with the value required (notallowed) is added to the document, all secondary object types with the value notallowed (required) must be removed by means of the keyword "remove":.

If contentStreamAllowed is specified in a secondary object type definition, this secondary object type cannot be referenced in folder object type definitions. The schema would be invalid.

...

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 ten + <tenant name>. Thus, the same object type name can occur in multiple tenant schemata.

...

Info

icon	false

Read on

Section

Column

width	25%

Managing the Schema

Insert excerpt

	Managing the Schema
	Managing the Schema
nopanel	true

Keep reading

Column

width	25%

Importing Documents

Insert excerpt

	Importing Documents via Core API
	Importing Documents via Core API
nopanel	true

Keep reading

Column

width	25%

Changing Schema Structures

Insert excerpt

	Changing Schema Structures ("Schema Flow")
	Changing Schema Structures ("Schema Flow")
nopanel	true

Keep reading

...

Versions Compared

Old Version 7

New Version Current

Key

Read on

Managing the Schema

Importing Documents

Changing Schema Structures

Page Comparison

Versions Compared

Old Version 7

New Version Current

Key

Read on

Managing the Schema

Importing Documents

Changing Schema Structures