This section provides a reference table of required and optional extension element attributes.
The extension element takes the following attributes.
Note
The
defaultName
,
defaultDescription
, and
defaultIcon
values are only used if equivalent
attributes are not specified in the resource property files in the
conf/locales
folder. For example, if you do not
specify an extension name for French locales in those resource property files,
then the
defaultName
value is used. For more information
on locales, see
Localizing Workbench extensions.
Attribute name |
Attribute value |
Required? |
---|---|---|
|
A unique string identifying this extension. Do not define an
extension with the same id as one of the predefined Oracle Commerce Workbench
pages. For a list of predefined Workbench pages and their ids, see the
reference table in “Predefined
|
yes |
|
The display name for this extension that appears in the navigation menu and launch page in Oracle Commerce Workbench. |
no |
|
A brief description of this extension that appears on the launch page in Oracle Commerce Workbench. |
no |
|
An absolute or relative URL to this extension. The extension must be a Web application reachable through HTTP or HTTPS, but it does not have to run on the same server as Oracle Commerce Workbench. If the extension is hosted on the same server as Oracle Commerce Workbench, the extension URL can be site relative (omitting the host name and port and beginning with the leading slash). |
yes |
|
An absolute or relative URL to a custom image for this
extension’s entry on the launch page. (Relative URLs are relative to
|
no |
|
Deprecated in release 11.0.0. Use
| |
|
This attribute is only used when you want an extension to display for administrators on the Workbench Admin page. The only value allowed is "admin." Any other value is ignored. |
no |
|
A shared key that Oracle Commerce Workbench uses to calculate the authentication token. |
no |