Configure Helix Search

The name that is shown in the Helix Core Server log.

The product version that is shown in the Helix Core Server log. Default value, the installed version of Helix Search.

Set the log file name the Helix Search log is saved as.

The location of the configuration file in the file system.

The host IP address for the Helix Search service.

The port number for the Helix Search service.

The protocol used for the Helix Search service. Options are: http or https.

Only if protocol is set to https. The location of the Java Keystore, see Configure SSL security for Helix Search.

Only if protocol is set to https. The location of the Java Keystore, see Configure SSL security for Helix Search.

Location of the Helix Search's local trust store.

Password for the Helix Search's local trust store. This password is randomly generated.

Cross Origin Resource Sharing (CORS). Specify origins for the browser to allow resource access. Include your domain along with the protocol and port number. Supports comma separated values. For example, https://*.mydomain.com:1601,https://*.mydomain.com:1602

If the CORS value is left blank, the external URL value is used as an allowed origin along with the protocol and port number. To secure your site, https protocol must be used.

The retry interval used by Helix Search when locating ElasticSearch and Helix Core Server Services (milliseconds).

An X-Auth-Token to validate configuration requests.

The URL of the Helix Search help documentation. Enables you to change the URL of the help document. For example, if you are running an isolated system and need to host it on your own server.

The URL of your Helix Search instance as seen by other applications. For example, this external URL can be used by Helix Core Server or Helix DAM to connect to a specific instance of Helix Search.

The number of live log lines to be displayed through the websocket.

The number of requests per minute for all API endpoints. Default value, 600 requests.

The number of login requests per minute for all API endpoints. Default value, 5 requests.

The duration after which the JWT Access token expires. Default value, 600 seconds.

Ensure that the value of the JWT access token is always smaller than the value of the JWT refresh token.

The Helix Core Server RPC host and port. For example, perforce.com:1666 or ssl.perforce.com:1666 if protocol is set to https.

The p4trust trusted fingerprint.

A comma-separated list of trusted IP addresses for Proxy services. For example, the IP address for your Swarm instance.

A Standard or Service user with a minimum of admin access. Used to authorize the proxy connection at security level 5 and above. For instructions on creating the Perforce Service User and printing out the ticket, see Create the Perforce Service user .

The long lived ticket to authorize the Perforce Service User. To print out a long lived ticket for the Perforce service user that is valid for all hosts, run the following command : p4 -p <p4port> -u <p4user> login -a -p

Optional: A Standard user with super access. Used to read content from the Helix Core Server, to set file attributes, and to install extensions. For instructions on creating the Perforce Index User and printing out the ticket, see Create the index user . If the index user is not defined, the Perforce Service user is used.

The long lived ticket to authorize the index user. To print out a long lived ticket for the index user that is valid for all hosts, run the following command : p4 -p <p4port> -u <p4user> login -a -p

Optional: An Anonymous user with read access in the Helix Core Server for the areas of the depot you want to allow search result access to. The anonymous search user is used for the unsupported search web pages. For instructions on setting the Anonymous User and printing out the ticket, see Create the anonymous search user (optional). If the anonymous user is not defined, anonymous access is disabled.

The long lived ticket to authorize the anonymous search user.

The P4IGNORE file name.

Name for the ElasticSearch Helix Core Server index. If you are using multiple instances of Helix Search ensure that you use a different index name for each instance.

Set to true to index restricted Helix Core Server changelists.

For use with Helix DAM only: A comma separated list of Helix Core Server file revision attribute tags to index. Any tag that begins with an index tag value in the list is indexed. The index tags are not case sensitive.

For example:

com.perforce.p4search.index.tags=DAM,FOO

If DAM and FOO are index tags, Helix Search will index any tag that begins with DAM or FOO. In this example, the DAM_TAG_bar, DAM_tag_lorry, and FOO_bar tags would all be indexed but a tag called TAG_DAM would not be indexed.

Maximum ElasticSearch batch size when indexing data.

The number of threads Helix Search uses when indexing Helix Core Server changelists.

Set to true to generate the blur and thumbnail/preview images when indexing is run, defaults to true.

• Blur images are stored on the Helix Core Server as an attribute of the original image file and indexed in Elasticsearch. They consist of a 4 pixel image stored as a Hash String that loads extremely quickly. Helix DAM displays the blur images for search queries while the thumbnail/preview images are loaded.

• Thumbnails/previews are stored on the Helix Core Server as an attribute of the original image files. They are up to 240 x 240 pixels depending on the original image's aspect ratio. P4V and Helix DAM use the thumbnails for image preview.

Thumbnail/preview image size in pixels. Set to 0 to disable preview generation.

Thumbnail/preview image type only supports jpg and webp image file types.

Set to Enable to enable Tesseract OCR.

The location where the live index journals are stored. This location is relative to the Helix Search install location. For example, com.perforce.p4search.index.journal-path=./jnl

A comma separated list of host addresses for ElasticSearch. For example, http://localhost:9200,http://localhost:9201

Elastic Search User for P4Search.

Elastic Search Password for P4Search.

To filter user search results based on their Helix Core Server permissions (output of the p4 protect command), set to true.

This requires the installation of the Helix Core Server p4search-filter plugin for Elasticsearch, see the Elasticsearch plugin documentation. Use of the Helix Core Server p4search-filter plugin will introduce a small overhead in the query time. This is mainly determined by the number of protection entries that are applied to the user running the query. In some situations you might want to disable the filter if Helix Search only contains indexed data that is visible to all users.

Maximum accurately counted total hit by ElasticSearch. To tune performance, set a limit to the number of results processed by a single query.

Timeout when parsing a file through Tika (in milliseconds).

Enable auto-tagging by specifying the detection model. Empty disables auto-image tagging.

Valid models are:

• DeepDetectModel

• AzureTagsModel

• RekognitionLabelsModel

• GoogleLabelModel

The host IP address for the auto-tagging service.

The language you want the image tags to be generated in. See your auto-detect engine for supported languages.

The API key for the auto-tagging service you are using.

The automatic image detection threshold as a floating point percentage. For example, 0.1=10%

The automatic best image detection results limit.

Enable image Optical Character Recognition (OCR) by specifying the OCR model. Empty disables auto-OCR.

Valid models are:

• AzureOcrModel

• RekognitionOcrModel

• GoogleOcrModel

The host IP address for the auto-tagging service.

The language you want the image tags to be generated in. See your auto-detect engine for supported languages.

Enable speech-to-text recognition by specifying the auto-speech model. Empty disables auto-speech.

Valid models are:

• AzureSpeechModel

• AmazonTranscribeModel

• GoogleSpeechModel

• WhisperSpeechModel

The host IP address for the auto-speech service.

The language of the audio you want to be transcribed.

This configurable is optional for WhisperSpeechModel.

The API key for the auto-speech recognition service you are using.

This configurable is optional for WhisperSpeechModel.

Set the automatic speech recognition threshold for your auto-speech service as a floating point percentage. The automatic speech recognition threshold is the accuracy returned by your auto-speech service. For example, 0.6=60%.

In this example when auto-speech threshold is set to 0.6, any transcription with 60% accuracy is accepted by the auto-speech service and anything below that is discarded.

Set the audio transcribe limit for your auto-speech service in seconds. Currently the default audio transcribe limit is set to 60 seconds and anything above that is discarded.

The name of the cloud storage bucket or container where the large audio files will be stored.

The render service implementation. For example, AWSRenderService or LocalRenderService.

Optional: The rendering service host IP address. For example, http://localhost:1602

The rendering service API security key for use with AWSRenderService. The LocalRenderService uses the X-Auth-Token configured in Index Auth Token.