The full schema for the existing .app files can be found in the JDECommons/lib/schema folder, specifically the application-view.xsd file.
The following outlines the additional content that will be added or where existing content will be used in a different context.
Relevant attributes on the application element:
| Attribute | Description/Use | New/Existing |
|---|---|---|
| id | Existing attribute, which identifies the unique id of the application and must match the name of the file. For internal applications this is linked to the APPLICATION_CODE codetable and the users home page. This is not the case for external applications. | Existing |
| title | A reference to content in the .properties file. This content is not displayed on the application banner, but used by the administration screens to identify the internal application. | Existing |
| subtitle | A reference to content in the .properties file. This content is not displayed on the application banner, but used by the administration screens to identify the internal application. | Existing |
| mode | Where this is not set, it is assumed the .app file is for an internal style application. Where this is set to external, the only supported value for now, this indicates that the .app file defines an external style application. This will be used to handle content and validation differently for both styles of application . | New |
All other attributes are unsupported and ignored for mode="external" .app files.
The following are new elements that will be supported as direct children of the application element. All elements are optional.
The icon and text displayed on the left hand corner of the application banner, including the hyperlink to what is known as the landing page. When an application is first loaded, it is this page that is opened, if defined. This is unlike an internal application which uses the users APPLICATION_CODE value. Note: If no page-id or landing-page element is specified, then the first entry in the navigation will be used as the landing page. It is possible for no landing-page element to be defined and the renderer will display nothing in this case.
| Attribute | Description | Required |
|---|---|---|
| title | A reference to the text displayed under the icon. | Yes |
| page-id | The page to open when the icon/text is clicked. | Yes |
| icon | A reference to the image icon to display. | No |
There are three types of banner-menu supported in the application banner:
It is possible to have no banner-menu elements and the renderer will display nothing in this case. In addition, a banner-menu can have no menu-items and again the renderer will handle this. In other words, these elements are optional.
| Attribute | Description | Required |
|---|---|---|
| type | mega, help and person are the currently supported values. And only one of each can be defined. | Yes |
| title | A reference to the title text to display. | Yes |
| page-id | A reference to the page to open. This is optional and only supported for the person menu in the first version. | No |
A banner-menu can have 0 to n menu-item elements as children, with the following attributes:
| Attribute | Description | Required |
|---|---|---|
| id | A unique id for the menu item. This must be unique within the file. | Yes |
| icon | A reference to the icon to display. | No |
| title | A reference to the title text. | Yes |
| text | A reference to a longer description text. | No |
| page-id | A reference to the page to open. | Yes |
A menu-item can have 0..n child elements called param. The params are hardcoded values that will be passed as parameters to the link associated with the menu-item. They will have the following attributes:
| Attribute | Description | Required |
|---|---|---|
| name | The name of the parameter to pass with the link. | Yes |
| value | A reference to the value of the parameter. This can be localized and if not, will be passed as is. | Yes |
A param is being used to set the "motivation" of the link. So in most cases the name will be motivation with some value. The value is localizable, but if it does not exist in the .properties file, the value specified in the xml will be sent.
A reference to the navigation file (.nav), which contains the list of items to display in the navigation bar for the application. Navigation bars are usually defined at a tab level, but in this case it is for the full application.
| Attribute | Description | Required |
|---|---|---|
| id | A reference to the id of the .nav file, which is the name of the file, e.g. <id>.nav | Yes |
| width | A reference to the value to be used as the pixel width of the navigation bar. This is to allow for localisation configuration on a per application basis. | No |