com.appian.connectedsystems.simplified.sdk

Class SimpleIntegrationTemplate

Object

com.appian.connectedsystems.simplified.sdk.configuration.ConfigurableTemplate

com.appian.connectedsystems.simplified.sdk.SimpleIntegrationTemplate

All Implemented Interfaces:

IntegrationTemplate

public abstract class SimpleIntegrationTemplate
extends ConfigurableTemplate
implements IntegrationTemplate

Each implementation of SimpleIntegrationTemplate represents a new type of integration available to designers in Appian.

Each new type of integration should represent a single operation in the external system. Create a new IntegrationTemplate for each operation.

Every SimpleIntegrationTemplate must be associated with exactly one SimpleConnectedSystemTemplate

Each implementation of this class must have the TemplateId annotation to be successfully deployed

Use the IntegrationTemplateType annotation to express whether this integration modifies or queries data

getConfiguration(SimpleConfiguration, SimpleConfiguration, PropertyPath, ExecutionContext) determines the UI that designers use to configure the integration for execution. execute(SimpleConfiguration, SimpleConfiguration, ExecutionContext) uses the integration and connected system's configurations to make a call to an external system.

SimpleIntegrationTemplates are re-instantiated per request. Therefore, each call to execute(SimpleConfiguration, SimpleConfiguration, ExecutionContext) or getConfiguration(SimpleConfiguration, SimpleConfiguration, PropertyPath, ExecutionContext) is on a new instance of the class.

Field Summary

Fields inherited from class com.appian.connectedsystems.simplified.sdk.configuration.ConfigurableTemplate

typePropertyFactory

Constructor Summary

Constructors

Constructor and Description
SimpleIntegrationTemplate()

Method Summary

Modifier and Type	Method and Description
IntegrationResponse	execute(ConfigurationDescriptor integrationConfigDescriptor, ConfigurationDescriptor connectedSystemConfigDescriptor, ExecutionContext executionContext)
protected abstract IntegrationResponse	execute(SimpleConfiguration integrationConfiguration, SimpleConfiguration connectedSystemConfiguration, ExecutionContext executionContext) Completes the operation in the external system and returns the result to the designer This method is called when a designer hits the test-request button in the Integration Designer, or when an integration is executed from a process, a SAIL form, or a Web API.
protected abstract SimpleConfiguration	getConfiguration(SimpleConfiguration integrationConfiguration, SimpleConfiguration connectedSystemConfiguration, PropertyPath updatedProperty, ExecutionContext executionContext) Returns a configuration that defines the UI and values of an Appian integration object.
ConfigurationDescriptor	getConfigurationDescriptor(ConfigurationDescriptor integrationConfigDescriptor, ConfigurationDescriptor connectedSystemConfigDescriptor, PropertyPath updatedProperty, ExecutionContext executionContext)
PropertyDescriptorBuilder	localTypeProperty(LocalTypeDescriptor localType)
PropertyDescriptorBuilder	localTypeProperty(LocalTypeDescriptor localType, String key)

Methods inherited from class com.appian.connectedsystems.simplified.sdk.configuration.ConfigurableTemplate

booleanProperty, deroot, documentProperty, doubleProperty, dropdownProperty, encryptedTextProperty, folderProperty, integerProperty, listTypeProperty, localType, textProperty

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleIntegrationTemplate

public SimpleIntegrationTemplate()

Method Detail

getConfiguration

protected abstract SimpleConfiguration getConfiguration(SimpleConfiguration integrationConfiguration,
                                                        SimpleConfiguration connectedSystemConfiguration,
                                                        PropertyPath updatedProperty,
                                                        ExecutionContext executionContext)

Returns a configuration that defines the UI and values of an Appian integration object. This method should update the integrationConfiguration.

Every call to this method must call SimpleConfiguration.setProperties(PropertyDescriptor[])

Example: Text field for entering customer ID and toggle for retrieving additional information

   return configuration.setProperties(
     textProperty("customerID").label("Customer ID").build(),
     booleanProperty("additionalInfo").label("Get Additional Info").build()
   );
 

This method is called in the following scenarios:

• A designer creates a new Integration.
• A designer loads an existing Integration in the Designer.
• A designer edits a property that has a refresh policy of ALWAYS.
• A designer selects a new connected system

Parameters:

integrationConfiguration - The current configuration This will never be null

connectedSystemConfiguration - The configuration of the designer-selected Appian connected system object associated with the Appian Integration object. This will never be null

updatedProperty - Field that has been modified by the designer. For a field to trigger the getConfiguration(SimpleConfiguration, SimpleConfiguration, PropertyPath, ExecutionContext) method, its RefreshPolicy must be set to RefreshPolicy.ALWAYS. Use this path to find the new, designer-updated value in the integrationConfiguration. This parameter will be null when a new Appian Integration object is created, when a saved Appian Integration object is reloaded in the designer, and when a new Appian connected system is selected.

executionContext - Contains all of the contextual information needed to configure the Appian Integration object, including Designer information, Designer locale, and proxy configuration. ExecutionContext

Returns:

The updated SimpleConfiguration integrationConfiguration

execute

protected abstract IntegrationResponse execute(SimpleConfiguration integrationConfiguration,
                                               SimpleConfiguration connectedSystemConfiguration,
                                               ExecutionContext executionContext)

Completes the operation in the external system and returns the result to the designer

This method is called when a designer hits the test-request button in the Integration Designer, or when an integration is executed from a process, a SAIL form, or a Web API.

Use the SimpleConfiguration.getValue(String) method to retrieve values from the integration and connected system. These values can then be sent to the external system.

Parameters:

integrationConfiguration - The configuration of the integration. This will never be null

connectedSystemConfiguration - The configuration of the connected system associated with the integration. This will never be null

executionContext - Contains all of the contextual information needed to execute the integration and configure diagnostics, including Designer information, Designer locale, and proxy configuration. ExecutionContext

Returns:

IntegrationResponse A success boolean, a result map, a list of errors, and designer-localized diagnostic information

getConfigurationDescriptor

public ConfigurationDescriptor getConfigurationDescriptor(ConfigurationDescriptor integrationConfigDescriptor,
                                                          ConfigurationDescriptor connectedSystemConfigDescriptor,
                                                          PropertyPath updatedProperty,
                                                          ExecutionContext executionContext)

Specified by:

getConfigurationDescriptor in interface IntegrationTemplate

execute

public IntegrationResponse execute(ConfigurationDescriptor integrationConfigDescriptor,
                                   ConfigurationDescriptor connectedSystemConfigDescriptor,
                                   ExecutionContext executionContext)

Specified by:

execute in interface IntegrationTemplate

localTypeProperty

public PropertyDescriptorBuilder localTypeProperty(LocalTypeDescriptor localType)

Overrides:

localTypeProperty in class ConfigurableTemplate

Parameters:

localType - Data structure composed of properties

Returns:

Local type property builder with the name of the local type as the key

localTypeProperty

public PropertyDescriptorBuilder localTypeProperty(LocalTypeDescriptor localType,
                                                   String key)

Overrides:

localTypeProperty in class ConfigurableTemplate

Parameters:

localType - Data structure composed of properties

key - Unique identifier to get and set the value of the property in SimpleConfiguration

Returns:

Local type property builder with the provided key