Invarosoft Deployment Guide

Modified on Mon, Oct 5 at 8:34 PM

IT
ITSupportPanel · Deployment

Invarosoft Deployment Guide

 Everything you need to roll out the ITSupportPanel agent: how to get the installer, how activation and user authentication work, what each error response code means, and how to uninstall the agent.

1 · Obtaining the agent installer

We deliver the agent installer through a CDN, so you get it quickly and you're always deploying the latest version.

Base download URLs

These links always deliver the latest installer:

MSI installer
https://goto.invarosoft.com/?id=latest-win-msi
Bootstrapped EXE
https://goto.invarosoft.com/?id=latest-win-exe
Pre-named MSI installer

Use this URL format to download an MSI already named with a client's activation code, so it activates automatically when installed (see MSI file name under Activation during installation).

https://goto.invarosoft.com/?id=latest-win-msi&code=ACTIVATION_CODE
Example: https://goto.invarosoft.com/?id=latest-win-msi&code=ABCDEFGHIJ
Storing the installer locally
Keep it up to date: you can store our installer on your server or on client file shares, but make sure you have a process to keep it updated. Future changes to our code may cause older installers to fail.
2 · Activation process

Activation is the first step after installing the agent. It links the agent to your Invarosoft partner record and to the right client in your partner account.

Activation codes

Each activation code is a 10-character alphabetic value, unique to one client across our entire partner base. Once a code is created and assigned to a client, it never changes.

Activation during installation

You can activate the agent as part of the MSI installation in two ways, so you have flexibility when writing your deployment scripts.

Option A · MSI parameter

Pass the activation code to msiexec.exe with the ACTIVATION parameter:

msiexec.exe /i MSI_FILE /q ACTIVATION=ACTIVATION_CODE
Example: msiexec.exe /i c:\installers\itsp.installer.msi /q ACTIVATION=ABCDEFGHIJ
Option B · MSI file name

Include the activation code in the MSI file name. The installer reads it from there:

itsp.installer_ACTIVATION_CODE.msi
Example: itsp.installer_ABCDEFGHIJ.msi
Note: these two methods only work to install and activate a new agent. They won't re-activate an agent or change its activation.
Activating after installation

Run this command against our service executable:

itsp.windows.service.exe activate ACTIVATION_CODE

Or with the full path:

C:\"Program Files (x86)"\"Invarosoft Pty Ltd"\itsp.windows\bin\itsp.windows.service.exe activate ACTIVATION_CODE
Deactivating after installation

Run this command against our service executable:

itsp.windows.service.exe deactivate

Or with the full path:

C:\"Program Files (x86)"\"Invarosoft Pty Ltd"\itsp.windows\bin\itsp.windows.service.exe deactivate
Tip: the agent's bin folder is registered in the Windows PATH variable, so you can run these commands from any folder. If a device doesn't recognize the command because of its specific configuration, use the full path shown above.
3 · User authentication

Once the agent is activated, the next step is making sure it's signed in as the right user. Authentication gives each user a personalized experience.

Before the user logs in

Every agent feature that doesn't need a user works right away, which helps your end users start engaging with Invarosoft. If a user tries a feature that does need identification, they're prompted to register or log in at that moment.

Authentication methods

We offer six methods to get your users logged in, each explained below:

1
AD Harvester Fully automated

Automatically authenticates users when agents run on a network managed by Microsoft Active Directory. It requires setting up the AD Harvester on the network's domain controller.

Once set up, users are logged in automatically, based on the relationship between their Windows user account and their PSA user or contact record. You'll find more AD Harvester resources in the Invarosoft Portal.

2
First ticket log identification

Works like Manual Registration (method 3), with one key difference. When the user logs their first ticket, they're asked for their first name, last name and email. If manual registration would have succeeded, the ticket is accepted and a confirmation email is sent to that address asking the user to confirm their identity.

Once the user confirms, two things happen:

  1. The ticket held in our system is released to the PSA.
  2. An Agent User Assign is run, logging the user into their agent.
3
Manual registration Not recommended

Checks the user against the list of users Invarosoft has for that client. The registration email contains what the user needs to enter in the agent's login screen.

We don't recommend this method because it requires more work from your client's users.

4
Assignment
Agent Assign

In the Invarosoft Portal, use the Assign button under the Users column on the agent screen. The selected user is queued for the agent to pick up.

If more than one instance of the app is running on that endpoint, it works on a first-in, first-served basis. That's why we recommend this method only for agents with a single user profile.

Agent User Assign

Use the Manage button under the Users column on the agent screen. It opens a list of the users seen on that agent; a user appears there after the agent runs for the first time under their profile.

This method isn't affected by multi-user environments, because the assignment targets a specific user context rather than the whole agent.

Not permanent: for both types of assignment, once the agent consumes the assignment it's cleared on the server side. To lock an agent to a specific user, use Agent Locked User (method 5).
5
Agent locked user

Set it on the agent's Edit screen. It forces login as the selected user on every instance of the agent running on that endpoint.

Note: the agent can't be logged out with this method. Any logout attempt results in an immediate re-login.
6
Client locked user

Set it on the client's Edit screen. It forces login as the selected user on every agent activated for that client.

Note: the agent can't be logged out with this method. Any logout attempt results in an immediate re-login.
4 · Activation & authentication response codes

When activation, registration or login fails, the agent shows a response code that explains exactly what went wrong. In most cases you can use it to fix the issue without contacting our support team.

Activation response codes
ACT-0An unhandled exception occurred on our server. For further diagnosis, email support@invarosoft.com including the GUID shown in brackets just before the [ACT-0] code.
ACT-1The request our server received was malformed or corrupted. Make sure nothing (firewall filtering, antivirus, etc.) is interfering with the HTTPS POST sent to our API server (https://api.itspservice.net).
ACT-2The activation code is invalid. This usually means the code was mistyped.
ACT-3The client's user directory isn't available. This is a server-side issue with the client's setup. Email support@invarosoft.com with the activation code used, mentioning it returned an [ACT-3] error.
ACT-4Creating the agent on our platform failed. Try again, and if the problem persists, email support@invarosoft.com for help.
Registration response codes
USU-1Registration succeeded, but sending the registration email to the newly created user failed. Try again, and if the problem persists, email support@invarosoft.com with the agent name and the email address used.
USU-2Creating the user failed (the record was not returned). Try again, and if the problem persists, email support@invarosoft.com with the agent name and the email address used.
USU-3The email address failed domain validation against other users of the same client. This usually means the user is registering with a non-company email. To fix it, create the user manually.
USU-4An unhandled exception occurred on our server while creating the user. For further diagnosis, email support@invarosoft.com including the GUID shown in brackets just before the [USU-4] code.
USU-5The request our server received was malformed or corrupted. Make sure nothing (firewall filtering, antivirus, etc.) is interfering with the HTTPS POST sent to our API server (https://api.itspservice.net).
USU-6An unhandled exception occurred on our server. For further diagnosis, email support@invarosoft.com including the GUID shown in brackets just before the [USU-6] code.
USU-7Registration succeeded, but issuing a password for the user failed. Try again, and if the problem persists, email support@invarosoft.com with the agent name and the email address used.
USU-8Registration succeeded, but sending the registration email to an existing user failed. Try again, and if the problem persists, email support@invarosoft.com with the agent name and the email address used.
USU-9A user record exists for that email, but it's inactive in the PSA or the Invarosoft Portal. Make sure the right user record is active.
USU-10Multiple user records were found for that email. Make sure the right user record is active.
Login response codes
USO-1The credentials don't exist for the client the agent is activated for (inactive users excluded from the check).
USO-2The credential check returned more than one user record. This shouldn't happen: email support@invarosoft.com with the email address used as the username and the agent name.
USO-3The credentials don't exist for the client the agent is activated for (inactive users included in the check).
USO-4The credentials exist, but the user is inactive in the PSA.
USO-5The credentials exist, but the user is inactive in the Invarosoft Portal.
USO-6This code should never appear. If it does, email support@invarosoft.com with the agent name and the email address used so we can review it.
USO-7More than one inactive user was found. Make sure the right user record is active.
USO-8The request our server received was malformed or corrupted. Make sure nothing (firewall filtering, antivirus, etc.) is interfering with the HTTPS POST sent to our API server (https://api.itspservice.net).
USO-9An unhandled exception occurred on our server. For further diagnosis, email support@invarosoft.com including the GUID shown in brackets just before the [USO-9] code.
5 · Uninstalling the agent
Uninstall and keep the configuration

Removes ITSupportPanel but keeps its configuration data. Use it if you plan to reinstall and want to keep the existing configuration.

itsp.windows.service.exe removeclean

Or with the full path:

C:\"Program Files (x86)"\"Invarosoft Pty Ltd"\itsp.windows\bin\itsp.windows.service.exe remove
Uninstall and wipe the configuration

Removes ITSupportPanel and wipes its configuration (activation, etc.) at the same time.

itsp.windows.service.exe removeclean

Or with the full path:

C:\"Program Files (x86)"\"Invarosoft Pty Ltd"\itsp.windows\bin\itsp.windows.service.exe removeclean
Tip: the agent's bin folder is registered in the Windows PATH variable, so you can run these commands from any folder. If a device doesn't recognize the command because of its specific configuration, use the full path shown above.
Invarosoft · ITSupportPanel documentation

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article