Portal wrappers
Portal Pages, Surveys, Tests, Reports and Dashboards should have a Wrapper assigned to them. This allows the Administrators to deliver multiple portal pages with the same theme.
Wrappers are comprised of the following elements:-
- Header banner – Graphics or Text
- Navigation Bar – giving portal users predefined navigation options
- Authentication. There are three Authentication methods
- CSS Block – Add custom CSS to the portal wrapper.
- JavaScript – Add custom JavaScript to the portal wrapper.
- HTML Header Block – add a constant web page Header.
- Footer Block – add a constant web page Footer.
The graphic below shows the construction of a Portal Wrapper.
Yellow regions are visible to users. Red and blue regions control the way the page behaves. The Green region denotes the item using the wrapper.
Default Wrappers
ManagementStudio creates two default wappers called 'MS-Default-NoAuthWrapper' and 'MS-Default-AuthWrapper'. These wrappers are automatically applied to pages that don't have a wrapper set.
MS-Default-NoAuthWrapper
Has no authentication set, this is the default for the Self-Schedule, Survey & Test Sign-Off pages.
MS-Default-AuthWrapper
Has basic authentication set where a User must use their ManagementStudio Username and Password to view the page
This is the default for Dashboards, Portal Pages & Dataming Reports
These default wrappers can be updated and their behaviour changed. However, they can not be deleted. If a default wrapper is renamed the system will
Blocks
Banner Block
Displays at the top of the page are usually used for a project title and image.
There is a example code for this but usually we would want to call an image file from the project resource
Nav Block
Displays under the Banner block and provides buttons for the user to navigate to other pages in the Portal
Authentication
Authentication
ManagementStudio supports multiple web end-user authentication method allowing administrators to configure authenticated views of data. For example, an end-user might connect to a portal landing page, login with an Azure\Entra and be presented with their current list of applications, devices, upgrade date and migration location. With the correct configuration the end-user might choose to change their Upgrade Date or Location.
By using Authentication project teams can be sure the user is presented the correct data. See the article on Portal Authentication for an explication on how to protect your portal.
Custom CSS / JS Blocks
These allow you to inject CSS or Javascript into any page that uses this wrapper. They are useful for providing a constant style to your Portal.
Footer Block
Displays at the bottom of the page.