Versions Compared

Version Old Version 7 New Version 8
Changes made by

Wanja Mensch

Wanja Mensch

Saved on

Key

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

Helm Chart V 0.2.1

  • added authTenantId to env section

Single Page Application V 0.5.1

Breaking Changes

Some modifications are needed related to the sharepoint integration. See point “Sharepoint Integration” below.

New Features

Sharepoint Integration

Sharepoint is now a built in storage location. It can be selected in the storage location dropdown when creating or updating a configuration item.

To make this work the following changes are needed:

AUTH_TENANT_ID environment variable

Also listed in the env variables overview. The application expects this new environment variable. It can be found in Azure here:

image-20240426-113022.png

Client api permissions:

For the client needs the following permission to work:

Microsoft Graph permission:

  • Sites.Read.All

These previously listed permissions are not needed:

Sharepoint permission:

  • AllSites.Read

  • MyFiles.Read

  • Project.Read

  • Sites.Search.All

Customization Deployment

Endpoints

Added endpoints to export customization data from one instance to import it to a different one. Every customization is recognized by its key. Is any customization with the given key absent in the target system, it will be created, otherwise it will be updated with the new data.

Endpoints are the following:
GET /{spaceKey}/api/v1/deployment/customizations/export

Exports a list of following elements:

  • PropertyTypes

  • RecordTypes

  • ReferenceTypes

  • StateMachines

  • ConceptTypes

  • Guards

  • MasterDataTables

The export also contains information about the version of the exported system. This version must match the version of the target system to avoid consistency and integrity issues.

It also provides a “Hash-based Message Authentication Code” (HMAC) to also ensure data integrity and authenticity.

POST /{spaceKey}/api/v1/deployment/customizations/import/impact

Lists the impact of the import, without performing an actual import. This endpoint expects a file as a body.

POST /{spaceKey}/api/v1/deployment/customizations/import

Performs import and lists result.

Configuration

Added HMAC_SECRET as an environment variable. This String is used as a secret for the HMAC calculation and is mandatory to set. This endpoint expects a file as a body.