Skip to main content
Version: 2.13.0

Get help

Hyground explains each of its pages in the web UI. It holds this User Guide. It also lists what each release changed.

Hyground gives you four ways to report a problem. They are the feedback form, the rating under a reply of the agent, the error report, and the support bundle. 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 summary in the panel. It describes the page you are on.

  3. Click the cross to close the panel.

On some pages the panel adds a short note under the summary. The note warns you about the behavior of that page. Read it before you use the page.

The panel also holds links into the documentation:

  • Read this in the User Guide opens the guide page for the page you are on.
  • View the full documentation opens the Documentation page.

Each link closes the panel. On the Documentation page the panel holds no link, because you are already in the guide.

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 a page in the Contents list beside the left navigation. That page opens.

The Documentation page holds this User Guide. It opens at User Guide, the first entry in the Contents list.

The Contents list names every page of the guide. Most pages sit under a group name, such as Start here. Click a group name to open or close its pages.

A link inside a guide page opens the page it names. You stay on the Documentation page.

The guide is in English only. The Documentation page tells you so when your language is not English. Set your language under Language in the settings menu. The rest of Hyground stays in your language.

Read what each release changed​

  1. Click the clock icon at the bottom of the left navigation. Its tooltip reads Change log. The Change log page opens.

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

  2. Read the entries. Each entry names a version and its date, then lists what that release changed.

The Milestones list beside the left navigation names each version on the page with its date. Click a version. The page scrolls to the entry of that version.

The Home page can also show the newest entry under What's new. Click View all updates below it to open the Change log 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.

Submit closes the panel. To close the panel without Submit, click somewhere else in the session or press Escape. Hyground then keeps your rating without a reason.

The panel stays open while the agent writes. The newest lines do not stay in view while the panel is open. Close the panel to follow the reply again.

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.

Ask for a support bundle​

Ask the agent for a support bundle in a session. The agent asks about the problem. It can also ask you to export the session with the problem and to attach the file. See Export a session. The agent then attaches a zip file to its reply. The file holds health information and logs from your installation. Hyground redacts credentials and email addresses in the file automatically. Download the file, inspect it, and attach it to your support request.

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.
  • Hyground support reads the support bundle that the agent assembles for you.