Article last updated on the 21st of September, 2023.
Contents
1. Introduction
2. Requirements
3.1. Top panel v1
3.2. Top panel v2
4.1. Viewing entity information
4.2. Viewing stage information
5. Notes
1. Introduction
The WorkPoint Top Panel is a key component of all WorkPoint solutions in that it is shown in every page. WorkPoint 365 solutions have two top panel layout versions; Top panel v1 and Top panel v2. The top panels are used for displaying various information, such as meta data for entities, the My Tools panel, and the WorkPoint Express panel.
Top panel v1 is the classic WorkPoint top panel which was released along with Modern UI. It features a navigation bar with a breadcrumb, a meta data panel, a Journal webpart, a stage band, the My Tools panel, and the WorkPoint Express panel - all available at any given time.
The following image demonstrates the Top panel v1 look for a Project on a Project Management solution:
Top panel v2 is a redesign of the top panel, where all the same elements from v1 are available, but structured in a different manner.
Certain parts of the top panel are accessed by clicking various controls in the top panel. For example, the meta data panel and the stage band are hidden but can be accessed by clicking the entity name in the navigation bar, as demonstrated in the following image:
Both panel versions allow for colorization for design and/or branding purposes. Top panel v1 also has the option to hide the SharePoint site header, but this is not recommended by Microsoft, and may introduce issues if Microsoft decides to implement new functionality in this header. Therefore, the option to disable the SharePoint site header is not available for Top panel v2.
One advantage of the Top panel v2 is that it solves an issue with space allocation which with Top panel v1 resulted in the contents of a site jumping up and down when first loaded. This caused frustration as it resulted in accidentally wrong button clicks. With Top panel v2, the space for the top panel is pre-allocated before loading the panel, which solves the before-mentioned issue. Additionally, Top panel v2 takes up significantly less space on pages, which frees up page real estate for other important information.
WorkPoint Top Panel supports Profile Cards. You can read more about Profile Cards in this article. Profile Cards require you to grant certain Microsoft Graph API permissions, which you can read more about in this article.
2. Requirements
There are no license requirements associated with the Top Panel.
3. Configuration
Since there are two different versions of the top panel in WorkPoint 365, we will go over both versions in separate sections.
In both cases, the settings for the top panel can be found in the WorkPoint Administration:
- On the WorkPoint solution, we click the "Home" button.
- In the bottom of the left side menu, we click the cog icon to to open the WorkPoint Administration.
- In the left side panel of the WorkPoint Administration, we click the "User Experience" header. This expands the header and reveals more options nested inside.
- In the "User Experience" menu, we click "Top panel".
From here, we continue in different sections depending on which version of the top panel you wish to configure.
3.1. Top panel v1
The following page is displayed if the Top panel v1 is active:
Note that if you change Top Panel layout from version 1 to version 2 and vice versa, a window appears, letting you know that a site collection synchronization is needed in order to synchronize the changes across the solution. If you accept this and save the settings, a site collection synchronization job is automatically started. If you decline this and save the settings, the settings will be saved, but the changes will not take place before you run a site collection synchronization job manually.
- In the "Layout" selector, you can select which version of the top panel should be active; version 1 or version 2. In this case, we select "Top panel v1".
- In the "Solution Title localizations" section, you can create translations for the solution title label shown in the "Home" menu of the solution, as shown in the following image:
- The "Navigation bar color" selector allows you to select a background color for the top panel. You can either type in a Hex color code in the field, or use the color picker to select a color.
- The "Navigation text color" selector allows you to select a text color for the top panel. You can either type in a Hex color code in the field, or use the color picker to select a color.
The color picker works as follows:
- Click the color picker button to open the color picker.
- Click anywhere in the large color selector window to select a color.
- You can use the eyedropper tool to copy a color from anywhere on your screen.
- The circle shows a preview of the color you have selected.
- Click and drag on the color spectrum to make more colors available in the large color selector.
- You can type in values for R (red), G (green), and B (blue) if you know the exact color values you wish to use
- Click this button to change input modes (instead of inputting values for red, green, and blue, you can input a HEX color code, or values for H (hue), S (saturation), and L (lightness).
For demonstration purposes, we have selected the following colors for the background and text:
- Click the "Save Top panel" button to save the configuration.
Upon saving the configuration, you will be taken to the WorkPoint Administration dashboard:
- The "Success" message lets us know that the configuration was successfully saved.
We now need to clear the WorkPoint 365 browser cache for the changes to become visible on the solution:
- First, we note that the top panel still has the standard white background.
- We now click the "Home" button on the solution.
- In the bottom of the left side menu, we click "Need help?".
- In the pop-up, we select "Clear WorkPoint 365 browser cache".
The page now reloads the the colors we selected for background and text should appear in the top panel:
As we can see, the top panel background is now a light blue color, and the text is dark blue - just like we configured. We can also see the classic version of the top panel.
3.2. Top panel v2
The following page is displayed if the Top panel v2 is active:
Note that if you change Top Panel layout from version 1 to version 2 and vice versa, a window appears, letting you know that a site collection synchronization is needed in order to synchronize the changes across the solution. If you accept this and save the settings, a site collection synchronization job is automatically started. If you decline this and save the settings, the settings will be saved, but the changes will not take place before you run a site collection synchronization job manually.
Note that the "Entity Navigation Visibility" option is available from WorkPoint 365 Version 4.9 onward.
- In the "Layout" selector, you can select which version of the top panel should be active; version 1 or version 2. In this case, we select "Top panel v2".
- In the "Entity Navigation Visibility" option, you can select to hide or show the list/library and submodule navigation elements displayed when expanding an entity in the top panel breadcrumb. The following image shown examples of both settings:
Shown:
Hidden:
- In the "Solution Title localizations" section, you can add translations of the WorkPoint solution title. This title is displayed in the top of the Home menu, when expanded. In this case, we have added one for English, but we could add one for multiple other languages if people from different locations were to use the same WorkPoint solution. The location of the Solution Title is shown in the following image:
- The "Navigation bar color" selector allows you to select a background color for the top panel. You can either type in a Hex color code in the field, or use the color picker to select a color.
- The "Navigation text color" selector allows you to select a text color for the top panel. You can either type in a Hex color code in the field, or use the color picker to select a color.
The color picker works as follows:
- Click the color picker button to open the color picker.
- Click anywhere in the large color selector window to select a color.
- You can use the eyedropper tool to copy a color from anywhere on your screen.
- The circle shows a preview of the color you have selected.
- Click and drag on the color spectrum to make more colors available in the large color selector.
- You can type in values for R (red), G (green), and B (blue) if you know the exact color values you wish to use
- Click this button to change input modes (instead of inputting values for red, green, and blue, you can input a HEX color code, or values for H (hue), S (saturation), and L (lightness).
For demonstration purposes, we have selected the following colors for the background and text:
- We click the "Save Top panel" button to save the configuration.
Upon saving the configuration, you will be taken to the WorkPoint Administration dashboard:
- The "Success" message lets us know that the configuration was successfully saved.
We now need to clear the WorkPoint 365 browser cache for the changes to become visible on the solution:
- First, we note that the top panel still has the standard white background.
- We now click the "Home" button on the solution.
- In the bottom of the left side menu, we click "Need help?".
- In the pop-up, we select "Clear WorkPoint 365 browser cache".
The page now reloads the the colors we selected for background and text should appear in the top panel:
As we can see, the top panel background is now a blue color, and the text is dark gray - just like we configured.
Note that if you click an entity name in the Top panel v2, you are presented with one or more tabs displaying information about the entity.
If the entity uses a stage model, the stage model is also displayed:
These tabs can be edited and new ones can be created. This is done from the Entity Presentation settings, and will be demonstrated in the following section.
By default, the following tabs are shown in the top panel: Entity Details, Journal, Stage Details*.
*Only if the business module uses a stage model.
3.2.1. Setting up entity details tabs
By default, the following tabs are shown in the top panel: Entity Details, Journal, Stage Details*.
*Only if the business module uses a stage model.
In this section, we will demonstrate how to edit and set up Entity Details tabs for the Top panel v2.
In this example case, we will edit the current Entity Detaqils tab for Projects on our Project Management solution.
Note that you can configure tabs for different business modules individually (Companies, Projects, Contacts, Clients, etc.)
For demonstration purposes, we now only have a single Entity Details tab in the panel:
We will edit the Entity Details tab to instead display an Adaptive Card presentation layout, as well as creating a new "Journal" tab showing the latest actions on the entity. Lastly, we will add a "Stage Details" tab to show us information about stages for the project:
- In the WorkPoint Administration, click the header of the business module of which you wish to set up the top panel tabs. In our case, that is the "Projects" business module.
- In the menu, click "Entity Presentation Settings".
This opens the Entity Presentation Settings page for the Projects business module:
- In this demonstration, we currently have three entity presentation layouts. The one we want to use in the "Entity Details" tab is the "AC Presentation Layout".
- Since Top panel v2 is currently active, the "Entity detail tabs" section appears in the Entity Presentation Settings page.
Not that the "Entity detail tabs" section ONLY appears in the Entity Presentation Settings page if Top panel v2 is active.
Also note that this article does not describe how to create entity presentation layouts. For more information on this topic, please visit this article.
Lastly, note that the "Hide stage information" option can be used to display or hide the pill that displays the current stage of an entity in the top panel.
To edit the current "Entity Details" tab, we can click it in the tabs list:
- We activate the "Entity Details" tab by clicking it in the tabs list.
- We can now edit the name of the tab. In this case, we leave the tab name as is.
- For tab type we can either select "Entity Presentation" or "Journal". Since we want to display an entity presentation layout, we leave this field as is.
- For "Presentation Layouts", we can selected between the existing layouts. Here, we can now select the "AC Presentation Layout":
We can now create the "Journal" tab:
- To add a new tab, click the "Add tab" button.
- For "Tab name" we type in "Journal".
- If we want to create localization for the tab name, we click the globe icon and provide the relevant translations.
- For tab type, we select "Journal".
Lastly, we can create our Stage Details tab:
- We click the "Add tab" button.
- We name the tab "Stage Details".
- For "Tab type", we select "Stage Details".
- We can now save our tab configurations.
You should now see the following message in the top of the Entity Presentation Settings page:
To view the changes to the Entity details panel, we need to clear the WorkPoint 365 browser cache:
- On the WorkPoint solution, click the "Home" button.
- In the bottom of the side panel, click "Need help?".
- Click "Clear WorkPoint 365 browser cache".
We can now open the entity details panel again to view the changes we made:
- We can see that the "Entity Details" tab now displays the "AC Presentation Layout" we set it to before.
- We can also see that the "Journal" tab has been added, and it displays the latest actions on the project.
- Lastly, we can see that the "Stage Details" tab shows us additional information about what stage we are in, as well as various other useful stage information.
4. End User Guide
This end user guide will focus only on how to use the Top panel v2 as version 1 is not used per se.
The Top panel v2 hides various information which is always visible in Top panel v1. This frees up space on the entity page, and is still easily accessible.
4.1. Viewing entity information
To view the entity details panel which displays information such as entity meta data, follow these steps:
- In the top panel, click the title of the entity.
- The entity information panel opens, presenting the available entity detail tabs. The currently active tab is underscored with a color dependent on the theme of the solution.
- The contents of the currently active tab is shown in the main section of the entity information panel.
- In the left side panel you can access the various libraries of the entity site.
4.2. Viewing stage information
To view the stage information of the current entity, follow these steps:
Be aware that if your entity does not currently have a stage, but staging is enabled for the module, the stage will NOT be shown in the breadcrumb. If this is the case, you can set a stage for the entity, that the stage will then be shown.
- If the entity utilizes a stage model and currently has a stage, the current stage is displayed after the entity title. You can click the title of the entity to view more information.
- In the top of the expanded top panel, the stage model is displayed. Displayed stages depend on which stage rendering mode is configured for the business module. For more information, please visit this article. Previous stages are marked with a check mark, the current stage is marked with an arrow and a target icon. Possible future stages are unmarked.
- If we go to the "Stage Details" tab, we can view more information about the stages of the entity.
- If the current stage has sub-stages, these are visible in the main section of the stage panel.
- Stage deadline information is provided below the stages overview. Deadlines more than a week from now are displayed with a standard black text. Deadlines closer than one week is displayed with an orange text and a clock icon. Overdue deadlines are displayed with a red text and an error icon.
- Additional information about the current stage is displayed in the left side of the stage panel.
- You can apply the stage filter by clicking the "Apply stage filter" button. This makes it so that only items created during the current stage will be displayed on the entity site.
- You can change the current stage by clicking the "Change stage" button.
Note that Stage Filtering is supported only by the WorkPoint 365 List View webpart.
5. Notes
Note that if you change Top Panel layout from version 1 to version 2 and vice versa, a window appears, letting you know that a site collection synchronization is needed in order to synchronize the changes across the solution. If you accept this and save the settings, a site collection synchronization job is automatically started. If you decline this and save the settings, the settings will be saved, but the changes will not take place before you run a site collection synchronization job manually.
Note that the navigation panel in both the Top panel v1 and v2 supports displaying recursive business module setups. You can read more about recursive business modules in this article.
Also note that for Top panel v2, simple stage information is displayed after the title of the entity. This is true only if the entity type utilizes a stage model. Full information about the stages of the entity, including current, past and possible future stages and sub-stage can be found by clicking the stage in the navigation panel.
Lastly, please note that Stage Filtering is supported only by the WorkPoint 365 List View webpart.
Comments
0 comments
Please sign in to leave a comment.