Extending the functionality of Assets 10 by using extension points

The default features and functionality of Assets make it possible to perform a multitude of tasks.

However, each working environment is different and requires specific features to be available and specific tasks to be performed.

With Assets being an open system, the basic functionality can be extended through the use of extension points such as plug-ins and APIs. This way, repetitive tasks can be automated, external systems can be integrated, and workflows can be customized.

Choosing the right implementation for a particular scenario can be challenging though.

This article explains the available integration options and advises on what to use in the various integration scenarios.

Discussed are:

• Plug-ins
• APIs

Example scenarios

The following table shows some example scenarios and the extension point type that can best be used for it.

#	Scenario	Extension point type
1	Integrating a process that requires user interaction.	Client application plug-ins
2	Triggering a background process when Assets data is changed such as when importing an asset or changing metadata.	API Webhooks

Plug-ins

Client plug-ins make it possible to provide end users with additional (custom) functionality in Assets.

The aim of adding such functionality is to improve the workflow and increase efficiency, resulting in a better (more standardized) working environment in which the user can perform tasks quicker with less risk of making errors.

Examples: Managing copyright information of images can be easily and efficiently managed by using a plug-in which stamps multiple files with a predefined set of metadata in one action. This way, the user does not have to repeatedly add metadata to each file with the risk of making mistakes. In a scenario where Assets is part of a bigger ecosystem where it needs to interact with other systems, plug-ins can help users with exporting assets to an external system such as a Web CMS or a video streaming platform.

Client plug-in types

A client plug-in is basically a small Web application consisting of HTML, JavaScript, and CSS files.

This has to be hosted on an external Web server. Configuration options are available for defining how it is triggered and how it is displayed.

A distinction is made between the following types of client plug-ins:

• Action plug-ins trigger a specific action. They are displayed in one of the following ways:
• As a fullscreen overlay
• In a new Web browser tab
• As a dialog

• Panel plug-ins appear as a panel in Assets.

For details about managing them, see:

• Managing Action plug-ins in Assets 10
• Managing Panel plug-ins in Assets 10

Choosing the plug-in type to use

Which plug-in type to use depends on the action that needs to be performed and how users need to interact with that action.

• Dialogs are best used for quick actions such as simple export actions or custom steps when importing assets. Because the rest of the application is not accessible as long as the dialog window is open, users do not lose the context of their current work (such as files that are selected, the scroll position in a window, and so on).

• Fullscreen overlays are useful when all available screen space is needed while not leaving the context of Assets, such as when creating an image contact sheet.

• Plug-ins that open in a new Web browser tab can be useful for loading external Web sites that do not allow to be embedded in another Web site such as Assets, typically because of security considerations. Opening such Web sites from within Assets makes sure that users are aware of these sites and can easily access them.

• Panel plug-ins are added as regular panels in Assets and can be accessed any time the user needs them. They are used by first selecting one or more assets and subsequently performing some kind of action in the panel.

Examples: Updating metadata. Showing contextual information based on the currently selected assets such as product information from an external PIM system.

Usage

Client plug-ins work best for processes where user interaction is required. Such processes should typically be short so that users are not blocked from doing their work.

Long-running jobs can best be offloaded as an asynchronous background process.

For more information, see:Extending the Assets 10 functionality with plug-ins .

APIs

The following API types are available:

• REST APIs
• Webhooks

REST APIs

Assets provides a large set of REST API endpoints for retrieving, creating, modifying, and deleting information. Supported actions include searching for assets, updating asset metadata, importing assets, sharing assets, copying folders, and much more.

The REST APIs are the core of the open platform that Assets provides and are used in Assets plug-ins, Web sites, mobile apps, and background jobs.

For more information, see The Assets 10 REST API.

Webhooks

REST APIs retrieve information from or change information in Assets but are not able to inform users on changes made in Assets so that they can be acted upon.

This is where Webhooks come in. Using Webhooks, an integration can listen for changes on assets, folders, and Collections and perform any custom action.

For more information, see Using Webhooks in Assets 10.