Developer
News and Updates
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Security for Connect apps
Framework overview
Building blocks
Modules
JavaScript API
Last updated Feb 24, 2026

Admin Page

Used to show a link and full page within an admin section

Properties

key

Typestring
Max length128
RequiredYes
Pattern^[a-zA-Z0-9-]+$
DescriptionA key to identify this module. This key must be unique across all modules defined by your app.

location

Typestring
Max length128
RequiredYes
DescriptionLocation in the application interface.

name

Typei18n-property
RequiredYes
DescriptionRepresents a string that can be resolved via a localization properties file. You can use the same i18n Property key and value in multiple places, but identical keys must have identical values.

Properties

url

Typestring
Max length2048
RequiredYes

conditions

Typearray of condition
DescriptionConditions control whether or not a module will be displayed based on the current context. See Conditions for more details

icon

Typeobject
DescriptionThis is not fully supported yet. If specified, this will take precedence over any aui icon classes specified via params.auiIcon.

Properties

params

Typeobject

tooltip

Typei18n-property
DescriptionRepresents a string that can be resolved via a localization properties file. You can use the same i18n Property key and value in multiple places, but identical keys must have identical values.

Properties

weight

Typeinteger
DescriptionDetermines the order in which the web item appears in the menu or list. The "lightest" weight (i.e., lowest number) appears first, rising relative to other items, while the "heaviest" weights sink to the bottom of the menu or list.

Rate this page: