Versions Compared

Key

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



Page Properties
hiddentrue


Status

Status
colourBlue
titleReview

Priority2
Note
AssigneeMax

Ressources

Event = Extending Functionalities by using System Hooks (Frage) What is the difference?

Remarks

  • This tutorial should eventually replace the System Hooks page in this directory, as the content of that page will be moved to a concept page.
  • Information on Configuration in On-Premise systems that should be moved to a different article:

Run Configuration

Running the Java application to register the service must include a number of parameters to communicate the services' existance and contact information to the Discovery Service. Find the full list of required parameters below:

NameValueDescription
spring.profile.active<active profiles>Profiles available and running within your system, defining in which Profiles the Interceptor will be active 
spring.cloud.config.uri<protocol>://<config url>URL of the Configuration service endpoint where the service can recieve system information
eureka.instance.prefer-ip-addresstrueDecides whether the Webhook service will register using its host name or its host ip. 
eureka.instance.ip-adress<your host ip>Define host ip, and host base url when used in conjunction with the previous parameter.



Excerpt

An example Webhook consumer service set up using Java and Spring Boot. 

...

To use the webhook service for the intended purpose of intercepting metadata when updating objects, we need to create a new entry in the Webhook list within our systems' SystemHookConfiguration.json file (\service-manager\config\system\systemHookConfiguration.json ). The url attribute must refer to the webhook service identifier (derived from the artifact ID in the services' maven file) and direct to one of the endpoints declared in the service.

The services responsible for the webhook execution need to be restarted after changing the SystemHookConfiguration.json file. The corresponding services of each webhook are listed here. For the enrichment of metadata, the pertaining Service service would be the API-gateway. 

Code Block
titleExample SystemHookConfiguration.json
{
  "systemhooks": {
    "webhooks": [
      {
        "enable": true,
        "predicate": "spel:true",
        "type": "dms.request.update.metadata",
        "url": "<protocol>://<webhook service identifier>/api/dms/request/update/metadata",
        "useDiscovery": true
      }
    ]
  }
}

...

In this tutorial, a Java-based method for Webhook consumption webhook consumption is outlined. The code presented, including the project structure and additional webhook management, can be found here in github


Info
iconfalse

Read on

Section


Column
width25%
Events 

System Hooks

Insert excerpt
System Hooks
System Hooks
nopaneltrue
 Keep reading


Column
width25%

Webhooks

Insert excerpt
Webhooks
Webhooks
nopaneltrue
 Keep reading


Column
width25%

Messaging when Importing Documents

Insert excerpt
Messaging when Importing Documents
Messaging when Importing Documents
nopaneltrue
 Keep reading