Skip to main content

Install ImmyBot Agent

Summary​

This script automates the installation of the ImmyBot Agent MSI installer with option to reinstall if needed.

Sample Run​

Image1

Dependencies​

User Parameters​

NameExampleAccepted ValuesRequiredDefaultTypeDescription
ReinstallAgentYesYes, NoNoNoFlagSet to ‘Yes’ to force a reinstall of the ImmyBot Agent.

Custom Fields​

NameExampleLevelTypeRequiredDescription
ImmyBot TenantxyzClientTextYesSubdomain part of your ImmyBot URL. For https://xyz.immy.bot, use xyz.
ImmyBot Installer IDcd87c48a-4ab2-4cab-ab6d-2c578ae646a9ClientTextYesAgent Installer ID.
ImmyBot Installer KeyRg6k0ITU4r1+AyCfI/VKWtN95+KVszyLFEJZ3PKigrD=ClientTextYesAgent Installer Key.

Obtaining Required Information​

ImmyBot Tenant​

  • Use the subdomain from your ImmyBot URL (xyz from https://xyz.immy.bot).
  • Save the value to the client-level custom field ImmyBot Tenant.

ImmyBot Installer ID and Key​

  • The Installer ID and Key are found in the install PowerShell script generated for your tenant.

Steps to Retrieve ID and Key​

  1. Open ImmyBot Agent Download

    • In the navigation pane, click the ImmyBot Agent button.
    • Click the Download link in the highlighted box.
      Image2

  2. Select Tenant

    • In the installer popup, select the correct tenant from the dropdown menu.
    • Click Next to proceed.
      Image3

  3. Choose Installer Format

    • Select PowerShell as the Installer Format.
    • Confirm your settings and options.
      Image4

  4. Generate Install Script

    • Click the Generate Install Script button.
    • Copy the generated PowerShell script from the field.
      Image5

  5. Extract ID and Key

    • Paste the copied script into a text editor.

    • Look within the script for the parameters labeled ID and KEY.

    • Example:

      PowerShell Script 1

    • The value after ID= is your ImmyBot Installer ID. Example: cd87c48a-4ab2-4cab-ab6d-2c578ae646a9

    • The value after KEY= is your ImmyBot Installer Key. Example: Rg6k0ITU4r1+AyCfI/VKWtN95+KVszyLFEJZ3PKigrD=

  6. Store Values

    • Save the ID and Key into the corresponding client-level custom fields:
      • ImmyBot Installer ID
      • ImmyBot Installer Key

Task Setup Path​

  • Tasks Path: AUTOMATION ➞ Tasks
  • Task Type: Script Editor

Task Creation​

Description​

  • Name: Install ImmyBot Agent
  • Description: This script automates the installation of the ImmyBot Agent MSI installer with option to reinstall if needed. Document: https://content.provaltech.com/docs/c2576ff2-e86f-43f7-94dc-462a7afbc7f1
  • Category: Application

Image6

Parameters​

Parameter NameRequired FieldParameter TypeDefault Value
ReinstallAgentDisabledFlagDisabled

ReinstallAgent:
Image8

Image7

Script Editor​

Row 1: Set Pre-defined Variable ( @ImmyBotTenant@ = ImmyBot Tenant )​

  • Variable Name: ImmyBotTenant
  • Type: Custom Field
  • Custom Field: ImmyBot Tenant
    - Operating System: Windows

Image9

Row 2: Set Pre-defined Variable ( @ImmyBotInstallerID@ = ImmyBot Installer ID )​

  • Variable Name: ImmyBotInstallerID
  • Type: Custom Field
  • Custom Field: ImmyBot Installer ID
  • Operating System: Windows

Image10

Row 3: Set Pre-defined Variable ( @ImmyBotInstallerKey@ = ImmyBot Installer Key )​

  • Variable Name: ImmyBotInstallerKey
  • Type: Custom Field
  • Custom Field: ImmyBot Installer Key
  • Operating System: Windows

Image11

Row 4: PowerShell script​

  • Use Generative AI Assist for script creation: False
  • Expected time of script execution in seconds: 600
  • Operating System: Windows
  • PowerShell Script Editor:

PowerShell Script 2

Image12

Row 5: Script Log​

  • Script Log Message: %Output%
  • Operating System: Windows

Image13

Completed Script​

Image14

Output​

  • Script Log

Changelog​

2025-08-04​

  • Initial version of the document