Versions Compared

Old Version 11

changes.mady.by.user Team Oktopus

Saved on

compared with

New Version Current

changes.mady.by.user Technische Redaktion

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Page Properties
hiddentrue
idPROGRESS

Product Version2021 Summer
Report Note
AssigneeAntje

Resources & Remarks

Modification History

NameDateProduct VersionAction
Antje28/29 APR 20212021 SummerPage created and filled with error codes for schema validation.
Agnieszka07 MAY 20212021 SummerrLANG
Antje09 MAY 20222022 Summeradd authentication service error codes
Antje24 MAY 20222022 Summeradd audit service error codes



Excerpt

Structure and identification codes of errors that can be thrown during different validation processes.


Section
bordertrue


Column

Table of Contents

Table of Contents
exclude(Table of Contents|Read on|Schema - Defining Object Types|Apps|Tagging)


...

Errors may occur in many different situations during the data processing. yuuvis® Momentum core offers in In addition to the HTTP status code, yuuvis® Momentum core offers a well-defined structure and labeling of any thrown error. It is thus possible to easily localize the origin of the problem. At the same time, automated catching and analyzing of errors can be implemented based on the fixed error structure and error codes.

...

ParameterDescription
httpStatusCodeThree-digit Integer integer specifying the HTTP status code as a class of the response in which the error is returned.
serviceErrorCodeFour-digit Integer specifying the concrete error type.
timeTimestamp of the error occurance in format "yyyy-MM-ddTHH:mm:ss.SSS".
messageString message describing the concrete error.
stackTrace

Origin of the error.

serviceThe name of the service that throwed the error.
tenantThe string tenant name where the error occured.
Code Block
languageyml
titleExample error with HTTP status code 409.
{
    "httpStatusCode" : 409,
    "serviceErrorCode" : 2800,
    "time" : "2021-04-21T04:36:30.813",
    "message" : "A non-empty folder cannot be deleted.",
    "stackTrace" : [ "com.os.enaio.cloud.gateway.resource.api.DmsController.deleteDmsObject(DmsController.java:719)" ],
    "service" : "api",
    "tenant" : "default"
}

Error Lists during Validation Processes

If errors occur during one of the following validation process, they are collected and returned in a list validationErrors in JSON format.

  • schema validation
  • role set validation
  • app set validation

Other validation processes return only single errors in the structure described above.

Within the JSON list validationErrors, the following parameters are provided for each error in the list:

...

Together with each non-empty validation errors list, the HTTP status code 422 is always returned, but not extra included into the individual entries.

The following code block shows an example error structure that can occur during a schema validation:

Code Block
languageyml
titleExample error list with HTTP status code 422.
{
	"validationErrors": [
		{
			"message": "Ambiguous ids. There are 2 property type definitions with the id 'from'.",
			"serviceErrorCode": 2110
		},
		{
			"message": "Wrong base id. The base id of the system:document type definition 'email' must be 'system:document', but it is 'system:folder'.",
			"serviceErrorCode": 2131
		},
		{
			"message": "Invalid property reference 'fromm' in type definition 'email'.",
			"serviceErrorCode": 2132
		},
		{
			"message": "Invalid secondary object type reference 'appAcl:aclowner' in type definition 'email'.",
			"serviceErrorCode": 2135
		}
	]
}

Error Codes and Messages

...

As of 2021 Autumn, stackTrace is included in the error structure only if the parameter app.stacktrace is set to FULL for the service throwing the error. Possible values for app.stacktrace are FULL and NONE (default). If app.stacktrace is not set for a service or set to NONE, error structures thrown by this service do not contain the stackTrace. It is recommended to set app.stacktrace in a global configuration file (i.e., application-prod.yml) such that the value applies to all services in order to unify their error structures.

serviceThe name of the service that threw the error.
tenantThe string tenant name where the error occured.
innerError (as of 2022 Winter)

Wrapped original error thrown by a webhook (find details below).


Code Block
languageyml
titleExample error with HTTP status code 409.
{
    "httpStatusCode" : 409,
    "serviceErrorCode" : 2800,
    "time" : "2021-04-21T04:36:30.813",
    "message" : "A non-empty folder cannot be deleted.",
    "stackTrace" : [ "com.os.enaio.cloud.gateway.resource.api.DmsController.deleteDmsObject(DmsController.java:719)" ],
    "service" : "api",
    "tenant" : "default"
}

Error Lists during Validation Processes

If errors occur during one of the following validation process, they are collected and returned in the validationErrors list in JSON format.

  • schema validation
  • role set validation
  • app set validation

Other validation processes return only single errors in the structure described above.

Within the JSON list validationErrors, the following parameters are provided for each error in the list:

ParameterDescription
messageString message describing the concrete error.
serviceErrorCodeFour-digit integer specifying the concrete error type.

Together with each non-empty validation error list, the HTTP status code 422 is always returned, but not specifically added to the individual entries.

The following code block shows an example error structure that can occur during a schema validation:

Code Block
languageyml
titleExample error list with HTTP status code 422.
{
	"validationErrors": [
		{
			"message": "Ambiguous IDs. There are 2 property type definitions with the ID 'from'.",
			"serviceErrorCode": 2110
		},
		{
			"message": "Wrong base ID. The base ID of the system:document type definition 'email' must be 'system:document', but it is 'system:folder'.",
			"serviceErrorCode": 2131
		},
		{
			"message": "Invalid property reference 'fromm' in type definition 'email'.",
			"serviceErrorCode": 2132
		},
		{
			"message": "Invalid secondary object type reference 'appAcl:aclowner' in type definition 'email'.",
			"serviceErrorCode": 2135
		}
	]
}

Errors Thrown by Webhooks

If a webhook throws an error in the yuuvis® Momentum error format, its individual parameters are presented as JSON substructure. The serviceErrorCode is 99999. The HTTP status code used for the final response depends on the webhook type. Errors thrown by dms.request.objects.contents webhooks, e.g., have the final HTTP status code 404.
>> Webhooks

Code Block
titleExample error with properly structured inner error.
{
    "serviceErrorCode": 99999,
    "service": "repository",
	"messageHistory": "\nMessage History\n---------------------------------------------------------------------------------------------------------------------------------------\nRouteId              ProcessorId          Processor                                                                        Elapsed (ms)\n[insertDocumentSetR] [insertDocumentSetR] [direct://insertDocumentSet                                                    ] [      2456]\n[insertDocumentSetR] [[conan] enrich add] [bean[ref:analyzeConfigurationPr [...]",
    "innerError": {
        "httpStatusCode": 422,
        "serviceErrorCode": 12345,
        "time": "2022-11-22T14:57:41.7317312",
        "message": "Virus [XXXX] detected. See inner error for further details.",
        "service": "virus-detection-app",
        "innerError": {
            "httpStatusCode": 0,
            "serviceErrorCode": 0,
            "message": "The virus [XXX] was detected in the file [myvirus.exe]. This virus is part of SIV 1.14356.234 from 2022-03-13. See 'https://gprivate.com/61xd3'."
        }
    },
    "time": "2022-11-22T14:57:41.735",
    "stackTrace": [
        "com.os.services.hel.repo.web.RepositoryRestController.postDmsObjects(RepositoryRestController.java:88)"
    ],
    "message": "Virus [XXXX] detected. See inner error for further details.",
    "tenant": "default",
    "httpStatusCode": 422
}

If the error thrown by the webhook does not match the yuuvis® Momentum error format, the entire original error is wrapped as String message of the inner error. The serviceErrorCode is 2471 and the HTTP status code is 422.

Code Block
titleExample error with inner error having a different structure.
{
    "serviceErrorCode": 2471,
    "service": "repository",
	"messageHistory": "\nMessage History\n---------------------------------------------------------------------------------------------------------------------------------------\nRouteId              ProcessorId          Processor                                                                        Elapsed (ms)\n[insertDocumentSetR] [insertDocumentSetR] [direct://insertDocumentSet                                                    ] [      2456]\n[insertDocumentSetR] [[conan] enrich add] [bean[ref:analyzeConfigurationPr [...]",
    "innerError": {
        "httpStatusCode": 422,
        "serviceErrorCode": 0,
        "message": "{\"wrong_body_format\":{\"httpStatusCode\":422,\"serviceErrorCode\":12345,\"time\":\"2022-11-22T15:19:52.3241064\",\"message\":\"Virus [XXXX] detected. See inner error for further details.\",\"service\":\"virus-detection-app\",\"innerError\":{\"httpStatusCode\":0,\"serviceErrorCode\":0,\"message\":\"The virus [XXX] was detected in the file [myvirus.exe]. This virus is part of SIV 1.14356.234 from 2022-03-13. See 'https://gprivate.com/61xd3'.\"}}}"
    },
    "time": "2022-11-22T15:19:52.34",
    "stackTrace": [
        "com.os.services.hel.repo.web.RepositoryRestController.postDmsObjects(RepositoryRestController.java:88)"
    ],
    "message": "Webhook response with statuscode '422' did not match the expected failure body format. Please see documentation to ensure correct webhook failure handling and have a look at the inner exception for details.",
    "tenant": "default",
    "httpStatusCode": 422
}

Any other problems related to the execution of webhooks are indicated with the serviceErrorCode 2470.

Error Codes and Messages

The following table provides an overview of errors that may occur during operation of yuuvis® Momentum core.

Note: In case you want to catch errors and analyse their content, please use the serviceErrorCode as unique identification of the error type. Please do NOT use the message since we reserve to modify it in future.

serviceErrorCodehttpStatusCodemessageOccurance
2100-The
id
ID '%s' is invalid. If
the id
the ID has a prefix, it is not allowed to start with 'ten' or 'app'.schema validation
2101-
The id
The ID '%s' is invalid. If
the id
the ID has a prefix, it is expected to be '%s'.schema validation
2102-
The id
The ID '%s' is invalid.
The id
The ID of an object type is not allowed to start with '%s'.schema validation
2103-
The id
The ID '%s' is invalid.
The id
The ID of
an
a property type is not allowed to start with '%s'.schema validation
2104-Too many property types. There are %s property types. Up to %s are allowed. This is a configurable
boundary
limit.schema validation
2105-There are references from the global schema to the schema of app '%s'. For tenant '%s' app '%s' is disabled.schema validation
2106-There are references from the schema of app '%s' to the schema of app '%s'. For tenant '%s' app '%s' is enabled and app '%s' is disabled.schema validation
2110-Ambiguous
ids
IDs. There are %s %s
%stype
type definitions with
the id
the ID '%s'.schema validation
2111-
Id missing
Missing ID. There is a %s definition without
id
ID.schema validation
2112-
Invalid id
Invalid ID. There is a %s with the
invalid id
invalid ID '%s'.
The id
The ID must match '%s'.schema validation
2113-
Id too
ID too long. The maximum length for
an id
an ID is %s without prefix. The length of '%s' is %s.schema validation
2120-
Property
Missing property type
missing
. The attribute 'propertyType' of the property type definition '%s' is missing.schema validation
2121-Wrong property type. The property type of the %s property type definition '%s' must be '%s',  but it is '%s'.schema validation
2122-Invalid attribute 'queryable' in the %s property type definition '%s'. The value 'false' is only supported for table property type definitions.schema validation
2123-Illegal
minimum length
minimum length of the property '%s'. The minimum length of a string property must not exceed %s.schema validation
2124-Illegal maximum length of the property '%s'. The maximum length of a string property must not exceed %s.schema validation
2125-Illegal cardinality of the property '%s'. The
minimum length
cardinality of a
string
table property must not
exceed %s
be 'multi'.schema validation
2124
2126-
Illegal maximum length of the
Invalid number of column property definitions for property '%s'. The maximum
length
number of columns in a
string property
table must not exceed %s. Column count: '%s'schema validation
2125
2127-Illegal cardinality of the property '%s'. The cardinality of a
table
structured data property must not
be 'multi'
be 'multi'.schema validation
2130-Missing base ID. The attribute 'baseId' of the type definition '%s' is missing.schema validation
2126
2131-
Invalid number of column property definitions for property
Wrong base ID. The base ID of the %s type definition '%s'
. The maximum number of columns in a table must not exceed %s. column count:
must be '%s',  but it is '%s'.schema validation
2127
2132-
Illegal cardinality of the
Invalid property reference '%s'
. The cardinality of a structured data property must not be 'multi
in type definition '%s'.schema validation
2130
2134-
Base id missing. The attribute 'baseId' of the type definition
There are %s property references with the value '%s' in the definition of the object type '%s'
is missing
.schema validation
2131
2135-
Wrong base id. The base id of the %s
Invalid secondary object type reference '%s' in type definition '%s'
must be
.schema validation
2136-Secondary object type '%s'
,  but it is
in type definition '%s' can be referenced only once.schema validation
2132
2140-
Invalid property reference

The document type '%s'

in type definition

does not allow content and has a static reference to the secondary object type '%s' that requires content. It is not possible to create instances of this document type.

schema validation
2134
2141-
There are %s property references with the value
The document type '%s'
in the definition of the
does not allow content and has a non-static reference to the secondary object type '%s' that requires content. This secondary object type cannot be assigned to instances of this document type.schema validation
2135
2142-
Invalid secondary object
The document type
reference
'%s'
in type definition
requires content and has a static reference to the secondary object type '%s'
.schema validation2136-Secondary object type '%s' in type definition '%s' can be referenced only once
that does not allow content. It is not possible to create instances of this document type.schema validation
2140
2143-The document type '%s'
does not allow
requires content and has a non-static reference to the secondary object type '%s' that
requires
does not allow content.
It would not be possible to create
This secondary object type cannot be assigned to instances of this document type.schema validation
2141
2144-The document type '%s'
does not allow content and
has
a non-
static
reference
references to
the secondary object type
secondary object types that require content ('%s') and that do not allow content ('%s'
that requires content. This secondary object type could never be assigned to
). It is not possible to create instances of this document type.schema validation
2142
2145-The document type '%s'
requires content and
has
a
static
reference
references to
the
secondary object
type
types that require content ('%s'
that does
) and non-static references to secondary object types that do not allow content
. It would not be possible to create
('%s'). These non-static secondary object types cannot be assigned to instances of this document type.schema validation
2143
2146-The document type '%s'
requires content and has a
has static references to secondary object types that do not allow content ('%s') and non-static
reference
references to
the
secondary object
type
types that require content ('%s'
that does not allow content. This secondary object type could never
). These non-static secondary object types cannot be assigned to instances of this document type.schema validation
2144
2150-The
document
folder type '%s' has static references to
the
secondary object types that require
content ('%s') and that do not allow
content ('%s'). It
would
is not
be
possible to create instances of this
document
folder type.schema validation
2145
2151-The
document
folder type '%s' has
static references to the secondary object types that require content ('%s') and
non-static references to secondary object types that
do not allow
require content ('%s'). These non-static secondary object types
could never
cannot be assigned to instances of this
document
folder type.schema validation
2146
2152-The
document
folder type '%s' has static references to
the
secondary object types that
do not
allow
content ('%s') and non-static references to secondary object types that require
content ('%s').
These non-static secondary object types could never be assigned to
It is not possible to create instances of this
document
folder type.schema validation
2150
2153-The folder type '%s' has non-static references to secondary object types that
require
allow content ('%s').
It would not be possible to create
These non-static secondary object types cannot be assigned to instances of this folder type.schema validation
2151The folder type '%s' has non-static references to secondary object types that require content ('%s'). These non-static secondary object types could never be assigned to instances of this folder type
2200
-
422Empty lists are not allowed. The property '%s' has an empty list as value.schema validation
2201422The cardinality of the property '%s' is 'multi',  but the value is not a list: %s.schema validation
2152
2202
-
422The
folder type
cardinality of the property '%s'
has static references to secondary object types that allow content ('%s'). It would not be possible to create instances of this folder type
is 'single',  but the value is a list: %s.schema validation
2153
2203
-
422
The folder type
Illegal number of values. The cardinality of the property '%s'
has non-static references to secondary object types that allow content ('%s'). These non-static secondary object types could never be assigned to instances of this folder type
is 'single',  but there are multiple values: %s.schema validation
2200
2204422
Empty lists
Null values are not allowed in lists. Property ='%s'schema validation
2210422Illegal property value. The property '%s'
has an empty list as value
is a boolean property and is unable to accept the value '%s'.schema validation
2201
2211422
The cardinality of the
Illegal property value. The property '%s' is
'multi',  but the value is no list: %s
a datetime property and is unable to accept the value '%s'.schema validation
2202
2212422
The cardinality of the
Illegal property value. The property '%s' is
'single',  but the value is a list: %s
a decimal property and is unable to accept the value '%s'.schema validation
2203
2213422Illegal
number of values
property value. The
cardinality of the
property '%s' is an ID property and is unable to accept the value '
single',  but there are multiple values: %s
%s'.schema validation
2204
2214422
Null values are not allowed in lists. Property=
Illegal property value. The property '%s' is an integer property and is unable to accept the value '%s'.schema validation
2210
2215422Illegal property value. The property '%s' is a
boolean
string property and is unable
to accept the value
to accept the value '%s'.schema validation
2216422Malformed table. The property part 'columnNames' of the table property '%s' is expected to be a list of strings. ColumnNames: '%s'
.
schema validation
2211
2217422
Illegal property value
Malformed table. The value of the table property '%s' is
a datetime property and is unable to accept the value '%s'.
expected to be a list. Table value: %sschema validation
2212
2218422
Illegal property value. The property
Malformed table. A row of the table '%s' is
a decimal property and is unable to accept the value
not a list. Row: '%s'
.
schema validation
2213
2219422Illegal property value. The value of the structured data property '%s' is
an id property and is unable to accept the value
expected to be a list or map. Value: %sschema validation
2220422Invalid JSON. The value of the structured data property %s must be valid JSON. Value = '%s'. Error message: %sschema validation
2214
2240422Illegal property value. The property '%s' is
an integer property
a datetime property with resolution 'date' and is unable to accept the value '%s'.schema validation
2215
2250422
Illegal property value
The decimal value %s is not valid. The
property
type '%s'
is a string property and is unable to accept the value '%s'
does not permit values smaller than %s.schema validation
2216
2251422
Malformed table. The property part 'columnNames' of the table property '%s' is expected to be a list of strings. ColumnNames: '%s'
The decimal value %s is not valid. The type '%s' does not permit values larger than %s.schema validation
2217
2260422
Malformed table
The integer value %s is not valid. The
value of the table property
type '%s'
is expected to be a list. Table value: %s
does not permit values smaller than %s.schema validation
2218
2261422
Malformed table. A row of the table '%s' is not a list. Row: '%s'
The integer value %s is not valid. The type '%s' does not permit values larger than %s.schema validation
2219
2270422
Illegal property value. The value of the structured data property
String value is too short. The type '%s' permits only strings with a length of at least %s. The length of '%s' is
expected to be a list or a map. Value: %s
%s.schema validation
2220
2271422
Invalid json. The value of the structured data property %s must be a valid json. Value = '%s'. Error message: %s
String value is too long. The type '%s' permits only strings with a length up to %s. The length of '%s' is %s.schema validation
2240
2272422
Illegal property value
String value is too long. A string property permits only strings with a length up to %s. The property '%s'
is
has a
datetime property with resolution 'date' and is unable to accept the value
value with the length %s: '%s'.schema validation
2250
2280422
The decimal value %s is not valid. The
Illegal column. A table of type '%s'
permits no values smaller than %s
cannot have a column named '%s'.schema validation
2251
2281422
The decimal value %s is not valid
Illegal column names. The
type
column '%s'
permits no values larger than
occures %s times.schema validation
2260
2282422
The integer value %s is not valid. The type '%s' permits no values smaller than %s.
Malformed table. The maximum number of rows in a table must not exceed %s. Row count: '%s'schema validation
2261
2283422
The integer value %s is not valid
Invalid row. The
type
row of a table property '%s'
permits no values larger than %s
is expected to contain exactly %s entries,  but row no. %s contains %s entries.schema validation
2270
2290422
String
Structure data value
is
too
short
large. The
type
value of the property '%s'
permits only strings with a length at least %s. The length of '%s' is %s
contains %s sub-values. Only up to %s are allowed.schema validation
2271
2291422
String
Structured data value
is
too
long
deep. The
type
value of the property '%s'
permits only strings with a length up to
has a depth of %s. The
length of '%s'
maximum depth is %s.schema validation
2272
2292422
String value is too long. A string property permits only strings with a length up to %s. The property '%s' has a value of length %s
Invalid value of structure data property '%s'. Non-string key found: '%s'.schema validation
2280
2293422
Illegal column. A table of type '%s' cannot have a column named '%s'.
Key too long. The length of the key '%s' in the value of the structured data property '%s' is %s. The maximum length is %s.schema validation
2281
2294422
Illegal column names. The column
Invalid key '%s' in the value of the structured data property '%s'. The key must match the regex '%s'
occures %s times
.schema validation
2282
2300422
Malformed table. The maximum number of rows in a table must not exceed %s. row count:
A required property is missing. property='%s'schema validation
2283422Invalid row. The row of a table property '%s' is expected to contain exactly %s entries,  but the %s. row contains %s entries.schema validation2290422Structure data value to large. The value of the property '%s' contains %s sub-values. Only up to %s are allowed.schema validation2291422Structured data value to deep. The value of the property '%s' has a depth of %s. The maximum depth is %s.schema validation2292422Invalid value of structure data property '%s'. Non-string key found: '%s'.schema validation2293422Key too long. The length of the key '%s' in the value of the structured data property '%s' is %s. The maximum length is %s.schema validation2294422Invalid key '%s' in the value of the structured data property '%s'. The key must match the regex '%s'.schema validation2300422A required property is missing. propertyschema validation2880-Unable to disable app '%s'. There are references from the tenant schema to the schema of app '%s'.

app set validation

2881-Unable to disable app '%s'. There are references from the global schema to the schema of app '%s'.app set validation2882-Unable to disable app '%s' and enable app '%s'. There are references from the schema of app '%s' to the schema of app '%s'.app set validation
2470422Webhook execution resulted in an unexpected failurewebhook execution
2471422

Webhook response with statuscode '%s' did not match the expected failure body format. Please see documentation to ensure correct webhook failure handling and have a look at the inner exception for details.

webhook execution
2880-Unable to disable app '%s'. There are references from the tenant schema to the schema of app '%s'.

app set validation

2881-Unable to disable app '%s'. There are references from the global schema to the schema of app '%s'.app set validation
2882-Unable to disable app '%s' and enable app '%s'. There are references from the schema of app '%s' to the schema of app '%s'.app set validation
2900403Method not allowed for tenant independent accounts.authentication
2901403External access is not allowed for the service account.authentication
2902403External access is not allowed for this endpoint.

authentication

2903422Could not create JWT. Cause [%s]

authentication

Anchor
audit
audit

2950500Could not write audit entry. Cause [%s]audit
2951500Database unreachable. Cause [%s]audit
99999depends on webhook type

<custom message>

webhook execution


Info
iconfalse

Read on

Section


Column
width25%

Schema - Defining Object Types

Insert excerpt
Schema - Defining Object Types
Schema - Defining Object Types
nopaneltrue
 Keep reading


Column
width25%

Apps

Insert excerpt
Apps
Apps
nopaneltrue
 Keep reading


Column
width25%

Tagging

Insert excerpt
Tagging
Tagging
nopaneltrue
 Keep reading



...