com.appian.connectedsystems.simplified.sdk.configuration

Class SimpleConfiguration

Object

com.appian.connectedsystems.simplified.sdk.configuration.SimpleConfiguration

public class SimpleConfiguration
extends Object

Defines the configuration of an Appian Connected System object or an Appian Integration object. The following example illustrates defining the structure of the data and UI, followed by setting a value and an error:

  
  integrationConfiguration.setProperties(
    textProperty("name")
    .label("Name")
    .build(),
   integerProperty("height")
    .label("Height")
    .build(),
   integerProperty("age")
    .label("Age")
    .build(),
   booleanProperty("requiresParentApproval")
    .label("Requires Parent Approval")
    .isReadOnly(true)
    .build());

  Integer age = integrationConfiguration.getValue("age");

  if (age != null)
    integrationConfiguration.setValue("requiresParentalApproval", age < 18);

  Integer heightInInches = integrationConfiguration.getValue("height");
  if (heightInInches != null && heightInInches < 60)
    integrationConfiguration.setError("height", "You are not tall enough to ride.");
 
 

Supports:

• setting and retrieving values on properties by keyed locations
• setting and retrieving errors on properties by keyed locations
• creating the UI and data structure on the Appian object

setProperties(PropertyDescriptor...) must be called per invocation of SimpleConnectedSystemTemplate.getConfiguration(SimpleConfiguration, ExecutionContext) and SimpleIntegrationTemplate.getConfiguration(SimpleConfiguration, SimpleConfiguration, PropertyPath, ExecutionContext)

As designers provide values, the SimpleConfiguration can be dynamically updated to display additional configuration options, fill in dropdown choices, and set default values.

*

Method Summary

Modifier and Type	Method and Description
static SimpleConfiguration	from(ConfigurationDescriptor configDescriptor, com.appian.connectedsystems.simplified.sdk.configuration.TypePropertyFactory typePropertyFactory, ExecutionContext executionContext)
List<PropertyDescriptor>	getProperties() Properties define how fields are displayed.
PropertyDescriptor	getProperty(String key) Properties define how fields are displayed.
<T> T	getValue(PropertyPath propertyPath) Gets a value stored anywhere in the configuration.
<T> T	getValue(String key) Gets a value stored in the configuration All values inside the configuration can be null.
SimpleConfiguration	setErrors(List<String> errors) Set errors at the highest level of the configuration Use this method to show invalid configurations in the connected system or errors resulting from an invalid combination of multiple fields' configurations
SimpleConfiguration	setErrors(PropertyPath propertyPath, List<String> errors) Sets an error anywhere in the configuration.
SimpleConfiguration	setErrors(String key, List<String> errors) Sets an error in the configuration.
SimpleConfiguration	setProperties(PropertyDescriptor... properties) Defines the UI and data structure of the Appian object integrationConfiguration.setProperties( textProperty("name") .label("Name") .instructionText("Please enter your first and last name") .build(), integerProperty("height") .label("Height") .build(), integerProperty("age") .label("Age") .build(), booleanProperty("requiresParentApproval") .label("Requires Parent Approval") .description("If true, you need to ask your parents first!")
SimpleConfiguration	setValue(PropertyPath propertyPath, Object value) Sets a value stored anywhere in the configuration.
SimpleConfiguration	setValue(String key, Object value) Sets a value stored in the configuration.
ConfigurationDescriptor	toConfiguration()

Methods inherited from class Object

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

Method Detail

setProperties

public SimpleConfiguration setProperties(PropertyDescriptor... properties)

Defines the UI and data structure of the Appian object

  integrationConfiguration.setProperties(
    textProperty("name")
    .label("Name")
    .instructionText("Please enter your first and last name")
    .build(),
   integerProperty("height")
    .label("Height")
    .build(),
   integerProperty("age")
    .label("Age")
    .build(),
   booleanProperty("requiresParentApproval")
    .label("Requires Parent Approval")
    .description("If true, you need to ask your parents first!")
    .displayMode(BooleanDisplayMode.CHECKBOX)
    .isReadOnly(true)
    .build()
  )
 

This method must be called per invocation of SimpleConnectedSystemTemplate.getConfiguration(SimpleConfiguration, ExecutionContext) and SimpleIntegrationTemplate.getConfiguration(SimpleConfiguration, SimpleConfiguration, PropertyPath, ExecutionContext)

Properties define how fields are displayed. Each editable (non-read-only and non-hidden) property represents data the designer can configure. Values can be modified using setValue(String, Object) or retrieved using getValue(String).

All existing values are migrated to the new data structure based on the property keys. Newly added fields are set to default values defined by SystemType.

Parameters:

properties - fields to be displayed in the UI

Returns:

updated SimpleConfiguration

getProperties

public List<PropertyDescriptor> getProperties()

Properties define how fields are displayed. Each editable (non-read-only and non-hidden) property represents data the designer can configure. Values can be modified using setValue(String, Object) or retrieved using getValue(String).

Returns:

list of properties that define the current UI

getProperty

public PropertyDescriptor getProperty(String key)

Properties define how fields are displayed. Each editable (non-read-only and non-hidden) property represents data the designer can configure. Values can be modified using setValue(String, Object) or retrieved using getValue(String).

Parameters:

key - property key uniquely identifying the property.

Returns:

specific property of the configuration at the given key

getValue

public <T> T getValue(String key)

Gets a value stored in the configuration All values inside the configuration can be null. Use reference types.

This value could be:

• the default value on initialization. See SystemType
• set using setValue(String, Object)
• entered by a user

Parameters:

key - property key uniquely identifying the property

Returns:

T value at the given key

getValue

public <T> T getValue(PropertyPath propertyPath)

Gets a value stored anywhere in the configuration. Use this method to access nested properties All values inside the configuration can be null. Use reference types.

This value could be:

• the default value on initialization. See SystemType
• set using setValue(String, Object)
• entered by a user

Fetch the value of height inside local property "personType"

   PropertyPath path = new PropertyPath("personType", "height");
   Integer height = integrationConfiguration.getValue(path);
 

Parameters:

propertyPath - list of property keys locating the property

Returns:

T value at the given key

setValue

public SimpleConfiguration setValue(String key,
                                    Object value)

Sets a value stored in the configuration. This will override any user-entered value at the same key.

Parameters:

key - property key uniquely identifying the property

value - value to insert at the key

Returns:

this

setValue

public SimpleConfiguration setValue(PropertyPath propertyPath,
                                    Object value)

Sets a value stored anywhere in the configuration. Use this method to access nested properties This will override any user-entered value at the same path.

   PropertyPath path = new PropertyPath("personType", "height");
   int heightInInches = 72;
   integrationConfiguration.setValue(path, heightInInches);
 

Parameters:

propertyPath - list of property keys locating the property

value - value to insert at the key

Returns:

this

setErrors

public SimpleConfiguration setErrors(List<String> errors)

Set errors at the highest level of the configuration Use this method to show invalid configurations in the connected system or errors resulting from an invalid combination of multiple fields' configurations

Parameters:

errors - the errors to display

Returns:

this

setErrors

public SimpleConfiguration setErrors(String key,
                                     List<String> errors)

Sets an error in the configuration. This error is displayed as a validation on the property in the UI.

Parameters:

key - property key uniquely identifying the property

errors - list of validations

Returns:

this

setErrors

public SimpleConfiguration setErrors(PropertyPath propertyPath,
                                     List<String> errors)

Sets an error anywhere in the configuration. Use this method to access nested properties This error is displayed as a validation on the property in the UI.

Parameters:

propertyPath - list of property keys locating the property

errors - list of validations

Returns:

this

toConfiguration

public ConfigurationDescriptor toConfiguration()

from

public static SimpleConfiguration from(ConfigurationDescriptor configDescriptor,
                                       com.appian.connectedsystems.simplified.sdk.configuration.TypePropertyFactory typePropertyFactory,
                                       ExecutionContext executionContext)