Path: application
Snippet ID: Application
Corresponding AUI Tree element: AUI Root Element
The Application is a unique object that represents the 4GL application currently running and used to rendered the current document.
This object value is rendered thru the Application snippet when invoked in a gwc:replace or gwc:content instruction.
| Fields | Type | Description |
| application/CID | Attribute (string) | The corresponding component identifier. |
| application/type | Attribute (string) | Type of the component. |
| application/connectorUri | Attribute (string) | Connector part of the URI |
| application/state | Object | An ApplicationState object handling the state of the application. |
| application/meta | Object | An ApplicationMetaInformation object handling miscellaneous information from the application depending to its state. |
| application/ui | Object | A UserInterface object handling the application abstract user interface description. |
| application/interrupt | Object | An Interrupt object handling the interruption of the application. |
Path: application/state
The ApplicationState is a unique sub-object from the Application object that represents the application state.
With the introduction of the snippet-based rendering engine, the main template can be used to surface the application regardless of its state, eliminating the need for individual template files for each application state. A change in the application state (interactive, processing, and so on) will be handled in the main template using the application state paths listed below.
| Fields | Type | Description |
| application/state/interactive | Attribute (boolean) | DVM state interactive or not. |
| application/state/processing | Object | A Processing object describing the processing state if any. |
| application/state/ended | Object | An Ended object describing the ended state if any. |
Path: application/state/processing
The Processing is a unique sub-object from ApplicationState object that represents the application processing state.
| Fields | Type | Description |
| application/state/processing/transactionPending | Attribute (boolean) | True if the application server is still processing the request. |
Path: application/state/ended
The Ended is a unique sub-object from ApplicationState object that represents the application ended state.
| Fields | Type | Description |
| application/state/ended/normal | Attribute (boolean) | True if the application has properly ended. |
| application/state/ended/timeout | Attribute (boolean) | True if the application has not been launch within DVM_AVAILABLE timeout. |
| application/state/ended/error | Object | An EndedError object describing the application error that provokes the application end. |
Path: application/state/ended/error
The EndedError is a unique sub-object from Ended object that represents the application error that provokes the application end.
| Fields | Type | Description |
| application/state/ended/error/message | Attribute (string) | Message displayed when the application stopped with an error. |
Path: application/meta
The ApplicationMetaInformation is a unique sub-object from Application object that represents the application meta information.
Information related to the application and independent of the application state [file transfer, launch] are called meta-information. This type of information can be used through the meta-information paths listed below.
| Fields | Type | Description |
| application/meta/launch | Object | An ApplicationLaunch object describing the sub-application currently launched. |
| application/meta/filetransfer | Object | A FileTransfer object describing the files transfers sessions currently active. |
| application/meta/variables | Collection of Variable objects | A list of session variables. |
Path: application/meta/launch
The ApplicationLaunch is a unique sub-object from ApplicationMetaInformation object that represents the sub application currently launched.
When a new application is launched, Information from the new application are retrieved with the paths below.
| Fields | Type | Description |
| application/meta/launch/url | Attribute (string) | URL of the new application launched. |
Path: application/meta/filetransfer
The FileTransfer is a unique sub-object from ApplicationMetaInformation object that handles files available through the File Transfer.
| Fields | Type | Description |
| application/meta/filetransfer/files | Collection of File objects | The list of all files in the application. Used in a repeat instruction to loop on each file in the list. |
| application/meta/filetransfer/currentfiles | Collection of File objects | The list of the current files in the application [i.e. files transferred since previous action]. Used in a repeat instruction to loop on each file in the list. |
The File object is a handled by the files and currentfiles collections from FileTransfers object. It describes one transfered file.
| Fields | Type | Description |
| url | Attribute (string) | URL to retrieve the file from the GAS file transfer directory. |
| name | Attribute (string) | Name of the file. |
| size | Attribute (number) | Size of the file in byte. |
| isCurrent | Attribute (boolean) | True if the file is part of the current file transfer process. |
Path: application/meta/variable[name]
Session variables are held by a collection. As a result, there is a collection path application/meta/variables to iterate through the full collection of variables, as well as a selector path to access variables by name.
| Fields | Type | Description |
| application/meta/variable/XDID | Attribute (string) | Name of the session variable for JavaScript usage. |
| application/meta/variable/name | Attribute (string) | Name of the session variable. |
| application/meta/variable/value | Attribute (string) | Value of the session variable. |
| application/meta/variable/readOnly | Attribute (boolean) | True if the session variable is read-only. |
Example
<h3>List of current session variables</h3>
<div gwc:omit-tag="true" gwc:repeat="var application/meta/variables">
<p>
<span gwc:content="var/name" style="color:red;"/><br/>
<span gwc:content="'XDID='+ var/XDID" /><br/>
<span gwc:content="'value='+ var/value" /><br/>
<span gwc:content="'readOnly='+ var/readOnly" /><br/>
</p>
</div>
For more details about session variables usage, see the chapter Session Variables and Cookies.
Path: application/ui
Snippet ID: UserInterface
Corresponding AUI Tree element: UserInterface
The UserInterface is a unique sub-object from Application object that represents the application abstract User Interface description.
This object value is rendered thru the UserInterface snippet when invoked in a gwc:replace or gwc:content instruction.
| Fields | Type | Description |
| application/ui/CID | Attribute (string) | The corresponding component identifier |
| application/ui/text | Attribute (string) | UserInterface text node value. |
| application/ui/dbDate | Attribute (string) | Application date format. |
| application/ui/intermediateTrigger | Attribute (string) | Indicates if the intermediate trigger should be executed. This corresponds to the Dialog.fieldOrder entry in the fglprofile. |
| application/ui/error | Attribute (string) | Error message |
| application/ui/startmenu | Object | A StartMenu object describing the StartMenu component attached to the application. |
| application/ui/topmenu | Object | A TopMenu object describing the TopMenu component attached to the application. |
| application/ui/toolbar | Object | A Toolbar object describing the Toolbar component attached to the application. |
| application/ui/styleList | Object | A StyleList object describing the application styles. |
| application/ui/windows | Collection of Window objects | The list of windows owned by the application. Used in a repeat instruction to loop on each window in the list. |
| application/ui/window[window-name] | Object | This selectable path will return the Window object of the application with this given name. If no selection is explicitely done. This path will return the Window object describing the current active window for this application. |
| application/ui/modalWindows | Collection of Window objects | The list of modal windows owned by the application. N.B. this is a sub-list of the application/ui/windows one. Used in a repeat instruction to loop on each window in the list. |
| application/ui/topMostNormaWindow | Object | A Window object which describes the most recent window with a non-modal (aka normal) style. |
Path: application/ui/styleList
Snippet ID: StyleList
Corresponding AUI Tree element: StyleList
The StyleList is a unique sub-object from UserInterface object that represents the application styles (see 4ST files in BDL manual).
This object value is rendered thru the StyleList snippet when invoked in a
gwc:replace or gwc:content instruction.
To access sub-element of the StyleList object there is currently no paths. You have either to use
xpath() function or XSLT snippets.
| Fields | Type | Description |
| application/ui/styleList/CID | Attribute (string) | The corresponding component identifier. |
| application/ui/styleList/type | Attribute (string) | Type of the component. |
| application/ui/styleList/name | Attribute (string) | Style name. |
Path: application/interrupt
Snippet ID: LocalAction
Corresponding AUI Tree element: UIDS2/LocalAction
| Fields | Type | Description |
| application/interrupt/CID | Attribute (string) | The corresponding component identifier |
| application/interrupt/type | Attribute (string) | Type of the component. |
| application/interrupt/DID Deprecated ! | Attribute (string) | The corresponding dialog identifier. This path is deprecated use XDID instead. |
| application/interrupt/XDID | Attribute (string) | Dialog identifier in
exclusive format. Example: <input type="radio" gwc:attributes="name application/interrupt/XDID;
value '';... />produces <input type="radio" name="x" value=""... />In inclusive format, no value is needed. Example: <input type="submit" gwc:attributes="name application/interrupt/XDID;"...
/>produces <input type="submit" name="x"... /> |
| application/interrupt/name | Attribute (string) | The interrupt identifier. |
| application/interrupt/text | Attribute (string) | The displayed text. |
| application/interrupt/image | Attribute (string) | The associated image. |
| application/interrupt/comment | Attribute (string) | The associated comment. |
| application/interrupt/isActive | Attribute (boolean) | True if the Interrupt is enabled. |