Application Properties

The following table shows the properties of an Application Integration Framework application.

Property Required Description

id

Yes

A non-empty string that uniquely identifies the application across Oracle Content Management.

name

Yes

A non-empty string that is displayed for the application’s web user interface. It can also be a key that can be translated using translation maps defined in stringsMap.

description

No

A string that is displayed with the application name in the web user interface. It can also be a key that can be translated using translation maps defined in stringsMap.

category

No

Category of the application. CUSTOM is the only allowed value. If you do not explicitly include category in the configuration file, it is dynamically added during application configuration and is given the default value of CUSTOM.

supportEmail

No

Email address of application support owner.

baseURL

No

Base URL used as a prefix to any relative URLs specified in the application.

stringsMap

No

Used to map languages to translation objects, so that keys in the application definition can be translated to the corresponding language.

info

No

Allows an integrator to show a dialog to display information about the application. It contains presentation and invoke properties.

documentation

No

Lets you add comments in the file, such as a comment to identify the purpose of an action. You might add a documentation property at the start of the code sample to describe the application itself.

tenantPrefs

No

Allows an integrator to expose application-level options in the preference settings. It contains presentation and invoke properties.

userPrefs

No

Allows an integrator to expose application-level options in the preference settings for users. It contains presentation and invoke properties.

actions

Yes

A collection of actions contained in the application. It must contain at least one action.