The catalog can be configured to show only the data that is appropriate for the context in which it will be used. An administrator can manage which elements are shown in the top navigation bar, which filters are available to be used, which product origins to display and which organization types to show. In addition, the user can configure the contents of the landing page, the background color for the site, the site logo, and the footer content. Each of these elements is described below.
Additionally, the catalog can be configured to show different data for different user roles. Each of these configurations is called a portal. If a user has access to more than one portal, they can use the main drop-down menu to switch between portal views.
Creating a New Portal¶
An administrator can access the portal screen from the main drop-down menu by selecting ‘Portal Views’. Initially, there is a single portal view configured (the default view). Click on the ‘Create New’ button to create a new portal view. Give the portal a unique name and description.
Assign User Roles¶
Click on the user roles that should have access to this portal view. If a user has access to multiple portal views, they will be able to switch between them.
Assign Product Origins¶
In the catalog, products may be associated with one or more origins (the source of the data about the product). In some cases, a portal may be configured to show only data from a subset of origins. The edit portal screen will show a list of all product origins. Turn off any origins that you do not wish to see product data from.
Assign Organization Types¶
There are multiple types of organizations in the catalog, including endorser (an organization that has endorsed the Digital Principles), MNI (a mobile network integrator/aggregator), or product owner. If you only wish to show certain types of organizations in the portal view, turn off those which should not be displayed.
Configure Portal UI Elements¶
The remaining elements on the portal view screen allow the administrator to customize UI elements for this portal. There is a WYSIWYG editor for the landing page and the footer content. The content of the landing page editor will be shown on the home page of the catalog. The editor allows uploading of images and allows for almost any content to be created.
Similarly, the the contents of the footer editor control will be rendered on the footer of each page of the catalog.
The user can configure the background color for the portal view. Enter the color that should be shown on the header and footer sections in #rrggbb (hex RGB) format.
Finally, the user can upload an image that will be shown in the header of each page. Generally, this will be a logo image for the organization that is configuring the catalog, but any image can be used.
Portal Switching by Sub-Domain¶
The catalog also allows for different views based on the URL that the user navigates to. For example, if the base URL is onlinecatalog.com, we can configure different portals for projects.onlinecatalog.com and aggregators.onlinecatalog.com.
Note that the administrator is responsible for configuring the DNS entries for these different subdomains, ensuring that they all point to the online catalog server
When this functionality is set, it will override any role-based portal selection.
- To configure this functionality:
- On the settings page,create a new setting called ‘Root Domain’. Set the value to the base URL for the online catalog
- In the portal view page, set the subdomain to the appropriate value. All requests to <subdomain>.<root domain> will be rendered with this portal view