Configure Find to Add User Identifiers to Queries

You can configure Find to add additional parameters to identify the user in the IDOL backend actions that use search filters (such as Query and GetQueryTagValues). When you use QMS, you can use this option if you want to use custom query adjustment for different users. You might also want to use it to make it easy to troubleshoot.

To use this option, you set the idol.user.request.prefix system property to a prefix to use for the user parameters. When you set this property, Find adds a parameter with the specified prefix to the requests, set to the name of the user sending the request.

You can also add user fields as additional parameters, by setting the idol.user.request.fields system property to a comma-separated list of the user fields to include. Find adds each field as a parameter with the specified prefix, set to the value for that user.

To configure Find to add user parameters to queries

  1. At the command line, send the java run command with the idol.user.request.prefix argument set to the prefix to use. Optionally also set the idol.user.request.fields argument to a comma-separated list of user fields. For example:

    java -Didol.user.request.prefix=Find -Didol.user.request.fields=Department -Didol.find.home=[home directory] -Dserver.port=[port] -jar find.war
  2. Restart Find to apply your configuration changes.

This example adds the parameter FindUser=username to the search ACI actions that Find sends to your IDOL components, and adds a FindDepartment parameter, set to the value of the Department user field.

If you run Find as a service on Windows, you can also add the idol.user.request.prefix and idol.user.request.fields properties to the find.xml file.

If you run Find as a service on Linux, you can add the arguments to the existing arguments variable in the start scripts (find.sh for SystemV, find.conf for Upstart, or find.service for systemd).

When you modify the Find configuration by modifying the XML file or start scripts, you must restart Find to apply your configuration changes.

On Upstart, you must also run initctl reload-configuration before you restart, to apply the init file changes. You can then run service find restart to restart the service.