chore: add docs for technician pod

immense · Jan 20, 2025 · 78414f1 · 78414f1
1 parent 6bd0bd3
commit 78414f1
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 4 deletions.
diff --git a/halo-integration-setup.md b/halo-integration-setup.md
@@ -1,12 +1,12 @@
 # HaloPSA
 
 Setting up this integration allows you to
-1. Deploy Software to machines covered by a certain contract type 
+1. Deploy Software to machines covered by a certain contract type
   - Example: Deploy Huntress to all customers with a Managed Security Contract
 1. (Preferred) Deploy Software to machines covered by an Contract with a specific recurring invoice item
   - Example: Deploy SentinelOne to all computers that have SentinelOne on a recurring invoice as a recurring invoice item on their contract
 
-## Create an ImmyBot Application under /config/integrations/api/applications 
+## Create an ImmyBot Application under /config/integrations/api/applications
 
 - Under the details section, select the Client ID and Secret Authentication Method
 - Generate and copy the Client ID and Client Secret
@@ -40,3 +40,22 @@ Within HaloPSA, configure the tab as follows:
 This tab will then show on all tickets in the system, like this:
 
 ![image](https://github.com/immense/immybot-documentation/assets/16939160/f4aaf5f2-08bf-4d56-b313-eeea62e21051)
+
+## Technician Tools
+
+HaloPSA version 2.125.5 introduced a new feature called Custom Tabs. You can configure these Custom Tabs to point to a web address that is rendered as an iframe.
+
+Within HaloPSA, configure the tab as follows:
+
+![alt text](image-10.png)
+
+Copy the url template:
+
+```https://<your-domain>.immy.bot/technician-pod/psa/<halo-integration-id>/ticket/$FAULTID```
+
+The URL is specific to your instance.  You'll need to replace `<your-domain>` with your domain and `<halo-integration-id>` with your halo integration id. This id can be found here:
+
+![alt text](image-2.png)
+
+After you setup the tab, navigate to a ticket and select the tab with the name you just created. It shoud load the technician tools page of Immybot.
+
diff --git a/image-10.png b/image-10.png
diff --git a/image-2.png b/image-2.png
diff --git a/image-3.png b/image-3.png
diff --git a/image-6.png b/image-6.png
diff --git a/image-7.png b/image-7.png
diff --git a/image.png b/image.png
diff --git a/terminology.md b/terminology.md
@@ -59,9 +59,9 @@ This is particularly useful for security software, help desk portals, or anythin
 
 ### Offboarding
 
-Conversely, you could create Deployments that remove your stack for customers you are offboarding. 
+Conversely, you could create Deployments that remove your stack for customers you are offboarding.
 - Create an "Offboarding" product in your PSA
-- Create a deployment for each of the pieces of software you would like removed setting the desired state to Uninstalled 
+- Create a deployment for each of the pieces of software you would like removed setting the desired state to Uninstalled
 - Target all customers with the "Offboarding" product on their agreement
 
 Note: ImmyBot even honors the date range on additions, making scheduled offboarding easier if say the customer wants your software removed on the last day of the month.
@@ -266,3 +266,35 @@ If it is a machine ImmyBot has seen before, it will be associated to the existin
 Computers can have one or more RmmComputers(Agents). You can think of these as logical "pathways" to the computer. We only need one to be online to function.
 
 ![](./.vitepress/images/2021-02-23-06-45-47.png)
+
+## Target Visibility
+
+The Target Visibility feature helps control where and how software deployments, task deployments, and other actions can be accessed in ImmyBot. There is currently one option:
+
+[Technician Tools](#technician-tools): When enabled, this makes the deployment visible and accessible through the technician tools interface. This is useful for actions that can assist IT staff when working on support tickets.
+
+This option is located at the bottom of the deployment details page.
+
+![alt text](image-3.png)
+
+## Technician Tools
+
+Technician Tools is a specialized interface designed for IT technicians working within PSA (Professional Services Automation) tickets.
+
+Think of it as a streamlined "command center" that gives technicians quick access to the tools and information they need while working on a support ticket, without having to switch between different systems or search for the relevant computers and software details.
+
+### What it looks like
+
+When a technician opens a ticket from their PSA system (like HaloPSA), this page shows relevant deployments from ImmyBot that resolved to that ticket.
+
+![alt text](image-7.png)
+
+![alt text](image-6.png)
+
+### Deciding which deployments show up
+
+Deployment [target visibility](#target-visibility) determines if it is enabled for a particular page.  Technician Tools is one of the available visibility options. When this option is selected and the deployment resolves to a person, tenant, or computer associated with the opened PSA ticket, it will show up in the list.
+
+### Supported Integrations
+
+- [HaloPSA](/halo-integration-setup.md#technician-tools)