Versions Compared

Key

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


Page Properties
hiddentrue


Status

Status
colourYellow
titlePROGRESS

Priority2
Note
AssigneeAntje

Ressources

Remarks

Concept article linking to the respecive tutorials

  • Antje: writing started

...

The interceptors allow for project-specific extensions of the yuuvis® Momentum standard process flows. The running process flow can be intervened in redirected by a condition set on the processed object , that has to be specified in the interceptor definition. Whenever the process flow satisfies meets the condition, the project-specific process extension is included for the currently processed object at this position of the process flow. Thus, the alternative process can entirely replace the standard one from this position completely on or resume the standard process at a specified position.

...

The condition for the intervention of the process flow is defined in the interceptor configuration file \system\interceptorConfiguration.json.

Parameters

The following parameters are available for the interceptor configuration:

ParameterTypeRequiredDescription
typeStringyesThe type of the interceptor. It defines the position in the process flow where the interceptor can step in.
predicateStringyesThe condition that triggers the intervention redirection of the process flow in order to include the project-specific process extension. The string can provide the condition either in Spring Expression Language (SpEL) or Javascript. Thus, the string always has to start always with a prefix spel: for SpEL or js: for Javascript.
urlStringyesHTTP address of the project-specific process extension. Dynamic components (properties of the processed object) can be included in braces curly brackets.
useDiscoverybooleannoDecides whether to resolve the url string at the Discovery-Service or not. If not specified, a default value is set.

...

There are different types of interceptors available , that interrupt the process flow at different positions.

Interceptor Typetype

Evaluation Target target of the PredicatepredicateInterceptor Input Datainput dataDescription
getContentAPI dms DMS object in JSON format derived from given objectIdobjectIdManipulation of the binary content of the return statement by a project-specific service
searchstructure Structure of the specific class SearchInterceptorObjectsearch Search query objectManipulation of the search query parameter and the search result.
updateDmsObjectfirst First API dms DMS object in the list in JSON format , that is passed to the corresponding update endpointupdated Updated metadata and metadata of current versionManipulation of the update properties that will be applied to a dms DMS object.

Summary

This article gave an overview of the interceptors in yuuvis® Momentum. If you want to extend the functionality of your system, also system hooks also might be an interesting topic for you.

...

Info
iconfalse

Read on

Section


Column
width25%

Interceptor Example Tutorial

Insert excerpt
Interceptor Example Tutorial
Interceptor Example Tutorial
nopaneltrue
 Keep on reading


Column
width25%

System Hooks

Insert excerpt
System Hooks
System Hooks
nopaneltrue
 Keep on reading



Column
width25%

Preprocessing Metadata using Webhooks

Insert excerpt
Preprocessing Metadata using Webhooks
Preprocessing Metadata using Webhooks
nopaneltrue
 Keep on reading