IBM Support

IBM HACP Extended Edition

Product Documentation


Abstract

IBM HACP Extended Edition is a plugin free, web-based terminal emulator. Unlike IBM Host On-Demand, HACP EE does not download any binaries that run on the client machine.

HACP EE reads the existing session definitions from Host On-Demand server and allows users to connect to their System z and System i hosts through an HTML5 compatible browser.

Content

How does it work?

HACP EE runs on an application server and provides the end users with a web-based interface to access the pre-configured HOD sessions and connect to the host systems.

It can fetch 3270/5250 display session configurations from both HTML-based model and configuration server-based model pages of Host On-Demand.

The following figure shows how a typical HACP EE setup works:

  • User opens a HTML5 compatible web browser and navigates to HACP EE application
    • Typically http(s)://<appserver_address:port>/hex/<hod_page_name>
  • HACP EE dashboard appears based on the html page requested by the user.
    • In case of HTML-based model page, session configurations are retrieved from HOD publish directory and listed.
    • If it’s a configuration-based model page, a login screen is presented using which an HOD user can login to fetch the session configurations.
  • User clicks on a session icon to connect to the host system.
  • HACP EE processes the request and renders the terminal screen on the web browser.
  • User interacts with the host using the terminal screen.

Why use IBM HACP EE?

  • Zero Foot Print - Nothing gets downloaded to end users' systems
  • No dependency on Java or any other browser plugins
  • Secure access to host systems using HTTPS and TLS connectivity
  • HTML5 compatible
  • Intuitive and user centric design

IBM HACP EE features:

  • Terminal Screen on the browser
    • New UI using HTML5 canvas for emulator screen
    • Field-based rendering of host data
  • Operator Information Area (OIA)
    • OIA using HTML5 canvas
    • Updates to cursor position and keyboard lock/unlock status
  • Productivity features
    • Context menu for Copy/Paste and disconnect operations
    • Host keypad
  • HOD integration
    • Interface for HOD client login to access session configurations from HOD configuration server
    • Access to both HTML-based and configuration server-based pages created using HOD deployment wizard
  • Security
    • TLS connectivity to host systems
  • Session Manager API
    • HACP EE also supports specialized APIs, called Session Manager APIs. These JavaScript-based APIs help application developers manage host sessions and text-based interactions with host sessions.
    • Refer to Session Manager API for configuration details and list of API's supported.
  • License tracking
    • HACP EE clients can be tracked using the Host Integration License Manager (LM) deployed on an application server. For configuration steps, refer to HACP License Manager
  • Touchpad support
    • Support for touch-enabled devices for HACP EE clients, so that the users can work with system touch keypad or use tap events on green screen.
  • Edit session properties
    • Configuration model-based users can edit session parameters from HACP EE clients, if they are not locked by an administrator.
  • Play Macros
    • All existing macros associated and configured with HOD sessions can be played using HACP EE client. The macro is played on the HACP EE application server, so users will not be able to see intermediate screens. The users will be able to play macros from the following locations:
      • Current session
      • Local macro
      • Server macro library (web only)
  • Keyboard Remap
    • Host On-demand users can map a single key or a key combined with Shift, Ctrl, or Alt to some action in session configuration. The action can be to display a character, to execute a host function and so on.

      The above mapping can now be used by HACP EE clients. If user types the sequence of mapped keystrokes, it performs the mapped action.

    • Key remap supports Macros Functions, and is also editable. HACP EE users can use the Key Remap editor capability to assign or unassign a key to a function or reset the key to its default assignment.

  • Custom function KeyRemap 

    • HACP Extended Edition v1.8 comes with a new functionality to add, update, and delete a custom function for keyremap, where a user can map any key to that user-defined custom function. The custom data can be a combination of mnemonic keyword along with a string (for example, logout[enter]). User can also give Unicode encoding, for example, unicode: \u0028 for the special character ‘(‘. 

      Add:

      §  The user can define name and data for the custom function and then map a key to that function.

      §  The data is processed when the mapped key is pressed.

      Update:

      §  Click the row of a specific custom function to view and update the name and data in their appropriate input fields for that function.

      §  The user is not allowed to give duplicate name and data for a custom function.

      Delete:

      §  The user can delete a custom function by selecting that specific function.

      Unicode Encoding:

      For Unicode encoding in custom function, only the following are supported:

      ·        Alphabets: A-Z, a-z

      ·        Numbers: 0-9

      ·        Special characters: !, ', (,), *, ?, @, ^, ;, <, >, ~

      All the unsupported Unicode is displayed as ”?” in the HACP EE green screen.

  • Extended ColorRemap Attributes: 

                    -  Using the Extended color remap property, the HACP EE user can change the color of the extended attributes present in the host screen. 

                    -  The Extended color remap attributes are specific to 3270-session type.  

    Select the foreground and background colors from the color picker for a specific-extended attribute. 

    The extended attributes include: 

  • Blue 
  • Green 
  • Pink 
  • Red 
  • Turquoise 
  • White 
  • Yellow 

NOTE: Default intensified, and default attributes are excluded. 

  • Cut/Copy/Paste:
    • HACP Extended Edition allows users to select different options that are available to edit functions (cut/copy/paste). 

      Cut/copy Tab:

      Cut/Copy only if a trim rectangle is marked

      If this checkbox is selected, the user must draw a trim rectangle in order to use the cut or copy function.

      If this checkbox is cleared, the user can do one of the following:

      ·        If no trim rectangle is drawn, the user can cut or copy the entire screen.

      ·        If a trim rectangle is drawn, the user can cut or copy the contents of that trim rectangle.

                             

      Trim Rectangle remains after edit function

      If this checkbox is selected, the trim rectangle remains on the screen after the completion of cut/copy function.

      If the checkbox is cleared, the trim rectangle disappears when the cut/copy function is completed.                                                                                           

      Copy As table 

      This function can be used in 3270 and 5250 field-formatted display sessions. It allows you to copy fields from the screen in a tabular form.

       

      Copy As Fields

      This function can be used in 3270 and 5250 field-formatted display sessions. The user can copy fields from the screen in a tabular form. Data inside every new field that is copied, is considered as a separate column in the table. By default, the Copy as Fields function is disabled. This menu option acts as a toggle switch. When it is enabled or disabled, the option is applicable only to the current session.

      Protected fields

      To copy data from the protected or non-editable fields.

      Unprotected fields

      To copy data from the unprotected or editable fields.

      Trim spaces in fields

      To trim leading and trailing spaces in the data field contents that were copied.

       

      Paste Tab

      Paste option is enabled if the user copies text from the emulator session. 

      Field Wrap: Allows the data that falls in a protected field is pushed to the next nearest unprotected field. The Field Wrap function does not break words in the middle, except when the first word encounters a protected field.

      Line Wrap: Enables recognition of end-of-line and end-of-screen indicators and continues to paste your data.

      Paste to marked area: Determines if you use a trim rectangle to designate exactly where to paste your data.

      Stop pasting when protected field encountered: Allows your data to be pasted until a protected field is encountered unless Field Wrap, Line Wrap, or Paste to marked area is enabled.

      Tab character processing.
      These paste preferences indicate how tab characters must be processed while pasting.

      a.      Advance to next tab stop: Enables you to align tabulated text at specified tab stops.

      b.      Replace with: Allows you to replace tab stops with a specified number of spaces.

      c.      Paste data to fields: Determines whether your tabulated text is placed in subsequent unprotected fields. When a tab character is encountered, the succeeding text data is pasted into the next unprotected field on the same line of the emulator session.

  • Add Workstation ID and LU Name: 
    • LUName or pool name is the session property that connects the session to the specified pool name, which is defined at the telnet server. The first character must be from A through Z, $ (dollar sign), @ (at symbol). The remaining characters can be from A through Z, 0 through 9, $, and @.

    • Workstation ID is the session property that defines the name of the workstation, If this field is left blank, the host automatically defines the unique ID. The first character must be from A through Z, $ (dollar sign), @ (commercial at sign), or # (number sign). The remaining nine characters can be from A through Z, 0 through 9, $, @ or _ (underscore). The first character can be % (percent symbol) that gets replaced by ‘S’ for display sessions, and when the next character is * (asterisk) it gets replaced by the session short name as in OIA. 

      For example, %M52* replaced by SM52A, SM52B. 

  • Print Screen
    • Support for printing contents of the terminal screen for both 3270 and 5250 display sessions. HACP EE supports two types of printing.
      There are two ways to print the terminal screen
      1. Print in color - Yes (Color printing)
      2. Print in color - No (Blank and white printing)
      3. Partially selected area of the screen
      4. Entire data available on screen
  • Selectable Font
    • Support to select fonts for both 3270 and 5250 display sessions. HACP EE supports the following list of fonts, for the terminal screen.
      • Consolas
      • Courier
      • Courier New
      • Monaco
      • Monospace
      • Ubuntu Mono
      • Anonymous Pro
      • Cousine
      • Space Mono
      • Terminal

            If any of the above fonts are available on the client system, the application will automatically detect and list them.

            If none of them are present, the application uses monospaced fonts.

  • Hotspot
    • Support to enable users to create Hotspots on any area of the session window, in order to execute a command or a function by pressing the left-hand button of a mouse.
    • Hotspots can be used to perform the following tasks :  
      1. Simulating Function keys.
      2. Executing a Macro that has the same name as the word that is selected on the screen.
      3. Simulating the Enter Key at the current Cursor location.
      4. Connecting to a website by clicking on a URL that appears on the screen.
  • Start Sessions Automatically
    • Support to launch a Session automatically (if the Start Automatically option is set to Yes) when a HACP EE user accesses the page, on which the session is defined.
    • The Start Automatically property is available under the session property window, and can be enabled by choosing the Radio button for 'Yes' against the field, 'Start Automatically'.
  • Auto-Start macros
    • Support to automatically play an already existing macro when the session connects.
  • Support for end-to-end security - refer to the link below for step-by-step instructions on how to setup end-to-end security.

http://www.ibm.com/support/docview.wss?uid=ibm10887015

  • Save User configuration for HTML-based model pages
    • User changes to the session configurations (like session properties, key remap, color remap etc.) are saved in the browser’s cache.

  • Asynchronous submission of host data and automatic refresh of the terminal screen 
    • Host data is sent to the server asynchronously and updated on the client without refreshing the terminal screen. The Host screen changes are queried at regular intervals and the terminal screen is updated accordingly without any user intervention.

  • Keystroke buffering/Type-ahead 
    • Enables the user to enter keystrokes in an emulator session while input is inhibited; keystrokes are buffered and processed later when the input-inhibited condition is removed.

How to deploy and configure IBM HACP EE?

IBM HACP EE package is available on IBM fix central.

Pre-requisites:

  • IBM Host On-Demand server
  • WebSphere Application Server (WAS)


Deployment steps:

  • Extract the contents of IBM HACP EE package (.zip) file
  • Deploy the EAR (Enterprise Application aRchive) file on WAS using WAS admin console.
  • Configure the initial parameters of HACP EE application on WAS with Host On-Demand service manager and web server details


System Requirements

  • Web browsers:
    • Google Chrome v59.0.3071.115 or above
    • Firefox v51.0.1 or above
    • IE 11 or above
    • Edge 41 or above
  • Application servers:
    • IBM WebSphere Application Server v9.0.0.4 and above
    • IBM WebSphere Application Server v8.5.5.11 and above *
  • Client Operating Systems:
    • Windows 10 and above
    • RHEL 7.2 and above
    • Mac OS 10.11 and above #

*JRE 1.7 or above is required.

# Only Firefox browser is supported.

List of APARs fixed in HACP Extended Edition

http://www.ibm.com/support/docview.wss?uid=ibm10887019

Known Issues and Limitations

UI Considerations:

  • For optimal user experience, minimum screen resolution must be 1366x768 or more.
  • Ribbon bar buttons are not accessible using keyboard shortcuts.
  • All the UI elements and strings are available in English only.
  • Back/Forward buttons on the browser are disabled.
  • All the active sessions are lost when the page is refreshed.


Home tab:

  • The Context menu item, ‘Properties’ can be used to view and edit the connection properties, if an administrator has enabled or unclocked properties.


Active sessions tab:

  • Navigation to other tabs, sessions, and ribbon bar buttons are disabled while establishing connection with the host.
  • When a screen is closed, the first entry in the active session list will be selected.


Terminal screen:

  • Only English code page (037) is supported. Even if the HOD session definition is set to a different code page, it would be changed to 037 while establishing the connection with the host.
  • Monospaced font is used by default and the text appearance may vary depending on the combination of the browser and OS.
  • Different combinations of the cursors cannot work at the same time. For example, insert mode cursor does not work while working with rule cursor.
  • Screen does not refresh automatically, without any user action. For example, progress updates of any background actions will not be shown on the screen unless user refreshes the screen using Ctrl+Shift+R key combination.
  • Paste option from context menu or the ribbon bar works only if the text is copied from terminal screens of the same applications. To paste the text that has been copied from other applications (for example notepad), user can use the keyboard shortcut Ctrl+V.
  • Text present in the clipboard will not be processed to identify the control characters (like enter, tab), if any before paste operation.
  • When session data is being encrypted, a + symbol appears in the 4th column of the OIA. There is no option to find more information about the encryption strength or the algorithm used.
  • ENPTUI (5250) and Host graphics (3270) are not supported.
  • For config-based pages, users need to clear the browser cache, to get the latest session definition changes from the server.


Secured connections:

  • HOD’s certificate store files are used for secured connections. For sessions configured with JSSE, CustomizedCAs.jks file will be used, else CustomizedCAs.p12 file will be used.
  • TLS Client authentication is not supported.


Session Manager API:

Example: [pf4]Some text

  • Cross Browser Communication is not possible through Session Manager API.
  • Macro APIs are not supported.
  • callCustomerFunction is not supported.
  • WorkAround with iframe is not supported.
  • Text after host function mnemonic ([pf1]..[pf24],[enter]) will be ignored.


Touch support:

  • Host keypad is not optimized for smaller screen devices.
  • On devices with smaller touch screen, the device system keypad might reduce the terminal screen to an unusable level.
  • Context menu for a session icon on HACP EE Home page is unavailable on iOS.


Play macros:

  • Users cannot see intermediate macro screens when the macro is played.
  • Following screen actions are not supported
    • Message
    • File transfer
    • Copy/paste
    • Box select
    • File upload action
    • Xfer action
    • SQL query
    • Run program
    • Perform action
    • Print start, Print extract and Print end
    • Interacting between two sessions using a macro
  • In case of local macros, the following macro actions are not supported
    • Chained macro action
    • Play macro action
  • Since the macros are executed on the HACP EE application server, they cannot open or run any native application.
  • If an active session is closed when a macro is playing, it may result in improper session termination. 


Edit session properties:

  • Session properties are read-only for HTML-based model pages.
  • Users can modify only those properties that are displayed on the properties panel on the HACP EE client.


Keyboard Remap:

  • Character, Macros, and Host Functions categories are supported.
  • If numpad is off, numpad keys are not supported.
  • On android device, key remap feature is not supported.

Custom function Key Remap:

  • Combination of Unicode encoding is not supported.
  • Carat encoding is not supported in the custom function.
  • For adding data or name in custom function, symbols ‘%’ and ‘#’ are not supported. If we add data or name as ‘#’ in custom function, it gets replaced with ‘=’ (equal sign). If we add data or name as ‘%’ in custom function, an error occurs while parsing the JSON data. As a result, the key remap tab is not clickable.
  • For Unicode encoding of custom functions if \u007B,\u007D-{ } is given; while returning data from HOD, due to JSON parsing those braces are not accepted when the Enter key is pressed in the Config model. 

Cut/Copy/Paste: 

  •  After the trim rectangle is drawn on the screen, screen co-ordinates reflect the co-ordinates of the rectangle only after the cut/copy function is performed.
  • Co-ordinates gets updated when the cursor position is changed on screen. 

Add Workstation ID and LU Name: 

  • Configuring Workstation ID with special characters does not support collision avoidance ID (=).
  • Wildcard entry combinations for Workstation ID is not supported (for example, : N=A=).


Print Screen:

  • Print Screen without graphics is not supported on Internet Explorer.
  • Print Screen without graphics is a blur on Chrome Browser.
  • Crop Printing is not supported in Internet Explorer & Edge.
  • Print screen functionality is not supported on iPad.
  • Print Screen not supported in Firefox browser in Android.


Selectable Font:

  • Selectable font feature is not supported on Android device in Firefox browser.

Color Remap:

  • An administrator can map default color of 3270 attribute or 5250 elements or OIA color.
  • Default screen gets repainted with the colors mapped in HOD.
  • HACP EE users can also edit the color of different attributes and save their changes.


Status Bar:

  • Status bar can be viewed on both 3270 and 5250 display sessions.
  • Connection details are shown in status bar. 
  • OIA (Operator Information Area) status are displayed as text in status bar.


Download as Image:

  • Users can download both 3270 and 5250 display sessions as an image.
  • Entire screen or a part of the screen can be downloaded.

[{"Business Unit":{"code":"BU011","label":"Systems - zSystems software"},"Product":{"code":"SSS9FA","label":"Rational Host On-Demand"},"Component":"Documentation","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF012","label":"IBM i"},{"code":"PF014","label":"iOS"},{"code":"PF016","label":"Linux"},{"code":"PF033","label":"Windows"},{"code":"PF035","label":"z/OS"}],"Version":"12.0.0;12.0.0.1;12.0.1;12.0.2;12.0.3;12.0.4;12.0.4.1;12.04.2;12.0.5;13.0.0;13.0.1.0;13.0.1.1;13.0.2.0;13.0.2.1;13.0.3;14.0.0;14.0.1","Edition":"All Editions"}]

Document Information

Modified date:
05 December 2019

UID

swg27050112