PxM Client for macOS

The PxM Client for macOS guide walks you through the installation process and explores the interface and available menu options. Also covered is the 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:

  • macOS/OSX 10.9 or above.

  • Safari 10 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

  • Click the Download button under MacOS and save the PxMClient_[version_no].dmg file to a preferred location.

  • Within the Application window, drag the PxM Client icon to the Applications folder on the right.
    PxM-Components

  • From the Applications folder double-click the PxM Client to launch. The Login window will open and the PxM Client icon will appear in the dock.

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. If the PxM Client Login window doesn't automatically appear then click on the PxM icon Taskbar icon in the dock.

    Mac PxM Client Login

    Note

    If you get an error the first time the PxM Client is run, close the dialog and relaunch.

  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.

    Interface device list

    An Info.plist 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.

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
    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.

PxM Client menu options

When the PxM Client has been launched click within the PxM Client Login window. The PxM Client menu will change to match the active window.

Menu options

Note

The Services menu option will not be explained as it is not specific to the PxM Client.

About PxM Client

The About PxM Client displays the versioning and copyright information.

Preferences

The Preferences allow you to update the following settings to suit your requirements:

  • Tools tab: : The tools list defines the commands that will be used by the client to launch a specific program, when the user tries to single sign onto a device tool.

    By default, the operating system default programs will be used unless specified otherwise.

    Preference options

  • Search tab: : Depending on your preference, you can change the search mode to one of the following:

    Search mode Description
    Substring Allows you to find a place where one or several patterns are found. The PxM Client will update your list as soon as you start typing in the Search window. Once you have typed the first search string, you can hit enter and then type a second search string which searches within what has been found already.
    Regex Allows you to use regular expressions to find patterns of text.

    Preference search

  • Other menu options:

    Option Description
    Hide PxM Client Hides the application which is currently the active window.
    Hide Others Hides all the applications apart from the active window.
    Show All Shows all the applications that are currently open.
    Quit PxM Client If your application is not responding use this option to force a shutdown of the application.

Connection menu options

The options listed under the connection menu are as follows.

Connections menu options

Menu option Description
Connection Status Shows all the open connections made through the PxM Platform. Connections window
Change Password Only locally authenticated PxM users have the ability to change their passwords.
Log Out Logs you out of the virtual appliance and disconnects all open device session connected through PXM Virtual Appliance. The PxM Client icon will remain running in the System Tray but the icon will be grayed out.
Change Tickets See Change ticket management tool.

PxM Client icon options

When you right-click the PxM Client in the Docker, you will see the following options.

Option Description
Keep in Dock The Dock is the bar of icons that sits at the bottom or side of your screen. To make the PxM Client accessible in the Dock select this option.
Open at Login The PxM Client will automatically open after login.
Show in Finder Will organise your PxM Client application so it can be found on the desktop or menu bar.

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. You will be presented with the Software update window.

    PxM-Components

  2. Click Install Update.

  3. Within the Updating PxM Client window, click the Install and Relaunch button. Wait while the PxM Client is installed.

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

Uninstalling

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. From your workstation, open the Application folder.

  2. Find the PxM Client application in your menu bar.

  3. Drag the PxM Client application icon into the Trash, located at the end of your Dock.

  4. Select Finder > Empty Trash to delete from your system.