Guides - Using the Halo MCP AI Agent With The ChatBot (Pre-Configured Environments)

<div><div><div><div><div><div><div><div><div><div><div><style>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><div><div>In this guide we will cover:- How to add a Report to a PDF Template- Filtering reports for a specific entity- Example  When supplying various services to your customers such as security management, data backups, device management, remote support etc, the charge for these services may vary each month based on activity/usage that month. When it comes to invoicing your customers for these services it can help to back these invoices up with data from Halo. This can be useful if a customer's invoice is substantially more/less than usual or fluctuates often, as the data justifies the charge. To do this you can add report data from reports to your PDF (invoice), then when the invoice PDF is generated the report is re-run and the most up to date report data will be added to this PDF automatically.  Report data can be added to the PDF template for the following entities, but in this guide we will focus on invoice PDF templates:<ul><li>Tickets</li><li>Quotations</li><li>Sales Orders</li><li>Purchase Orders</li><li>Invoices </li><li>Agreements </li><li>Assets</li></ul> How to add a Report to a PDF TemplateFirst you will need to choose the report you would like to appear on your chosen template. To do this head to Configuration > Reporting > PDF Templates, here you can change the entity you are viewing templates for on the top left. To change the entity you are viewing select the drop down and choose another entity.  <img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImMzNGU2MDA0LWJjYjAtNGI5MS04MjliLWRiMDQ1ZGVjZGZlNiJ9.r1l-kWG3bCpieYn9G5gQZqXyPv1ZF8ADPTHgT6K4q5o" class="fr-fic fr-fil fr-dib" style="width: 510px;">Fig 1. Template Entity Selection Now select the template you would like to edit, once inside the template, under the details tab, you will need to set which report you would like to be visible on the template. Setting the report here will provide you a variable to use on the PDF template. Select 'Add' on the table to add a new report.  <img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjZkMThjY2EzLTQ3NTYtNDI1OC1hMGFmLTY1YWFmMzQyMmZkNCJ9.IuIO7N_IRR3-yeKE3m5IyFRjE6elIAwWc-O7X3xQ4w8" class="fr-fic fr-fil fr-dib" width="1210" style="width: 1212px; height: 737.464px;" height="737">Fig 2. Report selection Table Now you will be prompted to search and select the report you would like to add, you can search either by report name, or report ID. Once selected your chosen report will appear in the table, and the variable for the report will be given.  <img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjA0MDJjODBkLWU1MjYtNDM0NS04M2M0LWFmYjA4YWNlZTI4ZSJ9.WFb5fnDSl2MKaZdh6K3VgJ16i7fhTwV6DkJBn-PNS68" class="fr-fic fr-fil fr-dib" style="width: 931px;">Fig 3. Report Variable Now the report has been chosen and the variable is available, we need to edit the template pages to include this variable. Head to the 'Pages' tab and add a new page. <img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImE3YWM2NzYzLTRlZGYtNDBhOS05ZGUzLTNhNDc3NzAyOGJkNCJ9.81We9fhqUr7pXMwA0i_3c4ApoTnznyxfYX94xT_MHPg" class="fr-fic fr-fil fr-dib" style="width: 914px;">Fig 4. Adding a new page to the template When adding, the page the editor screen will appear. By default the HTML from the 'Main Page' will be copied over into the new page, remove any information that you do not want to appear on the second 'report' page. To have report data pull through we need to format the data to be in table form, and give it a title. Here is some basic formatting you can use to copy and paste into your template HTML:     <h1>REPORTNAMEHERE</h1>            <div>                </div>        <div style="margin-top:30px">            <table class="detail-table">                $REPORT123DATA            </table> Fig. 5 Example HTML formatting for report table If you are using the above, you will need to replace 'REPORTNAMEHERE' with the title of your report and replace '$REPORT123DATA' with the variable of the report you want to pull through.  Once set ensure you save the HTML on the page you are editing, then you can use the 'Generate PDF' function to generate a PDF using this template and see what the template will look like with the report data applied.<img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjNkYTFkNzQyLTBiZjctNGE3Yi1hZGE5LWEyOWI1M2NlOTllOSJ9.YAGZ5XEfJHNXDSjvsbQW1ytTZY5FEz3OOZWwpaxO15g" class="fr-fic fr-fil fr-dib" width="1248" style="width: 1250px; height: 629.52px;" height="630"> Fig 6. Preview Print function Now when this template is applied to an entity, the report data will appear on the PDF. If any changes are made to the report, this will automatically update the report on the template, including if any filters are applied to the report.  Filtering Reports For a Specific entity If most of your reports are data overviews, showing data for various customers/suppliers/assets etc. you may want the report that shows on the PDF to be filtered so it only shows the data for the invoice/purchase order/sales order/customer etc. it is on. This can be done by adding To have report data only show data for the customer the invoice is for you will need to add a filter to the report using a $-variable. We will work through this with an example.  ExampleI have a report that shows a breakdown of all billable labour time spent on all tickets, showing when the action took place, which ticket this relates to, how long the action took, etc. However, at the moment the report shows all ticket action details for all my customers. I would like it to only show the action details that I am invoicing for on a particular invoice. <img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImE0NWZiMzEyLTJiMzUtNGY5MC1iOWI3LTBkZTRmZDNhZDZjNCJ9.AQhjtA5ltDA9WhsI7BqqZaxqJbR6uy82amaF9r1hzWI" class="fr-fic fr-fil fr-dib" width="1461" style="width: 1463px; height: 518.315px;" height="518">Fig 7. Example Report  To do this I will need to add the following line to my report data source: <div style="color: #000000;background-color: #fffffe;font-family: Consolas, 'Courier New', monospace;font-weight: normal;font-size: 14px;line-height: 19px;white-space: pre;" id="isPasted">where ihid = $invoiceid</div> This query filters the report to only show outstanding invoices for the customer linked to the invoice the report appears on. When you add this query to your report in the reporting suite it will pull through no data, this is expected as the report is not linked to a specific invoice with a customer yet. After I add the report to a template, and preview this on an invoice in my Halo instance I can see the report is being filtered by customer. In Fig 8 you can see how the report looks on an invoice PDF after the filter is applied, it is only showing the actions in the report that invoice is for (the actions you are billing for). See Fig A1 in appendix for the whole report script used here. <img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjkxNDdmNmJmLWEzZmUtNDdlMy1hNzZjLTBhMmRhNWUwMjczMiJ9.M5WRcvHa1XNJUXaCwH9jUlV2Q3nz89bFTW_RP-vMlK4" class="fr-fic fr-fil fr-dib" width="791" style="width: 793px; height: 481.737px;" height="482">Fig 8. Invoice PDF with report being filtered by customer  Note: The example SQL queries in this guide can be used as a base for a report filter, but they will need to be amended based on your report and the entity. For more information on adding report data to other PDF templates see our guide here: <a data-fr-linked="true" href="https://usehalo.com/halopsa/guides/2256" target="_blank" rel="noopener noreferrer">Pulling Report Data into a PDF template</a>. AppendixFigure A1 - SQL Script used for report 'Accounts report-Outstanding invoices' <div style="color: #000000;background-color: #fffffe;font-family: Consolas, 'Courier New', monospace;font-weight: normal;font-size: 14px;line-height: 19px;white-space: pre;" id="isPasted">selectuname as [Technician], area.aareadesc as [Client Name], sdesc as [Site Name], username as [Username], rtdesc as [Request Type],faults.faultid as [Request ID], whe_ as [Date/Time Done], round(timetaken,2) as [Time Taken], Actoutcome as [Outcome], note  as [Note] from actions left join faults on actions.faultid=faults.faultid left join site on ssitenum=sitenumber left join area on aarea=sarea  left join uname on who=uname left join requesttype on rtid=requesttypenew left join invoiceheader on ActionInvoiceNumber  = ihid  where ihid = $invoiceid </div> </div></div></div></div></div></div></div></div></div></div></div></div></div>

Keeper Integration

ISL Online Integration

Zapier Integration

Eracent Integration

Kaseya VSA X Integration

Tickets in the Self-Service Portal

Prometheus Integration

Cloudflare Integration

Google Business Integration

DB integrator error: Decryption check failed - please install the API certificate on this server, or ensure that the Halo DB Integrator is running on the application server

<div><div><style>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><div>This happens when the Integrator tries to decrypt a password from the connected database and fails. For the purpose of testing, it tries to decrypting the most recent password entered into Halo. Some reasons this might fail: They are using X.509 encrypted passwords and the server that the DB integrator is being run from does not have the X.509 certificate installed. If the DB integrator is installed on the web server then this should never be the case as the web server must have the certificate installed to access the passwords itself. It is conceivable that the X.509 certificate could be installed/have permissions in such a way as to allow the web app's context to access the certificate and not the Integrator's context, but this is unlikely, particularly if the X.509 setup guide has been followed correctly. They have X.509 encryption configured and the most recent password to be encrypted was not encrypted using the X.509 certificate. This seems to be fairly common. It can be because they have only recently switched to X.509 and have not yet encrypted their existing passwords (from the Security and Performance config page) or that there is some problem with X.509 encryption and new passwords are not being encrypted using the X.509 certificate. The most recent password is a blank string. Although this would decrypt successfully, the test considers a blank to be a failure to decrypt. It should not be possible to use and encrypt a blank string as a password/secret value in any areas of Halo, but it has been possible before and may happen again.</div></div></div>

Maintenance Windows

Quote Statuses

Benji Pays Integration

Nagios XI Integration

Restricting Information Access for Agents

Rapid7 Integration

CrewHu Integration

CyberCNS (Cyber CNS) Integration

Mail Campaigns

User Out of Office Detection

Invoice Approvals

Snipe-IT Integration

Distribution Lists

Importing Quotation Lines via XLS

Agent Access to Services

Cc and Bcc Email Configuration

Agent Cost Tracking and Profitability Reporting

KeyCloak Integration

Start to Finish: Project Dashboards

Tax Rates

Autotask Migration

Knowledge Base Article Feedback

(HH:MM) Conversion of a field in SQL to Hours and Minutes

AI Agents

Merging Invoices

Screen Layout Overrides

Notification Templates

Product Bundles

ArrowSphere Integration

Optional Services

Checking your DB Integrator Version

Double Line Spacing On Emails In Outlook

Barcode Scanning

Redact Sensitive Audit Logs on a Ticket

Custom HTML Banner on the Self-Service Portal

Start to Finish: Service Requests

Service Users

AI Abilities

Password hashing work factor

Ticket/Action Import - CSV/XLS/Spreadsheet Method

Supplier Import - CSV/XLS/Spreadsheet Method

Services Import - CSV/XLS/Spreadsheet Method

Asset Type & Asset Import - CSV/XLS/Spreadsheet Method

Client, Sites & Users Import - CSV/XLS/Spreadsheet Method

An Introduction to Halo

Thank you! Your submission has been received!

Oops! Something went wrong while submitting the form.

Using the Halo MCP AI Agent With The ChatBot (Pre-Configured Environments)

Feedback

This guide has multiple versions available:

Feedback

Guide name here

Thank you! Your submission has been received!

Oops! Something went wrong while submitting the form.

One unified platform. Every team. Every workflow.

Tailored solutions for every industry.

Powerful capabilities, endless possibilities.

Browse Guides

Platform

Use Cases

Resources

Halo

Subscribe to Halo for latest news

Follow