Web Client Configurator

Web Client Configurator
Cumulus Web Client is the perfect tool to access Cumulus with a modern and easy-to-use interface. Users can add files to catalogs, search for files, preview files, edit their metadata, share them with others or download them – all via a standard Web browser.
Appropriate access rights are granted via the Cumulus user management.
 
This section describes how to configure Cumulus Web Client. To gain an overview of the key features and get explained the basic usage, see its user assistance.
Overview
Cumulus Web Client is installed on a Web application server and communicates via TCP/IP with your Cumulus Server. The Web application server can be operated on the same machine on which the Cumulus Server is installed, or on another remote machine accessible by a TCP/IP connection. As with all Web server solutions, this configuration requires an appropriate Internet connection if you want your external visitors to have 24-hour access.
The Web Client provides the data according to the user access rights configured via the user management of your Cumulus edition – your data is secure at all times.
This section collects the necessary steps to configure a Cumulus installation so that all features like versioning are enabled in the Web Client, explaining the Why? and the How?
Prerequisites for Using the Cumulus Web Client
A Cumulus Server and the Cumulus Web Solutions (including Web Client, Sites, and the Web Server Console) must be installed and running. A Cumulus Client is also required for certain configuration tasks that must be performed via the client’s Preferences window.
For detailed information on how to install Cumulus, the Cumulus Web Solutions and the Cumulus Client, see respective Installation Guides..
Cumulus Web Client must be installed as a part of the Cumulus Web Solutions. It must be configured to have access to a Cumulus Server via the Web Client Configurator (see “The Settings Tab")
Server Settings
These basic settings must be performed via the Web Server Console, or the Cumulus Client’s Server Console.
Configure a base URL for Web access
Why:
A base URL is required for the Send collection link feature as well as for the Send upload link feature to work.
How:
Open the Server Console or the Web Server Console and select Remote Admin > Settings > Base URLs for Web Access and add an URL. A base URL must point to a valid sites installation, e.g. http://localhost:8080/sites.
See also:
Configuring Web URL
Configure a mail server to be used by Cumulus
Why:
This is a prerequisite for sending collection links or upload links via email from within Cumulus or the Cumulus Web Client.
How:
Open the Server Console or the Web Server Console and select Mail Manager, then enter the information for the mails server that you want to use.
See also:
Mail Manager
Add a versioning location
Why:
A versioning location is required if you are using the file system versioning feature. Without a versioning location, this feature won’t work.
How:
Open the Server Console or the Web Server Console and select File System Versioning, Then add the Central Asset Location that is configured for the catalog to be used as versioning location and configure its behavior.
See also:
Configuring the File System Versioning
Catalogs
Any catalog that shall be used with the Web Client must be prepared as follows.
These settings must be performed with the Preferences window of the Cumulus Client.
Enable Sharing and Web Access
Why:
If the Allow Web access option is deactivated, the catalog can’t be accessed with the Web Client.
How:
Select Preferences > Catalog Settings > General > Sharing and activate the Sharing and Allow Web access options.
This must be performed individually for each catalog that shall be accessed with the Web Client.
See also:
Overview: Catalog Settings
Set a Central Asset Location
Why:
A Central Asset Location is required e.g. for the send upload link feature to work. Beyond that, it is strongly recommended to employ a Central asset location for all catalogs that shall be accessed with the Web Client (e.g., because Tomcat should not have direct access to file server)
How:
Select Preferences > Catalog Settings > General > Copy Assets to Central Location and configure the usage of a Central Asset Location
As Mode, select Always. This will override whatever is specified in the Asset Handling Set, if applicable.
See also:
Overview: Catalog Settings; Employing a Central Asset Location
Add fields for versioning information to the catalog
Why:
These fields are required for the file system versioning feature to function.
How:
Select Preferences > Catalog Settings > Record Fields and add the fields from the Fields for Asset Usage History catalog template.
See also:
Adding Fields; File System Versioning
Add fields for asset usage history information to the catalog
Why:
These fields are required to track a file’s usage history and to show information about recent activities on the Web Client Dashboard as well as on the file’s History tab.
How:
Select Preferences > Catalog Settings > Record Fields and add the fields from the Fields for Tracking Usage History catalog template.
In the Asset Usage field properties, select the Usage History Options tab and activate the actions that you want to track.
NOTE: Currently, only the history for Check Out, Check In, and Download are shown in the Dashboard of the Web Client
See also:
Adding Fields; Report Manager
Make the category field "Description" user editable
Why:
A user should be able to enter or modify the description of a container/category, not only its name.
How:
Select Preferences > Catalog Settings > Category Fields >Description > Properties. On the Field Values tab, activate Allow user to edit.
See also:
User Generated Field Values
Enable text extraction from documents
Why:
Without text extraction, the contents of documents (e.g. PDF files or MS Word documents) can’t be searched with the Web Client.
How:
To configure text extraction you have to perform several tasks:
Add the Document Text record field to the catalog and enable it for indexing.
Add the Document Text field to the Asset Info Window view of the Record View Set that is to be used with the Web Client.
See also:
Cumulus Office Document Filters
Asset Handling Sets
Cataloging and accessing files via the Web Client is performed according to the Asset Handling Sets specified for the user and the current catalog. If no Asset Handling Set is specified, the default Asset Handling Sets is employed..
These settings must be performed with the Preferences window of the Cumulus Client.
Enlarge the size of thumbnails
Why:
Large thumbnails are required for the Dashboard key visual to work properly; besides, they provide a better visual quality.
How:
Select Preferences > Asset Handling Sets; then select the Asset Handling Set you want to be used by the Web Client. On the Thumbnails tab, set the size to 1024 pixel.
See also:
Asset Handling Sets.
Users
These settings must be configured via the Web Server Console, or the Cumulus Client’s Server Console.
Confugure user permissions
Why:
As always with Cumulus, what a user can see and do within a catalog can be precisely defined by granting or revoking respective permissions.
How:
Permissions are set via the User Manager module of the Cumulus Server Console. Open the Server Console or the Web Server Console an select the User Manager module.
See also:
Simple View: Permissions; Advanced View: Permissions for more information on how to set permissions for a user.
NOTE: In order to access a Cumulus catalog via the Web Client, a user must have at least the permission to open this catalog with any client.
Web Client configuration
Behavior and appearance of the Web Client are controlled via the Web Client Configurator which is a Module of the Web Server Console. The configuration options offered by the Web Client Configurator and the handling is described in the following sections. This section lists the minimal/initial configuration tasks that must be performed in order to use the Web Client.
To use the Web Client Configurator, open the Web Server Console and select Web Client Configurator.
Select a Record View Set and a Category View Set to be used
How:
Select the desired view sets on the Layout tab of the Web Client Configurator (see “The Layout Tab").
These view sets are effective for all users of the Web Client. Users cannot change view sets.
NOTE: Canto recommends to use the Web Client Record View Set and the Web Client Category View Set that are delivered with Cumulus.
If you modify one of this view sets, or if you want to use different View Sets, keep in mind that there are certain restrictions:
See also:
Record View Sets; Category View Sets for more information on how to configure view sets.
Configure available filter options
How:
Select the default filter options for newly created users on the Filter tab of the Web Client Configurator (see “The Filter Tab").
NOTE: These filter options only take effect if new users are created from scratch. New users that are created by duplicating existing ones inherit the filter options from the parent user.
Configure available asset actions
How:
Select the asset actions that are available for Web Client users with the Download and Print functions on the Download & Print tab of the Web Client Configurator (see “The Download & Print Tab").
Configuring Cumulus Web Client
The following sections describe how Cumulus Web Client is configured via the various tabs of the Web Client Configurator.
The Settings Tab
This tab contains the name or the IP address of the Cumulus Server that Cumulus Web Client accesses.
Use this tab to define:
Server Address – IP address or DNS-resolvable name of the machine running the Cumulus Server. Required Value!
If the Cumulus Server and the web application server of the Cumulus Web Client are running on the same machine, you can enter localhost instead of an IP address or server name.
The Layout Tab
This tab contains layout options for the Web Client.
Use this tab to customize the layout of the Web Client .
View Sets
This section is for specifying the default View Sets to be used with the Web Client.
Default Record View Set – Drop-down list to select the Record View Set to be used as default. This set must be a shared one.
Default Category View Set – Drop-down list to select the Category View Set to be used as default. This set must be a shared one.
Footer and Message
This section is for specifying messages the administrator wants to be displayed to users as well as for adding and customizing an additional footer. This footer can be used to display further information or navigation options.
The custom footer is displayed in addition to the default footer on every page. The default footer can not be modified or deleted.
Administrator Message – You can specify a message that is shown to logged-in users on every page.
Show message – If activated, you can enter a message. This message is displayed as soon as you save your changes.
Message – Enter the message to be displayed.
Footer – You can specify a custom footer that is displayed just above the default footer of the Web Client.
HTML Text – Define the footer you want to be displayed. Use standard HTML to design the footer’s appearance.
NOTE: When using HTML, be carefully not to interfere with the general layout of the page.
 
Login
This section is for specifying the layout of the login page (logo, tag line, and background image).
Logo – Select the logo file you want to use, then upload it. Any file in either SVG, PNG, JPG or GIF format can be used. The ideal size for the logo on the login page is 130 x 130 pixels. As soon as you save your changes, the uploaded file is used as the new logo.
To delete a file you have uploaded and return to the default logo, click Reset to Default. As soon as you save your changes, the default logo file is used again.
Background image – Select the image file that you want to use, then upload it. Any file in either PNG, JPG or GIF format of at least 800 x 600 pixels can be used as background image. As soon as you save your changes, the uploaded file is used as the new background image.
To delete a file you have uploaded and return to the default background image, click Reset to Default. As soon as you save your changes, the default background image file is used again.
Tag Line – You can customize the tag line.
Heading – Enter the text to be displayed as tag line heading. As soon as you save your changes, this text is used as tag line heading.
To return to the default tag line heading, delete any text in this field. As soon as you save your changes, the default heading is used again.
Heading text color – Activate Use custom color, then define the desired color for the tag line heading. As soon as you save your changes, the tag line heading is displayed in the selected color.
To return to the default text color, deactivate Use custom color. As soon as you save your changes, the default text color for the tag line is used again.
Sub heading text – Enter the text to be displayed as sub heading. As soon as you save your changes, this text is used as sub heading.
The sub heading text color can’t be changed.
To return to the default sub heading, delete any text in this field. As soon as you save your changes, the default sub heading text is used again.
NOTE: Tag line localization
A custom tag line can not be localized. It is always displayed as you have entered it, regardless of the language setting in the browser of the user.
Dashboard
This section is for customizing the layout of the Dashboard (logo, welcome text, text color, key visual).
Logo – Select the file you want to use, then upload it. Any file in either SVG, PNG, JPG or GIF format can be used. The ideal size for the logo on the dashboard is 160 x 43 pixels. As soon as you save your changes, the uploaded file is used as the new logo.
To delete a file you have uploaded and return to the default logo, click Reset to Default. As soon as you save your changes, the default logo file is used again.
Welcome Text – You can customize the welcome text.
Text – Enter the text to be displayed as welcome text. As soon as you save your changes, this text is used as welcome text.
To return to the default welcome text, delete any text in this field. As soon as you save your changes, the default welcome text is used again.
Welcome text color – Activate Use custom color, then define the desired color for the welcome text. As soon as you save your changes, the text is displayed in the selected color.
To return to the default text color, deactivate Use custom color. As soon as you save your changes, the default text color is used again.
NOTE: Welcome Text Localization
A custom welcome text can not be localized. It is always displayed as you have entered it, regardless of the language setting in the browser of the user.
Show random images from catalog on user’s dashboard – If activated, randomly selected images (or parts of images) from the catalog are displayed in the Dashboard’s header to make it visually appealing (key visual). At the same time, the color of the Dashboard’s header is adapted to the prevailing color of the image.
If deactivated, the key visual is taken from a predefined set of special images delivered with the Web Client. Instead of the default images, you can use an image of your own as key visual.
To delete a file you have uploaded and return to the default key visual files, click Reset to Default. As soon as you save your changes, the default key visual files are used again.
 
The Filter Tab
This tab contains filtering options in the Web Client.
Filtering
This section is for specifying filtering options.
Configured Filtering Fields – List of record fields that can be selected as filters in the Web Client. You can add more fields to, or remove fields from the list using the according buttons.
If Default is activated, the respective fields are displayed in the Manage Filter section of the Web Client’s filter bar when a user logs in on the Web Client for the first time.
NOTE: Employing filters influences the performance. The more filters are employed, the more load for the Cumulus Server.
The Download & Print Tab
This tab contains a section to select Asset Actions available when items are downloaded from the Web Client.
Asset Actions
This section is for specifying asset actions that can be applied when files are downloaded by Web Client users.
If the list is empty, all actions available to a user are offered and can be applied when assets are downloaded via the Web Client. If you add Asset actions to this list, the user can only select from these Asset Actions.
You can add Asset Actions to, or remove them from the list using the according buttons.
The History Tab
This tab contains a list of old versions of the Web Client configuration. A new entry is added each time you save changes made with the Web Client Configurator. While saving, you can add a description of your changes which might be helpful in order to keep track of them. You can load an old configuration and make it current again, and you can delete old configurations.
Current Change Description: Displays the description entered for the current version of the configuration.