NOTE: The initial Portals configuration is done via the customization.js file. For details, see the Cumulus Web Solutions chapter of the appropriate Installation Guide; under “Cumulus Web Solutions: Initial Steps” you will find the section “Initially Configuring Cumulus Portals.” However, you need a properly set up Portals configuration to be referenced by the customization.js file.
A Portals configuration is defined via various tabs:
Catalog Access Tab
• Require Login If activated, any website visitor must log in and therefore needs a Cumulus user account. Connecting to Portals opens a Welcome page with login prompt only.
If not activated, website visitors can use the configured catalog without being logged in.
• Catalog Aliases – For each usage case, select the desired Catalog Aliases from those that are configured under Catalog Access on the Settings tab (for the Server displayed).
NOTE: Video Cloud – Video Link If you publish videos to the Video Cloud and want to make use of the Video Link feature, you must specify an appropriate Catalog Alias, as defined in the CIP configuration. See also: Portals Preview Landing Page Catalog Alias.
• Catalog Name - Root Category – Name of the catalog and name of the category that will be displayed as the topmost level on the Portals landing Page. Only categories below the specified root category will be visible to the Portals user and displayed in the filter panel. – Any category with a valid Container Type can be configured as root category for Portals.
NOTE: This setting only affects the visibility of categories, not the visibility/accessibility of records or assets. Even items that are not assigned to any category, or to a category outside the tree defined by the specified root category, can be retrieved, e.g. via a quicksearch. To restrict the visibility/ accessibility of records and assets, you must use item permissions and user/role permissions.
• Offer Feature to Reset the Password – If activated, Portals users are enabled to reset their passwords themselves. A Reset password link is shown on the login page of Portals.
• Catalog alias to use – The catalog alias to be used for password reset requests.
NOTE: For security reasons it is strongly recommended to only use a specifically dedicated catalog alias for this purpose!
Layout Tab
This section is for specifying the Record View Sets to be used, and the asset relations types to be displayed in Portals.
• Default Record View Set – The Record View set that is employed for all users without a specific setting. Use the drop-down list to select a Record View Set to be used as default.
• Default Relation Types – The relation types that are displayed for all users without a specific setting. The ... button opens a dialog to configure the default Relations types.
• User/role specific Settings – Record View Set and Relation Types settings for individual users/roles. It’s a table with 3 columns: User (or Role, depending on the configuration of your Cumulus), Record View Set and Relation Types.
• Assets per Page – The maximum number of assets that will be displayed on any page in Portals, to be defined for different screen sizes.
Click Add to open the User/role specific settings dialog. Select a user or role. You must deactivate the Use Default option(s), before you can assign a specific Record View Set or specific Relation Types to a user or role. When you are done, Click OK. The user or role is added to the table.
Additional information on Record View Sets for Portals
Canto strongly recommends to create (and use) at least one dedicated Record View Set to be used with Portals.
• Only Find Masters – If activated, records for contained or referenced assets are not displayed.
• Filter Set – Select the desired Filter Set from those that are configured under Filters on the Settings tab.
NOTE: If the selected filter set contains field-based filters (standard, input or range filters), the respective fields must be contained in all catalogs that are accessible for a Portals user. Otherwise, the filter won’t be displayed to the user.
Sorting Tab
• Available Sorting Fields –The fields available for sorting are listed. You can edit, add and remove fields with the appropriate buttons.
• Initial Sorting – If activated, you can select the field to be used for sorting and the sorting direction.
• Show – Select how many fields you want to be displayed, all others will be hidden in a drop-down list.
Plug-Ins Tab
The Portals Plug-in API allows you to add additional functionality. This tab lists the uploaded and available plug-ins. You can configure, add and remove plug-ins with the appropriate buttons. The Configure button is only active with plug-ins that offer to configure parameters. The check marks under ACTIVE denote whether a plug-in is active and available to users.
Click Add to add a plug-in. Then you can select a plug-in file (ZIP archive) and upload it. Save it with your configuration and, if required, configure it. Once it is ready for use activate it. Then the additional functionality of the plug-in is immediately available for your Portals users.
NOTE: A plug-in with the same ID and version as one that is already installed cannot be uploaded. If you want to re-upload the same plug-in version, you need to remove the installed plug-in.
A plug-in for Portals consists of a number of files packaged into a ZIP archive. For more information on Portals plug-ins see the technical documentation provided with the Cumulus Portals SDK.
IMPORTANT! Migration of Plug-ins Prior to Cumulus 11.0 With Cumulus 11.0 Portals' code structure was improved - heading towards a design approach that helps customer developers with customization and theming. Therefore, all plug-ins developed prior to Cumulus 11.0 must be tested again and, if necessary, migrated. Also, UI customizations will no longer work and must be migrated! However, as the reworking of the Portals code is not yet finished, Canto cannot guarantee that migrated customizations will properly work in future releases. Therefore, it is strongly recommended to postpone migration of UI customizations until further notice. For more information see the technical documentation provided with the Cumulus Portals SDK.
Advanced Tab
• Skip landing page – If activated, users will not see a landing page when Portals is started (e.g. a top level categories overview), but the unfiltered content of the open catalog(s) below the root categories as defined on the Catalog Access tab.
• Enable terms and conditions while download – If activated, users who want to download files first must agree to certain terms and conditions by activating a respective checkbox in the download dialog. Only then, the download can be started. Additionally, a link to the terms and conditions in questions can be provided.
• Terms and conditions page – Link to a page that holds the terms and conditions in question. Any valid URL can be used.
NOTE: It’s up to you as a provider of downloadable content whether you require users to agree to certain terms and conditions, or not. But if you do so, it’s your responsibility to prepare, upload and maintain an appropriate terms and conditions page
Configuring Multiple Instances
You can configure and run simultaneously multiple Portals instances.
To create a new instance, you must perform following steps to:
• Copy and rename the Portals web application folder (e.g. C:\Program Files\Canto\Cumulus Web Solutions\apache-tomcat-x.x.xx\webapps\portals).
• Edit the customization.js file in the copied and renamed web application folder and give your new instance a new Portals Configuration name; e.g. set clientConfiguration to com.canto.cumulus.NewName (For details, see the Cumulus Web Solutions chapter of the appropriate Installation Guide; under “Cumulus Web Solutions: Initial Steps” you will find the section “Initially Configuring Cumulus Portals.”)
• Add your new Portals Configuration (use the new name) to the Portals Configurations on Portals tab of the CIP Configurator and configure it (see above).