ID: 11480

Print Friendly, PDF & Email

Curator Configuration

from Zoom 7.3 onwards

Curator configuration in Zoom 7.3 is simpler and quicker, without having to edit any XML files or installing any services manually. All required services are installed with the Zoom Server installer and then rest of Curator configuration is done using the Web Management Console only.

 

You need to set up a new Curator Server after upgrading to Zoom 7.3

After installing Zoom 7.3 on your Zoom MAM Server, you can begin configuring your Curator Server.

Designate a server to be used as the Curator Server. It could be a new or an existing server machine in your setup.

  • If it is a new server machine, install Zoom Server on this machine before proceeding further.
  • If you plan to use an existing server machine, choose any from your Zoom MAM Server or Preview Server.

Follow these steps to set up a New Curator:

On Linux:

  • On your designated Curator Server, start Zoom Curator Service. Zoom Curator service can be controlled, like other Zoom Services, with the following commands on the Linux Terminal:

           service curator-server status (Check the status of Curator service)

           service curator-server start (Start the Curator service) 

           service curator-server stop (Stop the Curator service)

           service curator-server restart (Restart Curator service)

 

On Windows:

  • On your designated Curator Server, start Zoom Curator Service. Zoom Curator Service can be controlled, like other Zoom services, from the Windows Services Manager or Task Manager.
The Curator service is not enabled by default.

 

Add New Curator:

  1. Log into your Web Management Console as an admin from one of your server machines like Zoom MAM Server, Preview Server or a new Curator Server machines (due to IP whitelisting restrictions).
    Sample URL for the Web Management Console is http://localhost:8443/
  2. Open Curator node under the System node in the Admin Menu sidebar. Open Curator Configuration from the Curator node.

  3. Click Add New Curator.

  4. Click Add to add a new curator.

  5. Specify a name for the new Curator, along with its hostname, and check the port number you plan to use with it. Enable SSL checkbox if you plan on using SSL with this Curator Server.
  6. Click Save. The settings for the curator are saved and it is listed with its name in the list of Curator Servers on that page. You can select any curator from this list and click Delete to delete the settings for that curator on the Zoom Server. You can also click Refresh to refresh this list and the data for all curators. Double-click any curator row in the list to edit that curator’s settings.
  7. You can repeat steps 4-6 to add another Curator Server.
  8. The newly added curator is also listed in the drop-down boxes for Audit Curator Name and Search Curator Name above. Select other parameters for curator settings as shown below:
    1. Content Search: select to enable full-text search on the contents of assets.
    2. Non Content Search: select to enable full-text search on non-content data of assets (like file name, metadata, etc.).
    3. Audit Content Search: select to enable search on the contents of audit logs.
    4. Audit Curator name: select Audit Curator from the list of available curators. This list shows the curators added as shown above. Indexing will run on the selected curator.
    5. Search Curator name: select Search Curator from the list of available curators. This list shows the curators added as shown above. Indexing will run on the selected curator.
  9. Click Save to save these settings. The settings are saved.
  10. Go back to the Curator Configuration page and click the Refresh button to update the Select Curator drop-down box. After refresh, the newly added curator is listed in the Select Curator box.
  11. Select your newly added curator from the Select Curator box. Once your new curator is selected from the Select Curator box, its URL is shown in the adjacent Curator URL box.
  12. Click Get Info to load this Curator’s settings in the boxes below.

  13. You can edit the Curator Server’s configuration in detail now. Update any values that you need to modify. Apart from the configuration parameters updated while adding this curator, these values are also available for editing on the various tabs as shown below:

    1. On the Curator Settings tab:
      1. Curator End Point: this is the Curator Service’s web API URL’s base path. The default value is /curator.
      2. Logs End Point: this is the Curator Service’s internal log base path. The default value is /logs.
      3. Failed Docs Notification: this is the frequency of sending email notifications to the super-admins about documents that fail to get indexed. It can be set to daily, hourly, weekly, or be disabled. The default value is Daily.
      4. Scheduler Frequency: this is the frequency (in milliseconds) with which the Curator will fetch the latest changes from the Zoom MAM Server. The default is 30000 ms.
      5. Log Level: select the logging level as needed. By default, it is set to INFO.
      6. Solr Data Directory: this is the path to the Solr database directory on the Curator Server machine, where indexing information about the Zoom repository files is stored. The default value is – [ZoomInstallDir]/db/solr-db.
      7. Solr End Point: this is the Curator Service’s internal Solr base path. The default value is /solr.
      8. Wait Time For Cores To Load(ms): this is the time to wait for Curator’s index initialization to complete before shutting down by registering a failure.
    2. On the Auto Restart tab:
      1. Enable: select this checkbox to enable auto restart on Curator Server. By default, it is set to true.
      2. Frequency: set the frequency (in days) with which the Curator Server is restarted.
      3. Date: shows the date (in mm//dd//yyyy format) of the next scheduled Curator Server restart. For example, 03/21/2018
      4. Time: shows the time(in hh:mm 24-hour format) set for the next scheduled Curator Server restart. For example, 01:00
    3. On the Zoom Server tab: the values list the Zoom Server settings. In a non-HADR setup, your single Zoom MAM Server should be added here. In case of an HADR setup, all HADR peers (Zoom Servers) that this Curator Server should connect to should be added here. List the Zoom Servers in the order in which this Curator Server should connect to these Zoom Servers.
    4. On the Preview Server tab: the values list the Zoom Preview Server settings. You need to add at least one Preview Server if you will be enabling content indexing as in the next step 13e.
    5. On the Content Index tab:
      1. Enable: select the Enable checkbox to enable content indexing on this Curator Server.
      2. Index Rule File: enter the path of index rules file here. The default is: conf/index-config.xml
      3. Max Threads: specify the maximum number of parallel threads for asset content indexing. The default value is 8
      4. Max Retry Count: specify the maximum number of attempts that this curator makes to index a document. The default value is 5
      5. Commit Frequency: specify the frequency (in milliseconds) with which changes in content indexes become searchable. It is recommended to set this higher than 15 seconds, i.e. 15000 milliseconds. The default value is: 25000
      6. Max Fuids Per Query: specify the maximum number of assets to be fetched for content indexing in a single query. The default value is 10000
      7. Max RRNs Per Query: specify the maximum number of repository revisions (RRN) to be fetched for content indexing in a single query. The default value is 100
    6. On the Non Content Index tab:
      1. Enable: select the Enable checkbox to enable non-content indexing on this Curator Server.
      2. Max Threads: specify the maximum number of parallel threads for asset metadata indexing. The default value is 8
      3. Max Retry Count: specify the maximum number of attempts that this curator makes to index a document. The default value is 5
      4. Commit Frequency: specify the frequency (in milliseconds) with which changes in metadata indexes become searchable. It is recommended to set this higher than 15 seconds, i.e. 15000 milliseconds. The default value is: 25000
      5. Max Fuids Per Query: specify the maximum number of assets to be fetched for metadata indexing in a single query. The default value is 10000
      6. Max RRNs Per Query: specify the maximum number of repository revisions (RRN) to be fetched for metadata indexing in a single query. The default value is 100
      7. Max Metadata Transactions Per Query: specify the maximum number of metadata change operations whose asset’s meta-information is obtained in a single query. Higher values mean faster indexes.
    7. On the Audit Settings tab:
      1. Enable: select the Enable checkbox to enable audit logging on Curator Server.
      2. Max Threads: specify the maximum number of parallel threads for audit logging. The default value is 8
      3. Commit Frequency: specify the frequency (in milliseconds) with which changes to the audit-log become searchable. The default value is 25000
      4. Max Retries: specify the maximum number of attempts this Curator makes to index audit logs. The default value is 5
  14. After making the desired changes, click Save. Your settings are saved and Zoom Curator Services are restarted automatically for the changes to take effect.

  15. The curator configuration is now complete. Your new curator is ready and starts indexing as per your settings. You can check the indexing progress on the Curator Dashboard.
  16. Click on Curator Dashboard under the Curator node in the Admin Menu sidebar.

  17. Once your new curator has indexed the assets, these will be listed under Assets Indexes.

 

You can add more Curator Servers as needed but it is recommended to have these on separate machines.
You can manually restart all Zoom Services on the Curator Server and Zoom MAM Server after making these configuration changes to make sure all settings are loaded successfully.
 
 
If you need to access Curator Settings anytime after setting up your Curator Server(s) as explained above then you can check the Curator Server Settings in the Server Control Panel.
  1. Log into the Web Management Console as an admin. Open Server Control Panel node from System node in the Admin Menu sidebar. Click on Curator Server Settings in the Server Control Panel page.

  2. Update the settings for using Content, Non Content, and Audit Search. Choose your Audit and Search Curators as needed. Click Save to save these changes. You could also add, edit, or delete Curators from the Curators list.

  3. Restart your Curator Services for the changes to take effect.

 

The file-types, for which content indexing and searching is available, are all listed in the Indexabletype.properties file, present in the conf folder (Windows: [ZoomInstallDir]\conf Linux: [ZoomInstallDir]/conf).

Administrators can add any file-type extension in this file to enable content indexing for that file-type. Removing an entry from this properties file will cause that file-type to be excluded from indexing from then on.

Indexing of the JSON, CSV, and XML file formats is performed as plain text files.

From Zoom 6.0 onwards, file content searching is not restricted to any specific set of languages by default.

 

On searching for a particular word, all files containing the input word in full or as part of another word will be returned as matches.

Search for “data” will fetch files containing “data”, “metadata”, “undatable” etc.

Phrase Search or Exact Match Search

To search for an exact phrase or word, enclose it with quotes – ” “.

 

List of Unsupported Special Characters for “Search Everywhere” in Asset Browser

# < >

List of Special Characters for “Advanced Search” in Asset Browser

The Asset Browser’s Advanced Search supports regular-expression search (with shell wild-card *). So when non-content search is enabled, if the following special characters need to be searched literally, devoid of their regular-expression meaning, they must be prefixed with a \.

& < > \ { } # +

e.g. text\# \<tag\>

 

If you encounter out of memory exceptions, then increase the Java heap size in conf/solr-server.conf inside the Zoom_Installation_Directory.
wrapper.java.additional.9=-Xmx2g
Here 2g represents 2GB RAM; increase this value accordingly.

If you encounter PERFORMANCE WARNING error often in bin/logs/solr.log, you can increase the number of maxWarmingSearchers. Do this only when confident of the available system resources (RAM, CPU, etc…).
Update the count <maxWarmingSearchers>2</maxWarmingSearchers> in conf/solr-core/ID/conf/solrconfig.xml file inside the Zoom_Installation_Directory.