Qorus Integration Engine®  5.1.2_git
Implementing Mappers

Mapper Development Overview

See also
Qorus Mappers for more information

All Qorus integration objects are described by YAML metadata produced by our IDE, which is available as a free (as in free of charge and also open source) extension to Microsoft Visual Studio Code, a multi-platform editor from Microsoft. The Qorus extension is called Qorus Developer Tools and can be installed directly from Visual Studio Code.

Mappers are developed in the IDE, loaded into the system schema with oload and participate in releases built with make-release.

Mappers in the Qorus IDE

Each mapper has its own sandboxed Program container that contains the mapping logic and any library objects imported into it. Mapper Program objects have the following sandboxing restrictions set by default:

For mapper library code, the following parse option is also set to restrict code from performing I/O or logging:

Note
The following system options can cause additional options to be set by default:
See also

Note that workflows, services, and jobs must declare mappers to be able to access them. The following api call should be used to acquire a mapper in your interface code:

Mapper Diagram in the Qorus IDE
See also
Mapper Library for more information.

Mapper Files

Mappers are defined as YAML metadata created by the Qorus IDE.

Mappers have the following attributes:

Mapper Name

The name of the mapper; the name and version together are unique identifiers for the mapper and are used to derive the mapperid (which is generated when the mapper is loaded into the system via oload).

Mapper Version

The version string for the mapper; the name and version together are unique identifiers for the mapper and are used to derive the mapperid (which is generated when the mapper is loaded into the system via oload).

Mapper Patch

A string "patch" label which can be used to show that a mapper was updated while not affecting the mapperid.

The patch label is descriptive only and does not affect the mapper's ID.

Mapper Description

A description for the mapper; the description field supports markdown for formatted output in the UI and IDE.

Mapper Options

An optional hash of mapper options.

Mapper Author

The optional author string for the mapper.

Mapper Library

Mappers support library objects that provide additional code for mapper fields using code to define the logic for the output mapping.

See also
Library Objects for more information

Mapper Groups

Mappers can be members of interface groups like other interface objects.

Mapper Context

The mapper context provides information to Qorus about other contextual information that can be used in a mapper such as a workflow's static data type.

Mapper Input

Mappers can declare input types that define the type of input data or an input provider that provides both the input data type and also a source for the data.

Mapper Output

Mappers can declare output types that define the type of output data or an output provider that provides both the output data type and also a source for writing or processing the data.