PxM Client for Windows

The PxM Client for Windows guide walks you through the installation process and explores the interface and available menu options. Also covered is the upgrade and uninstall process.

This section covers:

Prerequisites

Before you install the PxM Client for Windows ensure the following prerequisites have been met on your workstation to allow for a smooth installation:

  • Microsoft Windows with Microsoft .NET Framework Version 4.5.2 is required for PxM Platform release versions 4.6.3 and above.

  • Internet Explorer 11 or above / Google Chrome 70 or above.

The following information will be required when logging on and should be provided by the PxM superadmin

  • PxM Virtual Appliance address.

  • PxM user credentials. Depending on how the PxM Platform has been configured, this will either be a local PxM user account or an existing external account (Active Directory or RADIUS).

Installation steps

The installation of the PxM Client should only take a few minutes.

To install:

  1. Download the PxM Client installation package from the PxM Virtual Appliance download page. Open a web browser window and enter the following: https://(PxM_Virtual_Appliance_address).

    The page contains:

    • Download links for the PxM Client for Windows and MacOS.
    • User guide : Navigates you to the PxM Client online documentation.
    • Checksum : used to confirm the downloaded file is identical.
    • Host Key Fingerprint: used to verify that the PxM Client is connecting to the correct PxM Virtual Appliance address during logon.

    PxM-Components

  2. Click the Download button under Windows and save the Installer.exe file to a preferred location.

  3. Run the downloaded Installer.exe. The Desktop Client Setup window will open.

  4. Within the Choose Install Location select the folder location on your workstation for the installation of the PxM Client.

    Folder installation options include:

    • Installing to the default location : The default location will install to your home directory and does not require admin rights.

      C:\Users\username\AppData\Local\Osirium\Desktop Client

    • Installing to Program Files or Program Files (x86) : The PxM Client installer will need to be run as an administrator and the installation will be installed to:

      C:\Program Files\Desktop Client*

    Choose install location

  5. Click Next.

  6. In the Choose Start Menu Folder, accept the default or select a new shortcut location. If you do not wish to create a shortcut then tick the Do not create shortcuts checkbox.

    Choose install location

  7. Click Install.

  8. In the Complete the Desktop Client Setup Wizard, leave the checkboxes ticked.

    Warning

    If your workstation uses a web proxy then certain Windows settings need to be applied to allow the PxM Client to make web single sign-on connections.

    Click the link within the window or click here to view the Web Proxy Settings article available on the Osirium Support portal. This article will walk you through the configuration required on your internet options.

    Complete setup

  9. Click Finish to complete the installation. The Desktop Client Setup window is closed. Your installation of the PxM Client is now complete.

    The following can be found in your choose installation location:

    • Application files : including the Osirium.exe, Uninstall.exe and debug.log files.

    • Resources folder : contains the applications that will be used to launch a device tool selected within the PxM Client interface.

    • Trace.log files : keep a log of events (connections and authentication attempts) that occur on the PxM Client. Trace log files can be found in: C:\Users\username\AppData\Local\Osirium\Logs\Desktop Client

Logging on

Logging on via the PxM Client will authenticate your PxM user to the PxM Platform. Once successfully logged in, the PxM Client interface will dynamically update and present you with your personalised device access list. The device tools and tasks available to you will be aligned to your specific job role requirements.

To logon:

  1. By default, the Login window will automatically appears on your desktop. To manually display the Login window, click the PxM icon on the taskbar Taskbar icon.

    PxM Client Login

  2. Within the Login window enter the following:

    Field name Description
    Address: Enter the address (IP Address or hostname) of the PxM Virtual Appliance you want to connect to.
    Username/Password: Either enter your PxM user details as advised by your PxM superadmin.
    Token code: If multi factor authentication has been configured then enter the token code provided by your PxM superadmin. Only after successful verification of both the password and token code will you be logged in.
  3. Click Login.

  4. You will be asked to confirm the host key fingerprint which can be found on the Welcome to the PxM Platform download web browser page.

    Host key fingerprint

  5. Confirm the host key fingerprint matches that of the PxM Virtual Appliance, then click Yes. The Login window is closed. The PxM Client icon in the system tray changes from Logged out grey to Logged in blue when login has been successful.

    You will also be presented with the PxM Client interface window which will dynamically update and present you with a list of devices and accessible device tools and device tasks.

    An Osirium.exe.config file is created which will store the entered address and username. If you are logging onto multiple PxM Virtual Appliances the addresses will be available in the Address drop-down listbox.

    Interface device list

Customising your view

  • Device list view : To customise and organise your device list, right-click a device and select one of the following options.

    Options Description
    Pin Pinning allows you to place devices at the top of your PxM Client interface device list. This is useful when you have a lot of devices in the list but have a handful of devices which are accessed on a regular basis.
    Collapse All Hides the tools and tasks available for each device.
    Expand All Shows the tools and tasks available for each device.
  • Resizing the PxM Client interface : To resize the PxM Client interface window, using the left mouse button, click, hold and drag the edges of the window. When you release the mouse the resize changes will be automatically saved.

Right-clicking on the PxM Client icon in the System tray provides the following menu options:

Menu options Description
Login Opens up the Login window. Left-clicking the PxM Client icon running in the taskbar and selecting Desktop Client will also open the Login window.
Logout Logs you out of the PxM Platform and disconnects all open device session connected through the PxM Platform. The PxM Client icon will remain running in the System Tray but the icon will be grayed out Logged out .
Change Password Only locally authenticated PxM users have the ability to change their passwords.
Show Logs Opens up an File Explorer window were the PxM Client log files are stored on your workstation. These logs can be useful to help diagnose problems you may be having with the PxM Client.
About Displays the PxM Client versioning and copyright information. Clicking on the Techout button generates and opens the techout file. The techout file contains diagnostic data which maybe useful to send to your superadmin when you are having issues with your PxM Client.
Exit Logs you out of the PxM Platform and disconnects all open device session. The PxM Client icon will also be closed and will not be visible in System Tray.

Running multiple PxM Clients

Multiple instances of the PxM Client can be run to allow connections to different PxM Virtual Appliances. When multiple PxM Clients are running, the icons in the System Tray will be appended with an instance number Client numbered.

Note

No instance number will be shown within the PxM Client icon if: - only one instance of the PxM Client is running; or - that instance of the PxM Client has a custom client colour.

Customising the PxM Client colour

To easily identify between connections to different PxM Virtual Appliances the PxM Client can be colour-coded to help distinguish between the PxM Virtual Appliances connected to.

When configured the specified colour will appear as a border around the PxM Client icon and within the PxM Client interface window.

In the example below, the colour has been set to purple.

Client colour

Upgrading

After the initial installation, the PxM Client will be automatically upgraded during logon if the PxM Virtual Appliance has been upgraded. This ensures you have the correct version compatible with the PxM Virtual Appliance and the benefits of the latest features and updates.

  1. Logon to the PxM Client, the Osirium Autoupdater window will open if an update is required.

  2. Before clicking Apply, ensure all other PxM Clients on your workstation are exited, then click Apply to complete the installation.

    Client updater

  3. Once successfully upgraded, the PxM Client Login window will open. Installation is now complete and you can continue to login.

Uninstalling

The PxM Client uninstall can either be run from the Control Panel or from the Start Menu of your workstation. Uninstalling will remove the PxM Client application and files from your system. You will no longer be able to access the PxM Platform and your device list.

To uninstall the PxM Client:

  1. Run the Osirium - Desktop Client uninstall executable.

  2. Within the Desktop Client Uninstall window, click OK.

    Client uninstaller

  3. When the uninstall has successfully completed, click Close within the Desktop Client Uninstall window.

    Client uninstall complete