{"id":6735,"date":"2017-12-12T05:31:01","date_gmt":"2017-12-12T05:31:01","guid":{"rendered":"http:\/\/evolphin.com\/help\/?p=6735"},"modified":"2020-12-17T12:18:52","modified_gmt":"2020-12-17T17:18:52","slug":"web-client-configuration","status":"publish","type":"post","link":"https:\/\/evolphin.com\/help\/administration-server\/web-client-configuration\/","title":{"rendered":"Web Client Branding & Configuration"},"content":{"rendered":"\n

Zoom 7.0 introduced Evolphin Web Client application that can be branded for customer portals. This application lets users perform basic asset operations like searching, browsing, and metadata lookup. But, in addition, it is also a collaboration tool<\/span>, that can be used for sharing collections<\/span> of assets among a group of users and also exchange comments<\/span> and annotations<\/span> on the shared assets. Collections can be used to collaborate not just among your standard Zoom users within the organization, but also with outsiders using just their email addresses. It is also possible to publicly share links to chosen collections safely without requiring any user account or email address too!<\/span><\/p>\n\n\n\n

After you upgrade to Zoom 7.0, the Web Client is ready to use. However, it may be further configured, branded and personalized for use. The global configuration options are:<\/span><\/p>\n\n\n\n

  1. Personalizing Web Client:\n
      \n
    1. Your organization’s name and tagline<\/a><\/li>\n
    2. Your logo and a new welcome image<\/a><\/li>\n<\/ol>\n<\/li>
    3. File upload settings:\n
        \n
      1. Default upload location<\/a><\/li>\n
      2. Zip file upload setting<\/a><\/li>\n
      3. Duplicate file upload setting<\/a><\/li>\n
      4. Default metadata for uploads<\/a><\/li>\n<\/ol>\n<\/li>
      5. Customizing asset list display:\n
          \n
        1. Number of assets to show<\/a><\/li>\n
        2. Faceted filters in asset display<\/a><\/li>\n
        3. Customized names for filters in asset display (deprecated from Zoom 7.3 onwards)<\/a><\/li>\n<\/ol>\n<\/li>
        4. Setting in the Web Management Console<\/span>:<\/span>\n
            \n
          1. Email domains for invited collection sharing<\/span><\/a><\/li>\n
          2. Web Client Settings<\/a><\/li>\n<\/ol>\n<\/li><\/ol>\n\n\n\n

            These settings are only available to Zoom\u2019s admin users. Once these are configured, their effects are visible to all users of Web Client in your Zoom setup.<\/span> Besides these global options, each Zoom user may also set a custom profile picture<\/a> in the Web Client.<\/p>\n\n\n\n

            Many of these configuration settings are done through zoom.properties files. From Zoom 7.3 onwards, you can update these properties through the Web Management Console<\/a>.<\/div>\n\n\n\n

            Follow the sections below to see how to configure Web Client for the above options:<\/p>\n\n\n\n

            This post talks about the steps required to configure and customize your Web Client. To know more about using Web Client, go to The Web Client<\/a>\n\t\t\t\t\t\t<\/span>.<\/div>\n\n\n\n
            <\/a>Restart all Zoom services after changing configurations on any of your servers. The order to restart services is Zoom HADR, Zoom, Zoom Preview, and Zoom Curator Service.<\/div>\n\n\n\n

            Company name and tagline<\/h2>\n\n\n\n

            To set your company’s name and tagline on the Home page, follow these steps:<\/p>\n\n\n\n

            1. On the Zoom Server<\/span>, navigate<\/span> to the conf <\/span>folder in the Zoom Install directory (For Windows \u2013 [ZoomInstallDir]\\conf\\<\/em> and for Linux \u2013 [ZoomInstallDir]\/conf\/<\/span><\/em>).<\/li>
            2. Open<\/span> server.xml<\/code><\/span> for editing.<\/li>
            3. Under<repospec><\/code> , set<\/strong> <companyName><\/code> tag as {Your Company Name}<\/em><\/li>
            4. Set<\/strong> <companyTagLine><\/code> tag as {Your Company Tag Line}<\/em>
              For example, to set the company name as ABC and tagline as ‘For all of ABC’, set these tags as:  <\/span>

              <companyName>Evolphin Software<\/companyName><companyTagLine>Stay Awesome<\/companyTagLine><\/p><\/div> <\/li>

            5. Save<\/span> and close<\/span> the file.<\/li>
            6. Restart<\/strong> all Zoom Services on your Zoom Server in the order described<\/span> above<\/a>.<\/li><\/ol>\n\n\n\n

              Your chosen values are now set. These will be displayed in the Web Client after<\/span> the browser cache is cleared<\/span>. The default values are shown in Image 1<\/a>.<\/p>\n\n\n\n

              Change Login Background Image<\/h2>\n\n\n\n

              On visiting the Web Client sign-in, users can see their company’s login background image using these steps:<\/p>\n\n\n\n

              1. On the Zoom Preview Server<\/span>, navigate<\/span> to the conf>server-settings>settings>webclient\u00a0<\/span>folder in Zoom Install directory (For Windows \u2013\u00a0[ZoomInstallDir]\\conf\\server-settings\\settings\\webclient\\<\/em>\u00a0and for Linux \u2013\u00a0[ZoomInstallDir]\/conf\/server-settings\/settings\/webclient\/<\/em>).<\/li>
              2. Locate<\/span> login_background.jpg<\/code> .<\/li>
              3. Replace<\/span> with your company’s login image keeping the same file name.<\/li>
              4. Restart<\/strong> all Zoom Services on your Zoom Server in the order described<\/span> above<\/a>.<\/li><\/ol>\n\n\n\n

                Note: <\/strong>Supported image format is JPG\/JPEG only.
                Note:<\/strong> The preferred image size is 1920 x 1080 pixels.<\/p>\n\n\n\n

                Your chosen image is now set. This will be displayed in the Web Client after <\/span>the browser cache is cleared<\/span>. The default images in use are as shown below:<\/p>\n\n\n\n

                \"\"<\/figure>\n\n\n\n

                Change Company Logo and Welcome Image<\/h2>\n\n\n\n

                Configure the Web Client to display your Company’s logo using these steps:<\/p>\n\n\n\n

                1. On the Zoom Preview Server<\/span>, navigate<\/span> to the conf>server-settings>settings>webclient\u00a0<\/span>folder in Zoom Install directory (For Windows \u2013\u00a0[ZoomInstallDir]\\conf\\server-settings\\settings\\webclient\\<\/em>\u00a0and for Linux \u2013\u00a0[ZoomInstallDir]\/conf\/server-settings\/settings\/webclient\/<\/em>).<\/li>
                2. Locate<\/span> logo.png<\/code> .<\/li>
                3. Replace<\/span> with your company’s logo image keeping the same file name.<\/li>
                4. Restart<\/strong> all Zoom Services on your Zoom Server in the order described<\/span> above<\/a>.<\/li><\/ol>\n\n\n\n

                  Note: <\/strong>Supported image format is JPG\/PNG only.
                  Note:<\/strong> The preferred image size is 40×40 pixels.<\/p>\n\n\n\n

                  Now, to modify the welcome image on the Homepage (shown after login), follow these steps in the same folder.<\/p>\n\n\n\n

                  1. Locate<\/span> home_header.jpg<\/code>.<\/li>
                  2. Replace<\/span>\u00a0with the Welcome image of your choice\u00a0keeping the\u00a0same file name.<\/li>
                  3. Restart<\/strong> all Zoom Services on your Zoom Server in the order described<\/span> above<\/a>.<\/li><\/ol>\n\n\n\n

                    Note: <\/strong>Supported image format is JPG\/PNG only.
                    Note:<\/strong> The preferred image size is 1550×380 pixels.<\/p>\n\n\n\n

                    Your chosen images are now set. These will be displayed in the Web Client after <\/span>the browser cache is cleared<\/span>. The default images in use are as shown below in Image 1<\/a>.<\/a><\/p>\n\n\n\n

                    \"\"
                    Image 1: Homepage<\/figcaption><\/figure>\n\n\n\n

                    Change Default Upload Location<\/h2>\n\n\n\n

                    By default, the assets uploaded using the Web Client are saved in the default Zoom project, defproj<\/em><\/span>. You could change this to another project or a folder inside a project using a tag in preview-server.xml. Use the value of the disk path for the Zoom project or the folder inside the project. For example, if you want to change the upload location to the folder ‘Seasons’ inside the project ‘New Show’, then you need to use the path to the folder ‘Seasons’ on the disk. To get this path, right-click the desired folder in Asset Browser’s Browse tab and select Copy Path from the context menu.<\/p>\n\n\n\n

                    \"\"<\/a>
                    Image 2: Copy path in Zoom<\/figcaption><\/figure>\n\n\n\n

                    Follow these steps to update the default upload location:<\/p>\n\n\n\n

                    1. On the Zoom Preview Server<\/span>, navigate<\/span> to the conf<\/span> folder in the Zoom Install directory (For Windows \u2013 [ZoomInstallDir]\\conf\\<\/em> and for Linux \u2013 [ZoomInstallDir]\/conf\/<\/em>).<\/li>
                    2. Open<\/span> preview-server.xml<\/code> for editing.<\/li>
                    3. Under <previewserverspec><\/code>, set<\/strong> <defaultZoomUploadLocation<\/span>> <\/code> tag as {project path relative to Zoom root directory}<\/em>
                      If <defaultZoomUploadLocation> tag is not found then add it under <previewserverspec>.<\/div><\/li>
                    4. Save<\/span> and close<\/span> the file.<\/li>
                    5. Restart<\/strong> all Zoom Services on your Zoom Server in the order described<\/span> above<\/a>.<\/li><\/ol>\n\n\n\n

                      Your chosen upload location (project) is now set. New uploads from the Web Client will now be saved to the new location after the browser cache is cleared<\/span>.<\/p>\n\n\n\n

                      Zip File Handling<\/h2>\n\n\n\n

                      By default, uploaded zip files are automatically unzipped and each extracted file is added as a separate asset in the Zoom repository. Follow these steps to have Zoom add an uploaded zip file as an individual asset:<\/p>\n\n\n\n

                      1. On the Zoom Preview Server<\/span>, navigate<\/span> to the conf>server-settings>settings<\/span> folder in Zoom Install directory (For Windows \u2013 [ZoomInstallDir]\\conf\\server-settings\\settings\\<\/em> and for Linux \u2013 [ZoomInstallDir]\/conf\/server-settings\/settings\/<\/em>).<\/li>
                      2. Locate <\/span>preview-server.properties<\/code>. Create<\/span> this file, if it does not exist.<\/li>
                      3. Open<\/strong> this file for editing.<\/li>
                      4. Set<\/strong> EXTRACT_ZIP_ON_UPLOAD=false<\/code><\/li>
                      5. Save<\/span> and close<\/span> the file.<\/li>
                      6. Restart<\/strong> all Zoom Services on your Zoom Server in the order described<\/span> above<\/a>.<\/li><\/ol>\n\n\n\n

                        An uploaded zip file will now be added as-it-is to the Zoom repository when the Web Client is launched after the browser cache is cleared<\/span>.<\/p>\n\n\n\n

                        Duplicate File Handling<\/h2>\n\n\n\n

                        When a file is imported that has the same name as an existing asset, as default behavior, Zoom will create a new version of the existing file instead of uploading the file as a new asset. This behavior may be changed to let Zoom delete the existing asset and upload the new file as another asset. Follow these steps to change the handling of duplicate files:<\/p>\n\n\n\n

                        1. On the Zoom Preview Server<\/span>, navigate<\/span> to the conf<\/span> folder in the Zoom Install directory (For Windows \u2013 [ZoomInstallDir]\\conf\\<\/em> and for Linux \u2013 [ZoomInstallDir]\/conf\/<\/em>).<\/li>
                        2. Open<\/span> preview-server.xml<\/code> for editing.<\/li>
                        3. Set<\/strong> <onDuplicateDetect><\/code> tag to either MERGE or REPLACE.

                          When the value is set to REPLACE, Zoom will delete the existing asset and upload the new file as a new asset. <\/p>When the value is set to MERGE, Zoom will upload the new file as a new revision of the existing asset. This is the default<\/strong> setting.<\/span><\/li>

                        4. Save<\/span> and close<\/span> the file.<\/li>
                        5. Restart<\/strong> all Zoom Services on your Zoom Server in the order described<\/span> above<\/a>.<\/li><\/ol>\n\n\n\n

                          The chosen duplicate file handling option is saved and is enforced after the browser cache is cleared<\/span>.<\/p>\n\n\n\n

                          Default Metadata<\/h2>\n\n\n\n

                          While uploading files through the Web Client, default metadata values may be automatically attached to each added asset. To achieve this, firstly, mandatory metadata should be enforced from the Web Management Console<\/span>. The values for mandatory metadata (to be attached to an uploaded asset)<\/span> are fetched from a Blanket metadata file on the Preview Server.<\/p>\n\n\n\n

                          Follow these steps to enforce mandatory metadata:<\/p>\n\n\n\n

                          1. In your Web Management Console, log in<\/strong> as an admin.<\/li>
                          2. Open<\/strong> Server Control Panel<\/span> under System<\/span> node in the Admin Menu<\/span> sidebar.<\/li>
                          3. Click<\/strong> Repository Settings<\/span> on the Server Control Panel<\/span> page.<\/li>
                          4. Select<\/strong> Enforce Mandatory Metadata on every Check-In<\/span> checkbox and click<\/strong> Save<\/span>.<\/li>
                          5. Click<\/strong> Yes<\/span> to restart the Zoom Server.<\/li><\/ol>\n\n\n\n

                            Mandatory metadata is now enforced.<\/p>\n\n\n\n

                            Next, follow these steps to create and configure a blanket metadata file:<\/p>\n\n\n\n

                            1. Create a text file that has one or more metadata value pairs in the following format: MetadataGroupCode_MetadataFieldName=MetadataValue

                              A sample metadata file would have such entries:<\/p>

                              IPTC_Country=India<\/p>IPTC_City=Gurugram<\/span><\/div>

                              The metadata file may be created anywhere. It is a text file that specifies all metadata value pairs that would be attached to assets uploaded from the Web Client.<\/p> <\/li>

                            2. On the Zoom Preview Server<\/span>, navigate<\/span> to the conf<\/span> folder in the Zoom Install directory (For Windows \u2013 [ZoomInstallDir]\\conf\\<\/em> and for Linux \u2013 [ZoomInstallDir]\/conf\/<\/em>).<\/li>
                            3. Open<\/span> preview-server.xml<\/code> for editing.<\/li>
                            4. Under <previewserverspec><\/code>, update <defaultBlanketMDFile><\/code> tag to {Metadata filename with absolute path}<\/em><\/li>
                            5. Save<\/strong> and close<\/span> the file.<\/li>
                            6. Restart<\/strong> all Zoom Services on your Zoom Server in the order described<\/span> above<\/a>.<\/li><\/ol>\n\n\n\n

                              The default metadata values are now configured, these are enforced when the Web Client is launched after the browser cache is cleared<\/span>. Every time an asset is uploaded from the Web Client, these metadata values will be attached to it.<\/p>\n\n\n\n

                              Number of Assets on a Page<\/h2>\n\n\n\n

                              By default, 60 assets are shown at a time in the Web Client Assets page. If you continue scrolling down, more assets are displayed. Image 3<\/a> shows that 60 assets are loaded of the 273 filtered assets.<\/p>\n\n\n\n

                              To change the number of assets loaded at a time on the Assets page, update zoom.properties<\/span> for the Preview Server. Follow these steps:<\/p>\n\n\n\n

                              1. On the Zoom Preview Server<\/span>, make sure<\/strong> that hidden files are visible.<\/li>
                              2. Navigate<\/span> to the .zm<\/span> folder in System Home folder for user Evolphin on Linux or in the System folder for Windows.
                                For the user John on Windows, the path would typically be C:\\Windows\\System32\\config\\systemprofile\\.zmFor the user evolphin on Linux, the path would typically be $home\/evolphin\/.zm<\/div><\/li>
                              3. Locate <\/span>zoom.properties<\/code>. Create<\/span> this file, if it does not exist.<\/li>
                              4. Open<\/strong> this file for editing.<\/li>
                              5. Set<\/strong> VAB_PER_PAGE_ENTRIES={number of files per page}<\/code>.
                                The default value for VAB_PER_PAGE_ENTRIES<\/span> = 60.<\/div><\/li>
                              6. Save<\/span> and close <\/span>the file.<\/a> <\/li>
                              7. Restart<\/strong> all Zoom Services on your Zoom Server in the order described<\/span> above<\/a>.<\/li><\/ol>\n\n\n\n
                                \n

                                The chosen number of assets is now configured to be displayed on the Assets page when the Web Client is launched after the browser cache is cleared<\/span>.<\/p>\n<\/div>\n\n\n\n

                                \"Assets<\/a>
                                Image 3: Browsing Assets<\/figcaption><\/figure>\n\n\n\n

                                Faceted Filters for Viewing Assets<\/h2>\n\n\n\n

                                Assets may be filtered while viewing in the Web Client. Image 3<\/a> shows filters ‘Project Vault’, ‘Keywords’ and ‘File Types’ in effect.<\/p>\n\n\n\n

                                These filters may be picked from the Faceted Search Categories<\/a> listed in the Asset Browser. The search categories are:<\/p>\n\n\n\n

                                1. Project Vault – filtering assets on the basis of the project that these belong to.<\/li>
                                2. Metadata Properties – filtering assets on the basis of the chosen metadata field(s).<\/li>
                                3. Keywords – filtering assets on the basis of keywords assigned to them.<\/li>
                                4. File Types – filtering assets on the basis of file type filters set in the Asset Browser. Click here<\/a> to know more about adding or removing these file types filters. All file-type filters present in the Asset Browser are visible under the File Types filter when it is used in the Web Client.<\/li>
                                5. Path Status – filtering assets on the basis of their archived\/deleted\/expired status in Zoom.<\/li><\/ol>\n\n\n\n

                                  To use these faceted filters as described below, use the following code to refer to each filter:<\/p>\n\n\n\n

                                  Filter<\/strong><\/td>Code<\/strong><\/td>Remarks<\/strong><\/td><\/tr>
                                  Project Vault<\/td>project_name<\/td> <\/td><\/tr>
                                  Metadata Properties<\/td>metadata_key|[GroupCode_FieldName]<\/td>\n

                                  For example, to add metadata Video Codec from the Video Properties metadata group use the code:<\/p>\n

                                  metadata_key|VDEO_VideoCodec<\/p>\n<\/td><\/tr>

                                  Keywords<\/td>keyword<\/td> <\/td><\/tr>
                                  File Types<\/td>file_type_filter<\/td> <\/td><\/tr>
                                  Path Status<\/td>path_status<\/td> <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

                                  These asset filters are configured in preview-server.xml<\/span>. Follow these steps to change filters:<\/p>\n\n\n\n

                                  1. On the Zoom Preview Server<\/span>, navigate<\/span> to the conf<\/span> folder in the Zoom Install directory (For Windows \u2013 [ZoomInstallDir]\\conf\\<\/em> and for Linux \u2013 [ZoomInstallDir]\/conf\/<\/em>).<\/li>
                                  2. Open<\/span> preview-server.xml<\/code> for editing.<\/li>
                                  3. Under <previewserverspec><\/code>, update<\/strong> <webClientFilters><\/code> tag to {semicolon-separated Desired Filters code list}<\/em>.

                                    The default value of the <webClientFilters><\/code> tag is:<webClientFilters>project_name;metadata_key|IPTC_City;keyword;file_type_filter<\/webClientFilters><\/p>This gives us four default filters named ‘Project Vault’, ‘City’, ‘Keywords’ and ‘File Types’. <\/span>

                                    To add another metadata field IPTC Country in the end of these filters, update the tag as below:<webClientFilters>project_name;metadata_key|IPTC_City;keyword;file_type_filter;metadata_key|IPTC_Country<\/webClientFilters><\/p><\/div><\/li>

                                  4. Save<\/span> and close<\/span> the file.<\/li>
                                  5. Restart<\/strong> all Zoom Services on your Zoom Server in the order described<\/span> above<\/a>.<\/li><\/ol>\n\n\n\n

                                    The new faceted filters are now set when the Web Client is launched after the browser cache is cleared<\/span>.<\/p>\n\n\n\n

                                    Custom faceted filter labels<\/h2>\n\n\n\n
                                    This feature is not available from Zoom 7.3 onwards.<\/div>\n\n\n\n

                                    Faceted categories are shown as filters while viewing assets. These category filter names may be changed as per your convenience. Image 3<\/a> shows the names ‘Project Vault’, ‘Keywords’ and ‘File Types’.<\/p>\n\n\n\n

                                    To change the names displayed for the filters, modify the following property:<\/p>\n\n\n\n

                                    1. On the Zoom Server<\/span>, navigate<\/span> to the conf\/client-settings<\/span> folder in Zoom Install directory (For Windows \u2013 [ZoomInstallDir]\\conf\\client-settings\\<\/em> and for Linux \u2013 [ZoomInstallDir]\/conf\/client-settings\/<\/em>).<\/li>
                                    2. Locate <\/span>zoom.properties<\/code> . Create<\/span> this file, if it does not exist.<\/li>
                                    3. Open<\/strong> this file for editing.<\/li>
                                    4. Set<\/strong> FACETED_CATEGORY={Semi-colon separated list of CategoryName->Label pairs}<\/code>

                                      If we wish to change the category names ‘project_name’ to ‘Brand Vault’ and ‘keyword’ to ‘tag’ then sample entry would be: <\/span><\/p>

                                      FACETED_CATEGORY=project_name->Brand Vault;keyword->tag<\/p>Metadata fields cannot be renamed this way.<\/span><\/div><\/li>

                                    5. Save<\/span> and close <\/span>the file.<\/li>
                                    6. Restart<\/strong> all Zoom Services on your Zoom Server in the order described<\/span> above<\/a>.<\/li><\/ol>\n\n\n\n

                                      The faceted filter labels are now updated when the Web Client is launched after the browser cache is cleared<\/span>.<\/p>\n\n\n\n

                                      Email Domains for Invited Collection Sharing<\/h2>\n\n\n\n

                                      You can set email domains to be allowed or blocked while sharing a collection using an email invite. A few things to remember here are:<\/span><\/p>\n\n\n\n