Guide: help and support inside your application
Step by step so your product has a Help button with your help center and a Contact support form that creates cases in Elion ITSM.
On this page
This guide builds, in your product, the same thing Argunis Monitoring has:
a Help button that opens your help center in a panel, on the page that matches the screen the user is on;
a Contact support tab where the user opens a case, sees the team's replies, replies and rates the service.
Everything reaches an Elion ITSM service desk and your team handles it like any ticket.
Before you start
Your company's help center activated, with your documentation published. Read Help center.
A service desk for support, and you must be its Lead.
A development team that can modify your product (both the server side and the screen side).
Step 1. Allow your product to show its space
In Elion ITSM, go to Settings → Help center, Site tab.
In Included spaces, on your product's space row, enter its address in Show in iframe from, for example
https://app.miproducto.cl, and click Save spaces.
Your product will be able to show only that space, not the home page or the other help center spaces.
Read Show the help center inside another site.
Step 2. The Help panel in your product
Your development team:
Adds a Help button that opens a side panel with an
iframepointing tohttps://<tu centro de ayuda>/<espacio>/<ruta>?embed=1. With?embed=1only the content and the space's menu are shown.Maps each screen of your product to the path of its help page. Without a path, it opens the space's home page.
Adds an Open in another tab link, with the same address without
?embed=1.Allows your help center in your product's security policy (
frame-src).
Step 3. Create the case channel
Your development team creates, on your product's server, the URL that will receive the notifications, for example
https://api.miproducto.cl/hooks/argunis-itsm.In Elion ITSM, in your support desk, create a channel with that URL as the Outbound URL. Read Case channels.
Give your development team the channel URL, the inbound secret and the outbound secret. They are stored as secret variables on your product's server.
Step 4. Contact support
Your development team, on your product's server (the browser never talks to Elion ITSM or sees the secrets):
Form. Subject, description, type (problem or question), urgency and attachments. Add only useful context (screen, version, browser), never passwords or sensitive data.
Create the case. Generate an
externalId, store it with the user and send a signedPOST {URL}/cases, with the user's email and name asrequesterand their company ascompany. Read Create and track cases through the API and Sign requests.My cases. Show the user's cases with
stateLabeland the conversation (publicMessages), as text. To refresh one,GET {URL}/cases/{externalId}.Replies and attachments. Replies go to
POST {URL}/cases/{externalId}/replies; attachments are downloaded through your server.Receive notifications. At the notification URL, verify the signature and update the case with each
case.reply,case.state,case.resolvedandcase.closed, and notify the user inside your product. Read Receive notifications by webhook.Survey. With
case.csat(orcsatPending: true), show the 1 to 5 survey and send it toPOST {URL}/cases/{externalId}/csat.
With an outbound URL, Elion ITSM does not send emails to the user: your product is the one that notifies them. If you prefer that they also get emails, you can send them from your product when you receive each notification.
Step 5. Test
On the channel, click Test outbound and check in View deliveries that it says delivered.
Create a case from your product and check that it appears in the desk, with the source API.
Reply as an agent and check that the user sees the reply in your product.
Resolve the case and check that the survey appears.
Related
Content API, if you prefer to show the articles with your design instead of the iframe.