Ressources

Event = System Hooks  What is the difference?

Resources & 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:

Modification History

...

Requirements

In this tutorial, we'll create a Spring Boot Service using Java, meaning the requirements for the project are derived from Spring Boot. Thus, a JDK version 1.8 or later and Maven 3.2 or later are required. 

...

Setting up the Consumer Service

To implement processing of incoming update metadata using our webhook service, we need to configure an endpoint within a controller class of our Example Webhook Service, in this instance ExampleRestController. The URL we define between the RequestMapping annotation of the controller class and the PostMapping annotation of the endpoint method will need to find its way into the System Hook system hook configuration of our yuuvis® Momentum Systemsystem. We 'll will also define a stub method for working with the incoming metadata, which we 'll will call from within our endpoint method, the Object Map object map provided by the System Hooksystem hook. 

@RestController
@RequestMapping("/api/dms/request")
public class ExampleRestController
{
    @PostMapping(value = "/update/metadata", produces = {"application/json"})
    public Map<String, Object> updateDmsObjectMetadata(@RequestBody Map<String, Object> dmsApiObjectList, 
                                                       @RequestHeader(value = "Authorization", required = true) String authorization)
    {
        doSomething(dmsApiObjectList, authorization);
        return dmsApiObjectList;
    }
    private void doSomething(Map<String, Object> dmsApiObjectList, String authorization)
    {
        // do something with the metadata
    }
}

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:

...

...

Configuring the Webhook

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 systemHookConfiguration.json file , whereafter the API gateway (API Service) needs to be restarted.  (\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 would be the API-gateway. 

{
  "systemhooks": {
    "webhooks": [
      {
        "enable": true,
        "predicate": "spel:true",
        "type": "dms.request.update.metadata",
        "url": "<your host base 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. More concrete example webhook use cases are described in the articles linked below.