Package com.boomi.connector.api

Interface PayloadMetadata

All Known Implementing Classes:

SimplePayloadMetadata

public interface PayloadMetadata

Metadata that can be attached to an ExtendedPayload. Properties added to the metadata will be accessible in integration processes as either connector tracked properties or dynamic document / user defined properties. It is highly recommended that connector developers prefer tracked properties over dynamic document properties. Moved this interface from commonsdk to connector-sdk-api to ensure strict and non-strict connectors can access this functionality independently.

Method Summary

Modifier and Type	Method	Description
void	setTrackedGroupProperties(String groupId, Map<String,String> properties)	Sets the document level connector trackedGroup.
void	setTrackedGroupProperty(String groupId, String name, String value)	Adds a single property to a trackedGroup based on groupId.
void	setTrackedProperty(String name, String value)	Sets a connector tracked property.
void	setUserDefinedProperty(String name, String value)	Sets a user defined / dynamic document property.

Method Detail

setTrackedProperty

void setTrackedProperty(String name,
                        String value)

Sets a connector tracked property. The name should ideally correspond to tracked property declaration in the connector descriptor. This is not required to add the property but the property will not appear in process reporting or be accessible by any shapes that can read predefined connector properties. This method should be preferred over setUserDefinedProperty(String, String) whenever possible.

Parameters:

name - the name of the property as defined in the descriptor

value - the value of the property

setUserDefinedProperty

void setUserDefinedProperty(String name,
                            String value)

Sets a user defined / dynamic document property. Process designers will need to match the name and case of this property exactly in order to access the value. Additionally, dynamic document properties can cause issues with downstream connectors/shapes that may be accessing the properties as there's no supported way for process designers to remove unwanted properties. Connector developers should prefer setTrackedProperty(String, String) over this method whenever possible. Note: This method is not currently supported for LISTEN operations. Any user defined properties set by the operation will be ignored.

Parameters:

name - the name of the property

value - the value of the property

setTrackedGroupProperties

void setTrackedGroupProperties(String groupId,
                               Map<String,String> properties)

Sets the document level connector trackedGroup. The groupId should correspond to the tracked group declaration in the connector descriptor. The name / value property is stored only for the connector and is not mandatory to add, but the properties will not appear in process reporting or be accessible by any shapes that execute a get on connector properties based off of the groupId and the name. If there are duplicate name / value properties, then the last one will be accessible to the process developer.

Parameters:

groupId - the group id for properties.

properties - the properties associated with the groupId

setTrackedGroupProperty

void setTrackedGroupProperty(String groupId,
                             String name,
                             String value)

Adds a single property to a trackedGroup based on groupId. The groupId should correspond to the tracked group declaration in the connector descriptor. The name / value is stored only for the connector and is not mandatory to add, but the properties will not appear in process reporting or be accessible by any shapes that execute a get on connector properties based off of the groupId and the name. If there are duplicate name / value properties, then the last one will be accessible to the process developer.

Parameters:

groupId -

name -

value -