Q-Director: research and documentation
The Research & Docs tab decides whether Sherlock research is posted to HaloPSA, shapes the research note and its effort, and sets how your documentation is searched.
Written By Chris Scaminaci
Last updated About 2 hours ago
The Research & Docs tab of Q-Director Settings controls Sherlock, the research QuantumOps runs on a ticket: whether the findings are written to the HaloPSA ticket, the shape of the note, how much work each run may do, and whether your documentation is searched. Administrators use it.
Before you start: you need the Administrator or the Q-Director Configuration role. Documentation search also needs the Documentation module on, and at least one documentation source connected (see Documentation sources). The tab has four parts. The Research Output Profile and Company glossary cards save their own rows. The other two parts are kept when you select Save Changes at the top of the page.
Post research results to HaloPSA
The Research & Sherlock Module section has one switch, Post Sherlock research results to ticket. It adds the research findings to the HaloPSA ticket as a note. It is off for a new organisation.
With the switch off, research still runs and the findings still show in QuantumOps, including the Copilot tab and the browser extension's Ticket tab. They never reach HaloPSA, so anyone who works only in HaloPSA does not see them. Sherlock research and live context explains what the research covers, and What QuantumOps writes into HaloPSA shows the note.
Under the switch, a hint shows the recommended research effort for the Effort setting below.
Shape the research note
The Research Output Profile card sets how research findings are written. The Halo ticket note and related settings apply only while Post Sherlock research results to ticket is on. QuantumOps always keeps the full findings for its own panels.
Choose the Halo ticket note:
- Summary posts the headline findings only. This is the default.
- Full posts every section you select below.
- None keeps the findings in QuantumOps and posts nothing to HaloPSA.
Choose Halo note: when to post again. Each full re-analysis of a ticket runs research again, and this decides whether it posts another note:
- First time only posts one note per ticket. Later re-analyses update QuantumOps only.
- When findings change posts again only when the recommendation, the similar tickets or the confidence (by 20 points or more) changed, and the note says what changed. This is the default.
- Every research pass posts a new note each time, so a busy ticket can collect several.
Set Maximum sentences / items (1 to 12, default 3). It caps each prose field, such as the summary and the recommendation, and each list. A value of 1 to 3 gives a concise note.
Choose the Format: Bullet list (default) or Narrative (short prose).
Choose whether to Mention related / similar tickets (on by default) and whether to Include web search results in the note (off by default).
Tick the Sections in the note:
Check Preview of the Halo note. It uses an example ticket, not one of yours. It redraws when you tick or untick a section; after any other change, select Refresh preview. The preview says Nothing is posted to Halo with this profile when None is chosen.
Select Save research output profile. New research runs use it immediately.
Reset to defaults puts the built-in values back on screen. Select Save research output profile afterwards to keep them. If QuantumOps cannot read your saved profile, the card shows the defaults, turns the HaloPSA note off for now and disables saving, so the defaults cannot overwrite your profile. Reload the page to try again.
Set the research effort
Agent research on the same card sets how much work each ticket's research run may do before it answers with what it found. A higher effort looks more things up and uses more tokens, so it costs more.
To set your own limits, fill in either field. Blank always means the effort's own limit, never unlimited.
- Token cap per ticket accepts 20,000 to 2,000,000 tokens. It counts every round of lookups and the final answer. QuantumOps checks it before each request, so a run can finish slightly over it.
- Time cap per ticket (seconds) accepts 30 to 420 seconds and includes the final answer, which can take up to 90 seconds. A cap under 75 seconds still allows 30 seconds of lookups and a 45-second answer.
When a run reaches a cap, it stops looking things up and answers from what it already found. The legacy analysis runs only if that answer is unusable. A line under the fields shows what a run gets with the values on screen.
Below that, the card summarises the last 30 days: the number of runs, the average tokens, seconds and cost, how often a run closed at a cap, and how often it also ran the legacy analysis. It also counts runs refused before they started, because the daily budget was used or the ticket had no time left. Use these figures to decide whether to raise or lower the effort.
Search your documentation
The Documentation Search section lets the AI use your IT documentation alongside tickets and memories. It holds the same values as the Settings tab of the Documentation Hub, under other labels. The settings table on the Documentation Hub page matches each label here to its hub label and gives the ranges and starting values. Someone who has only the Q-Director Configuration role cannot open the hub, so this tab is where they change these values.
- Turn on Enable documentation search in RAG pipeline. It is off for a new organisation. The options below appear once it is on.
- Choose where documentation is used with Include in Sherlock research, Include in chat responses and Always include global documentation. Tick the sources you use under Documentation Sources, and open Advanced Settings to tune the results.
- Select Save Changes.
Include in chat responses is what makes Documentation available in the tools button (All sources) of Qubit chat; see What Qubit can use: tools and sources. Include in Sherlock research is the hub's Use in research notes.
Documentation search needs documentation that QuantumOps has already indexed. If nothing is indexed, a search finds nothing.
Teach the AI your vocabulary
The Company glossary card on this tab holds your own terms and the e-mail noise the AI should skip. See Company glossary.
Related pages
- Sherlock research and live context: what the research does.
- What QuantumOps writes into HaloPSA: the note the profile shapes.
- Company glossary: the glossary card.
- Documentation Hub: the documentation settings under the hub's labels.
- What Qubit can use: tools and sources: how chat uses your documentation.
- Q-Director Settings: the screen these tabs belong to.
Was this helpful?
Still need help? Ask the team