Page Comparison

...

Page Properties

hidden	true
id	PROGRESSREFACTURE

Product Version	2021 Summer
Report Note
Assignee	Antje

Resources & Remarks

Modification History

Name	Date	Product Version	Action
Antje	29- APR 2021	2021 Summer	Writing started.
Agnieszka	02 JUNE 2021	2021 Summer	rLANG
JaR	13 OCT 2023	2023 Autumn	Fixed wrong regex

Excerpt
A description of the structure in which yuuvis® Momentum expects objects to be formatted and returns objects.

...

The representation of objects in yuuvis® Momentum depends on their situation within the processing chain, but is always organized in a JSON structure. On the top level, this JSON structure always contains always the list objects. Each entry of the this list represents a set of metadata assigned to one object. The metadata are grouped into sections. The section properties is always present whereas the sections contentStreams, renditions and options are not always present.

During an import process, the JSON objects list is integrated into a multipart body. Thus, it is possible to handle binary content together with the metadata in one call. Multiparts are not discussed in this article, please . Please refer to the import endpoint description POST /api/dms/objects.

...

The code block below shows a small example for an objects list as it could appear in an import request body. Since there is no contentStreams section contentStreams, no binary content file will be assigned to the object. The properties section properties contains the required system:objectTypeId with the specified value that has to be an object type available in the applied schema. Additionally, a property name is set , that which does not have any prefix. The import body is valid only if the property is defined in the global schema.

...

Code Block

language	yml
title	Small Example: Import without Content

{
	"objects": [{
		"properties": {
			"system:objectTypeId": {
				"value": "smallDocument"
			},
			"name": {
				"value": "exampledocument-without-content"
			}
		}
	}]
}

The metadata will be automatically enriched with the not-specified system properties automatically. If the same object is retrieved later, they these properties will be listed in the response body as shown in the following example code block.

Code Block

language	yml
title	Small Example: Retrieve Retrieving Metadata

{
    "objects": [{
        "properties": {
            "system:objectId": {
                "value": "cdc7095f-a5ce-486d-92a7-6d0955d969ee"
            },
            "system:baseTypeId": {
                "value": "system:document"
            },
            "system:objectTypeId": {
                "value": "smallDocument"
            },
            "system:createdBy": {
                "value": "0d7fd0be-6a0b-4d3b-933c-25e0c4c5d794"
            },
            "system:creationDate": {
                "value": "2018-01-26T15:21:170Z"
            },
            "system:lastModifiedBy": {
                "value": "0d7fd0be-6a0b-4d3b-933c-25e0c4c5d794"
            },
            "system:lastModificationDate": {
                "value": "2018-01-26T15:21:170Z"
            },
            "system:versionNumber": {
                "value": 1
            },
            "system:tenant": {
                "value": "tenant1"
            },
            "system:traceId": {
                "value": "97a35859dbb4c435"
            },
            "name": {
				"value": "exampledocument-without-content"
			}
    }]
}

...

The values for table properties are specified in two lists as shown in the example below. The names of the table columns are listed in the correct order in columnNames. In the value array, for each table row a list of individual values is expected. The length of those lists has to equal to the length of the the columnNames list columnNames. The individual values need to have the appropriate type that is defined in the table property definition for the corresponding column.

...

Tags can be managed independently but also also in one call together with the metadata. The tags are stored in the system property system:tags system property in table format as described before.

...

Specifying Structured Data Properties

The Even if the schema allows various structured data properties in an object, the instantiated object can contain a value for at most one structured data property. The value for a structured data property has to be a valid JSON structure. It is not allowed to pass a single string, boolean or other variable format:

...

The maximum value for the total number of sub-properties within one JSON value is 500. The keys have to be strings not longer than 32 characters and have to follow the convention [a-zA-Zz][a-zA-Z0z0-9]*. The maximum depth for JSON structure is 16. Empty maps are not allowed in any position of the JSON and are replaced by null.

...

Code Block

language	yml

{
	"objects": [{
		"properties": {
			"system:objectTypeId": {
				"value": "document"
			},
			"name": {
				"value": "exampledocument-without-content"
			},
			"appTable:customerdetails": {
				"value": {
					"id": 2982,
					"uid": "711e1858-eb24-4183-8743-0292c7b9b93b",
					"word": "beverages",
					"words": [
						"tee",
						"milk",
						"water"],
					"sentence": "The customer prefers hot chocolate.",
					"sentences": [
						"Unfortunately, hot chocolate is not offered.",
						"The customer decides for milk instead.",
						"The milk should be cool."
					],
					"food": {
						"uid": "7aa4a2f2-3dc0-420c-a0d7-edc6af3619de",
						"dish": "Bunny Chow",
						"description": "Fresh Norwegian salmon, lightly brushed with our herbed Dijon mustard sauce, with choice of two sides.",
						"ingredient": "Jelly",
						"measurement": "1/2 teaspoon",
						"lastcooked": "2018-03-13T00:00:00.000Z"
					}
				}
			}
		}
	}]
}

Anchor

	ContentStreams
	ContentStreams

Section 'contentStreams'

The section contentStreams is always present for objects with a binary content file assigned to them. It is a list with one entry containing a set of content stream properties.
>> Schema - Defining Object Types#DefiningObjectTypes-ContentStreamProperties Content Stream Properties

Each object with an assigned content file stored in yuuvis® Momentum has the full set of those properties in addition to the previously described properties section.

...

Code Block

language	yml
title	Example with already existing Content

{
	"objects": [{
		"properties": {
			"system:objectTypeId": {
				"value": "largeDocument"
			},
			"name": {
				"value": "exampledocument-with-content"
			}
		}
		"contentStreams": [{
            "contentStreamId": "2B797243-A1F5-11EA-A814-9FABD98CE7A7",
            "repositoryId": "repo252"		
        }]
	}]
}

The metadata will be automatically enriched with the not-specified system properties automatically. If the same object is retrieved later, they the properties will be listed in the response body as shown in the following example code block.

Code Block

language	yml
title	Example Metadata retrieved for Object with assigned Content.

{
    "objects": [{
        "properties": {
            "system:objectId": {
                "value": "cdc7095f-a5ce-486d-92a7-6d0955d969ee"
            },
            "system:baseTypeId": {
                "value": "system:document"
            },
            "system:objectTypeId": {
                "value": "appEmail:email"
            },
            "system:createdBy": {
                "value": "0d7fd0be-6a0b-4d3b-933c-25e0c4c5d794"
            },
            "system:creationDate": {
                "value": "2018-01-26T15:21:170Z"
            },
            "system:lastModifiedBy": {
                "value": "0d7fd0be-6a0b-4d3b-933c-25e0c4c5d794"
            },
            "system:lastModificationDate": {
                "value": "2018-01-29T13:13:113Z"
            },
            "system:versionNumber": {
                "value": 2
            },
            "system:tenant": {
                "value": "tenant1"
            },
            "system:traceId": {
                "value": "97a35859dbb4c435"
            },
            "appEmail:from": {
                "value": "GarcoMaria MeisslerSchmidt <garco@example<schmidt@example.de>"
            },
            "appEmail:to": {
                "value": ["DudreasHans AnnkelMeier <dudreas@example<meier@example.de>"]
            },
            "appEmail:cc": {
                "value": ["KruedeasConrad AngerSchulze <kruedeas@example<schulze@example.de>",
                "VilsEmilia NormumLehmann <Normum@example<lehmann@example.de>"]
            },
            "appEmail:subject": {
                "value": "Updated Bewerbungsunterlagen"
            },
            "table": {
                "columnNames": ["iColumn1", "iColumn2", "iColumn3"],
                "value": [["something", "to know", true],["more", "infos", false]]
            }
        },
        "contentStreams": [{
            "contentStreamId": "2B797243-A1F5-11EA-A814-9FABD98CE7A7",
            "length": 173413,
            "mimeType": "message/rfc822",
            "fileName": "upload.eml",
            "digest": "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855",
            "repositoryId": "repo252"
        }]
    }]
}

...

The properties in these sections are not defined in a schema. They are not always present and appear only in specific situations. They cannot be used in SELECT and/or WHERE clauses of search queries.

Anchor

	Renditions
	Renditions

Section 'renditions'

The section renditions occurs during the import of objects with a binary content file. It contains a list of rendition specifications.

...

Property		Description	Required in an import body where the 'renditions' section is specified
mimeType		mimeType of the rendition. Available values: `"text/plain"`	yes
kind		Kind of the rendition. Available values: `"text"`	yes
contentStream		Section of content stream properties describing the details of the plain text file that should be read to create the text rendition. It has to be included into the multipart request body.	yes
	length	Length of the file to be read for the creation of the rendition.	no
	mimeType	mimeType of the file to be read for the creation of the rendition. Available values: `"text/plain"`	no
	fileName	Name of the file to be read for the creation of the renditionrendition file.	no
	cid	Reference within the multipart on the file to be read for the creation of the rendition.	yes

If a content file of appropriate format is imported in yuuvis® Momentum, the CONTENTANALYZER service can create a full-text rendition. The service will automatically add the section renditions to the corresponding object automatically.

If the section renditions is already specified by the user in the initial request body, the CONTENTANALYZER will not analyse extract the full text from the corresponding content file. ThusInstead, the user-specified text - rendition will be stored in the Elasticsearch index. This might be useful if the CONTENTANALYZER service is not used or the content file's format is not supported for the full-text analysis.

The example objects list below is taken from an import request body in which an email e-mail file is assigned as binary content file. Since also the section renditions is is also specified, the CONTENTANALYZER will not analyse analyze the email file. The plain text read from the file content.txt will referenced by cid will be stored in Elasticsearch for the full-text search.

Code Block

language	yml
title	Example from an import request body.

{
	"objects": [{
		"properties": {
			"enaio:objectTypeId": {
				"value": "E13C7EBF4B974B3A9FF296C01F90D0EE"
			},
			"sysfrom": {
				"value": "Garco Meissler <garco@example.de>"
			},
			"systo": {
				"value": "Dudreas Annkel <dudreas@example.de>"
			},
			"syscc": {
				"value": "Kruedeas Anger <kruedeas@example.de>"
			},
			"syssubject": {
				"value": "Wachsmalstift rückwärts kontrollieren"
			},
			"redline:baseTypeId": {
				"value": "DOCUMENT"
			},
			"redline:mandant": {
				"value": "default"
			}
		},
		"contentStreams": [{
			"mimeType": "message/rfc822",
			"fileName": "upload.eml",
			"cid": "cid_63apple"
		}],
		"renditions": [{
			"mimeType": "text/plain",
			"kind": "text",
			"contentStream": {
				"length": 39939,
				"mimeType": "text/plain",
				"fileName": "content.txt",
				"cid": "rendition_0"
			}
		}]
	}]
}

...

Versions Compared

Old Version 23

New Version Current

Key

Specifying Structured Data Properties

Section 'contentStreams'

Section 'renditions'