Supported Connector capabilities

Each Connector exposes a set of capabilities that implement the desired functionality for a particular use case.

Most of the capabilities come from the Connectors themselves; however, Tridion Integration Framework and the Application Client can also expose capabilities that all Connectors can use. The .NET and Java SDK's provide the same set of Connectors, which differ only in their naming conventions. Java Connectors follow the pattern FunctionCapability.java while .NET Connectors are IFunctionCapability.cs.

The following table lists the capabilities that Tridion Integration Framework currently supports:

CapabilityDescriptionUsage
Create entityCreate a new entityGeneric entities; used by Data CRUD connectors
Update entityUpdate an existing entity in an external systemGeneric entities; used by Data CRUD connectors
Delete entityDelete an existing entity in an external systemGeneric entities; used by Data CRUD connectors
Get entityRetrieve an entity from an external system based on the entity's identityGeneric entities; used by Data CRUD connectors
Get entitiesRetrieve a set of entities using given list of entity identitiesGeneric entities; used by Data CRUD connectors
List entitiesRetrieve a set of entities using a given parent entity identityGeneric entities; used by Data CRUD connectors
Query entitiesPerform a query on entities using a given entity filterGeneric entities; used by Data CRUD connectors
Download binaryDownload a binary asset from an external system using a given binary reference

The binary reference is normally given in entity data response. The returned data can include reference to a byte stream.

Binary data and metadata; used by multimedia connectors
Upload binaryUpload a binary asset to an external systemBinary data and metadata; used by multimedia connectors
Perform actionPerform another action, not included in any of the other available capabilities
Includes the following two tasks:
  • Performing an action on an identified entity
  • Performing an action through the Connector without any entity being identified
Other

Use this capability only when necessary and there is no other capability that is suitable, such as for a particular backward compatibility scenario.

TemplatePerform tasks related to Content Manager Templates
Includes the following two tasks:
  • Get a Template fragment
  • Get a direct link to a published item
Content items maintained in the Tridion Sites Content Manager

External Content Library Templates use this capability during publishing.

AssociationAssociate an entity identity with specified TCM-URI

Example: When a Component or a Page in Tridion Sites links to an asset that is managed in a Digital asset management (DAM) system, this capability can be used to flag the asset as "in use" in the external system.

Content items maintained in the Tridion Sites Content Manager
DeassociationDeassociate an entity identity from specified TCM-URIContent items maintained in the Tridion Sites Content Manager
Resize imageResize an image to a specified height and width

Tridion Integration Framework exposes this capability for Connectors to consume so that the Connectors do not need to implement it.

General content items (not specifically Tridion Sites content)
Create thumbnailCreate a thumbnail version of an image, and optionally, include one or more overlay images.

Tridion Integration Framework exposes this capability for Connectors to consume so that the Connectors do not need to implement it.

General content items (not specifically Tridion Sites content)
Get Content PathReturn the full path to the root of an item based on an ID provided for that item

External Content Library uses this capability to get a path to the mount point. Note that if a Connector returns null for the path, External Content Library will use fallback mechanism to determine path to root.

General content items (not specifically Tridion Sites content)

Example: Use this capability to build a navigation tree using the item paths.