Appendix C. HATS Studio files
When you use HATS Studio to build your project, files for each component of the project are created. This appendix tells you where the file is located on your system, how to view and edit the source for the file, and describes the tags that make up each file.
If you edit these source files, use the HATS Studio editors.
All of the files you create with HATS Studio are stored on your system in one or more workspaces managed by your WebSphere Studio program, such as WebSphere Studio Application Developer. You can choose your workspace directory, and you can have more than one. By default, your workspace directory will be drive:\ws_dir\wstools\eclipse\workspace, where drive:\ws_dir is the drive and directory where WebSphere Studio is installed. Refer to the information provided with WebSphere Studio for information about choosing your workspace.
All of the file locations in this appendix refer to the relative path from the directory named for your project, which will be created within your workspace.
The files contained in a HATS EJB project are differnt from those in a HATS project. For a description of the contents of a HATS EJB project, see Create and Using a HATS EJB application
Application files (.hap)
The application file contains XML tags that define the settings you choose when you create the project.
The application (.hap) file is stored in the project_name/Web Content/WEB-INF/profilesdirectory, where project_name is the name you gave the project when you created it. The application (.hap) file for a HATS EJB project is stored in the project_name directory. To view and edit the source of the application file for your HATS project, expand your project in the HATS Project View and double-click Project Settings to open the project editor. You can view the source by clicking on the Source tab.
You can modify the application file using any of the tabs in the project editor. HATS Studio updates the affected information on other tabs when you make changes on any tab.
In HATS V5 you can define more than one connection in each HATS project. Tags and settings related to the host connections, formerly stored in the session tag in the application file, are now stored in the connection (.hco) files. See Connection files (.hco) for a description of the .hco file.
<application> tag
The <application> tag is the enclosing tag for the project.
The attributes of the <application> tag are:
- active
- This attribute is not used by HATS. It is contained here for compatibility with HATS Limited Edition.
- configured
- This attribute is not used by HATS. It is contained here for compatibility with HATS Limited Edition.
- description
- Specifies the description you enter when you create a project.
- template
- Specifies the name of the template you selected for the project when you created the project. The default template is Simple1.jsp.
<connections> tag
The <connections> tag is a container for all the connection tags that define connections for this project.
The attributes of the <connections> tag are:
- default
- Specifies the name of the default connection. The default connection, which is created using the connection values that you specify in the New HATS Project wizard, defaults to the name of main.hco.
<connection> tag
The <connection> tag identifies a connection defined for the project and points to the connection (.hco) file that defines the connection.
The attributes of the <connection> tag are:
- name
- Specifies the name you entered when you created the connection.
<eventPriority> tag
The <eventPriority> tag is the enclosing tag for the screen customization events you defined for the project. The order of the event tags within the <eventPriority> tag is the order in which screen customizations are checked when a new host screen is encountered. This tag has no attributes.
<event> tag
The <event> tag specifies a screen customization that you defined for the project.
The attributes of the <event> tag are:
- enabled
- Specifies whether the screen customization's screen recognition criteria should be checked when a new host screen is encountered. Valid values are true and false. The default value is true.
- name
- Specifies the name you gave the screen customization when you defined it. If you store a screen customization file under a folder (or group), the name of the folder is prepended to the name of the file.
<classSettings> tag
The <classSettings> tag is the enclosing tag for the Java classes you include in the project. This tag has no attributes.
<class> tag
The <class> tag specifies a class whose attributes are defined in the enclosed <setting> tags.
The attributes of the <class> tag are:
- name
- Specifies one of the following Java classes:
- com.ibm.hats.common.AppletSettings
- com.ibm.hats.common.ApplicationKeypadTag
- com.ibm.hats.common.ClientLocale
- com.ibm.hats.common.DefaultConnectionOverrides
- com.ibm.hats.common.DefaultGVOverrides
- com.ibm.hats.common.HostKeypadTag
- com.ibm.hats.common.KeyboardSupport
- com.ibm.hats.component.*
where * is the name of a Version 4 component
- com.ibm.hats.widget.*
where * is the name of a Version 4 widget
- com.ibm.hats.transform.components.*
where * is the name of a Version 5 component
- com.ibm.hats.transform.widgets.*
where * is the name of a Version 5 widget
The class names on the name attribute must be enclosed in quotes.
<setting> tag
The <setting> tag specifies the settings associated with the class in which the <setting> tag is enclosed.
The attributes of the <setting> tag are:
- name
- Specifies the name of a customizable setting for the class (component, widget, locale, keypad, and so on). The available settings depend on the class.
For the com.ibm.hats.common.ApplicationKeypadTag class, the customizable settings are:
- defaultTemplate
- Specifies the template that is applied with the default rendering when a user clicks the Default button in the application keypad. The default value is "ClassicTerminal.jsp".
- show
- If true, shows a keypad in the application.
- showDefault
- If true, shows a key in the application keypad to change the presentation to the default transformation.
- showDisconnect
- If true, shows a key in the application keypad to disconnect from the host.
- showKeyboardToggle
- If true, shows a key in the application keypad for toggling display of a host keyboard.
- showPrintJobs
- If true, shows a key in the application keypad for showing print jobs.
- showRefresh
- If true, shows a key in the application keypad to refresh the browser window contents using the original transformation, and restore the input fields to their original value.
- showReset
- If true, shows a key in the application keypad to clear all the fields on the browser page of any entries made by the end user.
- showReverse
- If true, shows a key in the application keypad for bidirectional support.
- style
- Depending on the value attribute, shows the keys defined with value=true as either a button or a link in the application keypad.
For the com.ibm.hats.common.HostKeypadTag class, the customizable settings are:
- show
- If true, shows a host keypad in the application.
- showAltView
- If true, shows an AltView key in the host keypad.
- showAttention
- If true, shows an ATTN key in the host keypad.
- showClear
- If true, shows a CLEAR key in the host keypad.
- showEnter
- If true, shows an Enter key in the host keypad.
- showF1 - showF24
- If true, shows a Function key with the corresponding number in the host keypad.
- showHelp
- If true, shows a Help key in the host keypad.
- showPA1
- If true, shows a PA1 key in the host keypad.
- showPA2
- If true, shows a PA2 key in the host keypad.
- showPA3
- If true, shows a PA3 key in the host keypad.
- showPageDown
- If true, shows a Page Down key in the host keypad.
- showPageUp
- If true, shows a Page Up key in the host keypad.
- showPrint
- If true, shows a PRINT key in the host keypad for printing output.
- showSystemRequest
- If true, shows a SYSREQ key in the host keypad.
- style
- Depending on the value attribute, shows the keys defined with value=true as either a button or a link in the host keypad.
For the com.ibm.hats.common.KeyboardSupport class, the customizable settings are:
- enable
- Specifies whether keyboard support is available in the project.
- initialState
- If true, the initial state of the host keyboard is on (the user can interact with the application using the physical keyboard).
For the classes that define components and widgets:
- com.ibm.hats.component.*
- com.ibm.hats.widget.*
- com.ibm.hats.transform.components.*
- com.ibm.hats.transform.widgets.*
name specifies a customized component or widget setting. Refer to HATS User's and Administrator's Guide for descriptions of component and widget settings.
For the com.ibm.hats.common.ClientLocale class, name is always locale.
- value
- One of the following:
- For definitions of keypad keys, specifies whether to show the key in the keypad. Valid values are true and false. The default is true.
- For the attributes of the KeyboardSupport class, valid values are true and false. The default is true.
- For name=style, specifies how keys defined with value=true are displayed in the host keypad. Valid values are the following:
- Buttons
- Links
The default is buttons.
- For component or widget settings, value specifies what you specified for the customized setting. The default values vary depending on the setting. Refer to HATS User's and Administrator's Guide for descriptions of component and widget settings.
- Refer to HATS User's and Administrator's Guide for a description of the attributes of the com.ibm.hats.common.AppletSettings class.
- For the com.ibm.hats.common.ClientLocale class, value specifies characters that identify the country code of the locale. The default value is accept-language.
<textReplacement> tag
The <textReplacement> tag is the enclosing tag for any text replacement values you define in the project. This tag has no attributes.
<replace> tag
The <replace> tag specifies the text replacement values in a project.
If you are using a bidirectional code page, refer to HATS User's and Administrator's Guide.
The attributes of the <replace> tag are:
- caseSensitive
- Specifies whether the case of text replacement values must match before text replacement occurs. Valid values are true and false.
- from
- Specifies the text you want to replace. The text on the from attribute must be enclosed in quotes.
- to
- Specifies the text you want to insert in place of the value specified on the from attribute. The text on the to attribute must be enclosed in quotes.
Care should be taken when using text replacement. Text replacement with a disparate number of characters in the strings can cause changes in the HTML representation of the screen. Depending on the widget used for presenting a region of a screen, text on a line of the screen could be contracted, expanded, or forced to a new line.
<defaultRendering> tag
The <defaultRendering> tag is the enclosing tag for any default rendering settings you define in the project. This tag has no attributes.
<renderingItem> tag
The <renderingItem> tag is the enclosing tag for a specific rendering item.
The attributes of the <renderingItem> tag are:
- description
- The description entered when the rendering item was created.
- enabled
- Indicates whether this rendering item is enabled. Reflects the state of the check box on the Rendering page of Project Settings.
- endCol
- The last column of the host screen to which this rendering item should be applied. -1 means the rightmost column of the host screen.
- endRow
- The last row of the host screen to which this rendering item should be applied. -1 means the bottom row of the host screen.
- startCol
- The first column of the host screen to which this rendering item should be applied.
- startRow
- The first row of the host screen to which this rendering item should be applied.
- type
- The host component whose contents will be transformed.
- widget
- The widget into which the host component will be transformed.
<globalRules> tag
The <globalRules> tag is the enclosing tag for any global rules you define in the project. It has no attributes.
<rule> tag
The <rule> tag defines a global rule.
The attributes of the <rule> tag are:
- associatedScreen
- The name of a screen capture in the project, from which the global rule is defined.
- componentSettings
- Any settings configured for the global rule, such as recognition criteria.
- description
- The description entered when the global rule was created.
- enabled
- Indicates whether this global rule is enabled. Reflects the state of the check box on the Rendering page of Project Settings.
- name
- The name that will be shown in the list of global rules on the Rendering page of Project Settings.
- transformationFragment
- The name of the transformation fragment file associated with this global rule. This file contains the information specifying how to transform the host component. It will be included in a transformation if the appropriate input fields are present in the host screen.
- type
- The type of global rule, taken from the first page of the Create Global Rule wizard.
Connection files (.hco)
Each connection that you define in a HATS project is represented by a connection file. The connection (.hco) files are stored in the project_name/Web Content/WEB-INF/profiles/connections directory, where project_name is the name you gave the project when you created it. The default connection, which is created using the connection values that you specify in the New HATS Project wizard, is stored in main.hco.
<hodconnection> tag
The <hodconnection> tag begins the connection definition and specifies several characteristics for the connection.
The attributes of the <hodconnection> tag are:
- codePage
- Specifies the numeric value for the code page used on this connection. The default value is the value you selected when you created the project. Each connection can use a different code page. See the description of the codePageKey attribute for the code page numbers.
- codePageKey
- Specifies the usage key that corresponds to the numeric codepage. The default value is KEY_US. Valid values for codePage and the location or usage key are:
Table 5. Code pages and usage keys Code page Usage key 037
KEY_BELGIUM
KEY_BRAZIL
KEY_CANADA
KEY_NETHERLANDS
KEY_PORTUGAL
KEY_US
273
KEY_AUSTRIA
KEY_GERMANY
274
KEY_BELGIUM_OLD
275
KEY_BRAZIL_OLD
277
KEY_DENMARK
KEY_NORWAY
278
KEY_FINLAND
KEY_SWEDEN
280
KEY_ITALY
284
KEY_SPAIN
KEY_LATIN_AMERICA
285
KEY_UNITED_KINGDOM
290
KEY_JAPAN_KATAKANA_EX
297
KEY_FRANCE
420
KEY_ARABIC
424
KEY_HEBREW
500
KEY_MULTILINGUAL
803
KEY_HEBREW_OLD
838
KEY_THAI
870
KEY_BOSNIA_HERZEGOVINA
KEY_CROATIA
KEY_CZECH
KEY_HUNGARY
KEY_POLAND
KEY_ROMANIA
KEY_SLOVAKIA
KEY_SLOVENIA
871
KEY_ICELAND
875
KEY_GREECE
924
KEY_MULTILINGUAL_ISO_EURO
930
KEY_JAPAN_KATAKANA
933
KEY_KOREA_EX
937
KEY_ROC_EX
939
KEY_JAPAN_ENGLISH_EX
1025
KEY_BELARUS
KEY_BULGARIA
KEY_MACEDONIA
KEY_RUSSIA
KEY_SERBIA_MONTEGRO
1026
KEY_TURKEY
1047
KEY_OPEN_EDITION
1112
KEY_LATVIA
KEY_LITHUANIA
1122
KEY_ESTONIA
1123
KEY_UKRAINE
1137
KEY_HINDI
1140
KEY_BELGIUM_EURO
KEY_BRAZIL_EURO
KEY_CANADA_EURO
KEY_NETHERLANDS_EURO
KEY_PORTUGAL_EURO
KEY_US_EURO
1141
KEY_AUSTRIA_EURO
KEY_GERMANY_EURO
1142
KEY_DENMARK_EURO
KEY_NORWAY_EURO
1143
KEY_FINLAND_EURO
KEY_SWEDEN_EURO
1144
KEY_ITALY_EURO
1145
KEY_LATIN_AMERICA_EURO
KEY_SPAIN_EURO
1146
KEY_UNITED_KINGDOM_EURO
1147
KEY_FRANCE_EURO
1148
KEY_MULTILINGUAL_EURO
1149
KEY_ICELAND_EURO
1153
KEY_BOSNIA_HERZEGOVINA_EURO
KEY_CROATIA_EURO
KEY_CZECH_EURO
KEY_HUNGARY_EURO
KEY_POLAND_EURO
KEY_ROMANIA_EURO
KEY_SLOVAKIA_EURO
KEY_SLOVENIA_EURO
1154
KEY_BELARUS_EURO
KEY_BULGARIA_EURO
KEY_MACEDONIA_EURO
KEY_RUSSIA_EURO
KEY_SERBIA_MONTEGRO_EURO
1155
KEY_TURKEY_EURO
1156
KEY_LATVIA_EURO
KEY_LITHUANIA_EURO
1157
KEY_ESTONIA_EURO
1158
KEY_UKRAINE_EURO
1160
KEY_THAI_EURO
1364
KEY_KOREA_EURO
1371
KEY_ROC_EURO
1388
KEY_PRC_EX_GBK
1390
KEY_JAPAN_KATAKANA_EX_EURO
1399
KEY_JAPAN_ENGLISH_EX_EURO
- description
- Specifies a description for the connection. This value is always empty.
- host
- Specifies the name of the host to which the connection is made.
- LUName
- Sets the LUName property, which is the LU name used during enhanced negotiation. This property is valid only when the TNEnhanced property is true. This property is valid only for 3270 sessions. Values are in string format. Maximum length of LUName is 17 characters. There is no default. To configure print support for your 3270 HATS project, specify that the host type is 3270E. When you add the LUName parameter to the list of connection settings, do not use the printer LU name; use the name of your display LU or a pool of display LUs.
- LUNameSource
- LUNameSource is determined by the radio button selected on the Advanced tab of the connection editor. LUNameSource can be one of the following: None=Automatic, Prompt=prompt, Specified value=value, and Session variable=session.
- port
- Specifies the number of the port through which the connection to the host is made. The valid range for ports is 0-65535. The initial default is 23.
- printSupport
- Specifies whether your project includes print capability. Valid values for printSupport are true and false. The initial default is false.
- screenSize
- Specifies the number of rows and columns that the host terminal displays. Valid values for screenSize are:
- 2=24x80
- 3=32x80
- 4=43x80
- 5=27x132
- 6=24x132 (VT only)
The initial default screen size is 24 x 80.
- sessionType
- Specifies the type of terminal the host terminal displays. Valid values for type are:
- 1=3270
- 2=5250
- 3=VT
The initial default is 3270.
- SSL
- Specifies whether SSL is enabled. Valid values are:
- true
- SSL is enabled for the project.
- false
- SSL is not enabled for the project.
- TNEnhanced
- Valid only on 3270 connections. Specifies whether the connection is a TN3270E connection. Valid values are true and false. The initial default is true.
- VTTerminalType
- Valid only on VT connections. Indicates the type of VT terminal. Valid values are:
- 1=VT420_7
- 2=VT420_8
- 3=VT100
- 4=VT52
<otherParameters> tag
The <otherParameters> tag specifies additional Host On-Demand session parameters.
Host On-Demand session parameters supported by HATS include:
- Lamalef
- Sets the LamAlef property, which determines whether LamAlef should be expanded or compressed. This property applies to Arabic sessions only. Values are in string format. Valid values are:
- LAMALEF_ON
- LAMALEF_OFF
The default value is LAMALEF_OFF.
- numeralShape
- Sets the numeralShape property. This property applies to bidirectional sessions only. Values are in string format. The default value is NOMINAL.
- numericSwapEnabled
- Sets the Numeric swapping property. This property applies to Arabic 3270 sessions only. Valid values are true and false. The default value is true.
- roundTrip
- Sets the roundTrip property. This property applies to b-directional sessions only. Values are in string format. Valid values are:
- ROUNDTRIP_ON
- ROUNDTRIP_OFF
The default value is ROUNDTRIP_ON.
- SecurityProtocol
- Sets the SecurityProtocol property, which indicates whether to use the TLS v1.0 protocol or the SSL protocol for providing security. Values are in string format. The default value is TLS.
- SSLServerAuthentication
- Sets the SSLServerAuthentication property, which indicates whether SSL server authentication is enabled. Valid values are true and false. The default value is false.
- symmetricSwapEnabled
- Sets the Symetric swapping property. This property applies to Arabic 3270 sessions only. Valid values are true and false. The default value is true.
- textOrientation
- Sets the textOrientation property. This property applies to bidirectional sessions only. Values are in string format. Valid values are:
- LEFT_TO_RIGHT
- RIGHT_TO_LEFT
The default value is LEFT_TO_RIGHT.
- ThaiDisplayMode
- Sets the Thai display mode property. This property applies to Thai sessions only. Values are in string format. The default value is THAI_MODE_5.
- workstationID
- Sets the workstationID property, which is used during enhanced negotiation for 5250. Values are in string format. All lowercase characters are converted to uppercase. There is no default value.
To have more control over 3270 PDF print output format, you can add the following IBM WebSphere Host On-Demand connection session parameters to the list of connection settings:
- CPI
- Characters per inch. Specifies the number of characters printed per inch. On a Windows platform, three choices (10, 12, and 17) are available. The default value is 10.
- LPI
- Lines per inch. Specifies the number of lines per inch. On a Windows platform, five choices (2, 3, 4, 6, and 8) are available. The default value is 6.
- MCPL
- Maximum characters per line. Specifies the maximum number of characters per line, also called the Maximum Print Position or the Maximum Presentation Position (MPP). Enter a value in the range 1 to 255. The default value is 132.
- MLPP
- Maximum lines per page. Specifies the maximum number of lines per page, including the top and bottom margins. This value is also called Maximum Page Length (MPL). Enter a value in the range 1 to 255. The default value is 66.
- RTLfile
- Printing Right-to-left files. Specify true to print a file as it appears on a RTL screen. The default value is false.
<classSettings> tag
The <classSettings> tag is the enclosing tag for the Java classes you include in the connection definition.
<class> tag
The <class> tag specifies a class whose attributes are defined in the enclosed <settings> tags.
The attributes of the <class> tag are:
- name
- Specifies one of the following Java classes:
- com.ibm.hats.common.HATSPrintSettings
- com.ibm.hats.common.NextScreenSettings
The class names on the name attribute must be enclosed in quotes.
The attributes for the com.ibm.hats.common.HATSPrintSettings class are:
- printFontName
- Specifies the font in which you want your output printed. Valid values depend on the value of the codePage attribute.
- printOrientation
- Specifies how your printed output is positioned on the page. Valid values for printOrientation are:
- PDF_ORIENTATION_PORTRAIT
- Orients the paper vertically.
- PDF_ORIENTATION_LANDSCAPE
- Rotates the paper 90 degrees clockwise.
- printPaperSize
- Specifies the size of the paper on which to print your output. Valid values for printPaperSize are:
- ISO_A3
- ISO/DN & JIS A4, 297 x 420 mm
- ISO_A4
- ISO/DN & JIS A4, 210 x 297 mm
- ISO_A5
- ISO/DN & JIS A4, 148 x 210 mm
- ISO_B4
- ISO/DN B4, 250 x 353 mm
- ISO_B5
- ISO/DN B5, 176 x 250 mm
- JIS_B4
- JIS B4, 257 x 364 mm
- JIS_B5
- JIS B5, 182 x 257 mm
- ISO_C5
- ISO/DN C5, 162 x 229 mm
- ISO_DESIGNATED_LONG
- ISO/DN Designated Long, 110 x 220 mm
- EXECUTIVE
- Executive, 7 1/4 x 10 1/2 in
- LEDGER
- Ledger, 11 x 17 in
- NA_LETTER
- North American Letter, 8 1/2 x 11 in
- NA_LEGAL
- North American Legal, 8 1/2 x 14 in
- NA_NUMBER_9_ENVELOPE
- North American #9 Business Envelope, 3 7/8 x 8 7/8 in
- NA_NUMBER_10_ENVELOPE
- North American #10 Business Envelope, 4 1/8 x 9 1/2 in
- MONARCH_ENVELOPE
- Monarch Envelope, 3 7/8 x 7 1/2 in
- CONTINUOUS_80_COLUMNS
- Data Processing 80 Columns Continuous Sheet, 8 x 11 in
- CONTINUOUS_132_COLUMNS
- Data Processing 132 Columns Continuous Sheet, 13 1/5 x 11 in
- printURL
- Specifies the URL for an iSeries for Web Access (IWA) Printer Output window on a 5250 server. The default URL is http://hostname/webaccess/iWASpool, where hostname is the name of the 5250 server.
The attributes for the com.ibm.hats.common.NextScreenSettings class are:
- delayInterval
- Specifies the time (in milliseconds) that the server waits until a full host screen that is not the first host screen has arrived. The initial default value is 1200 milliseconds.
- delayStart
- Specifies the time (in milliseconds) that the server waits until the first full host screen has arrived. The initial default value is 2000 milliseconds.
<poolsettings> tag
The <poolsettings> tag defines pooling parameters for the connection.
The attributes of the <poolsettings> tag are:
- enabled
- Specifies whether pooling is enabled for this connection. Valid values for enabled are true and false. The initial default is false.
- initialconnections
- The number of connections to initialize the pool to once the WAR is started in the Application Server. Valid number of connections is between 0 and the value of maxconnections. The default is 0 (do not initialize any connections when the WAR is started in the App Server).
- maxbusytime
- The number of seconds before a connection that is in use by an end user will be terminated. If you do not want active connections to end, set this field to -1. This setting is available for connections that have pooling enabled as well as for connections that have pooling disabled. For a connection with pooling enabled, the connection returns to the pool if the number of available connections in the pool is less than the minimum number of connections you specified to remain connected. Otherwise, this connection is discarded. For a connection with pooling disabled, the connection is discarded. Valid number of seconds is either -1, or between 60 and 2147483647. The default is -1 (no maximum busy time).
- maxconnections
- The maximum number of connections in the pool that can be active. This setting is available only for connections that have pooling enabled. Valid number of connections is between 1 and 2147483647. The default is 1. When you reach the maximum specified and an additional request for a connection is received, HATS can either wait for the next available connection or create a new connection.
- maxidletime
- The number of seconds before a connection that is not in use by an end user will be terminated and removed from the pool. If you do not want inactive connections to end, set this field to -1. This setting is available only for connections with connection pooling enabled. The minimum number of connections you specify remain connected, whether or not they are used. Valid number of seconds is either -1, or between 60 and 2147483647. The default is -1 (no maximum idle time).
- minconnections
- The number of idle connections in the pool that remain connected. This setting is available only for connections that have pooling enabled and have the maxidletime before disconnection set to some value other than -1. Valid number of connections is between 0 and 2147483647. The default is 0 (do not keep connections connected).
- overflowallowed
- Whether a new, non-pooled connection should be created if the maximum limit of connections has been reached. If this value is false, specify the number of seconds to wait for a pooled connection to become available. If the time to wait elapses and a connection does not become available, HATS returns an error. If this value is true, a new, non-pooled connection will be created. When the end user finishes with this type of connection, it is not put back in the pool, but discarded.
- waittimeout
- The number of seconds to wait for a pooled connection to become available once the maximum limit of connections has been reached, and another request comes in. Valid number of seconds is between 0 and 2147483647, or -1 if you want to wait forever. The default is 120.
<webexpresslogon> tag
The <webexpresslogon> tag indicates whether the Web Express Logon function is enabled for this connection.
The attributes of the <webexpresslogon> tag are:
- enabled
- Specifies whether the Web Express Logon function is enabled for this connection. Valid values for enabled are true and false. The initial default is false.
Template and transformation files (.jsp)
These JavaServer Pages (JSP) files contain HTML and JSP tagging to define how your project appears in the end user's browser.
The template .jsp files are stored in the project_name/Web content/templates directory. The transformation .jsp files are stored in the project_name/Web Content/transformations directory. You can view and edit the source of the .jsp files by double-clicking on the name of the template or transformation in the HATS Project View to open the JSP editor. The source for the file can be viewed by clicking on the Source tab.
You can modify the template and transformation files using either the Design or the Source tabs in the JSP editor. When you make a change on one tab, HATS Studio updates the affected information on the other tab.
A template .jsp file contains HTML tagging to define links and images for the project page. The template .jsp file also contains a <HATS:Transform> tag that defines the transformation to be used with the template to present the page of your project.
A transformation .jsp file contains HTML tags to describe the layout of the information presented to the user of the project in a Web browser. The transformation .jsp file may also contain <HATS:Component> tags that define HATS components and widgets used to present the page of your project. For more information on the HATS:Component tag, see Component and widget properties in the HATS:Component tag.
Screen customization files (.evnt)
The screen customization files define how a host screen is recognized, and also defines the actions HATS performs when a screen is recognized.
The screen customization (.evnt) files are stored in the project_name/Web Content/WEB-INF/profiles/events/screencustomizations directory. You can view and edit the source of the screen customization files by double-clicking on the name of the screen customization in the HATS Project View to open the screen customization editor. The source for the file can be viewed by clicking on the Source tab.
You can modify screen customization files using the Screen Recognition Criteria, Actions, Text replacement, or Source tabs in the editor. HATS Studio updates the affected information on other tabs when you make changes on any tab.
The screen customization event files contain tags to define how a host screen is recognized and the actions that will occur when the host screen is recognized. The tags are:
- event
- Begins the definition of the screen customization. The event tag has the following attributes:
- description
- If you supplied a description of the screen customization when you created it, that description is defined in this attribute.
- type
- For a screen customization, type is always screenRecognize.
- actions
- Encompasses the actions defined in the screen customization. The possible actions and their attributes are:
- apply
- Defines the action for applying a transformation. The attributes of the apply tag are:
- applyGlobalRules
- Specifies whether HATS should look for global rules on this host screen. Default is "true.
- immediateKeyset
- Defines the host keys sent to the host immediately when pressed by the end user of your project. If you did not define any host keys to be sent to the host immediately, this attribute has an empty value.
- template
- Names the template file that surrounds the transformation being applied. If the default template is being used to surround the transformation, this attribute has an empty value.
- transformation
- Names the transformation file that is to be applied for this action.
- insert
- Defines the action for inserting a global variable or a string. The attributes of the insert tag are:
- row
- Defines the starting row on the host screen where the value is to be inserted.
- col
- Defines the starting column on the host screen where the value is to be inserted.
- source
- Specifies whether the value to be inserted is a string or the value of a global variable. Valid values are string and variable.
- value
- Specifies either the string to be inserted onto the host screen or the name of a global variable from which the value is taken.
- fill
- If the source of the value to be inserted is an indexed global variable, fill specifies whether the indices of the global variable are to be concatenated and inserted at the specified position, or inserted into a rectangular region of the host screen. Valid values are concatenate and rectangular.
- index
- If the source of the value to be inserted is an indexed global variable, index specifies the number of the index that is to be used as the value to be inserted onto the host screen.
- extract
- Defines the action for extracting a global variable. The attributes of the extract tag are:
- srow
- Defines the starting row on the host screen of the text being extracted.
- erow
- Defines the ending row on the host screen of the text being extracted.
- scol
- Defines the starting column on the host screen of the text being extracted.
- ecol
- Defines the ending column on the host screen of the text being extracted.
- name
- Specifies the name of the global variable to which the text is extracted. This can be an existing global variable or a new global variable.
- overwrite
- Specifies whether the text extracted is to overwrite the value of an existing global variable. Valid values are true and false.
- indexed
- Specifies whether the text extracted is a single string or a list of strings, where each string in the list corresponds to a single row of text from the extracted region. Valid values are true and false.
- index
- If an existing global variable is indexed, this attribute specifies the index number to which the extracted value is to be written. The effect of this attribute is dependent on the value of the overwrite attribute. If overwrite=true, the extracted value overwrites the existing variable, starting at the specified index. If overwrite=false, the extracted value is inserted into the existing variable, beginning at the specified index.
- set
- Defines the action for setting a global variable. The attributes of the set tag are:
- name
- Specifies the name of the global variable being set. This can be an existing global variable or a new global variable.
- type
- Specifies whether the value of the global variable being set comes from a fixed constant or a calculated value. Valid values are string and calculate.
- overwrite
- Specifies whether the value being set is to overwrite the value of an existing global variable. Valid values are true and false.
- index
- If the value being set is being written to an existing indexed global variable, this attribute specifies the index number to which the value being set is written. The effect of this attribute is dependent on the value of the overwrite attribute. If overwrite=true, the value being set overwrites the existing variable, beginning at the specified index. If overwrite=false, the value being set is inserted into the existing variable, beginning at the specified index.
- op1
- Specifies whether the first operand of a calculated value is a fixed constant or the value of an existing global variable. Valid values are a fixed constant or the name of a global variable.
- op1_type
- Specifies whether the value of the first operand of a calculated value is set as a fixed constant or from an existing global variable. Valid values are string and variable.
- op1_index
- If the source of the value of the first operand of a calculated value is an indexed global variable, op1_index specifies the number of the index used as the value for the calculation.
- op
- Specifies the type of operation to occur between the first and second operands of a calculated value. Valid values are + (add), - (subtract), * (multiply), / (divide), and % (modulo).
- op2
- Specifies whether the second operand of a calculated value is a fixed constant or the value of an existing global variable. Valid values are a fixed constant or the name of a global variable.
- op2_type
- Specifies whether the value of the second operand of a calculated value is set as a fixed constant or from an existing global variable. Valid values are string and variable.
- op2_index
- If the source of the value of the second operand of a calculated value is an indexed global variable, op2_index specifies the number of the index used as the value for the calculation.
- dec
- Specifies the number of decimal places to which a calculated value is rounded. Valid values are 0-999.
- execute
- Defines the action for executing business logic. The attributes of the execute tag are:
- class
- Names the Java class that contains your business logic. The class value is required.
- method
- Names the method inside the class that executes the business logic. The method value is required.
- package
- Names the package that the Java class resides in on your file system. The package value is optional.
- show
- Defines the action for showing a URL. The show tag has the following attribute:
- url
- Identifies the Uniform Resource Locator (URL) of the Web page to show. This attribute is required.
- disconnect
- Disconnects the default connection. Use this action carefully and only for events from which you cannot recover. The disconnect tag has no attributes.
- play
- Defines the action for playing a macro. The play tag has the following attribute:
- macro
- Names the macro to be played. This attribute is required.
- perform
- Defines the action for playing a macro on any connection, not necessarily the default connection.This action does not affect the current host screen. The perform tag has the following attributes:
- connection
- The connection on which the macro is to be played. The default is main.
- enabled
- Indicates whether this action is enabled for use. The default is true.
- macro
- The name of the macro to be played.
- associatedScreens
- The associatedScreens tag encompasses the screen tag that follows.
- screen
- Defines a screen associated with the screen customization. The screen tag has the following attribute:
- name
- Specifies the name of a captured screen, for which the screen recognition criteria and actions have been defined.
- description
- The description tag is the enclosing tag for the description associated with the screen customization, which is comprised of the oia tag and the string tag. There are no attributes for the description tag.
- oia
- The oia tag specifies an operator information area (OIA) condition to match. This tag is optional. The default is to wait for inhibit status.
The attributes of the <oia> tag are:
- status
- If NOTINHIBITED, the OIA must be uninhibited for a match to occur. If DONTCARE, the OIA inhibit status is ignored. This has the same effect as not specifying OIA at all. Valid values are NOTINHIBITED and DONTCARE. This is a required attribute.
- optional
- If false, this descriptor is considered non-optional during screen recognition. If the descriptors are comprised of more than one non-optional descriptor, and more than one optional descriptor, the non-optional descriptors are checked first. If all of the non-optional descriptors match, the screen matches. If at least one of the non-optional descriptors does not match, the optional descriptors are checked. One of the optional descriptors must match for the screen to match. Otherwise, the screen fails to match. The value must be true or false. This attribute is optional. The default is false.
- invertmatch
- If true, recognition matching passes only if the screen does not match this description element (boolean not operation). The value must be true or false. This attribute is optional. The default is false.
- string
- The string tag describes the screen based on a string. The attributes of the <string> tag are:
- value
- The string value. This value can contain any valid Unicode character. This is a required attribute.
- row
- The starting row position for a string at an absolute position or in a rectangle. The value must be a number or an expression that evaluates to a number. This value is optional. If not specified, Macro logic searches the entire screen for the string. If specified, col position is required. <erow> and <ecol> attributes can also be specified to specify a string in a rectangular area.
Negative values are valid and are used to indicate relative position for the bottom of the screen (for example, -1 is the last row).
- col
- The starting column position for the string at an absolute position or in a rectangle. The value must be a number or an expression that evaluates to a number. This attribute is optional.
- erow
- The ending row position for string in a rectangle. The value must be a number or an expression that evaluates to a number. This attribute is optional. If both erow and ecol are specified, string is in a rectangle.
- ecol
- The ending column position for string in a rectangle. The value must be a number or an expression that evaluates to a number. This attribute is optional. If both erow and ecol are specified, string is in a rectangle.
- casesense
- If true, string comparison is case sensitive. The value must be true or false or an expression that evaluates to true or false. This attribute is optional. The default is false.
- optional
- If false, this descriptor is considered non-optional during screen recognition. If the descriptors are comprised of more than one non-optional descriptor, and more than one optional descriptor, the non-optional descriptors are checked first. If all of the non-optional descriptors match, the screen matches. If at least one of the non-optional descriptors does not match, the optional descriptors are checked. One of the optional descriptors must match for the screen to match. Otherwise, the screen fails to match. The value must be true or false or an expression that evaluates to true or false. This attribute is optional. The default is false.
- invertmatch
- If true, recognition matching passes only if the screen does not match this description element (boolean not operation). The value must be true or false or an expression that evaluates to true or false. This attribute is optional. The default is false.
Macro files (.hma)
Macro files are stored in the project_name/Web Content/WEB-INF/profiles/events/macros directory. You can view and edit the source of the macro files by double-clicking on the name of the macro in the HATS Project View to open the macro editor. The source for the file can be viewed by clicking on the Source tab.
Macro files contain tags that define a set of screens. The tags are:
- macro
- Begins the definition of the macro. The macro tag has no attributes.
- extracts
- The extracts tag encompasses the extract tag that follows. The extracts tag has no attributes.
- extract
- The extract tag defines the extraction to occur. The attributes of the extract tag are:
- name
- Specifies the name of the extraction.
- handler
- You can select a .jsp file to display the extracted information to the end user. A default macro handler is shipped with HATS, and it is named default.jsp. You can find this file by clicking the HATS Project View tab of the HATS Studio and expanding the project name, and expanding Macros > Macro Event Handlers. If you want to create your own handler, ensure that you return control to the HATS runtime.
- showHandler
- Specifies whether the extracted information should be shown to the end user. Valid values are true and false.
- save
- Specifies whether the extracted information is saved to a global variable. Valid values are true and false.
- variableName
- If the extracted information is being saved to a global variable, variableName specifies the name of a new or existing global variable.
- overwrite
- If the extracted information is being saved to an existing global variable, overwrite specifies whether the extracted information is to overwrite the current value of the existing global variable, or whether the extracted information is to be appended to the current value. Valid values are true and false. True specifies that the value of the existing global variable is overwritten.
- indexed
- Specifies whether the extracted information is a single string or a list of strings. Valid values are true and false. True specifies that the extracted information is a list of strings.
- prompts
- The prompts tag encompasses the prompt tag that follows. The prompts tag has no attributes.
- prompt
- The prompt tag defines the prompt to occur. The attributes of the prompt tag are:
- name
- Specifies the name of the prompt.
- handler
- You can select a .jsp file to prompt the end user for the necessary information, and include a button for the user to submit the information. A default macro handler is shipped with HATS, and it is named default.jsp. You can find this file by clicking the HATS Project View tab of the HATS Studio and expanding the project name, and expanding Macros > Macro Event Handlers. If you want to create your own handler, ensure that you return control to the HATS runtime.
- source
- Specifies whether the value of the prompt is set to a string or the value of a global variable. Valid values are string and variable.
- variableName
- If the value of the prompt is being saved to a global variable, variableName specifies the name of a new or existing global variable.
- variableIndex
- If the value of the prompt is being saved to an indexed global variable, variableIndex specifies to which index the value should be assigned. This value is always 0.
- value
- Specifies either the string to be used for the prompt or the name of a global variable from which the value is taken.
- HAScript
- The HAScript tag is the main enclosing tag for the other macro tags and attributes.
Screen capture files (.hsc)
Screen capture files are XML representations of host screens, used to create or customize screen customizations or transformations.
Screen capture files are stored in the project_name/screens directory. You can view these files by double-clicking on the name of the screen capture in the HATS Project View. You cannot edit screen capture files.
Image files (.gif or .jpg)
Image files are used in HATS Studio within template files to create the Web page displayed to the user of your project.
Image files are stored in the project_name/Web Content/common/images directory. You can view and edit the image files by double-clicking on the name of the image in the HATS Project View to open the WebSphere Studio WebArt Designer.
Stylesheet files (.css)
Stylesheet files are used in HATS Studio within template files to specify appearance items such as color, font, font size, whitespace, and spacing between letters.
Stylesheet files are stored in the project_name/Web Content
/common/stylesheets directory. You can edit the stylesheet files by double-clicking on the name of the stylesheet in the HATS Project View to open the stylesheet editor.
ComponentWidget.xml
The ComponentWidget.xml file contains the definitions of all the host components and widgets provided with HATS. If you add your own host components or widgets, you will need to update this file. For an explanation and a small sample of the file, see Registering your component or widget. The ComponentWidget.xml file appears as the last item in your project in the Navigator view. To edit the file, double-click the file name in the Navigator view and select the Source tab.
For a description of the contents and use of this file, see Registering your component or widget.
Web Express Logon configuration file (hatswelcfg.xml)
Web Express Logon (WEL) credential mapping is configured in an XML file named hatswelcfg.xml, which is stored in the root directory of the EAR project for HATS servlet projects, and in the WEB-INF directory of HATS portlet projects. To view the source of the WEL configuration, open the WEL editor from the Security tab of the Connection Editor, then click on the Source tab. However, modify the configuration using the Network Security Plugin and Credential Mapper Plugins tabs of the WEL editor.
<credentialmapper> tag
The <credentialmapper> tag is the enclosing tag for the Web Express Logon configuration. The attribute of the <credentialmapper> tag is:
- class
- Specifies the Java class to use as the WEL Credential Mapper. This value is not editable on the two plugin tabs of the WEL Editor. Do not change this value unless directed to do so by IBM Service.
<networksecurity> tag
The <networksecurity> tag is a container for zero or one Network Security plugin tag (<plugin>), and has no attributes.
<cmplugins> tag
The <cmplugins> tag is a container for a number of Credential Mapper plugin tags (<plugin>), and has no attributes.
<plugin> tag
The <plugin> tag identifies either a Network Security plugin or a Credential Mapper plugin, and encloses the tags for the plugin's parameters. The attributes of the <plugin> tag are:
- class
- Specifies the Java class that contains the plugin code.
- authenticationtype
- Specifies the types of hosts for which the plugin can map credentials, and is used by Web Express Logon to determine which plugin will handle a request. Valid values are AuthType_3270Host, AuthType_5250Host, and AuthType_VTHost. Multiple values can be used, separated by vertical bar (|). This attribute is valid only for a Credential Mapper plugin, when the <plugin> tag is enclosed by the <cmplugins> tag
- hostmask
- Specifies the names of hosts for which the plugin can map credentials, and is used by Web Express Logon to determine which plugin will handle a request. The value of this attribute can contain one or more host addresses, with the vertical bar (|) to join multiple addresses, and the asterisk (*) as a wildcard at the beginning and/or the end of a host address. This attribute is valid only for a Credential Mapper plugin, when the <plugin> tag is enclosed by the <cmplugins> tag.
<param> tag
The <param> tag identifies a plugin parameter's name and value. The attributes of the <param> tag are:
- name
- Specifies the name of the plugin parameter. Each plugin Java class defines the set of parameter names it will accept.
- value
- Specifies the value of the plugin parameter. If the parameter is defined in the plugin Java class to be an encrypted parameter, the value here must be encrypted.
Home