Product Documentation

Supporting Terminal Emulators

May 11, 2015

To enable HLLAPI support for any terminal emulator in Single Sign-on, you must enable support for terminal emulators in the console.

When terminal emulator support is enabled, SSOShell starts the Ssomho.exe process. This process first reads the Mfrmlist.ini file located at %Program Files%\Citrix\MetaFrame Password Manager\Helper\MFEmu, then looks for all configured emulators and attempts to load the HLLAPI-compliant .dll assigned in the file.

The Mfrmlist.ini file can be extended to accommodate additional HLLAPI-compliant emulators.

The Ssomho.exe process looks in the HKEY_LOCAL_MACHINE\SOFTWARE registry hive for the location of the HLLAPI-compliant .dll unless otherwise specified in the Mfrmlist.ini file.

Some terminal emulators place the location in the HKEY_CURRENT_USER hive. For those emulators, manually specify the location of the DLL file using the explicit path setting in the Mfrmlist.ini file.

To configure emulator support

Configuring Single Sign-on to work with the tested emulator programs is a multistep process. This process requires installing the emulator software, creating an emulator session to be used with Single Sign-on, and configuring Single Sign-on with a terminal emulator-based application definition that uses text matching so it can recognize a particular emulator session.

  1. Install the terminal emulator software and restart the computer.
  2. Start the terminal emulator software and create a new session, defining the display and the connection.
  3. Set the session short name.
  4. Enable HLLAPI API support.
    Note: A separate terminal emulator application definition is required for each unique session that will be used with Single Sign-on. The plug-in software detects sessions by matching text on the terminal emulator-based application screen with text in a specified row and column provided in the application definition. Single Sign-on submits the credentials based on row and column information provided in the application definition. Therefore, each unique session requires its own host application definition.
  5. Save and close your session.
  6. Exit the terminal emulator.
  7. Create an application definition for the host application.
  8. Open the console and verify that support is enabled in the appropriate user configurations.
  9. Run the emulator and open the session.
  10. Start or refresh the Single Sign-on Plug-in software.
The plug-in software recognizes the connection screen and displays a form for credentials to be entered and saved.