Documentation

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Update Action

Use the Update action to post information to the request timeline. This feature helps you collaborate with team members and customers.

Update action screenshot

Administrators can enable or disable this action in the service configuration.

Add a comment

You can include text, images, and embedded multimedia or hyperlinks in your updates.

Wiki markup

Use wiki markup to format your text. You can apply formatting like italics and bold, or create bulleted and numbered lists.

  • Use the CTRL+B keyboard shortcut for bold text.
  • Use the CTRL+I keyboard shortcut for italic text.

Select the Preview wiki markup button wiki preview button to see how your content will appear before you post it to the timeline.

Mentions

To notify a coworker about an update, use an @mention. Type the @ symbol followed by the first few letters of the coworker’s name. Select the correct person from the list that appears. The coworker will receive a notification that includes a link to the request.

HAi Text Assist

HAi Assist logo HAi Text Assist is an AI tool that helps you write request updates. Clear and concise updates improve communication with your team and customers. These updates also provide data for request summarization and knowledge article generation.

  • Ask HAi: Enter an open-ended prompt to find solutions for common issues. For example, type “How to set up an email signature in Outlook in Office 365.”
  • Change Tone: Adjust the tone of your text to suit your audience. Options include Apologetic, Professional, Friendly, and Technical.
  • Improve Text: Correct spelling and grammar mistakes to improve readability.
  • Shorten Text: Remove unnecessary words from your update.
  • Listify: Convert blocks of text into a list format.

Customer email notifications

Email notifications can be automatically sent to customers when you add an update with the visibility level set to Customer. These emails include links to the original request so the customer can read and respond. Any subsequent comments on a customer-visible update also trigger a notification.

To ensure customers receive these emails, verify the following configurations:

  • Default Email Template: Use the provided CustomerTimelineUpdateNotification template or a custom version.
  • Email Template Setting: If you use a custom template, update the guest.app.requests.notification.emailTemplate.customerTimelineUpdate system setting with the new template name.
  • Email Notification Setting: Change the guest.app.requests.notification.emailMailbox setting to the name of the mailbox you want to use for Service Manager notifications. This defaults to “helpdesk” upon installation.
  • Notify Customer: Enable the Notify Customer option in the Request Action configuration.

Note: With customer email notifications enabled, workflow automations that update a request with the timeline visibility set to Customer under the category of Update will also trigger an email notification to the customer.

Update linked requests

If a request has linked requests, you can send updates to the timelines of those linked requests simultaneously. After linking a request, the Update button includes an arrow.

Settings

This feature is disabled by default. You can enable it in the Service Manager Application Settings by changing the following system setting:

  • app.request.update.enableLinkedRequestAction: Set this to enabled to allow updates to linked requests from the Update tab.

Usage

When linked requests exist, the Update button includes an arrow. Select Update this and linked requests… to open a dialog box.

Update linked requests button

Select Update this and linked requests… to open a dialog box. From the dialog box you can select which linked requests to include in the update.

Update linked requests dialog box

  • Select All: Select or deselect all requests in the list.
  • Check boxes: Select specific requests to include in the update.
  • Update: Apply the text to all selected requests.

Tip

Updates to linked requests are one-way. If a user comments on the update within a linked request, that comment does not appear in the original request.

In This Document