Understand Application Integration Framework (AIF)

Application Integration Framework (AIF) provides a simple and effective way to integrate third-party services and applications into the Oracle Content and Experience Cloud interface.

Using AIF, you can quickly define the actions that are exposed in the interface, respond to user selections, call third-party services, and specify how the results are presented to the user. The framework supports variables and expressions and provides multiple language support.

Note:

Custom AIF applications are not applied when you access them through an applink or public link.

The definition for one or more integrations is stored in a single file in JSON format. As an administrator, you can upload the configuration file and add it to a list of available applications. Also as an administrator, you can edit and validate the configuration file directly in the interface, enable or disable the app for general use, set administration-level preferences, or delete the app.

The definition for one or more integrations is stored in a single configuration file in JSON format. The configuration file defines and manages the interactions between the app, native objects and interface elements. The configuration file includes:
  • App properties including tenant and user preferences

  • Actions that are exposed in the interface and the service calls they make

  • How the results are presented to the user

  • Interface strings with support for multiple languages


Description of aif_process_flow.png follows
Description of the illustration aif_process_flow.png

An administrator adds the configuration file, enables the integration, and provides tenant and account information to get started. Also as an administrator, you can edit and validate the configuration file directly in the interface, download the configuration file, or delete the app.

To manage apps created with Application Integration Framework, sign in as an administrator, open your user menu, choose Administration, and then choose Integrations. Under Custom Actions, click Add.


Description of admin_applications.png follows
Description of the illustration admin_applications.png

From the Applications page, an administrator can use the following options.

Setting Description

Custom Application On/Off button

Enable or disable the application for users. When you enable the application, you can specify preferences for the application from the user menu, by choosing Preferences and then Applications Settings. You specify the user preferences resource in the userPrefs element in the configuration file.

Add a New Application Definition button

Browse local folders and files to locate and upload an application configuration file.

Information icon

Display the information defined for the application and specified in the info element of the configuration file.

Preferences icon

Display the preferences resource for administrators defined in the tenantPrefs element of the configuration file.

Edit icon

Open the configuration file in the integrated JSON editor. The editor validates the syntax of the file to ensure that the file contains valid JSON code. Changes you make to the configuration file are immediately available in the enabled application.

Note:

Changes you make to the configuration file are stored only in the server copy of the file. To back up your changes, use the Download icon to save the file locally.

Download icon

Download the file from the server to a local destination.

Trash icon

Delete the configuration permanently.

Note:

When you delete a configuration file, the deletion is permanent. The file can’t be restored from the trash.