Buildhelper

Buildhelper is a tool within Integration Gateway (formerly known as Glyue) that aims to provide a basic starting point for Service Requests against an external API or System.

Importing a Service Request

The Import Service Request feature assists the integration developer to create new Service Requests for supported Systems (aka Adapters) with predefined Field Mapping rows. This saves the developer the trouble of referencing API documentation outside Glyue to ascertain the payload structure of the request (i.e. the fields).

Referencing external API documentation is still recommended.

Buildhelper functions as a “wizard” where the developer selects the System they are building against, then the applicable Service, then Field Mappings, and then import options.

A Service is simply a grouping of related request types for a given System. Often, this is because the various request types will perform different actions on the same object/record in the target system.

Example

Imagine a “Customer” service on an arbitrary ReSTful API that has separate URL paths and HTTP methods for creating, editing, getting, and deleting Customer records in the target System.

Let's say we want to edit and existing Customer record. The Service Request would look something like this:

  • The Service Request’s Service Name would be Customer

  • The applicable Field Mapping set might be labeled as Update Customer or similar

  • The Buildhelper will provide all fields for this type of request

Not all Systems have Services and some Services only have one Field Mapping Set.

Not all Systems/Adapters are yet supported, but we are actively working on generating field metadata for commonly used systems, as well as all new systems going forward.

Usage

  1. Open the Buildhelper interface on the Build page by clicking the Buildhelper button on the bottom bar.

  2. Select the target system.

  3. Select the applicable Service.

  4. Select the applicable Field Mapping set.

  5. A preview of the Field Mappings will be displayed. Click the bottom button: Accept and Proceed to Import Options.

  6. Name your new Service Request (the Formula variable), select an existing Integration to add the Service request to, or create a new Integration with this Service Request. Then click Add Rows to Table.

  7. The Build page will automatically navigate to show you the imported data.

These changes are merely staged and not yet saved. The user must save changes for the data to persist, just like making any other changes on the Build page.

PreviousLoggingNextGlyue ETL Overview

Last updated

Was this helpful?