Using the Revealed Agent

To start the Revealed Agent, search for Teramind Agent on your Windows Start menu or Mac Finder. The Revealed Agent has a user interface similar to the one below:

Enter your username and password. If you do not have your credentials, please ask your admin to add you as a user/employee.
Click the Advanced link to select your server. This will bring up a pull-down menu where you can select your server. If you are a cloud customer, just select Teramind Cloud from the pull-down list. If you are an on-premise customer, enter the server instance name (the URL of your Teramind dashboard without the https).
Click the Save password option to enable/disable saving of your username and password.
When the Save password option is enabled, you will see another option, Stay logged. When this option is enabled, the user will be automatically logged in when the agent starts. The user will still have to select a task and click the Start button to activate monitoring (see below).
Click the Sign in button to start the Agent:

On the top of the interface, you will see the currently active task or a ‘Not active’ status.
To start/stop clock-in/clock-out: Select a task from the list and click the Start/ Stop button.
To view a list of tasks: Click the Tasks tab.
To view past activities: Click the History tab.
To search for a task: Click on the Search field and start typing.
To add a task or sub-task: Hover over a task or sub-task. Click the Plus icon to add a task.
To start a task: Hover over a task or sub-task. Click the Play icon to start the task.
At the bottom left, you will see the agent version.
Click the Gear icon at the top-right corner to Refresh tasks, Sign out or Exit the agent.

Revealed Agent Launch Parameters

Since Windows Agent 13.0 and Mac Agent 1.239, the Revealed/Visible Agent supports some command line parameters when launching the Agent. These parameters can be used to automatically log in a user and start a predefined task. This might be useful in situations where you want to run the Agent from another application or script. For example, if you already use a time-tracking application and still want to use Teramind for tracking detailed user activities and recording the screen.

Here is the list of the new launch parameters:

Launch Parameter	Description
`--run` Windows Agent only	Runs the Agent without the `tsvchst` service. This service helps manage the Agent, e.g., recovery from a crash, etc.
`--router <address>`	`<address>` is the domain name or IP address of your Teramind instance. For example: `192.168.1.201`, `acme.teramind.co`, etc.
`--username <username>`	`<username>` is the username/login ID of the user (usually the email address). For example: `[email protected]`.
`--password <password>`	`<password>` is the user's password. For example: `mYP@assw0rd`.
`--task-id <id>`	`<id>` is the task ID. For example: `123`. See the Getting the List of Tasks/Task IDs section below to learn how to get the task IDs.
`--hide-ui`	Hides the Agent window/UI and any messages that the Agent might display (e.g., the Connected/Reconnecting messages). If you don't use this parameter, then the Agent will be launched with its regular UI but it will log in the user and start the task passed in the `<task-id>` automatically.
`--hide-reconnecting` Windows Agent only	Hides only the reconnect messages. There’s no need to use this if you are using the `--hide-ui` parameter.

Example Usage (Windows Command Prompt)

tmagent.exe --run --router acme.teramind.co --username [email protected] --password mYP@ssw0rd --task-id 123 --hide-ui

Example Usage (Mac Terminal)

open '/usr/local/teramind/agent/bin/Teramind Agent.app' --args --router acme.teramind.co --username [email protected] --password mYP@ssw0rd --task-id 123 --hide-ui

Getting the List of Tasks/Task IDs

To get a list of tasks and task IDs, you can utilize the Teramind API. The command to use it is:

GET: https://<address>/tm-api/v1/tasks

Here, <address> is the domain name or IP address of your Teramind instance.

You can also use the link directly on the browser to get the list of tasks (note that you will have to log in as an administrator to get the list of tasks). For example:

https://acme.teramind.co/tm-api/v1/tasks

This will return a JSON string with the list of tasks and their IDs. For example:

[
    {
        "task_id": 4,
        "name": "Sales training",
        "parent_id": 0,
        "is_trackable": true,
        "assign": 1,
        "integration_id": null
    },
    {
        "task_id": 2,
        "name": "Data entry",
        "parent_id": 0,
        "is_trackable": false,
        "assign": 0,
        "integration_id": null
  }
]

Note that only task IDs with the is_trackable: true attribute can be used with the --task-id parameter. In the above example, only task ID 4 can be used.

Notes

If the network connection to the server is lost or you specify a wrong address in the --router parameter, the Agent will continue to try to reconnect until it’s successful.
If the user locks their computer, the Agent will be paused. When the user unlocks the computer, the Agent will continue from where it was paused, e.g., continue recording the same task.
If you want to change the user and/or task:
1. First stop the Agent with one of these commands:
  Windows Command Prompt:
```
taskkill /IM tmagent.exe /F
```
  Mac Terminal:
```
killall "Teramind Agent"
```
2. Then relaunch the Agent with the new username and/or task-id.

Launching the Revealed Agent without the Username/Password

Since Windows 24.31 we have added a new configuration parameter that can be used to automatically log into the Revealed Agent without entering the username/password. This can be done either through the config file or the installation command.

Via the Config File:

You can add the revealed-passwordless parameter to the config.cfg file:

revealed-passwordless=1
router=rt.teramind.co
instance=acme.co

Via the Installation Command:

You can use the /revealed-passwordless option with the EXE installer. For example:

teramind_agent_revealed_v5.0.0.exe /revealed-passwordless

Or, if you are using a MSI installer, use the TTMREVEALEDPASSWORDLESS parameter. For example:

msiexec /i teramind_agent_v5.0.0_x64.msi TMREVEALEDPASSWORDLESS=1 TMROUTER=10.55.55.58

When enabled, the Agent will automatically log in without requiring the user to enter any username/password.

If the login fails, the user will see an error message but they will not be able to edit any of the username and password fields or change other options:

Notes for Cloud Deployments

Cloud customers have to contact their customer service representatives to activate this feature on their instances.
Out of the box, this feature will work for cases where agents already exist in the system, for example as a result of Active Directory import. For all other cases, manual editing of the configuration file is required, i.e., the instance and router values need to be specified. For example:
```
instance = acme
router = rt.teramind.co
```

Notes for On-Premise Deployments

On-Premise customers can add the revealed.allow_passwordless=1 value to the kv_store to activate the feature.
To use the feature, the router parameter (config file) or -TMROUTER (MSI installation option) has to be set, as the user will not be able to select the Server option from the UI.

How to switch the Agent from Cloud to On-Premise or vice-versa

How to download and install the Teramind Agent

Windows Agent 13.0 (2023-05-19)

Mac Agent 1.239 (2023-05-19)

Windows Agent 24.31 (2024-08-30)