Versions Compared

Key

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



Ressources

partly described in Tutorial System Hooks

Page Properties
Status
Status
colourRed
titlestub
Priority1
Notecontent in tutorial System Hooks
Assignee
Page Properties
hiddentrue
idDONE

Product Version
Report Notepresentable
Assignee

Resources & Remarks

  • concept article linking to the respective tutorials

Modification History

NameDateProduct VersionAction
Antje08 FEB 20212.4New page properties macro.



Excerpt

System Hooks, that allow for messaging triggered by function calls under specified conditions.


Section
bordertrue


Column

Table of Contents

Table of Contents
exclude(Table of Contents|Read on|Another Tutorial|Another Concept ArticleConcept of System Hooks|Webhooks|Another interesting Tutorial|System Hooks)


Introduction

Main part(s)

Subsection(s)

Code Block
languagejava
titleFor Loop in Java (brief, concise title)
linenumberstrue
for (int i = 0; i < 10; i++)
{
	System.out.println("Hello World " + i);
}

Summary

With an AMQP Hook, messages are sent to a configured messaging system using Advanced Message Queuing Protocol 1.0 (AMPQ). Where and when these messages are sent is defined in the System Hook configuration. Any changes to the System Hook configuration will not apply until the affected services have been restarted.

The AMQP Hooks allow for asynchronous reactions to events like object creation, update or deletion. There are different types of AMQP Hooks available, each of them specialized for selected function calls. The messages contain the object metadata which is the target of the function call triggering the AMQP Hook. The action code is included in the message as well as the history code that is added to the audit trail. The AMQP Hook can be triggered by any endpoint that induced the characteristic history codes of the AMQP Hook.

Types of AMQP Hooks

AMQP Hook Type

Description

Action / History Codes
Object deletion events can trigger this AMQP Hook with the corresponding object properties in its body.200 - OBJECT_DELETED
202 - OBJECT_FLAGGED_FOR_DELETE

Object creation events can trigger this AMQP Hook with the corresponding object properties in its body.

101 - OBJECT_CREATED_WITH_CONTENT
100 - OBJECT_CREATED

dms.response.update

Object update events and tag operations can trigger this AMQP Hook with the corresponding object properties in its body.

300 - OBJECT_METADATA_CHANGED
301 - OBJECT_DOCUMENT_CHANGED
325 - OBJECT_RESTORED_FROM_VERSION (as of 2022 Spring)
303 - OBJECT_UPDATE_CONTENT_MOVED
110 - OBJECT_TAG_CREATED
310 - OBJECT_TAG_UPDATED
210 - OBJECT_TAG_DELETED

Configuring AMQP Hooks

As a type of system hooks, AMQP Hooks are configured in the \service-manager\config\system\systemHookConfiguration.json configuration file within the service manager in JSON format. Any changes to the system hook configuration will not apply until the affected services have been restarted.

>> systemHookConfiguration.json

Summary

In this article, we gave an introduction to AMQP Hooks, covered the configuration using the example of asynchronous full text indexing and provide a list of all AMQP Hooks available. Check out Webhooks which are the second type of System Hooks in yuuvis® Momentum.


Info
iconfalse

Read on

Section


Column
width25%

...

Another Tutorial

...

width25%

Another interesting Tutorial

...

System Hooks

Insert excerpt
System Hooks
System Hooks
nopaneltrue
 Keep reading


Column
width25%

...

Another Concept Article

Brief summary of the article linked.

Webhooks

Insert excerpt
Webhooks
Webhooks
nopaneltrue
 Keep reading