Successfully implementing a Baseline process relies heavily on arbitrary data models from disparate systems of record having similar data structures. Mappings enables persistent data alignment through a collection of RESTful API interfaces that allow a developer to define and maintain
MappingFieldobjects as they relate to external data structures within a baseline workgroup.
Mappings should be used by participants in a
Workgrouptaking part in a
Workflowto align the data used in a
Mappingis referenced as a domain model when defining a
Workstepwithin a draft
Workflow. They are utilized at run-time upon
WorkstepInstanceinstantiation to align data models between a primary and secondary system of record. This alignment is paramount in the processes involved in a baseline process, such as zero-knowledge state synchronization.
Mappings created through the API are used to dynamically generate mapping tables that are stored in a postgres database within the provide stack (local, hybrid or cloud). Input and output that conforms to the
MappingModeldefined in a
Mappingwithin a domain model is referenced in a
A mapping is a hierarchically structured object that contains the information necessary to process and align data elements (fields) between two disparate data models. Mappings are composed of three distinct components:
Mappingobject that provides context for a nested array of
MappingModelobject that provides context for a nested array of
MappingFieldobject that defines field attributes and relationships between the source and a target schema
All objects and related tables within a mapping are programmatically generated from the data included in the request.
MappingFieldobjects do not have separate endpoints.
The Mappings API is intended to function within the context of an
Organizationacting as a
Within this context, it is assumed that:
Organizationscoped JWT is available for use
Organizationhas connected a system of record (the SOR to be mapped)
Workgrouphas more than 1 system of record connected
- destination SOR data structure is known
- origin SOR data structure is known
Returns a list of mappings