Before Cumulus Portals can be used, some basic configuration tasks must be performed.
NOTE: Cumulus Portals Requires a Running CIP Installation! As Portals is a web solution built on the Cumulus Integration Platform (CIP), CIP must be entirely configured before you start configuring Portals.
Initially Configuring Cumulus Portals
The basic configuration and customization is done via the customization.js file.
You find it in the portals folder inside the webapps folder of your web server application, e.g.: C:\Program Files\Canto\Cumulus Web Solutions\apache-tomcat-X.X.xx\webapps\portals\
Use an UTF-8 compatible editor (: and run it as administrator) to edit the file.
NOTE: All configuration and customization tasks are optional! Only if Portals and CIP are running on different machines than, you must explicitly specify the CIP’s base URL (e.g., 'https://www.customer.com/CIP').
Configuration
• CIP – The base URL of the Cumulus Integration Platform (CIP), default value ('/CIP/').
• clientConfiguration – Name of the Portals Configuration as defined via the CIP Configurator. (For details on the CIP Configurator, see the (Web) Server Console help.) Replace the default value with the name of the Portals configuration you want to employ.
Customization
Basic customization edits are:
• logoURL
• logo-s – Small logo image. Replace the default value 'img/logo-s.svg' with the name (and relative path to) of an image of your company’s logo in SVG format (40x40).
• logo-m – Medium logo image. Replace the default value 'img/logo-m.svg' with the name of (and relative path to) an image of your company’s logo in SVG format (size 124x40).
NOTE: Other Image Formats If you want to use a logo image in PNG format, you can deactivate the SVG line and activate the PNG line above. And then replace the image name (and path) in that line. OR: If you want to use a logo image in another format such as JPEG or GIF, you can deactivate the SVG line and insert a corresponding line for your desired image format.
• favicon – The default favicon can be replaced with a customized icon of the same format. The favicon.ico contains images sized 16×16 and 32×32 pixels. Either replace the default icon with the customized one, or store the customized icon in a different location and enter the proper path here. To change the Apple touch icons, the default files must be replaced with the customized ones. The sizes required for the Apple touch icons are included with their file names.
• theme – Name of the theme that control the visual appearance of Portals. Empty initially, which means, the default theme (‘dark’) is used. An additional ‘bright’ theme is provided out-of-the-box with any Portals installation. Further themes can be created and used as required. To change the theme, enter it’s name here, e.g.: 'theme': 'bright'
• company – Replace the default value 'Portals' with the name of your company. The string specified here is displayed as the first part of the title of each Portals browser tab, followed by a dash, e.g. “Portals - Details for xyz”. If left empty, the dash is not displayed either.
• cookieConsent – default: 'false'. If set to 'true', a customizable cookie consent banner will be displayed to every Portals user.
• showPageFooters – default: 'false'. If set to 'true', a customizable footer will be displayed on every Portals page.
Some of the mor advanced customization possibilities:
• i18n – Internationalization. The locale identifiers of the languages that are currently supported.
• defaultLocale – The locale identifier of the default language. The default language will be used when no language file matches the language of the employed browser.
• custom_i18n– You can add a JSON file containing strings that you want to replace certain (or all) default strings.
• customHomeScreenIcons: – default: 'false'. If set to 'true', the custom home screen icons and the manifest.json in the root of the custom folder will be used.
• website – Name of the folder that contains the current web application.
• categoryPage – Values determining the appearance of thumbnails on the landing page:
• sizeType – maxsize (the image is downscaled so that its longest side matches the given number of pixel; the aspect ratio is preserved), OR size (the image is downsized so that its shortest side matches the given number of pixel; the resulting image is always a square).
• contentScale – contain (background image is resized to be fully visible) OR cover (background image is resized to cover the entire container. (Only takes effect in combination with “sizeType: maxsize”!)
• size – auto (available space is calculated according to the dimensions of the image panel), OR integer(value) (number of pixels preserving the aspect ratio of the image).
BACKGROUND INFO: Portals customization and the PortalsSDK
Many customization tasks require the usage of the Portals SDK, which is provided as a separate download file. For more information on how to further customize Portals, see the technical documentation provided with the Cumulus Portals SDK.
Employing the CIP Configurator
Cumulus Portals also retrieves configuration data from the CIP Configurator. The corresponding Portals configuration tasks are performed with the CIP Configurator module which is a part of the Web Server Console. For more information on configuring Portals with the CIP Configurator, see the (Web) Server Console help.
With these settings, Portals is ready for use and can be tested. However, before public use Canto recommends configuring a few more things.
Testing the Installation
Before you start testing Portals, make sure that:
• Your Cumulus Server is running
• Your Web application server (e.g., Cumulus Web Solutions service) is running
• The catalog specified in the Portals Configurator is opened at the Cumulus Server and enabled for web access
To test the installation:
1. In the address field of your browser, enter [WebServer Address]:[8080]/portals Replace [WebServer Address] with your Web servers IP address or DNS name. If the browser runs on the same computer, you may as well use localhost.
If your Web application server software is able to find the Portals default pages, you’ll see a Cumulus Portals page.
NOTE: For Portals to work properly, cookies must be enabled in your browser!
Search Engine Optimization for Cumulus Portals
Cumulus Portals supports and is well prepared for SEO.
SEO support of Portals is closely related to the customer-specific customization of a Portals installation.
Therefore it is crucial that the information provided in the customization is appropriate, accurate and uses specific terms that can help finding a customers company via a web search (e.g., “digital asset management”, or terms related to the customers business).
Basic SEO settings
Any Portals installation comprises two SEO related files by default: robots.txt and sitemap.xml.
• The robots.txt file is used to control which search engine crawlers are welcome to scan the website. By default, Portals allows every crawler to access the website.
By default, Portals allows to the whole website to be accessed (user-agent: *). Administrators can restrict this by editing the robots.txt file accordingly.
• The sitemap.xml files defines, among others, which URLs of a website should be accessed by search engine crawlers, their priority and how often crawlers should access them.
Search engine crawlers rely on the content of certain elements of an HTML page, such as
• tags in the header section (<head><meta name="Keywords">, <head><meta name="description">, and <head><meta name="title">, which is the unique title of a web page;
• tags in the content section (especially H1 headings), or static URLs.
The content of these elements can not be adapted or modified directly by an administrator, but depends on the customization settings of a Portals installation, as well as on information retrieved from any open catalog.
• Customization can be done by modifying the customization.js file (the Company Name), as well as via the language-specific i18n/*.json files (the welcome text [key "LOGIN-TITLE"], the sub title [key "LOGIN-SUB-TITLE"] , the login page title [key "LOGIN-PAGE-TITLE"]).
• Information retrieved from open catalogs includes category names and descriptions, record names and descriptions, keywords, and copyright information.
Portals takes care of writing this information properly into appropriate meta tags so that it can easily be found by search engine crawlers. The following table depicts which kind of information is currently written into which SEO relevant HTML element on different kinds of pages.
: and run it as administrator) to edit the file.