App Toolbar
Configuring the application toolbar components
The App Toolbar configurator is available from the App Studio.
The App Toolbar Configurator is a modal dialogue with a master hierarchical tree of toolbar elements on the left, with element properties displayed on the right. There are 7 major elements to the toolbar.
Each of the toolbar elements configures one or more toolbar components:
When editing the properties of each toolbar element, the 3 buttons to the bottom right of the popup modal dialogue are used to either save or discard your changes:
Apply
Apply/save your changes. The app toolbar refreshes to reflect the changes. The popup remains open.
Apply & Close
Apply/save your changes. The app toolbar refreshes to reflect the changes. The popup closes.
Close
Cancel/discard all changes. The app toolbar does not refresh. The popup closes.
There is also a small x to the top right of the popup dialogue. Clicking this will close the popup without saving your changes.
Each of the toolbar elements are documented below.
Navigation Bar
The navigation bar appears to the left of the application and it contains groups of menu items configured using its own configurator, however there are other non-menu elements, and these can be configured as follows:
ID
The read-only unique identifier of this element. This is only of importance to developers wishing to customise this on-the-fly.
Name
This is the read-only name of the element.
Description
A description about what this element does.
Type
This is the read-only type of the element. NavBar is shorthand for a navigation bar.
Locked
Whether the item is locked. NavBar is always locked.
Visible
Whether the navbar is visible or not.
Brand Name
The brand name of the application. You can brand your application to match your business.
Product Name
Whilst Flexiva is the name of our product, you can call yours whatever you like.
Top Product Logo
You can add your own company logo to the top of the navbar.
Bottom Logo URL
You can also add your own company logo to the bottom of the navbar.
Search...
The search box appears on the top of the toolbar to the right of the navigation bar. It is used by end-users to search for all data in all of your ReST API's configured as data sources.
The most important item in this is therefore the Data Source Request which will be a Read ReST API which searches over all your ReST API's. Examples might be to allow end-users to search for products by a code, or a customer by name, or a vehicle by registration number.
Here is a list of all of the search box properties:
ID
The read-only unique identifier of this element. This is only of importance to developers wishing to customise this on-the-fly.
Name
This is the read-only name of the element.
Description
A description about what this element does.
Type
This is the read-only type of element.
Locked
Whether the item is locked. The search box is locked i.e. cannot be removed.
Caption
The watermark text of the search box.
Tooltip
When the user hovers over the search box you can remind them of any specific instructions.
Icon
The icon that appears to the left inside the search box.
Visible
Whether this is search box visible or not.
Data Source Request
This is the ReST API data source request which is used to search across all of your databases supplying data to this application.
History
The history drop down menu appears on the top of the toolbar to the right of the search box. It shows all previously opened forms, allowing end-users to quickly resume working with a specific lookup or record.
Here is a list of all of the history properties:
ID
The read-only unique identifier of this element. This is only of importance to developers wishing to customise this on-the-fly.
Name
This is the read-only name of the element.
Description
A description about what this element does.
Type
This is the read-only type of element.
Locked
Whether the item is locked. The History menu is locked i.e. it cannot be removed.
Caption
The text of the history menu button.
Tooltip
When the user hovers over the history menu you can remind them of any specific instructions.
Icon
The icon that appears to the left of the menu caption.
Visible
Whether this is visible or not.
Add
The Add toolbar element appears to the right of the History drop down menu. It is drop down menu of all data entry forms allowing users to quickly add records.
Here is a list of all of the add menu properties:
ID
The read-only unique identifier of this element. This is only of importance to developers wishing to customise this on-the-fly.
Name
This is the read-only name of the element.
Description
A description about what this element does.
Type
This is the read-only type of element.
Locked
Whether the item is locked. The Add menu is locked i.e. it cannot be removed.
Caption
The text of the menu item.
Tooltip
When the user hovers over the menu item you can remind them of any specific instructions.
Icon
The icon that appears to the left of the menu item.
Visible
Whether this is visible or not.
Any number of data entry forms can be added to this menu, and each item can be configured also using properties. Note that ordering the add menu items is done by dragging and dropping the menu item into the correct order.
Here are the properties of each add menu item:
ID
The read-only unique identifier of this element. This is only of importance to developers wishing to customise this on-the-fly.
Name
This is the read-only name of the element.
Description
A description about what this element does.
Type
This is the read-only type of element.
Locked
Whether the item is locked. The Add menu item is not locked i.e. it can be removed.
Caption
The text of the menu item.
Tooltip
When the user hovers over the menu item you can remind them of any specific instructions.
Icon
The icon that appears to the left of the menu item.
Visible
Whether this is visible or not.
Form
This a drop down to a form which is opened when the user selects this menu item.
Section Label Before
Menu items can be grouped for clarity. This text creates a section header above this menu item with this text.
Custom Buttons
Custom buttons can be added to the toolbar to the right of the Add drop down menu.
Each custom button can be linked to a form.
The customs button group has these properties:
ID
The read-only unique identifier of this element. This is only of importance to developers wishing to customise this on-the-fly.
Name
This is the read-only name of the element.
Description
A description about what this element does.
Type
This is the read-only type of element.
Caption
Whether the item is locked. The custom button is not locked i.e. it can be removed.
Tooltip
When the user hovers over the button you can remind them of any specific instructions.
Icon
The icon that appears to the left of the button.
Style
The button can be styled using the standard 'bootstrap' colours: Blue [info], Green [success], Grey [default], Red [danger], Themed, Yellow [warning]
Visible
Whether this is visible or not.
Form
This a drop down to a form which is opened when the user selects this custom button.
Each specific custom button can be configured also:
The ordering of each custom button can be repositioned by dragging and dropping the custom button into the desired location.
The custom button properties are:
ID
The read-only unique identifier of this element. This is only of importance to developers wishing to customise this on-the-fly.
Name
This is the read-only name of the element.
Description
A description about what this element does.
Type
This is the read-only type of element.
Locked
Whether the item is locked. The custom button is not locked i.e. can be removed.
Caption
The text of the custom button.
Tooltip
When the user hovers over the custom button you can remind them of any specific instructions.
Icon
The icon that appears to the left of the custom button.
Style
The custom button can be styled using the standard 'bootstrap' colours: Blue [info], Green [success], Grey [default], Red [danger], Themed, Yellow [warning].
Visible
Whether this is visible or not.
Form
This a drop down to a form which is opened when the user selects this custom button.
Show Help
The show help button appears on the toolbar to the immediate left of the account summary drop down.
The following properties can be set:
ID
The read-only unique identifier of this element. This is only of importance to developers wishing to customise this on-the-fly.
Name
This is the read-only name of the element.
Description
A description about what this element does.
Type
This is the read-only type of element.
Locked
Whether the item is locked. The show help button is locked i.e. cannot be removed.
Caption
The text of the show help button.
Tooltip
When the user hovers over the show help button you can remind them of any specific instructions.
Icon
The icon that appears to the left of the show help button.
Style
The button can be styled using the standard 'bootstrap' colours: Blue [info], Green [success], Grey [default], Red [danger], Themed, Yellow [warning]. The default is green.
Visible
Whether this is visible or not.
Account Summary
The account summary is a drop down menu which appears on the far right of the toolbar.
It displays useful information about the current logged in user.
Here are the account summary properties:
ID
The read-only unique identifier of this element. This is only of importance to developers wishing to customise this on-the-fly.
Name
This is the read-only name of the element.
Description
A description about what this element does.
Type
This is the read-only type of element.
Locked
Whether the item is locked. The Activity Summary is locked i.e. cannot be removed.
Visible
Whether this is visible or not.
There are a number of items comprising the account summary drop down menu.
Each menu item can be dragged and dropped into the preferred position.
Both the Subscriber Name and Subscriber Company have similar properties to control how the respective logged-in user name and company are displayed:
The Profile/User Settings, Lock Account and Logout have an additional Icon property.
The Activity Metrics menu item properties can also be configured, however the actual metrics themselves are controlled by the specialised activity metrics configurator.
Delete
The Delete button will delete the selected tree view element. Once deleted, the element will no longer be visible in the toolbar.
Last updated