Skip to main content
Version: 2.7.0

Get help

Hyground explains each of its pages in the web UI. It also gives you three ways to report a problem. They are the feedback form, the rating under a reply of the agent, and the error report. For symptoms and their causes, see Troubleshooting.

Open the help for a page​

  1. Click the question mark icon at the bottom of the left navigation. Its tooltip reads Help & guidance.

    The question mark icon at the bottom of the left navigation is marked.

  2. Read the sections in the panel. They describe the page you are on.

  3. Click the cross to close the panel.

Click View the full documentation instead of the cross to open the Documentation page. The panel closes.

The panel always describes your current page. Open it again after you move to another page.

Read the documentation in the web UI​

  1. Click the book icon at the bottom of the left navigation. Its tooltip reads Documentation. The Documentation page opens.

    The book icon at the bottom of the left navigation is marked.

  2. Click an entry in the Contents list beside the left navigation. The page scrolls to the section of that entry.

The page holds one section for each page of your installation. Each section has an arrow that opens that page.

Send feedback​

  1. Click the gear icon at the bottom of the left navigation. The settings menu opens.

  2. Click Send feedback. The Share product feedback dialog opens.

    The open settings menu shows the Send feedback entry marked.

  3. Optional: select a Category. You can choose Feature request, UX issue, Bug, or Other.

  4. Type your feedback in the text box. Send feedback stays inactive until you type.

  5. Click Send feedback in the dialog.

Hyground then shows Thanks for your feedback!

Rate a reply​

  1. Click the thumbs up icon or the thumbs down icon under a reply of the agent. Their tooltips read Good response and Bad response. A panel opens.

    The thumbs up and thumbs down icons under an agent reply are marked.

  2. For Bad response, select one reason or more. The panel offers these reasons:

    • Inaccurate / Incorrect
    • Not helpful
    • Missing context
    • Too verbose
    • Hallucinated / Made up
    • Confusing / Unclear

  3. Optional: write more in the box that reads Additional details (optional).

  4. Click Submit. The button stays inactive until you select a reason or write a comment.

Hyground then shows Thanks for your feedback!

For Good response the panel asks what worked well and offers no reasons. Only a comment activates Submit there.

If you close the panel without Submit, Hyground keeps your rating without a reason.

To change your rating, click the other thumbs icon. The new rating replaces the old one.

Report an error​

Hyground opens the Something went wrong dialog when an error occurs. The dialog holds a reference for that error.

  1. Read the code beside Reference. The dialog shows its first characters only.
  2. Click the copy icon to copy the full reference. Its tooltip reads Copy full reference.
  3. Click Report this error. The button then reads Reported.
  4. Click Dismiss to close the dialog.

Quote the reference when you contact your administrator. If the dialog reads No reference is available for this error. instead, it offers no report button.

Where else to look​

  • Troubleshooting lists symptoms and what to do.
  • FAQ answers short questions.
  • Your data explains what a session stores.
  • Your administrator answers questions about the systems that Hyground reaches.