Skip to main content
Hitachi Vantara Knowledge

Using the Search Console

To use the Search Console, you need one of these:

  • A tenant-level user account that is defined in HCP
  • If HCP is configured to support Active Directory® (AD), an AD user account that is recognized at the tenant level
  • A system-level user account that is defined in HCP and has the search role
  • An AD user account that is recognized at the system level and has the search role

Additionally, to perform searches while the Data Discovery Suite search facility is active, you need an Data Discovery Suite user name and password. After logging in to the Search Console, you need to set your Data Discovery Suite user name and password in the Console. To get an Data Discovery Suite user name and password, see your HCP or Data Discovery Suite administrator.

When you log into the Search Console with a tenant-level user account that’s defined in HCP or an AD account recognized at the tenant level, you access the Console for a specific HCP tenant. You can search only searchable namespaces owned by that tenant. Your user account specifies which of those namespaces you have permission to search. If you don’t have permission to search a given namespace, search results don’t include any objects from that namespace.

When you log into the Search Console with a system-level user account that’s defined in HCP or an AD user account recognized at the system level, you can search the default namespace and you may also be able to search the searchable namespaces belonging to one or more HCP tenants. This depends on the configuration of those tenants.

Search Console URL

Tenant-level users and system-level users specify different URLs to access the Search Console. In either case, access to the Console requires the use of SSL security with HTTP (HTTPS).

NoteIf you inadvertently use http instead of https in the URL, the browser prompts you to open or save a file. Cancel out of the prompt and try again, this time using https.
Search Console URL for tenant-level users

To access the Search Console with a tenant-level user account, you use a URL with this format:

https://tenant-url-name.hcp-domain-name:8888

For example, to access the Search Console for the tenant named Finance in the HCP system named hcp.example.com, you use this URL:

https://finance.hcp.example.com:8888

Typically, HCP relies on DNS for hostname resolution. If this is not the case, you need to provide a mapping of the tenant hostname to an IP address for the HCP system. You specify this mapping in the c:\windows\system32\drivers\etc\hosts file (Windows®), the /etc/hosts file (Unix), or the /private/etc/hosts file (Mac OS® X) on the client.

Each line in a hosts file is a mapping of a hostname to an IP address. So, for example, if one of the IP addresses for the HCP system is 192.168.210.16, you would add this line to the hosts file on the client to enable access to the Search Console for the Finance tenant:

192.168.210.16 finance.hcp.example.com

For the IP addresses for the HCP system, see your HCP tenant administrator.

Search Console sessions

A Search Console session begins when you take one of these actions:

  • Log into the Console using an HCP user account.
  • Access a Console page while logged in to Windows with an AD user account that HCP recognizes. This is called single sign-on.

    For single sign-on to work, your web browser must be configured to support it.

  • Log into the Console using a recognized AD user account other than the one with which you’re currently logged in to Windows.

A session ends when you log out.

During a session, if you don’t take any action for a certain amount of time, the Console automatically logs you out if you explicitly logged in or, in the case of single sign-on, returns you to the Simple Search page. The exact amount of idle time allowed is determined by the tenant configuration.

Logging into the Search Console

  1. Open a web browser window.

  2. In the address field, enter the URL for the Search Console.

    One of these happens:
    • If all of these are true, you are automatically logged in to the Search Console, and the Simple Search page appears:
      • The tenant is configured to support AD authentication.
      • Your web browser is configured to support single sign-on with AD.
      • You are currently logged in to Windows with a recognized AD user account.

      In this case, no further action is required.

    • If the tenant is configured to support AD authentication but any of the following apply, a message appears indicating that single sign-on was not possible:
      • Your web browser is not configured to support single sign-on.
      • You are not currently logged in to Windows with a recognized AD user account.
      • You are not on a Windows computer.

      In these cases, you need to click Console login page in the message to display the Search Console login page.

    • If the tenant is not configured to support AD authentication, the Search Console login page appears.
  3. On the Search Console login page, if HCP is configured to support AD, take either of these actions in the Domain field:

    • If you’re using an HCP user account, select the fully qualified name of the HCP system.
    • If you’re using a recognized AD user account, select the AD domain in which your user account is defined.
    If HCP is not configured to support AD, the login page does not display the Domain field.
  4. In the Username field, type your user name.

  5. In the Password field, type your case-sensitive password.

    ImportantIf you’re using an HCP user account, you should change your password as soon as possible the first time you log into the Search Console.
  6. Click Log In.

    The Search Console displays the Simple Search page (shown below) or, if you logged in using a user account that’s defined in HCP and you’re required to change your password, the Account Management page. You also set your Data Discovery Suite credentials on the Account Management page if the Data Discovery Suite search facility is active.GUID-28C40D99-B227-47AE-A8E4-5264AFC1ADDD-low.png

Logging out of the Search Console

  1. Click Log out in the top right corner of the page.

    The Console returns to the login page. To continue using the Search Console, you need to log in again.
  2. If you explicitly logged in, close the browser window to ensure that other users cannot go back into the Search Console using the credentials you used to log in.

Search Console pages and navigation

Each page in the Search Console lets you perform a specific activity. To navigate among the pages, you can use the tabs at the top of the page. You can also use shortcut keys for navigation. Each link that has a shortcut key has one letter underlined. To use the shortcut key, follow the convention for the browser you’re using.

While the metadata query engine is active, on each page, the Search Console indicates how current the index is by showing the date and time before which eligible objects are guaranteed to be indexed. That is, any eligible object that was added to a namespace or that had a metadata change before the indicated date and time is guaranteed to be indexed. Objects that were added or had metadata changes after that date and time may or may not be indexed.

Search Console pages do not automatically refresh themselves while they remain open. To see the latest results for the current search, use your browser refresh button.

When you switch from one page to another, the Console does not retain the search on the original page (neither the query nor the search results). To see that search again, you can either recreate it or use the browser back button to return to it. Alternatively, you can save it before you switch pages.

Viewing search documentation

HCP documentation is available online in PDF format. To view a document from the Search Console, take either of these actions:

  • In the top right corner of the Search Console window, place the cursor on Documentation. Then, in the dropdown menu, click the document you want.
  • In the top right corner of the Search Console window, click Documentation. Then, on the Documentation page, click the document you want.

Changing your password

If you used a locally authenticated HCP user account to log into the Search Console, you can change your password in this Console. When you change your password in the Console, the password also changes for any other HCP interfaces to which your user account gives you access.

The next procedure describes how to change your password using the Search Console.

Procedure

  1. Click the Account Management tab.

  2. On the Account Management page, in the Change Password for User section:

    1. In the Existing Password field, type your current password.

    2. In the New Password field, type your new password.

      Passwords can be up to 64 characters long, are case sensitive, and can contain any valid UTF-8 characters including white space. To be valid, a password must include at least one character from two of these three groups: alphabetic, numeric, and other. When changing your password, you cannot reuse your current password.
    3. In the Confirm New Password field, type the new password again.

  3. Click Submit.

Setting Data Discovery Suite credentials

  1. In the HCP Search Console, click the Account Management tab.

  2. On the Account Management page, in the Set HDDS Credentials section, enter your case-sensitive Data Discovery Suite username and password.

  3. Click Test to ensure that your username and password are valid.

    If the test fails, contact your HCP tenant administrator. Data Discovery Suite may be unavailable, or your credentials may be invalid.
  4. Click Save.

    Note
    • Once set, your Data Discovery Suite credentials are saved for future Search Console sessions.
    • If the test fails, you can still set your Data Discovery Suite credentials by clicking Save. However, your queries will not return any results until you provide valid Data Discovery Suite credentials.

 

  • Was this article helpful?