TABLE OF CONTENTS

• Portal Wrappers Overview
• Default Wrappers
  • MS-Default-NoAuthWrapper
  • MS-Default-AuthWrapper
• Wrapper Blocks
  • Banner Block
  • Nav Block
  • Authentication
  • Custom CSS / JS Blocks
  • Footer Block
• Additional Notes

Portal Wrappers Overview

Portal Pages, Surveys, Tests, Reports, and Dashboards in ManagementStudio must have a Wrapper assigned. Wrappers enable administrators to deliver multiple portal pages with a consistent theme and layout.

A Wrapper consists of the following components:

• Banner Block: Displays graphics or text at the top of the page.
• Navigation Block: Provides predefined navigation options for portal users.
• Authentication: Supports multiple authentication methods.
• CSS Block: Allows custom CSS to be applied to the wrapper.
• JavaScript Block: Allows custom JavaScript to be added.
• Footer Block: Displays a fixed footer at the bottom of the web page.

The diagram below illustrates the structure of a Portal Wrapper, where yellow regions are user-visible, red and blue regions control page behaviour, and the green region represents the wrapped item.

Default Wrappers

ManagementStudio provides two default wrappers:

• MS-Default-NoAuthWrapper
• MS-Default-AuthWrapper

These wrappers are automatically applied to pages without an explicitly set wrapper. They can be edited to change their behaviour, but they cannot be deleted.

MS-Default-NoAuthWrapper

• No authentication required.
• Default for Self-Schedule, Survey, and Test Sign-Off pages.

MS-Default-AuthWrapper

• Requires users to authenticate with their ManagementStudio Username and Password.
• Default for Dashboards, Portal Pages, and Datamining Reports.

If a default wrapper is renamed, the system will retain its functionality but the display name will reflect the change.

Wrapper Blocks

Banner Block

The Banner Block displays at the top of the page and is typically used for project titles and images. Example markup for displaying an image from the project resource library:

<header>
  <div class="container" id="header-container" style="text-align: center;">
    <img src="" title="BannerImage" height="80px">
  </div>
</header>

If you require Keywords in banners, enable the Keyword Parser in the banner block settings. To support Markdown, enable the Markdown Parsing checkbox as well.

Uncheck these options if Keyword lookup or Markdown support is not needed.

Nav Block

The Navigation Block places a menu bar beneath the banner, providing links and structured navigation for users. The menu format is important. Example Nav Block configuration:

<i class="fa-solid fa-house" title="Return to the home page"></i> | 

<b>Upgrade Planning </b>
    Future Upgrades | 
    Todays Upgrades | 
    Yesterdays Upgrades | 
    Older Upgrades | 

<b>Send User Communications</b>
    Self Book Invite | 
    Booking Confirmation | 
    Cancel Booking | 
    Send Satisfaction Survey | 

<b>Dashboards</b>
    Progress | 
    Booked | 
    Satisfaction | 

<b>Engineering</b>
    Upgradium Deployment Units

<b>ESM</b>
    ESM Dash | 

A Navigation Block in use appears as shown below:

Authentication

Wrappers support multiple authentication methods for web end-users. Administrators can configure which authentication method is required to access portal content. For example, end-users may log in using Azure/Entra ID to see relevant data and perform actions such as changing their upgrade date or location.

Authentication ensures that users see the correct data for their profile. For detailed configuration instructions, refer to the Portal Authentication article.

Custom CSS / JS Blocks

Custom CSS and JavaScript blocks allow additional customisation of the wrapper’s appearance and behaviour. For example, to make the portal full width, use the following CSS:

.container {
    width: 100% !important; /* Override Bootstrap's default width */
    max-width: 100% !important; /* Remove maximum width restriction */
}

Footer Block

The Footer Block displays fixed content at the bottom of each page using the wrapper. This is typically used for copyright, support links, or other persistent information.

Additional Notes

• Always assign an appropriate wrapper to every portal page, survey, test, report, or dashboard.
• Default wrappers can be customised to fit project requirements, but cannot be deleted.
• All wrapper blocks are optional and can be configured as needed to achieve the desired user experience and security model.