Browse Guides

BACK TO TOP
Process Agent Use Case: CRM Client Enrichment
Reading mode
Copy Link
Link Copied!
Print
Feedback
This guide is part of a collection:
<style> .chartjs-size-monitor { display: none !important; height: 0 !important; overflow: hidden !important; }p { margin: 0; }span.fr-emoticon.fr-emoticon-img { background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle; } span.fr-emoticon { font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0; } blockquote { border-left: solid 2px #5e35b1; color: #5e35b1; margin-left:0; padding-left:5px;}blockquote blockquote{ border-color: #00bcd4; color: #00bcd4;}blockquote blockquote blockquote{ border-color: #43a047; color: #43a047;} table.grid{ border-collapse: collapse;} table.grid td, table.grid th { border: 1px solid #ddd;} .fr-fic.fr-dib{ display: block; margin: 5px auto;}.fr-fic.fr-dib.fr-fir{ text-align: right; margin: 5px 0 5px auto;}.fr-fic.fr-dib.fr-fil{ text-align: left; margin: 5px auto 5px 0;}.fr-fic.fr-dii{ float: none; margin: 5px auto;}.fr-fic.fr-dii.fr-fil{ float: left; margin: 5px auto;}.fr-fic.fr-dii.fr-fir{ float: right; margin: 5px auto;}img.fr-dib.fr-fir { margin-right: 0; text-align: right;}img.fr-dib.fr-fil { margin-left: 0; text-align: left;}img.fr-dib { margin: 5px auto; display: block; float: none;}img.fr-bordered { box-sizing: content-box; border: solid 5px #CCC;}img.fr-shadow { box-shadow: 10px 10px 5px 0px #cccccc;}img.fr-rounded { border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box;}</style><p><strong>In this guide we will cover:</strong></p><p data-pasted="true"><strong><a href="#What-is-Client-Enrichment-">- What is Client Enrichment?</a></strong></p><p><strong><a href="#Key-Considerations">- Key Considerations</a></strong></p><p><strong><a href="#Pre-Requisites">- Pre-Requisites</a></strong></p><p><strong><a href="#The-Process">- The Process</a></strong></p><p><strong><a href="#Plug-AI-Search-Engine-Credentials-in---For-Instances-deployed-after-September-2026">- Plug AI Search Credentials in</a></strong></p><p><strong><a href="#Building-Client-Enrichment">- Building Client Enrichment</a></strong></p><ul><strong></strong><li style="font-weight: bold;"><strong><a href="#Create-Client-Enrichment-Instructions-Article" style="font-weight: bold;">Create Client Enrichment Instructions Article</a></strong></li><li style="font-weight: bold;"><strong><a href="#Create-Perplexity-Custom-Integration" style="font-weight: bold;">Create Perplexity Custom Integration</a></strong></li><li style="font-weight: bold;"><strong><a href="#Creating-an-API-Application--Versions-prior-to-v2-250-only-" style="font-weight: bold;">Creating an API Application</a></strong></li><li style="font-weight: bold;"><a href="#Creating-the-Process-Agent-and-Runbook" style="font-weight: bold;"><strong>Creating the Process Agent and Runbook</strong></a><p><br></p></li></ul><p><br></p><p><strong><span style="font-size: 14pt;">What is Client Enrichment? <a id="What-is-Client-Enrichment-" class="fr-anchor" title="What-is-Client-Enrichment-"></a></span></strong></p><p>The Client Enrichment automation utilises AI to streamline your sales processes. Client Enrichment automates the client research portion of lead qualification, researching clients/accounts for you and adding findings to your opportunity ticket. Your sales team will no longer need to spend time researching clients/accounts and can instead immediately action opportunities based on the information AI finds.&nbsp;</p><p><br></p><p><strong><span style="font-size: 14pt;">Key Considerations<a id="Key-Considerations" class="fr-anchor" title="Key-Considerations"></a></span></strong></p><p data-pasted="true">The Client Enrichment automation will be built into instances of Halo used by MSPs that were deployed after September 2026.</p><p><br></p><p data-pasted="true">If you have been using this functionality on a trial, but have since been deployed to a live instance, you will need to plug your Perplexity API key into you instance to resume use of this functionality. Or plug in credentials for anot<span style="color: rgb(0, 0, 0);">her AI search tool. If you already have this functionality built in and you just need to plug in AI search tool (perplexity) credentials see the section &#39;Plug in AI Search Tool Credentials&#39;.</span></p><p><br></p><p data-pasted="true">If this Agent is not already built into your instance, this guide will walk you through how to build this.&nbsp;</p><p><br></p><p><strong><span style="font-size: 14pt;">Pre-Requisites<a id="Pre-Requisites" class="fr-anchor" title="Pre-Requisites"></a></span></strong></p><ul><li>You must have a Default AI Connection set for your instance (this can be Halo&#39;s own AI connection).</li><li style="color: rgb(0, 0, 0);">You must have a Perplexity AI account (+API key) OR credentials for another AI search Tool.<ul style="color: initial;"><li>This does not apply if you are on a trial instance as credentials will be built in already for testing.</li></ul></li></ul><p><strong><span style="font-size: 14pt;">The Process<a id="The-Process" class="fr-anchor" title="The-Process"></a></span></strong></p><ul><li>When a new ticket is logged with &quot;CRM Client Enrichment&quot; enabled, the CRM Client Enrichment automation runbook will trigger (the trigger for this automation can be customised).&nbsp;</li><li>A prompt is sent to Perplexity AI to have Perplexity research the company (client/account) the opportunity ticket is for. Research is based on the client/account assigned the ticket and the website field.&nbsp;<ul><li>A knowledge base article is used in the prompt to brief the AI search engine on how to conduct the research.&nbsp;</li></ul></li><li data-pasted="true">A Process Agent then analyses the research done by perplexity and uses this to produce the following information about the client/account:<ul><li data-pasted="true">Industry, employee count, revenue, tags, website URL, recent news, a deal note, client note.&nbsp;</li></ul></li><li>This information is then added to the opportunity ticket as a formatted note, for agents to easily review.</li></ul><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImEwNWQ4Y2ViLTYwODEtNDIwYi1iNzI1LTc2OGQxNDg1MDc1YyJ9.r7w3wv3mISQrTUulQW23RPQbjNSsLVw1v-bKJ4DRlvc" class="fr-fic fr-fil fr-dib" width="1443" style="width: 1445px; height: 875.024px;" height="875"></p><p><strong><span style="font-size: 10pt;">Fig 1. Client Enrichment Note added to Opportunity Ticket</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Plug AI Search Engine Credentials in - For Instances deployed after September 2026<a id="Plug-AI-Search-Engine-Credentials-in---For-Instances-deployed-after-September-2026" class="fr-anchor" title="Plug-AI-Search-Engine-Credentials-in---For-Instances-deployed-after-September-2026"></a></span></strong></p><p>If you are in a live Halo environment (non trial) you will need to plug your Perplexity AI credentials into Halo. If you are not using Perplexity and instead have an alternative AI search engine you would like to leverage, you will need to make a new <a href="https://www.usehalo.com/guides/2660" target="_blank" rel="noopener noreferrer">custom integration</a> for this.&nbsp;</p><p><br></p><p>For information on obtaining an API key for Perplexity, check out their documentation here: <a target="_blank" rel="noopener noreferrer" data-fr-linked="true" href="https://docs.perplexity.ai/docs/admin/api-key-management" data-pasted="true">API Key Management</a>.</p><p><br></p><p>Once you have your API Key, head to Configuration &gt; Integrations &gt; Custom Integrations &gt; Custom Integrations &gt; Perplexity &gt; edit the integration and paste your API key in the &quot;Bearer Token&quot; field.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjdiNTdkOGZjLTM3OWItNDlkNy1iNjhmLTY2MDhiMjc3Zjk0NyJ9.50eoJztn2BcFL_vS2n6WNhtWL_uZhTVjmFT3gH1SWZI" class="fr-fic fr-fil fr-dib" width="1726" style="width: 1728px; height: 867.183px;" height="867"></p><p><strong><span style="font-size: 10pt;">Fig 2. Field to plug API Key into</span></strong></p><p><br></p><p>Now the Perplexity integration is ready to use.&nbsp;</p><p><br></p><p><strong><span style="font-size: 14pt;">Building Client Enrichment<a id="Building-Client-Enrichment" class="fr-anchor" title="Building-Client-Enrichment"></a></span></strong></p><p>If you are looking to utilise CRM Client Enrichment but this is not built into your instance, follow this section of the guide for steps on how to build this.&nbsp;</p><p><br></p><p><strong><span style="font-size: 12pt;">Create Client Enrichment Instructions Article<a id="Create-Client-Enrichment-Instructions-Article" class="fr-anchor" title="Create-Client-Enrichment-Instructions-Article"></a></span></strong></p><p>A knowledge base article is used when prompting Perplexity to research the client/account to give instructions on how the research should be conducted. This article will need to be created in your instance.&nbsp;</p><p><br></p><p>Head to the Knowledge Base to create a new article, the html for the example article can be found attached to this guide under &quot;Enrichment Instructions Article&quot;. You can use this html when creating the article, but this can be customised based on how you would like the research to be conducted. If you are viewing this guide on our website you will need to <a href="https://support.haloservicedesk.com/kb?id=3043" target="_blank" rel="noopener noreferrer">head to our portal here</a> to obtain the attachment. &nbsp;</p><p><br></p><p>Once the article is created, keep a note of the article ID as this will be needed later.&nbsp;</p><p><br></p><p><strong><span style="font-size: 12pt;">Create Perplexity Custom Integration <a id="Create-Perplexity-Custom-Integration" class="fr-anchor" title="Create-Perplexity-Custom-Integration"></a></span></strong></p><p>Perplexity is used to research the client/account, therefore a custom integration need to be created to authorise access to Perplexity&#39;s API.&nbsp;</p><p><br></p><p>First ensure you have obtained an API key, information on obtaining an API key for Perplexity, can be found here: <a href="https://docs.perplexity.ai/docs/admin/api-key-management" target="_blank" rel="noopener noreferrer">API Key Management.</a></p><p><br></p><p>Now create a new custom integration in Halo under Configuration &gt; Integrations &gt; Custom Integrations &gt; Custom Integrations &gt; New &gt; configure the details for the integration as shown in Figure x, plugging your API key into the &quot;Bearer Token&quot; field.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImZjMjkwYzRjLWIyYTQtNGQ5OC04YmY4LTZmZDJmYTk0ODViZiJ9.rnqQu9K79ifiuvjzilnqHedDnXBUcD9rq0BC5HE3wEc" class="fr-fic fr-fil fr-dib" width="1538" style="width: 1540px; height: 819.134px;" height="819"></p><p><strong><span style="font-size: 10pt;">Fig 3. Perplexity Custom Integration Configuration</span></strong></p><p><br></p><p>Then use the &quot;Import from JSON&quot; button and paste the JSON attached to this guide titled &quot;Perplexity Custom Integration&quot;. This will create the custom integration method required.&nbsp;</p><p><br></p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;" data-pasted="true"><strong><span style="font-size: 12pt;">Creating an API Application (Versions prior to v2.250 only)<a id="Creating-an-API-Application--Versions-prior-to-v2-250-only-" class="fr-anchor" title="Creating-an-API-Application--Versions-prior-to-v2-250-only-"></a></span></strong></p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;">If you are on a versions prior to v2.250 you will need to create an API application, this will be given to your process agent to authorise it to execute requests in your Halo instance. On v2.250+ you can skip this section and head to &quot;Creating the Process Agent and Runbook&quot; as an application will be created for you automatically when the agent is created.&nbsp;</p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;"><br style="box-sizing: inherit;"></p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;">To create an API application head to Configuration &gt; Integrations &gt; Halo API, and click on the &quot;View Applications&quot; button.&nbsp;</p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;"><br style="box-sizing: inherit;"></p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;">Head to Configuration &gt; Integrations &gt; Halo API, and click on the &quot;View Applications&quot; button.&nbsp;</p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;"><br style="box-sizing: inherit;"></p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImZkYjg2NzVlLWYwOGItNGE0Yy05MWJjLTBmNTM3ZTM3MjY5NyJ9.uW05fLQ8TxH1-lnYjLzYpIJpzsxNFdINrJ7GUmgN2oA" width="1485" height="324" style="box-sizing: inherit; border-style: none; text-align: left; width: 1177px; height: 256.8px;" class="fr-fil fr-dib"></p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;"><strong><span style="font-size: 10pt;">Fig 4. View Applications</span></strong></p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;"><br style="box-sizing: inherit;"></p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;">Click &quot;+ New&quot; to create a new API Application.&nbsp;</p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;"><br style="box-sizing: inherit;"></p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;">Give this application a sensible name and set the Authentication Method to &quot;Halo Automation Identity&quot;.&nbsp;</p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;"><br style="box-sizing: inherit;"></p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;"><img data-fr-image-pasted="true" src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijg5ZTQ3MmQ4LTVkNWItNGZlMS1hNzgwLTM2ZjY1NGFiZDZjYiJ9.RWP-ZqE2pgIrgMgALa-wWpdouyEuj5VYsGtJ19Yg4zM" width="1157" height="644" style="box-sizing: inherit; border-style: none; text-align: left; width: 1159px; height: 643.889px;" class="fr-fil fr-dib"></p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;"><strong><span style="font-size: 10pt;">Fig 5. Create API application using Halo Automation identity</span></strong></p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;"><br style="box-sizing: inherit;"></p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;">Once selected, you will need to specify an identity for the application. This informs the base level of access granted to the application. The option &quot;Application identity&quot; is recommended here, as you can use roles to control the base level of permission rather than having to pick a specific Agent. When this option is selected the &quot;Identity Roles&quot; field can be used to determine which roles to use as the base level permissions.</p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;"><br style="box-sizing: inherit;"></p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;">Now under the permissions tab assign the application the following permission:</p><ul><li style="box-sizing: inherit; margin-top: 0px; margin-right: 0px; margin-bottom: 0px; line-height: 1.4285em; color: rgb(0, 0, 0);">all</li></ul><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;"><br style="box-sizing: inherit; color: rgb(0, 0, 0); font-family: Poppins, sans-serif, Roboto; font-size: 14px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; white-space: normal; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial;"></p><p><strong><span style="font-size: 12pt;">Creating the Process Agent and Runbook<a id="Creating-the-Process-Agent-and-Runbook" class="fr-anchor" title="Creating-the-Process-Agent-and-Runbook"></a></span></strong></p><p data-pasted="true">The runbook and Process agent required can either be:</p><ul><li>Created in your instance manually</li><li>Downloaded from the online repository (from v2.250+)</li></ul><p>Downloading from the repository is a much faster method of setup.&nbsp;</p><p><br></p><p>We detail both methods of setup in this guide; you only need to follow one of the respective sections.&nbsp;</p><p><br></p><p><strong><em>Note: When downloading the agent from the repository the required API application will be created for you automatically.&nbsp;</em></strong></p><p><br></p><p><strong>Creation by Downloading from the Online Repository (v2.250+)</strong></p><p>The runbook online repository can be found under Configuration &gt; Integrations &gt; Custom Integrations &gt; Integration Runbooks &gt; select the Globe symbol.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjAxNDllYWQ3LWE4NDMtNDY5MS04NjM2LTM3NTAxNGFhNjM0ZSJ9.gYzDtlYWhKTtS2lIq98-ldwU02L2YfJd4zpmoMejazg" class="fr-fic fr-fil fr-dib" width="1824" style="width: 1826px; height: 832.732px;" height="833"></p><p><strong><span style="font-size: 10pt;">Fig 6. Access Runbook Online Repository&nbsp;</span></strong></p><p><br></p><p data-pasted="true">From here select &quot;AI CRM Client Enrichment&quot;. Then use the &quot;Install to Halo&quot; button to add this to your instance (this will be disabled when added).</p><p><br></p><p><strong><em>Note: Some instances of Halo may already have the runbook and ability required added. If this is the case an &quot;Update local version&quot; button will be available in place of the &quot;Install to Halo&quot; button, you do not need to complete any further setup.&nbsp;</em></strong></p><p><br></p><p>When installing, both the runbook and Process Agent will be created in your instance. You will need to set which role/agent will authorise the Process Agent&#39;s permissions, it is recommended to set the &quot;Agent to log in as&quot; to &quot;Application Identity&quot;, so authorisation is not tied to a specific agent.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImI1ZmU4MjlhLThhNGMtNGFjOC1iZWZmLTRjZDhhMTQzZGEzNyJ9.tUfUqn-RpS1iubOOxDKyh-7mIkQslOeF3Bg5ctUOswE" class="fr-fic fr-fil fr-dib" width="709" height="471"></p><p><strong><span style="font-size: 10pt;">Fig 7. Downloading Process Agent/Runbook from Repository&nbsp;</span></strong></p><p><br></p><p>The permissions this created Process Agent will have will be set automatically based on the requirements of the runbook.&nbsp;</p><p><br></p><p>Once installed, head back to Configuration &gt; Integrations &gt; Custom Integrations &gt; Integration Runbooks and select the &quot;Halo AI - CRM Client Enrichment&quot; runbook that has just been installed. Here, you will need to ensure the custom integration method has been assigned to the first step correctly. Edit the first step of the runbook.</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijc1MjNlMjQ0LTVjNzYtNGJlOS05ZWZjLWJhY2FlYmQxZTgwNCJ9.4QtqAoqQqbN_NNnfkRvNjVya6eZptULado4-BnmqUls" class="fr-fic fr-fil fr-dib" width="696" style="width: 698px; height: 454.577px;" height="455"></p><p><strong><span style="font-size: 10pt;">Fig 8. Edit Perplexity Research Step&nbsp;</span></strong></p><p><br></p><p>Then ensure your custom integration method &quot;Client Enrichment Research&quot; is chosen here.&nbsp;<br><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjEzZDUyNjMwLWQ2MzItNGUyNC1iYmM0LWNiNGFlYTZjNDIxOSJ9.lG8BQE97Vo-lHIK4SDt1yK6Sr_fC4R0skSJp9SYPJjw" class="fr-fic fr-fil fr-dib" width="777" style="width: 779px; height: 530.336px;" height="530"></p><p><strong><span style="font-size: 10pt;">Fig 9. Custom Integration method chosen for step</span></strong></p><p><br></p><p>Now, you will need to edit the instructions for the Process Agent created to ensure the Agent looks at the article created earlier.&nbsp;</p><p><br></p><p>Head to Configuration &gt; AI &gt; AI Agents &gt; Process Agents &gt; select &quot;CRM Client Enrichment Agent&quot; &gt; Edit the article ID highlighted in Figure 10 to the ID of the article you created earlier.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImNjNjcyZjE0LWY3OTktNGViZi1iMzU1LTIzMDEyYzMxNjBlZSJ9.vYAoXeVR_LfOSwJm6mTgdlle95uu63zrzTsKns7_6UI" class="fr-fic fr-fil fr-dib" width="1581" style="width: 1583px; height: 694.922px;" height="695"></p><p><strong><span style="font-size: 10pt;">Fig 10. Article ID to edit in Agent Instructions&nbsp;</span></strong></p><p><br></p><p>Now, head to the section &quot;Set Triggers&quot;.&nbsp;</p><p><br></p><p><strong>Manual Creation</strong></p><p>To create a Process agent, head to Configuration &gt; AI &gt; AI Agents &gt; Process Agents &gt; New. Give the Agent a name and choose the AI connection method to use.&nbsp;</p><p><br></p><p>Then in the &quot;Halo Application to authorise as&quot; field select the application created earlier, or if you are on v2.250+, you have the option to create an application identity to authorise the agent with here.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjE2YzU4MWM0LWJlMTctNGU4NC05Y2JjLTBkNGQxZTAxNTJiOSJ9.IXVNnFEO7_4lnLRHq3_3WL9iJYfDODyIsLqp2rTrRF0" width="1682" style="width: 1684px; height: 608.722px;" height="609" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 11. New Process Agent</span></strong></p><p><br></p><p>Then in the &quot;Instructions&quot; field paste the instructions attached to this guide, titled &quot;CRM Client Enrichment Agent instructions&quot;.&nbsp;</p><p><br></p><p>Once pasted, edit the article referenced in the instructions that tells the Agent how to interpret the research. Edit the article ID highlighted in Figure x to the ID of the article you created earlier.&nbsp;</p><p><br></p><p>Then add the input variables shown in Figure 12. and enable &quot;Include all system functions&quot;.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjMxYTc3ZDI1LWUyM2YtNGVkZi04M2RhLTIzMzBkN2JkOWZlYSJ9.1U04M-aEtbJ10AHR1pSyJdyAZ21S8mPtMjtm-HIBufA" class="fr-fic fr-fil fr-dib" width="1786" style="width: 1788px; height: 625.302px;" height="625"></p><p><strong><span style="font-size: 10pt;">Fig 12. Process Agent variables and Functions</span></strong></p><p><br></p><p><strong><em>Note: No additional functions need to be configured for the agent.&nbsp;</em></strong></p><p><br></p><p>Now save the agent and you are ready to create the runbook required.&nbsp;</p><p><br></p><p>Head to Configuration Integrations &gt; Custom Integrations &gt; Integration Runbooks &gt; Import from JSON.</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjJjODhlZDBmLTIyZDItNDA2Zi05MjFjLWI0ZDRmNzJmNzkzZiJ9.Q6Ua3kbZx66pwtALcPsk4-hJOu-YdHa5UaTq6KhA2Bg" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 13. Create Runbook by importing from JSON</span></strong></p><p><br></p><p>Here, paste the JSON attached to this guide titled &quot;AI CRM Client Enrichment Runbook JSON&quot;.&nbsp;</p><p><br></p><p><strong><em>Note: If you are using another AI Search Engine (not Perplexity) you will need to edit the first step of the runbook and add/configure your custom integration method for your AI search engine.&nbsp;</em></strong></p><p><br></p><p>Once the runbook has been created you will need to map the Process Agent&#39;s input variables to runbook variables.&nbsp;</p><p><br></p><p>Edit the &quot;Trigger AI CRM Client Enrichment Agent&quot; step and map each of the agent&#39;s input variables to runbook level variables as shown in Figure 14.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjU2MTdiYmJiLTdkNDgtNGY4ZC1iNjc5LWNiOWM5NWEwNzYwNiJ9.tEfjLi0FFFE7AjUXicsoISCRX5M7_PBuiVBnjrNk5YY" class="fr-fic fr-fil fr-dib" width="1609" style="width: 1611px; height: 583.094px;" height="583"></p><p><strong><span style="font-size: 10pt;">Fig 14. Map Variables&nbsp;</span></strong></p><p><br></p><p><strong>Set Triggers</strong></p><p>Now you will need to set when the runbook, therefore the whole automation, is triggered. To do this head to the &quot;Details&quot; tab within the runbook and add which events trigger this.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImNjM2IzMzU0LTViZmEtNDQyZS1hNmM4LWZhNDkwMzIzNmUzZCJ9.0lDALe5d8Nbf46gMlU7GW9SN6zSLCtja4pNJkcE5VAw" class="fr-fic fr-fil fr-dib" width="1698" style="width: 1700px; height: 550.116px;" height="550"></p><p><strong><span style="font-size: 10pt;">Fig 15. Add Event Triggers</span></strong></p><p><br></p><p>Out of the box, the automation is triggered each time a new ticket is logged as long as &quot;AI CRM Client Enrichment&quot; is checked.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijk0OGJmZDAzLTFmYjktNDIyNC04NDZhLTVhYjk0NjY0OTczZSJ9.5o5k7R_C9oYdbs19SiDA5Py7l4I4dpUO-IxaaiqOdLw" class="fr-fic fr-fil fr-dib" width="601" style="width: 603px; height: 476.097px;" height="476"></p><p><strong><span style="font-size: 10pt;">Fig 16. Trigger for runbook</span></strong></p><p><br></p><p><strong><em>Note: Keep in mind only ticket related events can be used to trigger this runbook, e.g. ticket logged, ticket updated, action added by agent.&nbsp;</em></strong></p><p><br></p><p>Now the automation is ready to use.&nbsp;</p>
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.