Update Instructions 2021 Summer

When updating your yuuvis® Momentum installation to version 2021 Summer, manual configuration changes are required for some services.

Table of Contents

Web-API Gateway

Renaming of Endpoints

As of Release Candidate Alpha5: As described in the Breaking Changes, the endpoint URLs of the Web-API Gateway were modified. Thus, the entries for the API-WEB service endpoints in the authorization.accesses section of the authentication-prod.yml profile have to be adjusted as follows:

### api-web
  - endpoints: /api-web/swagger-ui.html/**,/api-web/**/springfox-swagger-ui/**,/api-web/**/swagger-resources/**,/api-web/**/v2/api-docs/**
  - endpoints: /api-web/api/resources/**,/api-web/api/users/**,/api-web/api/bpm/**,/api-web/api/dms/**
  - endpoints: /api-web/api/system/**
    access: hasAuthority('YUUVIS_SYSTEM_INTEGRATOR')
  - endpoints: /api-web/api/admin/**
    access: hasAuthority('YUUVIS_TENANT_ADMIN')

App Schema Modification

If the service SOTHOOK is running in your system and the clientsystem app schema exists, it is recommended to do the following adjustment. The leadingTypeId property in the app schema for the clientsystem app should be required now in order to immediately recognize any failure of the SOTHOOK.

  • Retrieve the app schema for the clientsystem ap via the GET /api/system/apps/{app}/schema endpoint.
  • In the definition of the leadingTypeId string property, set the boolean value for the required attribute to true.

    <required>true</required>
  • Update the app schema for the clientsystem app via the POST /api/system/apps/{app}/schema endpoint. Pass your modified XML in the request body.

Tenant Management API

The service providing the Tenant Management API was renamed from API-TM to TENANT-MANAGEMENT. Thus, the entries for the Tenant Management API endpoints in the authorization.accesses section of the authentication-prod.yml profile have to be adjusted as follows:

### api-tm
  - endpoints: /tenant-management/swagger-ui.html/**,/tenant-management/**/springfox-swagger-ui/**,/tenant-management/**/swagger-resources/**,/tenant-management/**/v2/api-docs/**
  - endpoints: /tenant-management/api/system/**
    access: hasAuthority('YUUVIS_SYSTEM_INTEGRATOR')
  - endpoints: /tenant-management/api/admin/**
    access: hasAuthority('YUUVIS_TENANT_ADMIN')

Webhooks

Please consider the changes regarding naming and behavior of our webhooks as described in the Release Information. Especially, two webhooks are renamed and one is deprecated.
>> Release Information Webhooks