# CAXperts Licence Portal

## Requesting access

To request access, please contact CAXperts at <support@caxperts.com>.

Please include the following details for each user who needs access:

- Email address
- First name
- Last name

Once your login has been issued, you will receive an invitation email similar to the one shown below:

![Example invitation email](./media/image7.png)

Select **SIGN UP** to register your account and create a password.

## Opening the portal

1. Go to <https://licensing.caxperts.com/>.
2. Log in using your credentials.

## Licence overview

All customer licences are listed under the **Licences** section of the portal.

![Licences overview](./media/image8.png)

Depending on the licence type, additional actions and pages may be available.

| Item | Icon | Description |
| --- | --- | --- |
| Assignments | ![Assignments icon](./media/image9.png) | Opens the list of device assignments for a licence. |
| Sessions | ![Sessions icon](./media/image10.png) | Opens the list of active sessions (floating licences only). |
| Copy licence key | ![Copy licence key icon](./media/image1.png) | Copies the licence key to the clipboard. |

## Assignments

The **Assignments** view shows the relationship between a licence and the devices that are using it.

| Action | Icon | Description |
| --- | --- | --- |
| Copy internal token ID | ![Copy token ID icon](./media/image2.png) | Copies the internal token ID. |
| Show internal token ID | ![Show token ID icon](./media/image11.png) | Displays the internal token ID. |
| Name an activation | ![Name activation icon](./media/image3.png) | Assigns a friendly name to the activation. |
| Suspend / unsuspend a device | ![Suspend icon](./media/image4.png) ![Unsuspend icon](./media/image12.png) | Suspends or unsuspends a device (see below). |
| Copy client ID | ![Copy client ID icon](./media/image13.png) | Copies the client ID. |
| Unassign / delete activation | ![Unassign icon](./media/image14.png) | Unassigns (deletes) the activation. |
| View device heartbeats | ![Heartbeats icon](./media/image15.png) | Shows the heartbeats for the device. |

### Suspending a device

Select the suspend button ![Suspend button](./media/image16.png) to block a device for a defined time period. While suspended, all licence requests from that device will be rejected.

![Suspend device dialogue](./media/image17.png)

To remove the block, select the **unsuspend** action.

## Sessions

The **Sessions** view shows currently open sessions. This is only available for floating licences.

| Action | Icon | Description |
| --- | --- | --- |
| Close a session | ![Close session icon](./media/image18.png) | Closes a single session. |
| Close all sessions | ![Close all sessions icon](./media/image19.png) | Closes all sessions for the licence. |

## Session analytics

To view analytics, open the **Sessions** page and select the **Analytics** tab.

![Analytics tab](./media/image20.png)

On this page you can set a date range and view reports.

![Analytics reports](./media/image21.png)

| Action | Icon | Description |
| --- | --- | --- |
| Zoom in | ![Zoom icon](./media/image22.png) | Zooms into the selected area of the chart. |
| Open details | ![Details icon](./media/image6.png) | Opens the details view for the report. |
| Settings | ![Settings icon](./media/image23.png) | Opens report settings. |

To download a report, select the download icon:

![Download icon](./media/image24.png)

This opens a detailed view where you can export the data.

![Export options](./media/image25.png)

| Format | Icon | Description |
| --- | --- | --- |
| CSV | ![CSV download icon](./media/image5.png) | Downloads the data as a CSV file. |
| Excel | ![Excel download icon](./media/image26.png) | Downloads the data as an Excel file. |

## UDiTH components and floating licences

### UDiTH Builder / Adapters

Running UDiTH Builder/Adapters does not open a session.

### UDiTH

Each UDiTH session (starting the software) consumes one token from the UDiTH licence.

If a licence is borrowed (checked out), one token remains blocked until the licence is returned.

## Support

For any questions, please contact <support@caxperts.com>.