Differences

This shows you the differences between two versions of the page.

Link to this comparison view

application header [2016/09/14 14:19] (current)
Line 1: Line 1:
 +====== Application Header ======
 +The **Application Header** is the portion of the [[Form Type - Page|page]] at the top that is the same for every page.  When displayed in a full page it will contain the Logo, Favorites, Search, Logout, and the Page History by default. Additional [[Field|fields]] can be added to the header by the software developer. When displayed in a popup it will contain the Logo, Page Title, and any Page title bar [[Field Type - Link|Links]].
 +
 +===== Logo =====
 +
 +{{::​logo_location.pnp.png?​direct|}}
 +
 +The Logo that is displayed in the top right corner of the Application Header is controlled by two settings on the Application. ​ The **Application Logo** setting is a static file attachment field that will display the same logo to all the users of the system. ​ The **Dynamic Logo File** is a [[Query Builder|Query]] to find a file field that contains the logo to display. ​ This allows the software developer to define a logo per tenant or even per user.  If no logo is found by the **Dynamic Logo File** query then the **Application Logo** is used.  If neither setting has a value then a default WorkXpress Logo will be used.  When choosing a [[Field Type - File Attachment|File Attachment Field]] to use for the dynamic logo if it is a field that can be changed by the end user and you want that change to be reflected immediately then the cache that holds the logo definition needs to be cleared. ​ To clear that cache use a [[Action Type - Set Field Value|Set Field Value]] action to set the "​Expire Security Caches Older Than" field on the current application to [[Expression Function - Now|NOW()]].
 +===== Favorites =====
 +
 +{{:​favorites_location.png?​direct|}}
 +
 +The **Favorites** flyout contains two sets of page links. ​ The top set of links allows a user of the application to manage and add links to a page as a favorite. ​ The lower section will contain a list of recent Pages that were viewed for records. ​ If the software developer does not want to use the favorites system it can be turned off for all users by using the **Hide the Favorites Menu from users** setting on the Application.
 +===== Search =====
 +
 +{{:​navigation_location.png?​direct|}}
 +
 +The header'​s Search control allows the software developer to define many Search Configurations for their user to choose from.  Each Search Configuration can direct the user to a search page of records for a table or trigger a link for a record they found with auto complete. ​ These Search Configurations can be mixed together, and sorted among each other. ​ To hide this control, delete all of the Search Configuration records.  ​
 +
 +Common to all Search Configuration records are the Name, Group, Order, and Security settings. ​ The Name will be used for the dropdown that the user will use to select a search to use.  The Group allows similar Search Configuration records to be grouped in the dropdown the user sees and show a header for those grouped options. ​  The Order will determine in what order records will be displayed in the dropdown. If two Search Configuration records have the same order number the order will be indeterminate. ​ The Security setting is used to show some Search Configuration options to only some of the end users. ​ If the query, when run, finds a record then the Search Configuration option will be available to the current user. 
 +
 +To setup a Search Configuration record that redirects the user to a search page the software developer needs to select a link that directs to a Page with a List on it.  If the software developer wants to allow the user to perform a search when redirected to that Page the software developer needs to select a filter from the List Form on the Search Page.  ​
 +
 +{{::​navigation_search.png?​direct|}}
 +
 +To setup a Search Configuration that redirects the user to a page about a specific record the software developer will need to select a link that directs to the page to be displayed about the record that's found. ​ In addition, the interface will need to be configured by building a query that finds the records the user is allowed to search for.  Next to the record picker there is a button that the user can click on to trigger the link for the record that's found. ​ There are several styles that can be used to render this link.  There are 4 styles of links: Text Only, Image Only, Text and Image, and HTML Button. ​ For the Text Only, Text and Image, and HTML button options the software developer will find a setting for the Link Text.  For the Image Only and Text and Image options the software developer will find a setting for the Image to use.  For the Text and Image option the software developer will find a setting to determine the alignment of the image relative to the link text.  For the HTML Button option the software developer will find two optional setting that will allow for the override of the background color and border color of the html button. ​
 +
 +{{::​link_navigation_setup.png?​direct|}}
 +
 +
 +===== Logout =====
 +
 +{{:​logout_link_location.png?​direct|}}
 +
 +The logout link is used by the end user to logout of the application and will redirect the user to the login page.  The logout link can be disabled per user using the **Remove Logout Link From the Application Header** setting on the user record. ​ This is commonly done for users that are used to display public facing pages such as registration pages where it would be inappropriate for the end user to logout.
 +
 +===== Page History (Breadcrumb Trail) =====
 +
 +{{::​page_history_location.png?​direct|}}
 +
 +The page history displays a series of links that allow the user to return to a previously viewed page.  When viewing a previously viewed page things like open tabs or search filters will be retained. If the application builder does not want to use the page history system it can be turned off for all users by using the **Hide the breadcrumb trail from users.** setting on the Application.
  
application header.txt ยท Last modified: 2016/09/14 14:19 (external edit)
Copyright WorkXpress, 2019