Create an Integration


In this article, you will learn how to create and configure an integration, as well as how to use the integration designer to test and troubleshoot problems.

  • To learn about integration objects and their configuration options, see Integration Object.
  • To learn about connected system objects and their configuration options, see Connected System Object.
  • To learn how to call an integration from other places in your application, see Call an Integration.
  • For a real-world example of how to to build and use integrations, see the Integration Tutorial.
  • To learn how to use different types of connected systems to connect to different systems, see Connected Systems.

Note: Below are details of an HTTP integration. The following screens will change depending on the selected connected system template.

Create the HTTP Integration Object

Integrations are created in Appian Designer.

  1. Open the destination application for the new integration.

  2. Click New, then choose Integration from the dropdown menu.

  3. Fill out the Create Integration form.

  4. Select a connected system using the picker or select Create from scratch (HTTP only) to create a HTTP integration without using a connected system.

  5. Once you’ve named and described your integration, you can click Create to start editing the integration immediately.

  6. If you want to change the description or folder later, select Properties in the integration designer gear menu.

Configure the HTTP Integration Definition

The configuration pane of the integration designer allows you to define the HTTP request details for your integration.

For more information about the integration definition fields, see Integration Objects.

Note: Below are details of an HTTP integration. The following screens will change depending on the selected connected system template

  1. Select whether you want to use an existing connected system to share connection details across multiple integrations. If you created this integration directly from a connected system then this option will already be selected and the connected system will be pre-populated.

  2. Fill out the Connection details. If you are using an existing connected system, select a Connected System using the picker. Otherwise, provide the Authentication details (if applicable) directly, as shown below.

  3. Add Parameters and Headers.

  4. If the selected Method supports it, define the request Body and Content Type.

Content Type Selection

The Content Type field must be configured for integrations where the Method is set to POST, PUT, PATCH, or DELETE. Although the Content Type field is configured in the Body section of the configuration pane, it's actually sent as an HTTP header. This field indicates the media type of the resource(s) defined in the request Body. The selection is based upon the web service that you're integrating with. See the content types page for more information.

Add Automatic Parsing

Once you've configured the integration definition, it's a good idea to set automatic parsing on the response body.

Automatic parsing only applies to JSON responses.

Instead of having to write a wrapper rule, automatic parsing will convert the results into an Appian value. This will allow you to use dot notation and index() in another expression simply by passing in an integration rule.

Test the Integration

Once you've finished configuring the integration definition, you'll want to test the integration and view details about the request and response.

  1. Click Test Request.
  2. The Result tab displays the Time taken for each phase of the integration and the resulting Value.

  3. If an error occurs, the Result tab also displays the error details and recommended Next Steps.

  4. The HTTP Request tab displays the raw request sent to the external system.

  5. The HTTP Response tab displays the raw response received from the external system.

Any request or response body content over 10 KB in size will be truncated in the integration designer. The complete body is available when the integration is called from other objects in your application.

Add Custom Error Handling

By default, an integration will return an error when it's unable to connect or when the external system responds with an HTTP error status code. Even when the HTTP call succeeds, you may still need to check for error messages or unexpected content before using the response in your application.

You can add custom error handling to an integration within the Error Handling section

  1. Select Override and define all error conditions
  2. In the Success Criteria field write an expression that returns true.
  3. In the Error Message field use a!integrationError() to construct a custom error message.

Instead of returning an unwanted success status, the integration will return an error, allowing you to more easily handle future error handling.

Define Inputs

After the integration is tested, you can define inputs that will allow you to reuse this object throughout your application.

  1. Expand the inputs pane on the right hand side of the integration designer.

  2. Click the + button in the top right-hand corner.

  3. Configure the input Name, Type, and whether or not it is an Array from the grid. You can also change the order of inputs using the up and down arrows.

  4. If you have one or more inputs, you can enter values for each input in the test inputs pane. These values are used when testing the integration.

  5. To save the current input values as a set of default test values, click the Set as default test values link below the grid. Once set, the default values will be saved with the integration.

Open in Github Built: Thu, Feb 23, 2023 (02:59:22 PM)

On This Page