Difficulty: novice
Content
Learning Objectives
After reading this article you will be able to:
Access a page via the page definition.
Add and remove fields, functions and includes.
Components on a page
A page consist of several components that are fully customizable.
1. Tabs
- Opens up a new page when you click on it
2. Headers
- Used to sort content
3. Labels
-The name of a field
4. Fields
- Input field and/ or displays information
5. Functions
-Clickable areas that performs an action
5a. Icon buttons
5b. Form buttons
6. Includes/Reports
-Data tables
Opening the page definition
The page definition is a shortcut to the back-end page of a page. It can be found on every page and include. It is only accessible for users with system admin rights. The page definition can be accessed as follows:
Click on the gear symbol > Page definiton
Page definition is accessible directly on includes via the monitor symbol
Page definition acts as a shortcut to the back-end of a specific page. This allows the user to access the page, fields, functions and include settings in a quick manner without remembering the technical names of every page.
Navigating to the page definition via ‘Pages’ | Navigating to the page definition via the instance page | |
|---|---|---|
 |
 | |
 |
 |
Note! Not all the settings that are visible on a page, actually apply to this specific page. Hence, it is possible to encounter settings that you can change but will have no effect on the page.
We aim to make this more user friendly by hiding non-applicable functions.
For example, when opening the page definition of a searchView page you will have the setting ‘External URL’, changing this will have no effect on the page.
Making use of the page level
The page definition contains a lot of information and settings. The following information is often used to change pages:
1: The parent page name.
2: The name of the page that is opened (depending on the page name additional logic is applied e.g. pages ending on “List” will always display a list page).
3: The fields that are on the page.
4: The functions that are on the page.
On the top of the page, the tabs “Fields” and “Functions” are found. These tabs are used to view/ change fields and functions on a page. When these tabs are opened the list of fields and functions belonging to the page is shown. These can both be fields and functions that are visible or hidden on the page. What we mean by this is that some field are set to ‘hidden’ or maybe specific access rights result in the field not being visible to some users. Not matter the status of the visibility of the field/ function to the user, it is always shown to the application manager in the page definition.
Settings on the page definition
It is possible to adjust page settings via its back-end. In the table below, the basic settings are discussed. In the next chapter the advanced setting are explained.
By default, the most commonly used, standard, settings are shown. To access the advanced settings, set “Show advanced settings = yes” on this page.
PAGE | Setting explanation |
|---|---|
Parent | This field determines the parent page of the current page. Note, make sure that the parent page name and the child name are correctly named. Otherwise, the functions and fields will not be inherited. |
Name | This is the name of the current page. Look at the previous article /wiki/spaces/KB/pages/27623427 to make sure the naming of the page is correct when creating a new page |
Header | The header of the page will be displayed in the “Breadcrumb trail” at the top of the page. |
File name | This field is informative and read-only. Special pages such as the calendar are programmed via JSP |
Setting explanation | |
|---|---|
PDF parameters | It is possible to link a page with additional parameters that are not available on the current page by default. |
PDF template | This is a read-only field. Some pages have a default PDF template linked. When exporting this page, or a child page, this template is used to generate a PDF document. When linking a PDF via the PDF tab, this overrides the default template. |
ELEMENTS | |
|---|---|
Notes | When set to “Yes”, a note field is automatically added to the instance page. When saving the instance, the information currently present in the note field will be saved to the objectNoteList. When enabling this feature, make sure to check if an objectNoteList include is available on the page. NB! This setting is not available for the Adaptive User Interface (AUI). |
Help | A help text can be displayed on the top of the page as an information panel. You can enter a text or a translation string. |
Inherit fields | Fields are not automatically inherited to child pages. By turning this setting to “Yes”, the page will inherit the fields of the parent page. |
Inherit fields - Help | If you create a sub page you can inherit the help text from the parent page. You can turn off the inheritance or enter a specific text in the ‘Help’ text field that overrides the parent’s help text. |
LAYOUT | |
|---|---|
Mobile page layout | A setting specifically configured when using the Axxerion mobile app. The layout can be configured using the continuous or grid view. Note: the Axxerion App is NOT the same as the Workplace App. |
Page includes layout | It is possible to change how includes are presented on the page. Default include layout is “Standard”, meaning they are shown below one another. |
Populate filter | A filter that populates the search view page when navigating to the search view page. For example, “show today's reservations”. If the field is populated, today’s reservations will be available without having to “search” for them. If this is empty, nothing will be shown directly before “search” is initiated. |
Search filter | Determines which field the search filter will base its search on. If the filter is empty, the system will search in all fields that has “search” set to true on an object level. |
Populate scripts | Similar to the ‘populate filter’ setting, but then using a script. |
Advanced settings on a page
By default, the most important settings for pages are shown. To access the advanced settings, turn the “Show advanced settings” to “Yes”.
The advanced settings available on pages are explained in the tables below.
PAGE | |
|---|---|
Header Width | The header width limits the maximum amount of characters that can be used in a header. |
Width | For survey pages, it is possible to specify the width in pixels. |
Number of rows | Specifies the maximum number of rows that are displayed after sorting. You can for example use this setting on a report result page to show the top 10 listings. |
PDF page size | PDF size of the page (A2, A3, A4) when exporting. Default is A4. |
PDF orientation | PDF orientation (Landscape, portrait) when exporting. Default is portrait. |
Show icons in PDF | Note: This functionality is for now only supported by the original interface. Determines if the icons (example: flag) in front of an object should be visible in a PDF export. |
New page subtotal | A new PDF page is created after each sub total on a list page. |
ELEMENTS | |
|---|---|
Width | Determines the width of the notes field. |
Height | Determines the height of the notes field. |
Inherit Scripts | It is possible to inherit the scripts from the parent page by turning this setting to “Yes”. |
Custom fields | All client-specific fields that are unique to a category of an object can automatically be added to the page. E.g. client specific fields of the asset category ‘Car’ are automatically added to the pages if you create an objects in the category ‘Car’. |
LAYOUT | |
|---|---|
Layout | By default the fields in a column are positioned below each other in the order of the row number. This does not take into account the row numbers of the previous column. With a grid layout a field with number “100”is always positioned in the same row as the field with row number “100”in the previous column. So fields are only be in the same row as they have the exact same row number. |
Style | Workplace pages can be embedded in an intranet. By linking a stylesheet to the page, it is possible to match the look and feel of the rest of the intranet. |
Link fields | If this setting is turned to “Yes”, there will be a an automatic linking between object fields based on their object relationship. For example, if you have the field contact.phone followed by address.city, the system will check if there is a contact.addredssId field and generate the link. If instead you would like to link the address field to the contact.postalAddressId you have to turn off the auto link and add this as a hidden field before the address field. |
Reload interval | A reload interval determines the refresh rate of the page (in minutes). For example it can be used on a dashboard for incoming tickets. |
Use object access | If a list is called from within an object, the object access is passed on to the list. For example, if a request is not editable, the related documents in the list are also not editable. |
Update object items | Specifies whether a change to a field on the page is propagated to the object level of the field. |
Final | If a page is final, it is not possible to create overrides. The baseline page will be used for display. |
External URL | Will display the content of the external URL. Will only work as an embedded page. |
Region | Note: This setting is used for custom menu pages only. When using region separation, this setting can be used to specify that this page is only accessible for users with access to that region. Users that end up on this page whilst not having access get a ‘no access error’. |
Show objects from child clients | Note: This setting is obsolete. Using the page option 'Show objects from child clients', the system will add objects from child clients to the collection of objects for the page. This is implemented for list pages that use the generic method for building the collection of objects. |
Fields
Fields are also managed via the page definition.
To view what fields are available on a page:
open the page definition > Fields tab, or;
if ‘inherit field = yes’ for the page, use the tab ‘Fields, including inherited’ instead.
More on fields is explained in the article /wiki/spaces/KB/pages/79790133.
Function buttons and tabs
A function on a page is often displayed as a button or a tab. Pressing a function button is followed by an action. This could be to open a new page, exporting data to Excel, or to save all changes to the page.
To view what functions are available on a page: open the page definition > Functions tab. Remember, a tab is also a function.
More on functions is explained in this article /wiki/spaces/KB/pages/94011487 .
If you can't find the function you are looking for, the function might be inherited from the parent page. Try these steps:
Open the page definition > press the magnifying glass behind the ‘parent’ field to navigate to the parent page > Functions tab.
Includes and report
Includes are often displayed at the bottom of an instance page. They are, of course also managed via the page definition.
To view what page includes are available on a page: open the page definition > scroll down to the ‘Page include’ include.
More on functions is explained in this article /wiki/spaces/KB/pages/108429580 .
Overrides and client-specific pages
Most pages cannot be edited directly because they are inherited from a baseline and are therefore read-only. However, usually it is possible to create an override on a baseline page.
An override creates a copy of a (baseline) page, its name, and its components.
If the override is not renamed, the override will be displayed instead of the baseline page. This is a powerful tool that allows the user to adapt the components of a baseline page, without altering the actual baseline page.
Before pressing override, the settings, fields and functions are not editable.
Before creating the override, the fields and functions of the page are grayed out and not editable.
The override becomes a child page. Now it is possible to edit the name, change the settings, change fields and functions, copy and delete the override.
The fields and functions of the override page are no longer grayed out and are now editable.
Overrides makes the environment more complex. When a new functionality is added to the baseline page, it depends on the settings of the override if this change is also available for the client environment.
Only create overrides when its absolutely necessary.
Summary
Search