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)
Antje	12 JUL 2022	2022 Autumn	add fulltextIndexed attribute for String Properties
Agnieszka	06 SEP 2022	2022 Autumn	rLANG (partial)
Antje	14 OCT 2022	all versions	table columns can have cardinality "multi"
Antje	06 MAR 2023	2023 Spring	restructuring, add instantiable system:document type

...

Tenant-specific (or app-specific) properties and object types should be defined in a tenant (or app) schema, whereas the properties and object types defined in the global schema are available for all tenants and apps.

Schema Outline

A schema contains property definitions and object type definitions in XML format in the following mandatory order. It is possible to skip parts but not to change their order.

Label (as of 2023 Autumn)
Property definitions
Object Type definitions:
1. Document type definitions
2. Folder type definitions
3. Secondary object type definitions

The label is an optional string field to specify a project-specific schema versioning information. Its string value is limited to 128 characters.

Code Block

title	A valid example schema
linenumbers	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>

...

	Retrieval	Validation	Update
global schema	GET /api/system/schema	POST /api/system/schema/validate	POST /api/system/schema
app schema	GET /api/system/apps/{app}/schema	POST /api/system/apps/{app}/schema/validate	POST /api/system/apps/{app}/schema
tenant schema of any tenant	GET /api/system/tenants/{tenant}/schema	POST /api/system/tenants/{tenant}/schema/validate	POST /api/system/tenants/{tenant}/schema
tenant schema of the own tenant	GET /api/admin/schema	POST /api/admin/schema/validate	POST /api/admin/schema

Anchor

	typeIDs
	typeIDs

Naming Conventions for Property and Object Type IDs

...

Note

title	Note

As of 2023 Spring, the predefined object type system:document can be used as object type. It automatically has a floating reference on all SOTs that are available in the applied tenant schema as described below.

Custom document object type definitions have the following specific attributes:

...

As of 2023 Spring, the predefined object type system:document automatically has a floating reference on all SOTs that are available in the applied tenant schema. Nevertheless, the rules for the contentStreamAllowed attribute for the the individual SOTs have to be considered before they are assigned to an object.

The property groups of static referenced secondary object types are automatically available in all instances of the object type. Floating secondary object types can be handled in a flexible way during the import (POST /api/dms/objects endpoint) or at runtime for already existing instances of an object type with an update (POST /api/dms/objects/{objectId} / PATCH /api/dms/objects/{objectId}). The keywords "add":, "value": or "remove": can be used in the "system:secondaryObjecttypeIds": property area of the metadata.json filecan.

...

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.

...

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 183

New Version Current

Key

Schema Outline

Naming Conventions for Property and Object Type IDs

Read on

Managing the Schema

Importing Documents

Changing Schema Structures

Page Comparison

Versions Compared

Old Version 183

New Version Current

Key

Schema Outline

Naming Conventions for Property and Object Type IDs

Read on

Managing the Schema

Importing Documents

Changing Schema Structures