Schema mapping

Certain applications that use Link require that connectors define a schema mapping.

The mapping provides a way for Link to get the field definitions that a connector is expecting for a given operation. These field definitions are used in the mapping page of the embedded Link user interface.

Fields can either be static or dynamic. Statically defined fields are fixed in the schema definition. Dynamic fields are obtained by calling an endpoint that produces a list of fields.

A schema mapping definition consists of:
  • Name – only serves to identify a schema mapping definition.
  • Condition – conditions can be specified so that alternate schema mappings can be used based for different conditions. The condition specifies an expression which if it evaluates to true will result in the mapping being utilized. Expressions are of the same form as defined for property enablement.
  • Static Fields – these additional fields, that should always be present in the schema, are defined in a table of static field definitions.
  • Dynamic Field Endpoint – specifies an endpoint that is called to obtain fields dynamically. Only endpoints that define schema field responses are shown in the list of available endpoints.