In this page, you will learn how to create and configure an integration, as well as how to use the integration designer to test and troubleshoot problems.
Note: Below are details of an HTTP integration. The following screens will change depending on the selected connected system.
To create an integration in Appian:
Open the destination application for the new integration.
Select a creation method:
Configure the following properties:
|Connected System||Browse to and select a connected system. This property is only present if you selected Use a connected system.|
|Integration to Duplicate||Browse to and select the existing integration you want to copy. This property is only present if you selected Duplicate existing integration.|
|Name||Enter a name that follows the recommended naming standard.|
|Description||(Optional) Enter a brief description of the integration.|
|Save In||Browse to and select an existing folder to store the integration object, or click Create New Rule Folder to create and select a new folder for the object.|
If you want to change the description or folder later, open the integration object, then select Properties in the gear menu.
As you continue to modify and define your integration, you may encounter guidance. Appian design guidance reinforces best practice design patterns that should be implemented in your objects. Guidance is calculated while editing expressions within the integration or when a precedent of the integration is updated.
When a recommendation or warning is triggered you'll see an indicator icon in the header (A) and next to the corresponding line in the expression editor (B).
Click on the icon in the header to learn more about the suggested guidance (C) and how it can be addressed.
If a recommendation is not applicable to your use case, you can Dismiss (D) that individual recommendation for that integration. Learn more about recommendation dismissal. Warnings cannot be dismissed and should always be addressed to avoid complications when the logic in the object is executed.
Integration design guidance is also visible outside of the object on the Health Dashboard.
See design guidance for the full list of possible guidance.
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
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.
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.
Add Parameters and Headers.
If the selected Method supports it, define the Request Body and Content Type.
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.
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.
Finally, you should decide whether to enable HTTP request/response logging for the integration.
Ensure that you are familiar with the integration logging guidelines before making this decision.
If you do choose to enable HTTP request/response logging, it will only write to the
integration_req_resp_activity.log log if that functionality is also enabled in the Admin Console. The dynamic message below the checkbox will tell you whether HTTP request/response logging is enabled for your environment.
Once you've finished configuring the integration definition, you'll want to test the integration and view details about the request and response.
The Result tab displays the Time taken for each phase of the integration and the resulting Value.
If an error occurs, the Result tab also displays the error details and recommended Next Steps.
The HTTP Request tab displays the raw request sent to 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.
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
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.
After the integration is tested, you can define inputs that will allow you to reuse this object throughout your application.
Expand the inputs pane on the right hand side of the integration designer.
Click the + button in the top right-hand corner.
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.
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.
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.
On This Page