ID: 6735

Print Friendly, PDF & Email

Web Client Configuration

Zoom 7.0 introduces a brand new Web Client application. This application lets users perform basic operations like searching, browsing, metadata look-up etc. But in addition, it is also a collaboration tool that can be used for sharing collections of assets amongst a group of users and also exchange comments and annotations on the shared assets. Collections can be used to collaborate not just amongst the standard Zoom users, but also outsiders using just their email addresses. It is also possible to publicly share links to collections safely without requiring any user account or email address too. 

After the upgrade to Zoom 7.0, the Web Client is ready to use. However, it may be configured and personalized. The configuration options with their default values are listed below:

This post talks about the steps required to configure the application. To know more about the Web Client and its features, go to The Web Client .
Stop Zoom and Zoom Preview services before making any changes. Restart these services when the configuration changes are complete.

 

To set your company’s name and tagline on the Home page, update the following tags in server.xml. The default values are shown as in Image 1.

On the Zoom Server, navigate to the conf folder in Zoom Install directory (For Windows – [ZoomInstallDir]\conf\ and for Linux – [ZoomInstallDir]/conf/).

Open server.xml to setup Company Name and Tag Line.

Under<repospec> , set <companyName> tag as {Your Company Name}

Set <companyTagLine> tag as {Your Company Tag Line}

Save and close the file.

 

Configure the Web Client to display your Company’s logo using these steps.

On the Zoom Preview Server, navigate to the conf>server-settings>settings>webclient folder in Zoom Install directory (For Windows – [ZoomInstallDir]\conf\server-settings\settings\webclient\ and for Linux – [ZoomInstallDir]/conf/server-settings/settings/webclient/).

Locate logo.png .

Replace with your company’s logo keeping the same name.

Supported image formats are JPG and PNG.
Preferred image size is 40 x 40 pixels.

 

Now, to modify the welcome image on the Homepage, follow these steps in the same folder.

Locate home_header.jpg.

Replace with the Welcome image of your choice keeping the same name.

Supported image formats are JPG and PNG.
Preferred image size is 1550 x 380 pixels.

 

The default images in use are as shown below.

Web Client Homepage
Image 1: Homepage

 

From Zoom 7.1 onwards, users can update profile picture by clicking on the user menu in the top right, and selecting Edit User Profile.

Image 2: User menu

 

On the Edit User Account window, click the profile picture to upload a new profile image.

Image 3: Edit profile

 

For Zoom 7.0, the profile picture has to be added/updated on the Zoom Preview ServerNavigate to the conf>server-settings>settings>userSettings folder in Zoom Install directory (For Windows – [ZoomInstallDir]\conf\server-settings\settings\userSettings\ and for Linux – [ZoomInstallDir]/conf/server-settings/settings/userSettings/). Create the userSettings directory inside settings directory, if it does not already exist.

Save a user’s profile picture as {username}.jpg (eg. for Admin save the file as admin.jpg). If needed, save profile pictures for more users as per their usernames.

Supported image formats are JPG and PNG.
Preferred image size is 40 x 40 pixels.

If no profile picture is set, a generic icon with user’s initials is displayed. Image 1 shows the profile picture for the logged-in user on the top right.

 

By default, the assets uploaded using the Web Client are stored in the default Zoom project defproj. To change this to another project, modify a tag in the preview-server.xml file.

On the Zoom Preview Server, navigate to the conf folder in Zoom Install directory (For Windows – [ZoomInstallDir]\conf\ and for Linux – [ZoomInstallDir]/conf/).

Open preview-server.xml .

Under <previewserverspec>, set <defaultZoomUploadLocation> tag as {project path relative to Zoom root directory}

If <defaultZoomUploadLocation> tag is not found then add it under <previewserverspec>.

Save and close the file.

 

Instruct Zoom to always unzip/extract the contents of an uploaded Zip file with the following property.

On the Zoom Preview Server, navigate to the conf>server-settings>settings folder in Zoom Install directory (For Windows – [ZoomInstallDir]\conf\server-settings\settings\ and for Linux – [ZoomInstallDir]/conf/server-settings/settings/).

Locate preview-server.propertiesCreate this file, if it does not exist.

Set EXTRACT_ZIP_ON_UPLOAD=true

Save and close the file.

The extracted files are added as independent uploaded assets.

 

When an asset is imported with the same name as an existing asset, Zoom will upload the new file as the existing revision or a new revision based on the value of the following property. By default, this property is set to upload the new file as the existing revision.

On the Zoom Preview Server, navigate to the conf folder in Zoom Install directory (For Windows – [ZoomInstallDir]\conf\ and for Linux – [ZoomInstallDir]/conf/).

Open preview-server.xml.

Set <onDuplicateDetect> tag to either MERGE or REPLACE (default)

When the value is set to REPLACE, Zoom will upload the new file as the existing revision.

When the value is set to MERGE, Zoom will upload the new file as a new revision.

Save and close the file.

 

When assets are uploaded through the Web Client, some mandatory metadata values may be automatically attached to each asset. The mandatory metadata may be turned on or off in the Web Management Console. (System > Server Control Panel > Repository Settings > Enforce Mandatory Metadata on every Check-In).The mandatory metadata is fetched from the Blanket metadata file on the Preview Server.

On the Zoom Preview Server, navigate to the conf folder in Zoom Install directory (For Windows – [ZoomInstallDir]\conf\ and for Linux – [ZoomInstallDir]/conf/).

Open preview-server.xml.

Under <previewserverspec>, update <defaultBlanketMDFile> tag to {Metadata file name with absolute path}

The metadata file may be created anywhere. It is a text file that specifies the one or more metadata value pairs that would be attached to all assets uploaded from the Web Client.

A sample metadata file would have such entries:

IPTC_Country=India

IPTC_City=Gurugram

 

Save and close the file.

 

Assets may be filtered while viewing in the Web Client. Image 4 shows filters ‘Project Vault’, ‘Keywords’ and ‘File Types’ in effect.

The asset filters to show in Web Client are set from preview-server.xml.

On the Zoom Preview Server, navigate to the conf folder in Zoom Install directory (For Windows – [ZoomInstallDir]\conf\ and for Linux – [ZoomInstallDir]/conf/).

Open preview-server.xml.

Under <previewserverspec>, update <webClientFilters> tag to {Semi-colon separated Desired Filters list}.

The default value of the <webClientFilters> tag is:

<webClientFilters>project_name;metadata_key|IPTC_City;keyword;file_type_filter</webClientFilters>

This gives us four default filters ‘Project Name’, ‘Metadata > IPTC_City’, ‘Keywords’ and ‘File Type’.

Save and close the file.

 

By default, 60 assets are shown at a time in the Web Client Assets tab (continue scrolling down to see more assets). Image 4 shows that 60 assets are loaded of the 273 filtered assets for the user.

Change the number of assets displayed at page load with a property value.

On the Zoom Preview Server, make sure that hidden files are visible. Navigate to the .zm folder in System Home folder for Evolphin (For Windows – [UserDir]\.zm and for Linux – [UserDir]/.zm).

For the user John on Windows, the path would typically be C:\Users\john\.zm
For the user evolphin on Linux, the path would typically be $home/evolphin/.zm

Locate zoom.properties . Create this file, if it does not exist.

Set VAB_PER_PAGE_ENTRIES={number of files per page}

The default value for VAB_PER_PAGE_ENTRIES = 60.

 

Save and close the file.

Assets in Web Client
Image 4: Browsing Assets

 

Faceted categories are shown as filters while viewing assets. These category filter names may be changed as per your convenience. Image 4 shows the names ‘Project Vault’, ‘Keywords’ and ‘File Types’.

To change the names displayed for the filters, modify the following property:

On the Zoom Server, navigate to the conf/client-settings folder in Zoom Install directory (For Windows – [ZoomInstallDir]\conf\client-settings\ and for Linux – [ZoomInstallDir]/conf/client-settings/).

Locate zoom.properties . Create this file, if it does not exist.

 

Set FACETED_CATEGORY={Semi-colon separated list of CategoryName->Label pairs}

If we wish to change the category names ‘IPTC_city’ to ‘My City’, ‘project_name’ to ‘Brand Vault’ and another category name ‘keyword’ to ‘tag’ then sample entry would be:

FACETED_CATEGORY=IPTC_city>My City;project_name->Brand Vault;keyword->tag

 

Save and close the file.