# Buildhelper

## Importing a Service Request <a href="#buildhelper-importservicerequest" id="buildhelper-importservicerequest"></a>

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 Integration Gateway to ascertain the payload structure of the request (i.e. the fields).

{% hint style="warning" %}
Referencing external API documentation is still recommended.
{% endhint %}

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.

{% hint style="info" %}
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
  {% endhint %}

{% hint style="warning" %}
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.
{% endhint %}

### Usage

1. Open the Buildhelper interface on the Build page by clicking the **Buildhelper** button on the bottom bar.<br>

   <figure><img src="/files/aJZNAuw3MSeWMI6TjSvc" alt=""><figcaption></figcaption></figure>
2. Select the target system.<br>

   <figure><img src="/files/HTVJwx0G9cBzi0TwgdiD" alt=""><figcaption></figcaption></figure>
3. Select the applicable Service.<br>

   <figure><img src="/files/ugNwAHyeozVLzHEiZJh4" alt=""><figcaption></figcaption></figure>
4. Select the applicable Field Mapping set.<br>

   <figure><img src="/files/uhV1UnaJpxiMR1l4ICKa" alt=""><figcaption></figcaption></figure>
5. A preview of the Field Mappings will be displayed. Click the bottom button: **Accept and Proceed to Import Options.**<br>

   <figure><img src="/files/ttnCeIlczX8InpXDdsiZ" alt=""><figcaption></figcaption></figure>
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.**<br>

   <figure><img src="/files/1yidl3uYJvSNeiavBxen" alt=""><figcaption></figcaption></figure>
7. The Build page will automatically navigate to show you the imported data.<br>

   <figure><img src="/files/VJouUyQJAa3EQy0vbe9z" alt=""><figcaption></figcaption></figure>

   <figure><img src="/files/PuGiyRPq4t7AZ4OJsNlC" alt=""><figcaption></figcaption></figure>

   <figure><img src="/files/MMoN3tXoER1zzmIU6jLq" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
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.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://glyue.docs.sandboxbanking.com/integration-gateway-platform-reference/buildhelper.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.