The Header component controls the placement of the following UX components:
- Logo
- Breadcrumbs
- UserManager
The Header component is passed a parameter MyInstance that determines which instance data is being displayed on the page.
The Logo region is just an image that displays the branding logo. The logo displayed is defined in the theme that’s currently loaded.
These workspace configuration parameters allow for adjustments to the logo’s visibility and position.
- HeaderLogoVisible – This parameter determines the visibility of the logo in the header. It accepts either “True” or “False” as values. If left unconfigured, the default value is True, resulting in the logo being visible.
- HeaderLogoPosition – This parameter determines the placement of the logo within the header. Accepted values are “Left” or “Right”. If unconfigured, the default position is Left, setting it to Right moves the logo to the far right side of the header.
The Breadcrumbs component is used to render the Instance Hierarchy and provide clickable links to ancestors of the current Instance. The MyInstance parameter is passed into the Breadcrumbs during initialization. The Breadcrumbs also displays the status of the Instance record currently loaded to the right of the clickable links.
The UserManager region displays a user icon with notification icons if the user has any pending alerts and the name of the user that’s currently signed in. The UserManager region is also a dropdown list that includes the following options:
- My Profile – Opens a popup window to edit user specific settings.
- Alerts – Opens the Alerts component. Icon will glow red if there are pending alerts.
- History – Opens the History component.
- Sign Out – Signs out the user and returns them to the Index page.
The Alert Notifications and Alerts option in the dropdown are only visible if alerts are not suppress for the user. If the user has a configuration parameter called SuppressAlerts with the value true, alerts will not be visible.
The History option in the dropdown will only be displayed if history is not suppressed. If the user has a configuration parameter called SuppressHistory with a value of true, history will not be visible.
The user icon can alternatively be an avatar that contains the users initials. To achieve this the user needs to have the configuration parameter UseDefaultUserProfileIcon with the value false. If initials cannot be retrieved for the user a ? will be displayed in place of the initials.