Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Step 12: Enabling Elastic search

Updated on September 18, 2020

Enable Elastic search to enhance the data retrieval process and to improve the search capabilities across the system. Enabling Elastic search re-indexes the Data and Work classes only in the Pega Foundation for Healthcare core layer. Therefore, if you imported sample data, you must re-index the Data and Work classes after enabling Elastic search in order to view the sample codes, sample code groups, and sample common object instances in the portals of the demo application.

  1. In the header of Dev Studio, Click Records > SysAdmin > Dynamic System Settings.
  2. Verify that Elastic search is enabled by checking that the value for the following dynamic settings is true:
    • indexing/distributed/enabled
    • indexing/distributed/index_enabled
    • indexing/distributed/search_enabled
    • indexing/distributed/search/fuzzy/enabled
    • indexing/useDataInstances
  3. If any of the values is not set to true, click the setting and update the value, and then click Save. If any of the settings do not appear in the list, you can search for that setting. If necessary, add the setting and set the value to true.
  4. Configure the number of shards for each Elastic search index and Thread pool settings by modifying the following Dynamic system settings:
    • Number of shards – Configure the number of shards for Work, Data and dedicated indices using a DASS setting:

      DASS: indexing/distributed/numshards

      Ruleset: Pega-SearchEngine

      Default: 3 (for newly created work, data and dedicated indices)

    • Threadpool settings:

      Threadpool settingElastic search default valuePega's default in Embedded mode (up to 8.1)DASS to configure
      thread_pool.index.size# of available processors1indexing/distributed/index_threadpool_size ((# of available processors * 3) / 2) + 11indexing/distributed/search_threadpool_size
      thread_pool.bulk.size# of available processors1indexing/distributed/bulk_threadpool_size
      thread_pool.force_merge.size# of available processors-indexing/distributed/forcemerge_threadpool_size
      thread_pool.refresh.maxMin (10, (# of available processors) /2)-indexing/distributed/refresh_threadpool_size
      • Create all settings in the Pega-SearchEngine ruleset.
      • The Thread pool type used for refresh is “scaling.” The DASS sets the max size of thread pool.
      • Thread pool settings are applicable only to the Embedded mode.
  5. Re-index the Data and Work classes:
    1. Click Configure > System > Settings > Search.
    2. On the Search tab, on the System Settings screen, select the All data and All work classes check boxes.
    3. Click Re-index to the right of a row to re-index that class.
  • Previous topic Step 11: Implementing Elastic search on HIPAA security policy
  • Next topic Step 13: Defining the security model and organization structure

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us