Infocenter

Session parameters

  • Session1 parameters
  • Session2 parameters
  • Saving preferences parameters
  • 3270 and 5250 host print session parameters
  • 3270 host print session only parameters
  • 5250 host print session only parameters
  • Disabling functions
  • Cached client installation parameters
  • Session1 parameters

    Parameter name Description Valid values Default value
    User User ID  The ID of the user. None
    Password Password The user's password. None
    Launch The name of the session as typed in the configuration panel. The case of the characters must match exactly (upper/lower). If the name includes one or more spaces, you must enclose it in double quotes (" "). The name of the session None
    Embedded Run the session embedded in an HTML file or in a separate window. true = Run embedded within the browser file
    false = Run in a separate window 
    false
    Locale Sets the locale. xx_YY
    xx = language code YY = country or region code
    Locale returned by the JVM

    Session2 parameters

    Parameter Name Description Valid values Default value
    3270InputAreaIndication Indicates unprotected fields using dots ("."), underlines, or 3D rectangles. 1=Underdot,Underline,3D
    2=Display,NonDisplay,DisplayAndNonDisplay
    Display - unprotected displayable fields are indicated
    NonDisplay - unprotected nondisplayable fields are indicated
    DisplayAndNonDisplay - all unprotected fields are indicated
    None
    AutoConnect The session connects automatically when it starts. true, false true
    AutoReconnect The session reconnects automatically if the link recovers after failure. true, false true
    BlockCursor Changes the cursor to a blinking solid block. true, false false
    ButtonText Text on the start session button. text string Start Session or Start Session: SessionName
    CICSGWCodePage (CICS only) The code-page defined at the CICS gateway. A supported CICS-Gateway code-page 000
    (auto-detect)
    CICSServerName  (CICS only) The host name or IP address of the CICS Gateway for Java. Host name or IP Address None
    CodePage The code-page of the zSeries or iSeries to which the session will connect. A supported host code-page 037
    DBCSInputVisible DBCS input visible. true, false false
    Embedded Run the session embedded in an HTML file or in a separate window. true = Run embedded within the browser window 
    false = Run in a separate window 
    false
    FontName Font name font name monospaced
    FontSize Font size integer 12
    FontStyle Font style 0 = Plain
    1 = Bold
    2 = Italic
    0 = Plain
    GUIEmulation Session uses the Alternate Terminal interface. When true, the Embedded parameter is ignored and the session is run in a frame. true, false false
    Host Host name or IP address of the target telnet server. Host name or IP address None
    Keypad Show or hide the keypad in the session window. true = Show the keypad 
    false = Do not show the keypad 
    false
    LightPenMode Light pen support true = On
    false = Off
    false
    Locale Sets the locale. xx_YY
    xx = language code YY = country or region code
    Locale returned by the JVM
    LUName The name of the LU or LU Pool, defined at the target server, to which you want this session to connect. If you do not specify this, the session connects to the first available LU. The name of an LU or LU Pool None
    MacroManager Show the Macro Manager toolbar. true=Yes
    false=No
    false
    markedAreaPrintingEnabled Enables print screen only for the marked area. true, false true
    MaxSessions Limits the number of sessions a user can start. Integer None
    NumeralShape (BIDI only) Numeral Shape NOMINAL NATIONAL CONTEXTUAL    NOMINAL
    OIAVisible Show or hide the OIA (operator information area) in the session window. true = On
    false = Off
    true
    Port The port number on which the target telnet server is listening. Any valid TCP/IP port number 23
    (CICS 2006)
    Rule Displays rule lines on the screen. true, false false
    ScreenSize The number of rows and columns on the screen. 2 = 24x80 
    3 = 32x80 (3270 only)
    4 = 43x80 (3270 only)
    5 = 27x132 (3270, 5250 only)
    6 = 24x132 (VT only)
    2
    SessionID The short name you want to assign to this session (appears in the OIA). It must be unique to this configuration. One character A
    SessionName The name you want to assign to this session (appears at the top of the window). Any string None
    SESSION_QUIETMODE Allows users to start a 3270 session without beeping noises. true, false false
    SessionType The type of session you want to configure. 1 = 3270
    2 = 5250
    3 = VT
    4 = CICS gateway
    5 = 3270 printer
    6 = 5250 printer
    1
    SLPAS400Name SLP AS400 Name String - 8 + 8 with "." as a delimiter Net ID "." LU Name. Fully qualified CP name: 1-8 byte character string for each Net ID, and LU Name. The first character must be alphabetic(A-Z) or a special character (@,#,$). The remaining characters can be alphanumeric (A-Z, 0-9) or special characters(@, #, $). ""
    SLPEnabled Enable SLP support. true, false false
    SLPMaxWaitTime SLP maximum wait time. integer 200
    SLPScope SLP Scope String - alphanumeric or special characters which include comma, asterisk, equal sign, plus sign, colon, semicolon, quotation marks, vertical bar, question mark, slash, backslash, left angle bracket (<), right angle bracket, left square bracket ( [ ), right square bracket and the number sign (#). *
    SLPThisScopeOnly SLP this scope only. true, false false
    SSL Enable SSL encryption. true, false false
    SSLServerAuthentication Enable server authentication by SSL. true, false false
    StartupApplet The name of an applet to start when the session starts. The name of the applet's class file None
    Statusbar Show or hide the status bar at the bottom of the session window. true = Show the status bar
    false = Do not show the status bar 
    true
    TextType (BIDI only) Text type VISUAL, LOGICAL VISUAL
    TextOrientation (BIDI only) Text Orientation LEFTTORIGHT RIGHTTOLEFT LEFTTORIGHT 
    ThaiDisplayMode (Thai only) Thai display mode 1 = Non-composed
    2 = Composed
    3 = Composed with space alignment
    4 = Composed with EOF alignment
    5 = Composed with space and EOF alignment
    5
    TNEnhanced (3270 only) Enable TN3270E support. true, false true
    Toolbar Show or hide the toolbar in the session window. true = Show the toolbar
    false = Do not show the toolbar 
    true
    ToolbarText Show text that explains the purpose of each toolbar button. true = Show the text 
    false = Do not show the text 
    true
    TraceLevel Trace level 0 = Off
    1 = Minimum
    2 = Normal
    3 = Maximum
    0 = Off
    VTAutowrap (VT only) Auto-wrap true = On
    false = Off
    false
    VTBackspace (VT only) Backspace mode true = Delete
    false = Backspace
    false
    VTCursor (VT only) Cursor mode true = Application 
    false = Normal
    false
    VTKeypad (VT only) Keypad mode true = Application
    false = Normal
    false
    VTLocalEcho (VT only) Local-echo mode true = On
    false = Off
    false
    VTNewLine (VT only) New-line operation true = CR 
    false = CRLF
    true
    VTTerminalType (VT only) The terminal-type required by the server to which the session will connect. 1 = VT220_7_BIT
    2 = VT220_8_BIT
    3 = VT100
    4 = VT52
    1
    WorkstationID Name of this workstation. Unique name for this workstation None

    Saving preferences parameters

    You can save all the configuration information to a single configuration file and then use that configuration file to configure the session when a downloaded client starts the session.

    Note: Microsoft Internet Explorer and Netscape Navigator write the session preferences file to a different directory on the client system. Preferences saved using one of the browsers will not be loaded by the other.
    Parameter name Description Valid values Default value
    Save Name of a local file in which preferences must be saved. filename  
    Config The name of a file on the server from which preferences must be read. You cannot save changes here. The file can be either an absolute URL or a relative file name to the Session2.html document URL. filename  
    ConfigDefault True: first time reads from the server, saves locally. After the first time, reads from local file. False: reads from server and local files, and combines. When both the Save and Config parameters are specified, the ConfigDefault parameter is used. When set to true (the default) the config file on the server will only be read if the config file on the local hard drive is not found. If set to false both the config file on the server and on the local hard drive will be read and combined into a single configuration object. true, false true
    ConfigOverwrite True: Reads from server and local files; if conflict, server definitions prevail. Additions saved locally. False: Reads from server and local files; if conflict, local definitions prevail. Changes or additions saved locally. When both the Save and Config parameters are specified and the ConfigDefault parameter is set to false, the ConfigOverWrite parameter is used. When both config files are read and combined into one configuration object, collisions with data will occur. This parameter controls the outcome of those collisions. If set to true, information in the server config file will be used in the case of a collision. If set to false (the default), information in the local config file will be used in the case of a collision. true, false false

    3270 and 5250 host print session parameters

    Parameter name Description Valid values Default value
    useWindowsPrinter Choose whether Windows printer (either in GDI or Windows spooler mode) is used or not. true, false true on Windows platforms, false on other platforms
    useWindowsDefaultPrinter Choose whether Windows default printer is used or not. true, false true
    windowsPrinterName Windows printer name to be used for printing. string none
    printDestination Choose whether the output should go to a printer or to a file. When true, it goes to printer. true, false true
    printerName The name of the port for the printer to be used. Any valid printer names LPT1
    printFileName The path and name of the file when the print destination is a file. Any valid path name none
    separateFiles When the print destination is a file, choose whether you want to save each print job to a unique file or have jobs appended to each other in one file. true, false false
    intervTime The amount of time in seconds to wait for printing to start. If printing does not start within the time set, an Intervention Required message pops up. Integer between 10 and 255 25
    graphicsVisible Display a window that includes several items of information, and shows the printer, workstation and host system as icons. true, false true

    3270 host print session only parameters

    Parameter name Description Valid values Default value
    usePDT Choose whether PDT mode printing is used with a Windows printer. true, false false
    faceName Font name to be used for Windows non-PDT printing string Varies on the system locale. With US English, it is Courier New.
    bestFit Choose whether selected CPI/LPI will override the commands sent by the host. It will work correctly only when the host does not send the command to set CPI/LPI/MPP/MPL. true, false false
    printBufferSize The size of the block of memory reserved for print data that is being sent to the printer. This applies only to LU3 sessions. 1920, 2560, 3440, 3564 1920
    PDTFile PDT resource path name with directory name from the code base directory where HOD is installed. Full path string to a PDT file /pdfpdt/basic.hodpdt
    charsPerInch The number of characters printed per inch Entries defined in the PDT Taken from the DEFAULT_CPI? entry in the PDT if this entry exists.
    linesPerInch The number of lines per inch. Entries defined in the PDT Taken from the DEFAULT_LPI? entry in the PDT if this entry exists.
    maxLinesPerPage The maximum number of lines per page, including the top and bottom margins. Integer between 1 and 255 Taken from the MAXIMUM_PAGE_LENGTH entry in the PDT. If the entry is not found, the default value, 66, is used.
    maxCharsPerLine The maximum number of characters per line. Integer between 1 and 255 Taken from the MAXIMUM_PRINT_POSITION entry in the PDT. If the entry is not found, the default value, 132, is used.
    suppressNullLines Suppress the lines that contain only non-printable characters. This parameter applies only to an unformatted LU Type 3 job and when bits 2 and 3 in the Write Control Character (WCC) are not B'00'. true, false Taken from the COMPRESS_LINE_SPACING? entry in the PDT. If the entry is not found, the default value, false, is used.
    printNullsAsSpaces Print Nulls as spaces (X'40'). This parameter applies only to LU Type 3 sessions. true, false Taken from the OVERRIDE_FORMATTED_PRINT? entry in the PDT. If the entry is not found, the default value, true, is used.
    suppressAutoNewlineCR Suppress an automatic-new-line if there is a Carriage Return (CR) code at (Maximum Print Position) MPP+1. This parameter applies only to an unformatted LU Type 3 job and when bits 2 and 3 in the Write Control Character (WCC) are B'00'. true, false Taken from the NO_AUTO_NL_IF_CR_AT_MPP_PLUS_1? entry in the PDT. If the entry is not found, the default value, false, is used.
    suppressAutoNewlineNL Suppress an automatic-new-line if there is a new-line (NL) code at MPP+1. This parameter applies only to an unformatted LU Type 3 job and when bits 2 and 3 in the Write Control Character (WCC) are B'00'. true, false Taken from the NO_AUTO_NL_IF_NL_AT_MPP_PLUS_1? entry in the PDT. If the entry is not found, the default value, false, is used.
    ignoreFFFirstPos If the session is LU Type 3 and you choose true, a form feed (FF) at the first position on the first line is ignored. If the session is LU Type 1 and you choose true, an FF or a CR+FF combination at the beginning of a print job is ignored. true, false Taken from the IGNORE_FORM_FEED_AT_FIRST_POS? entry in the PDT. If the entry is not found, the default value, false, is used.
    FFTakesPrintPos If you choose true, FF is executed, takes a print position and is printed as a blank in the first position on the first line of the next page. Therefore, the next print-position will be the second position of that line. If you choose false, FF is executed and the next print-position is the first position on the first line of the next page. That is, FF does not take a print position. This parameter applies only to LU Type 3 sessions. true, false Taken from the FORM_FEED_TAKES_POSITION? entry in the PDT. If the entry is not found, the default value, false, is used
    formFeedPosition If you choose true, FF is performed wherever it appears. If you choose false, FF is performed only if it appears at column 1. When FF is not at column 1, it is printed as a space character. This parameter applies only to LU Type 3 sessions. true, false Taken from the FORM_FEED_ANY_POSITION? entry in the PDT. If this is defined as Any, true is used. If the entry is not found, the default value, false, is used.
    ignoreAttr Choose true to ignore all 3270 attributes except non-printable attributes. This parameter applies only to LU Type 3 sessions. true, false false
    drawFieldAttr Use this parameter to determine how the 3270 field-attribute byte is drawn. If you choose 0 (None), the field-attribute byte is drawn as a space character without an attribute. If you choose 1 (Here), the field-attribute byte is used to draw the current byte. For example, if the current byte is defined as an underscore field, the field-attribute byte is drawn as a space character with the underscore attribute. If you choose 2 (Next), the field-attribute byte is used to draw the next field-attribute byte. This parameter applies only to LU Type 3 sessions. 0, 1, 2 0
    concatTime The expiration time for the print-job concatenation timer, which starts at the end of a print job. If the next print job arrives before the timer expires, that job is treated as a continuation of the previous job. If the time expires, an end-of-job command is sent to the printer and the next job is treated as a separate job. The value is specified in seconds. Integer 0
    termTime The expiration time for the print-job termination timer, which starts at the end of the print data. If another print-data record arrives before the timer expires, that job is treated as the continuation of the previous record. Otherwise, an end-of-job command is sent to the printer and the next print record is treated as the beginning of a separate print job. Integer 0
    SCSSense If you choose true, a negative response is sent to the host when an incorrect SCS command or parameter is received. If there is more data in the job, printing continues, though some of the printed data may be incorrect. If you choose false, printing continues but no notification is sent to the host. If there is a physical printer or connection problem, a sense-code is sent to the host even if you choose false. This parameter applies only to LU Type 1 sessions. true, false true
    inheritParms If you choose true, the parameters used in LU Type 1 print-job processing, such as tab positions, MPP or MPL, are inherited by the next job. This parameter is used when the host system sends a formatting command such as Set Horizontal Format for the first job, but assumes that the second and later jobs will use the format that is set for the first job. This parameter applies only to LU Type 1 sessions. true, false false
    tractor If you choose true, a form feed is not sent at the page boundary; a newline (NL) is sent instead. However, if a SET_AUTO_PERFORATION_SKIP command is defined in the PDT, a form feed is not sent, regardless of the setting of this parameter. true, false false
    printerFontCodePage This parameter is useful only for printers that do not support the default code page. It defines the ASCII code-page used for the printer (hardware) font. It should be consistent with the character code-points specified in the PDT file. Integer 850 for Latin-1 countries or regions and the respective country or region's default ASCII code-page for other countries or regions.
    pa1KeyVisible Choose whether to have a button on the screen for the Program Attention 1 key. The function of the key depends on the host application. true, false false
    pa2KeyVisible Choose whether to have a button on the screen for the Program Attention 2 key. The function of the key depends on the host application. true, false false
    PDTFile PDT resource path name with directory name from the code base directory where HOD is installed. Full path string to a PDT file /pdfpdt/basic.hodpdt
    TermAssocPrinter This parameter closes the associated printer session when the 3270 display session is closed. This parameter takes effect for all 3270 sessions defined for that user. The user must close the 3270 session. Disconnecting the session has no effect. Default behavior stays the same. true, false true

    5250 host print session only parameters

    Parameter name Description Valid values Default value
    messageQueue The name of the queue where operational messages for the printer device are sent. String QSYSOPR
    messageLibrary The name of the library where the printer message queue is located. String *LIBL
    hostFont The font ID used for a print file if a font is not specified by the application. See session configuration panel on which ID corresponds to which font. Integer 11
    useCustomizingObject Choose whether you want to use an object file to format print data instead of using the formatting provided by the application. true, false false
    customizingObject The name of a user-defined iSeries file that can be used to format the data for this device. String NONE
    customizingLibrary The name of the iSeries system library that contains the customizing object file. String *LIBL
    printerModel The printer model string of the printer that will be used for this session. See OS/400 documentation for printer models that are available on your OS/400. String *IBM42011
    drawer1 Specifies the size of the paper in Source 1.
    FF - None
    FE - Default used for printer
    00 - No Change
    01 - Letter
    02 - Legal
    03 - Executive
    04 - A4
    05 - A5
    06 - B5
    07 - Continuous 80 column form
    08 - Continuous 132 column form
    0E - A3
    0F - B4
    10 - Ledger
    00
    drawer2 Specifies the size of the paper in Source 2.
    FF - None
    FE - Default used for printer
    00 - No Change
    01 - Letter
    02 - Legal
    03 - Executive
    04 - A4
    05 - A5
    06 - B5
    07 - Continuous 80 column form
    08 - Continuous 132 column form
    0E - A3
    0F - B4
    10 - Ledger
    00
    envelopeHopper Specifies the size of the paper in the envelope feeder.
    FF - None
    FE - Default used for printer
    00 - No Change
    06 - B5
    09 - Monarch
    0A - Number9
    0B - Number10
    0C - C5
    0D - DL
    00
    asciiCodePage899 Choose true if your printer supports ASCII code-page 899. This is not resident on most printers. true, false false

    Disabling functions

    The following functions can be disabled using the DISABLE parameter:
    Parameter Value Function
    CLRMAP Color remapping
    CUTPASTE Cut/copy/paste
    EMUL3270 3270 session
    EMUL5250 5250 session
    EMULCICS CICS gateway session
    EMULVT VT session
    FILEXFER3270 3270 file transfer
    FILEXFER5250 5250 file transfer
    EMUL3270PRT 3270 printer session
    EMUL5250PRT 5250 printer session
    KEYMAP Keyboard remapping
    MACRO Macro record/play
    SSL Security
    USERAPPLET Startup-applets and run applet

    Cached client installation parameters

    Parameter name Description Default value Valid values
    CachedAppletNonNetworkLoad When set to true the cached client recognizes that it is being loaded from a LAN drive or a CD, so it can present more helpful error messages and an end of installation message.
    false
    true, false
    CachedClient Must be set to true in cached client HTML pages. Host On-Demand uses this parameter internally to determine if it is in a cached environment. The Deployment Planning Wizard sets this parameter appropriately when building HTML pages.
    false
    true, false
    CachedClientSupportedApplet Applet that is started by HODCached.html.
    com.ibm.eNetwork.HOD.HostOnDemand
    valid class name
    DebugCachedClient Allows the cached client to output debug information.
    false
    true, false
    DebugComponents Determines if the cached client should load debug components instead of normal cached client components.
    false
    true, false
    InstallerFrameHeight Allows for customization of Installer.html file so you can add installation specific HTML to the installation page.
    250
    integer
    InstallerFrameWidth Allows for customization of Installer.html file so you can add installation specific HTML to the installation page.
    600
    integer
    PreloadCodeModules The list of components to be downloaded initially. If there is no parameter specified, the default will be the Host On-Demand default cached client.
    HABASE, HAPRINT, HA3270, HA3270B, HA3270T, HA3270P, HA5250, HA5250B, HA5250T, HA5250P, HA5250E, HACICS, HAVT, HAVTT, HAVTB, HATHAI, HADBCS, HABIDI, HAMACRT, HAMACUI, HAXFER, HA3270X, HA5250X, HASSL, HACLTAU, HASLP, HAHOSTG, HALUM, HACOLOR, HAKEYPD, HAKEYMP, HACP, HODBASE, HODIMP, HODTH, HODBI, HODSSL, HODAPPL, HODMAC, HODIMG, HAHINDI, HA5250H, HAFNTIB, HAFNTAP, HAFNTAR, HAFNTHE, HAFNTTH, HODHLL
    list of components
    UpgradePercent Sets the percentage of users who can upgrade when a new version of Host On-Demand is available.
    100
    0 (no one is upgraded) - 100 (everyone is upgraded immediately)
    UpgradePromptResponse Allows the administrator to answer the upgrade prompt now, later, or background without displaying the prompt to the browser. When this parameter is set to prompt, the browser displays the choice.
    prompt
    now, later,
    background, prompt
    UpgradeURL Specifies a URL that is used to determine whether a user should be upgraded when a new version of Host On-Demand is available. If the retrieved document contains the word upgrade, the user is upgraded
    <none>
    URL, or file name relative
    to code base