The Generic Layout serves as a framework to provide page access and navigation.
| Property Name |
Description |
| Includes |
Defines custom JavaScript functions in the Layout:
| Property Name | Description | | Identifier | Unique identifier for this item. | | URL | URL of the JavaScript (*.js) file containing the functions. Indicate
the entire URL from the root of your Web Application. For example:
WEB-OPAL/mydir/filename.js | | Position | Specifies where the file is called in the page:
| Value | File called... | | head | Before the body text. | | Foot | After the body text. |
|
|
| Sidebar |
The side bar contains various hyperlinked information groups such as "Other
Tasks".
| Property Name | Description | | Lists | Defines the contents of the sidebar.
| Property Name | Description | Identifier | The unique identifier of the list. | Type | Defines the type of list to be displayed:
| Operations | : | This will display all the operational data.
The "Other Tasks" section in the sidebar contains
operation entries. The operation entries are actually
buttons, which are defined as operations (hyperlinks)
in the advancedtoolbar element. The operation entries
defined in advancedtoolbar will automatically get displayed
in the sidebar. | | Bulletins | : | This will display all the bulletins available. You do
not need to fill in the entries, it will automatically
get populated in the sidebar, if specified in the "Populate
Bulletins Data" property. | | Favorites | : | This functionality has been deprecated. | | History | : | This will display all the list of all the visited links.
You do not need to fill in the entries, it will automatically
get populated in the sidebar, if specified in the "Populate
History Data" property. | | User | : | To display the entries in the sidebar for this particular
type, you need to define a sub-collection e.g., attachments,
categories, roles etc., in the "Items" section below. |
| Show List | "Yes" will show the list on the sidebar. If no option is selected,
then by default the list will not get displayed. | Text | The text to display as the list header in the sidebar. | URL | URL of the page to open or the Javascript to execute, when
clicked the header text. You can either enter an URL or a Javascript
function. Specify the Javascript function like "javascript:myfunction()".
| Release Locks | This is a "Yes/No" flag property to specify that any data
locks on the page should or should not be released when the
link is selected. This property defaults to "Yes". Whenever
a page navigates away to any other page, all locks should be
released. If the link causes a pop-up page to be displayed,
the lock should not be released as the data is still editable
in the window. | | Items | The items/entries to get displayed as sub collection,
if the Type="User" above. The properties for the items are:
| Property Name | Description | Identifier | The unique identifier of the content. | Show Item | "Yes" will display the content of the defined list.
If no option is selected, then by default the content
will get displayed. | Text | The text to display when there is no content to get
displayed. However, if you choose any of the pre-defined
list type (except User), then this text will get overwritten
by the list type content. | URL | URL of the page to open or the Javascript to execute,
when clicked on the text. You can either enter an URL
or a Javascript function. Specify the Javascript function
like "javascript:myfunction()". | Release Locks | This is a "Yes/No" flag property to specify that any
data locks on the page should or should not be released
when the link is selected. This property defaults to "Yes".
Whenever a page navigates away to any other page, all
locks should be released. If the link causes a pop-up
page to be displayed, the lock should not be released
as the data is still editable in the window. |
|
|
|
| style Sheets |
CSS for the Layout:
| Value | File called... | | Identifier | Unique idetifier for this item. | | URL | Path and location of the CSS. |
|
| JavaScript Literals |
If language translation of a JavaScript message is performed by a language-specific
JavaScript include file, set this property to recognize the correct language
literals. For example, if the property is "WEB-OPAL/scripts/language/literals_{{english}}.js",
the partial property translation can translate "English" to another language
such as "French". The translated property and included file will then be
"'WEB-OPAL/scripts/language/literals_french.js". |
| Is Popup |
Determines if this can be displayed as a dialog. |
| Navigator Border Bars |
Formats the Navigation border bars:
| Value | File called... | title | title of the border bar. | JavaScript Call | JavaScript to execute. | Validation Script | Valid selections when the border bar is selected. Return an empty
string or validation fail message to show. | Show | Shows/hides the border bars. |
|
| Page Options |
Determines behavior of the Tabs and Menu when the page loads:
| Property Name | Description | Selected Tab Id | Identifier of the tab selected when the page loads. Specify the
tab identifier using the Tabs property below. If you do not specify
a value for this property, the Layout will not render. | Selected Menu Id | Identifier of the menu item selected when the page loads. Specify
the menu item identifier using the Menus property (under the Tabs
property below). If you do not specify a value for this property,
the Layout will not render. | Page Margin | Distance (in pixels) between the edge of the Page Area and the page.
This value sets the left, right, top, and bottom margins. |
|
Application title
|
Text displayed in the header.
This can be used to display the version number. For example, specifying
[version], [build], [patch], and [title] replaces these by the relevant
information. The configuration for the OOB product is: [title] [version] giving "LabVantage n" for the title. |
Application Image
|
Image displayed in the header. |
styleSheet
|
The CSS you choose here is used to render the page in the Layout. |
| Links |
Hyperlinks appearing in the top right corner of the header.
| Property Name | Description | Identifier | Unique identifier for this item.NEW | Text | Hyperlink text. | Show | "Yes" shows the hyperlinks. | Icon | Icon to use for the link. NEW | URL | Destination of the link, specified as a call to the Request Controller.
For syntax rules and guidelines, see Request
Controller and Variables.
As an alternative, you should also be able to specify a JavaScript
function. Use the syntax javascript:myfunction(), e.g., javascript:window.open( 'WEB-OPAL/help/index.htm'
) | Release Locks | When the link is clicked, a value of "Yes" (default) releases all
data locked by the page. If the link opens a child page, locked data
are not released. | Group | Identifier to define a group. enter the same identifier for items
you wish to be grouped together.NEW | Is Mobile | "Yes" allows display on mobile platform. "No"
prevents display on mobile platform. NEW |
|
| Processing Message |
Message displayed when a page is being loaded into the parent window
in response to clicking a button or hyperlink.
| Property Name | Description | Show | Yes (default) shows the message. | Text | Text of the message. | Show Initially | "Yes" shows the "processing" <div> initially.
NEW | Image | If you want to display an image with the message, specify the URL
of the image. If you leave this property blank, a default image is
displayed. |
|
| Current Session Info |
Displays information regarding the current session on all pages loaded
into the Layout.
| Property Name | Description | Display User | Choose "UserId" to show the current User (default), "Description"
to show the User description, or "None" to show nothing.
This has been deprecated in favor of using "Session Text"
below. | Display Database | "Yes" shows the name of the database (Connection Cache)
currently being accessed. If you leave this property blank, no database
is displayed.
This has been deprecated in favor of using "Session Text"
below. | Display Job Type | "Yes" shows the Job Type for the current User.
This has been deprecated in favor of using "Session Text"
below. | Session Text | Use tokens to display session information as shown below. If left
blank, the information shown defaults to the deprecated properties
above. NEW
| [currentuser] | | Currently logged-in User | | [sysuserdesc] | | Currently logged-in User Description | | [databaseid] | | Current database | | [timezoneid] | | Current time zone | | [jobtype] | | Currently logged-in User's Job Type | | [servername] | | Name of the application server issuing the page | | [hostid] | | Combination of application server name and cluster information | | [platform] | | Application server platform issuing the page | | [xxx] | | Where xxx is any property from the connectionInfo object (such
as sysuserid, sysusername, deviceid, tool, dbms, usertype, dbserver,
rolelist, language, modulelist, departmentlist, or jobtypelist).
|
|
|
The GenericBlank Layout loads only a single page into the browser window. It
does not provide any framework, such as that supplied by the Generic Layout.
This is typically used with pages loaded into an iframe.
GenericBlank
Layout Properties
|
| Property Name |
Description |
| Processing Message |
Message displayed when a page is being loaded into the parent window
in response to clicking a button or hyperlink.
| Property Name | Description | | Show | Yes (default) shows the message. | | Show Initially | Yes shows the message when the window opens. | | Text | Text of the message. | | Image | If you want to display an image with the message, specify the URL
of the image. If you leave this property blank, a default image is
displayed. |
|
| Is Popup |
Yes opens the Layout in a new window. |
styleSheet
|
The CSS you choose here is used to render the page in the Layout. |
| JavaScript Literals |
If language translation of a JavaScript message is performed by a language-specific
JavaScript include file, set this property to recognize the correct language
literals. For example, if the property is "WEB-OPAL/scripts/language/literals_{{english}}.js",
the partial property translation can translate "English" to another language
such as "French". The translated property and included file will then be
"'WEB-OPAL/scripts/language/literals_french.js". |
| style Sheets |
CSS for the Layout:
| Value | File called... | | Identifier | Unique idetifier for this item. | | URL | Path and location of the CSS. |
|
| Includes |
Defines custom JavaScript functions in the Layout:
| Property Name | Description | | Identifier | Unique identifier for this item. | | URL | URL of the JavaScript (*.js) file containing the functions. Indicate
the entire URL from the root of your Web Application. For example:
WEB-OPAL/mydir/filename.js | | Position | Specifies where the file is called in the page:
| Value | File called... | | head | Before the body text. | | Foot | After the body text. |
|
|
The GenericPopup Layout is designed to host "popup" windows (child windows
opened from a parent).
GenericPopup
Layout Properties
|
| Property Name |
Description |
| Processing Message |
Message displayed when a page is being loaded into the parent window
in response to clicking a button or hyperlink.
| Property Name | Description | | Show | Yes (default) shows the message. | | Show Initially | Yes shows the message when the window opens. | | Text | Text of the message. | | Image | If you want to display an image with the message, specify the URL
of the image. If you leave this property blank, a default image is
displayed. |
|
| Is Popup |
Yes opens the Layout in a new window. |
styleSheet
|
The CSS you choose here is used to render the page in the Layout. |
| JavaScript Literals |
If language translation of a JavaScript message is performed by a language-specific
JavaScript include file, set this property to recognize the correct language
literals. For example, if the property is "WEB-OPAL/scripts/language/literals_{{english}}.js",
the partial property translation can translate "English" to another language
such as "French". The translated property and included file will then be
"'WEB-OPAL/scripts/language/literals_french.js". |
| style Sheets |
CSS for the Layout:
| Value | File called... | | Identifier | Unique idetifier for this item. | | URL | Path and location of the CSS. |
|
| Includes |
Defines custom JavaScript functions in the Layout:
| Property Name | Description | | Identifier | Unique identifier for this item. | | URL | URL of the JavaScript (*.js) file containing the functions. Indicate
the entire URL from the root of your Web Application. For example:
WEB-OPAL/mydir/filename.js | | Position | Specifies where the file is called in the page:
| Value | File called... | | head | Before the body text. | | Foot | After the body text. |
|
|
