Merge f7f6f6e into 4766477

api/tacticalrmm/autotasks/models.py

@@ -413,7 +413,7 @@ def send_email(self):
         from core.models import CoreSettings
 
         CORE = CoreSettings.objects.first()
-
+        # Format of Email sent when Task has email alert
         if self.agent:
             subject = f"{self.agent.client.name}, {self.agent.site.name}, {self.agent.hostname} - {self} Failed"
         else:
@@ -427,11 +427,10 @@ def send_email(self):
         CORE.send_mail(subject, body, self.agent.alert_template)
 
     def send_sms(self):
-
         from core.models import CoreSettings
 
         CORE = CoreSettings.objects.first()
-
+        # Format of SMS sent when Task has SMS alert
         if self.agent:
             subject = f"{self.agent.client.name}, {self.agent.site.name}, {self.agent.hostname} - {self} Failed"
         else:

api/tacticalrmm/scripts/community_scripts.json

@@ -276,7 +276,7 @@
     "guid": "5320dfc8-022a-41e7-9e39-11c493545ec9",
     "filename": "Win_AD_Hudu_ADDS_Documentation.ps1",
     "submittedBy": "https://github.com/unplugged216",
-    "name": "ADDS - Direcotry documentation in Hudu",
+    "name": "ADDS - Directory documentation in Hudu",
     "description": "Auto generates ADDS documentation and submits it to your Hudu instance.",
     "args": [
       "-ClientName {{client.name}}",

docs/docs/3rdparty_screenconnect.md

@@ -0,0 +1,103 @@
+# Screenconnect / Connectwise Control
+
+## Connectwise Control Integration
+
+!!!info
+     To make this work you will need the name of a the Service from one of your agents running a Screen Connect Guest.
+
+!!!info
+     You can setup a full automation policy to collect the machine GUID but this example will collect from just one agent for testing purposes.
+
+From the UI go to **Settings > Global Settings > CUSTOM FIELDS > Agents**
+
+Add Custom Field</br>
+**Target** = `Client`</br>
+**Name** = `ScreenConnectService`</br>
+**Field Type** = `Text` </br>
+**Default Value** = `The name of your SC Service eg. ScreenConnect Client (XXXXXXXXXXXXXXXXX)`</br>
+
+![Service Name](images/3rdparty_screenconnect1.png)
+
+Add Custom Field</br>
+**Target** = `Agent`</br>
+**Name** = `ScreenConnectGUID`</br>
+**Field Type** = `Text`</br>
+
+![Service Name](images/3rdparty_screenconnect2.png)
+
+While in Global Settings go to **URL ACTIONS**
+
+Add a URL Action</br>
+**Name** = `ScreenConnect`</br>
+**Description** = `Launch Screen Connect Session`</br>
+**URL Pattern** =
+
+```html
+https://<your_screenconnect_fqdn_with_port>/Host#Access/All%20Machines//{{agent.ScreenConnectGuid}}/Join
+```
+
+![Service Name](images/3rdparty_screenconnect3.png)
+
+Navigate to an agent with ConnectWise Service running (or apply using **Settings > Automation Manager**).</br>
+Go to Tasks.</br>
+Add Task</br>
+**Select Script** = `ScreenConnect - Get GUID for client` (this is a builtin script from script library)</br>
+**Script argument** = `-serviceName{{client.ScreenConnectService}}`</br>
+**Descriptive name of task** = `Collects the Machine GUID for ScreenConnect.`</br>
+**Collector Task** = `CHECKED`</br>
+**Custom Field to update** = `ScreenConectGUID`</br>
+
+![Service Name](images/3rdparty_screenconnect4.png)
+
+Click **Next**</br>
+Check **Manual**</br>
+Click **Add Task**
+
+Right click on the newly created task and click **Run Task Now**.
+
+Give it a second to execute then right click the agent that you are working with and go to **Run URL Action > ScreenConnect**
+
+It should ask you to sign into your Connectwise Control server if you are not already logged in and launch the session.
+
+*****
+
+## Install Tactical RMM via Screeconnect commands window
+
+1. Create a Deplopment under **Agents > Manage Deployments**
+2. Replace `<deployment URL>` below with your Deployment Download Link.
+
+**x64**
+
+```cmd
+#!ps
+#maxlength=500000
+#timeout=600000
+
+Invoke-WebRequest "<deployment URL>" -OutFile ( New-Item -Path "C:\temp\trmminstallx64.exe" -Force )
+$proc = Start-Process c:\temp\trmminstallx64.exe -ArgumentList '-silent' -PassThru
+Wait-Process -InputObject $proc
+
+if ($proc.ExitCode -ne 0) {
+    Write-Warning "$_ exited with status code $($proc.ExitCode)"
+}
+Remove-Item -Path "c:\temp\trmminstallx64.exe" -Force 
+```
+
+**x86**
+
+```cmd
+#!ps
+#maxlength=500000
+#timeout=600000
+
+Invoke-WebRequest "<deployment URL>" -OutFile ( New-Item -Path "C:\temp\trmminstallx86.exe" -Force )
+$proc = Start-Process c:\temp\trmminstallx86.exe -ArgumentList '-silent' -PassThru
+Wait-Process -InputObject $proc
+
+if ($proc.ExitCode -ne 0) {
+    Write-Warning "$_ exited with status code $($proc.ExitCode)"
+}
+Remove-Item -Path "c:\temp\trmminstallx86.exe" -Force 
+```
+
+*****

docs/docs/functions/custom_fields.md

@@ -7,6 +7,9 @@
 
 In the dashboard, go to **Settings > Global Settings > Custom Fields** and click **Add Custom Field**.
 
+!!!info
+    Everything between {{}} is CaSe sEnSiTive
+
 The following options are available to configure on custom fields:
 
 - **Model** - This is the object that the custom field will be added to. The available options are:

docs/docs/functions/keystore.md

@@ -6,4 +6,7 @@ To Add/Edit values in the Global Key Store, browse to **Settings > Global Settin
 
 You can reference values from the key store in script arguments by using the {{global.key_name}} syntax.
 
+!!!info
+    Everything between {{}} is CaSe sEnSiTive
+
 See [Scripts](scripting.md) for more information.

docs/docs/functions/scripting.md

@@ -73,7 +73,7 @@ Tactical RMM allows passing in dashboard data to scripts as arguments. The below
 ```
 
 !!!info
-    Script variables are case-sensitive!
+    Everything between {{}} is CaSe sEnSiTive
 
 See a full list of available options [Here](../script_variables.md)
 

docs/docs/script_variables.md

@@ -4,6 +4,9 @@ Tactical RMM allows passing dashboard data into script as arguments. This uses t
 
 See below for the available options.
 
+!!!info
+    Everything between {{}} is CaSe sEnSiTive
+
 ## Agent
 
 - **{{agent.version}}** - Tactical RMM agent version

docs/docs/tipsntricks.md

@@ -8,45 +8,3 @@ At the top right of your web administration interface, click your Username > pre
 
 *****
 
-## Screenconnect / Connectwise Control
-
-### Install Tactical RMM via Screeconnect commands window
-
-1. Create a Deplopment under Agents > Manage Deployments
-2. Replace `<deployment URL>` below with your Deployment Download Link.
-
-**x64**
-
-```cmd
-#!ps
-#maxlength=500000
-#timeout=600000
-
-Invoke-WebRequest "<deployment URL>" -OutFile ( New-Item -Path "C:\temp\trmminstallx64.exe" -Force )
-$proc = Start-Process c:\temp\trmminstallx64.exe -ArgumentList '-silent' -PassThru
-Wait-Process -InputObject $proc
-
-if ($proc.ExitCode -ne 0) {
-    Write-Warning "$_ exited with status code $($proc.ExitCode)"
-}
-Remove-Item -Path "c:\temp\trmminstallx64.exe" -Force 
-```
-
-**x86**
-
-```cmd
-#!ps
-#maxlength=500000
-#timeout=600000
-
-Invoke-WebRequest "<deployment URL>" -OutFile ( New-Item -Path "C:\temp\trmminstallx86.exe" -Force )
-$proc = Start-Process c:\temp\trmminstallx86.exe -ArgumentList '-silent' -PassThru
-Wait-Process -InputObject $proc
-
-if ($proc.ExitCode -ne 0) {
-    Write-Warning "$_ exited with status code $($proc.ExitCode)"
-}
-Remove-Item -Path "c:\temp\trmminstallx86.exe" -Force 
-```
-
-###