com.appian.connectedsystems.simplified.sdk

Class SimpleConnectedSystemTemplate

Object

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

com.appian.connectedsystems.simplified.sdk.SimpleConnectedSystemTemplate

All Implemented Interfaces:

ConnectedSystemTemplate

Direct Known Subclasses:

SimpleOAuthConnectedSystemTemplate, SimpleTestableConnectedSystemTemplate

public abstract class SimpleConnectedSystemTemplate
extends ConfigurableTemplate
implements ConnectedSystemTemplate

Each subclass of SimpleConnectedSystemTemplate represents a new type of ConnectedSystem available to designers in Appian.

A Connected System in Appian stores shared information, usually credentials, across multiple integrations. The data structure will be created in getConfiguration(SimpleConfiguration, ExecutionContext)

Each subclass must have the TemplateId annotation to be successfully deployed

Your plugin must contain at least one subclass of SimpleConnectedSystemTemplate

This should only be extended directly if the Connected System has no credentials to test or credentials are untestable. Otherwise extend one of the subclasses of SimpleConnectedSystemTemplate: TestableConnectedSystemTemplate or OAuthConnectedSystemTemplate.

Field Summary

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

typePropertyFactory

Constructor Summary

Constructors

Constructor and Description
SimpleConnectedSystemTemplate()

Method Summary

Modifier and Type	Method and Description
protected abstract SimpleConfiguration	getConfiguration(SimpleConfiguration configuration, ExecutionContext executionContext) Returns the configuration that defines the UI and data stored for an Appian Connected System object.
ConfigurationDescriptor	getConfigurationDescriptor(ConfigurationDescriptor configDescriptor, PropertyPath updatedProperty, ExecutionContext executionContext)

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

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

Methods inherited from class Object

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

Constructor Detail

SimpleConnectedSystemTemplate

public SimpleConnectedSystemTemplate()

Method Detail

getConfiguration

protected abstract SimpleConfiguration getConfiguration(SimpleConfiguration configuration,
                                                        ExecutionContext executionContext)

Returns the configuration that defines the UI and data stored for an Appian Connected System object.

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

Example: Creating a single input for an API Key

   return configuration.setProperties(
     encryptedTextProperty("apiKey").label("API Key").build()
   );
 

This method is called in the following scenarios:

• A designer creates a new Connected System.
• A designer loads an existing Connected System to edit.
• A designer edits a property that has a refresh policy of ALWAYS.

Parameters:

configuration - The current configuration. This value will never be null

executionContext - The ExecutionContext for the current evaluation of the Connected System descriptor This value will never be null

Returns:

The updated configuration

getConfigurationDescriptor

public ConfigurationDescriptor getConfigurationDescriptor(ConfigurationDescriptor configDescriptor,
                                                          PropertyPath updatedProperty,
                                                          ExecutionContext executionContext)

Specified by:

getConfigurationDescriptor in interface ConnectedSystemTemplate