Change History

Review what's new in this document.

January 2024

The following table lists the changes introduced in this version of the document.

Change Type Description

Admin APIs

  • Updated systemDescriptors, connectionDescriptors and routingCriteria APIs.
  • Introduced extensibilitySecrets API
Extensibility Secrets: Secrets API helps Tenant to store non public information like UserName, Password ..etc securely to the CXIF Vault.
Document Management API

New API added POST /uploadMultiple to support multiple file uploads in a single request.

Upload multiple documents: This operation uploads multiple files (a max of 5 per request) to the CMS.

July 2023

The following table lists the changes introduced in this version of the document.

Change Type Description

Business Logical Extensions

A new resource has been added to manage business logical extensions. Each Business Logical Extension can be triggered based on combination of an entity action (Create, Modify, Deleteetc.) and conditions that are provided by tenants or SI.
Access Roles for Resources New topic defining the different user access roles. A new topic has been added to define the various user access roles aplicable to different APIs.

April 2023

The following table lists the changes introduced in this version of the document.

Change Type Description
After-Market Extensibility A new resource has been added to manage after-market extensions. The resource lets you view all extensiblie resources, view all current extentions, and get information about an extension.

January 2023

The following table lists the changes introduced in this version of the document.

Change Type Description
Administration Following new APIs are added:
  • API Annexes

    The API Annexes are accessible through Industries Framework. An API Annex can be used as extension to the existing API. For a single API there can be multiple API Annexes.

  • Routing Status

    This service performs the operation to get spoke system registration information for a specific API, version and path.

  • Gatekeeping Rules Annexes

    A Gatekeeping Rule Annex can be used as extension or to overwrite the context of an API defined for the target system. For a single Gatekeeper there can be multiple Gatekeeping Rule Annexes.

October 2022

The following table lists the changes introduced in this version of the document.

Change Type Description
Extensibility Following new APIs are added:

Extensibility micro service

Industries Framework Extensibility micro service supports OpenAPI, Json Schemas, and Generation Rules.
Extension Publisher New API Extension Publisher has been added. The Extension Publisher resource is used to get all the extensions based on the extension name.
User Management Following API is updated

User Management - The User Management API lets you to create users in identity management systems that are compliant to SCIM 2.0. The API supports customization of the requested user to be created in the sense of custom attribute mapping and group allocation, based on the requested user profile and destination identity management system.

July 2022

The following table lists the changes introduced in this version of the document.

Change Type Description
Administration API Following new APIs are added:
The Administrative APIs of DX-Fabric Configuration defines the following 6 major components:
  • Export Configurations - Export is used to move configuration data between different clusters.
  • Import Configurations - The exported configurable configurations can be imported into another cluster.
  • Interaction Context Enrichments - Captures the operations that create or update a routing interaction context. Such a context is a short-lived map of information that is retained in an in-memory cache as part of the Fabric. In case a routing target specifies that it requires the publishing of a key/value pair on the context, Fabric automatically extracts the relevant information from the request and response and either creates or updates such an interaction context.
  • OIDC Servers - List of the OpenID Connect servers that Fabric will interact with. This document appears both globally and on a per-workspace basis. Global documents are stored within the on-cluster control plane to describe for example the OIDC server that Fabric is secured with itself. Per-workspace servers are stored in a single respective document per namespace.
  • Routing Criteria - RoutingCriteria is a collection of different Criterias used by different end systems for routing. Will be used in RoutingMS to evaluate the criteria based on Incoming call.
  • SCIM Configurations - The System for Cross-domain Identity Management (SCIM) specification is designed to make managing user identities in cloud-based applications and services easier.
  • Workspace Clients - This document type describes the lookup of client application specific OAuth/OpenID Connect secrets that identify the client application on the various different AuthZ servers. It also references the secrets that are needed to sign OIDC token assertions
  • Workspaces - Workspace is a collection of fabric configurations. Will be used in identifying the workspace to which the Microservice needs the call to be routed to.
User Management Following new API is added

User Management - The User Management API lets you to create users in identity management systems that are compliant to SCIM 2.0. The API supports customization of the requested user to be created in the sense of custom attribute mapping and group allocation, based on the requested user profile and destination identity management system.

April 2022

The following table lists the changes introduced in this version of the document.

Change Type Description
Administration API Following new APIs are added:
The Administrative APIs of DX-Fabric Configuration defines the following 6 major components:
  • APIs - Defines APIs that are accessible through DX-Fabric. An API can be used to configure an adapter for a service that implements the API. An API can also be used to configure a listener for API events.
  • Connection Descriptors - An instance of a target system that is a participant in the DX Fabric environment. This implements the connection characteristic of the corresponding System Descriptor.
  • Feature Flags - Configurations to modify system behavior to enable/disable features without changing code
  • Listener Registrations - Defines Listener Registrations for DX-Fabric API events including connection details.
  • Routing Rules - Defines Routing Rules to route DX-Fabric API requests to an internal or external adapter.
  • System Descriptors - Defines a target system that is a participant in the DX Fabric environment. This definition can include APIs supported and business events subscribed to.

January 2022

The following table lists the changes introduced in this version of the document.

Change Type Description
Get Started section Updates to topics The topics in this section have been revised and improved to increase usability.

October 2021

The following table lists the changes introduced in this version of the document.

Change Type Description
Get Started section Updates to topics The topics in this section have been revised and improved to increase usability.

July 2021

The following table lists the changes introduced in this version of the document.

Change Type Description
Administration APIs Updates to topics Starting 21C, Fabric supports only Gatekeeping Rules and Tenant Configurations.

November 2020

This is the first publication of the guide.