Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Controlling user access to search indexes

You use the query settings for an index collection to specify who is allowed to search that index.

You can create multiple sets of query settings per index collection. Each set of query settings can provide a different level of index access to that index to a different group of users.

You can also configure an index to be publicly searchable by all users.

NoteThe local admin user account has access to all search indexes. If multiple sets of query settings, including public, are enabled, the public query settings apply to the admin user. If public is disabled but multiple private query settings are enabled, the local admin account gets the settings from the first set in the list.

Granting limited access to a search index

Each index collection can also have any number of private query settings. When a private set of query settings is enabled, users in groups associated with that set of query settings can search the index.

You can associate a group with only one set of private query settings per index collection.

Procedure

  1. Create an index collection. For information, see Adding index collections.

    When doing this, set Initial Visibility to Private.

    NoteYou can change this at any point by enabling and disabling query settings for the index collection. For information, see Enabling and disabling query settings.
  2. Create a set of private query settings for the index collection. Configure the query settings to provide the search experience you intend for your users. For information, see Query setting configuration options.

  3. Enable the query settings you created. For information, see Enabling and disabling query settings.

    NoteA user might belong to more than one group, and thereby be associated with more than one set of private query settings. In this case, if multiple query settings are enabled, the user gets the search experience from only one of those query settings, the one that was created first.
  4. Click the Security tab for the index.

  5. Click Add Group.

    The Select a group to add menu appears and lists the groups that your administrator has added to the system.
  6. Select both a group and a set of query settings to associate with that group.

    NoteFor a group to be able to search an index, your system administrator also needs to grant Search Query permissions to the group.

Granting public access to a search index

Each index collection has a special set of query settings called Public. When it's enabled, all users can search that index.

If the Public query settings are disabled, users can search an index only if:

  • They belong to a group that's associated with a private set of query settings for the index collection.
  • The applicable set of private query settings is enabled.

See Granting limited access to a search index.

Procedure

  1. Create an index collection. When doing this, set Initial Visibility to Public.

    For information, see Adding index collections.

  2. Configure the Public query settings to provide the search experience you want to provide to all users accessing searching this index.

    For information, see Query setting configuration options.

  3. Click the Security tab for the index.

  4. Click Add Group.

    The Select a group to add menu appears and lists the groups that your administrator has added to the system.

  5. Select both a group and a set of query settings to associate with that group.

    NoteFor a group to be able to search an index, your system administrator also needs to grant Search Query permissions to the group.

Enabling multiple query settings for an index collection

This table summarizes how query settings affect what search experience a user receives. It supposes that:

  • A single index collection has three sets of query settings: Public, Private 1, and Private 2.
  • User1 belongs to a group that is associated with only the Private 1 set of query settings.
  • User2 belongs to a group that is associated with only the Private 2 set of query settings.
NoteA user might belong to more than one group, and thereby be associated with more than one set of private query settings. In this case, if multiple query settings are enabled, the user gets the search experience from only one of those query settings, the one that was created first.

Public enabled Private 1 enabled Private 2 enabledWhich query settings apply
Local admin accountUser1User2
NoNoNoNo accessNo accessNo access
NoNoYesPrivate 2No accessPrivate 2
NoYesYesPrivate 1Private 1Private 2
YesYesYesPublicPrivate 1Private 2
YesYesNoPublicPrivate 1Public
YesNoNoPublicPublicPublic
NoYesNoPrivate 1Private 1No access
YesNoYesPublicPublicPrivate 2

 

  • Was this article helpful?