Pathway,I Ts Web Client Programming Manual
Upcoming SlideShare
Loading in...5
×
 

Pathway,I Ts Web Client Programming Manual

on

  • 2,704 views

 

Statistics

Views

Total Views
2,704
Views on SlideShare
2,704
Embed Views
0

Actions

Likes
1
Downloads
18
Comments
0

0 Embeds 0

No embeds

Accessibility

Categories

Upload Details

Uploaded via as Adobe PDF

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

Pathway,I Ts Web Client Programming Manual Pathway,I Ts Web Client Programming Manual Document Transcript

  • HP NonStop Pathway/iTS Web Client Programming Manual Abstract This manual describes how to convert SCREEN COBOL requesters to web clients and explains how to build and deploy those clients. It also provides the information Java developers and web designers need to modify and enhance the Java and HTML portions of the converted clients. Product Version Pathway/iTS 1.1 Supported Release Version Updates (RVUs) This publication supports J06.03 and all subsequent J-series RVUs and H06.03 and all subsequent H-series RVUs, until otherwise indicated by its replacement publications. Part Number Published 520270-003 May 2008
  • Document History Part Number Product Version Published 426746-001 Pathway/iTS 1.0 October 2000 520270-001 Pathway/iTS 1.0 Update June 2001 520270-002 Pathway/iTS 1.1 May 2007 520270-003 Pathway/iTS 1.1 May 2008
  • Legal Notices © Copyright 2008 Hewlett-Packard Development Company L.P. Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. The information contained herein is subject to change without notice. The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein. Export of the information contained in this publication may require authorization from the U.S. Department of Commerce. Microsoft, Windows, and Windows NT are U.S. registered trademarks of Microsoft Corporation. Intel, Itanium, Pentium, and Celeron are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries. Java is a U.S. trademark of Sun Microsystems, Inc. Motif, OSF/1, UNIX, X/Open, and the "X" device are registered trademarks and IT DialTone and The Open Group are trademarks of The Open Group in the U.S. and other countries. Open Software Foundation, OSF, the OSF logo, OSF/1, OSF/Motif, and Motif are trademarks of the Open Software Foundation, Inc. OSF MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THE OSF MATERIAL PROVIDED HEREIN, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. OSF shall not be liable for errors contained herein or for incidental consequential damages in connection with the furnishing, performance, or use of this material. © 1990, 1991, 1992, 1993 Open Software Foundation, Inc. This documentation and the software to which it relates are derived in part from materials supplied by the following: © 1987, 1988, 1989 Carnegie-Mellon University. © 1989, 1990, 1991 Digital Equipment Corporation. © 1985, 1988, 1989, 1990 Encore Computer Corporation. © 1988 Free Software Foundation, Inc. © 1987, 1988, 1989, 1990, 1991 Hewlett-Packard Company. © 1985, 1987, 1988, 1989, 1990, 1991, 1992 International Business Machines Corporation. © 1988, 1989 Massachusetts Institute of Technology. © 1988, 1989, 1990 Mentat Inc. © 1988 Microsoft Corporation. © 1987, 1988, 1989, 1990, 1991, 1992 SecureWare, Inc. © 1990, 1991 Siemens Nixdorf Informationssysteme AG. © 1986, 1989, 1996, 1997 Sun Microsystems, Inc. © 1989, 1990, 1991 Transarc Corporation. This software and documentation are based in part on the Fourth Berkeley Software Distribution under license from The Regents of the University of California. OSF acknowledges the following individuals and institutions for their role in its development: Kenneth C.R.C. Arnold, Gregory S. Couch, Conrad C. Huang, Ed James, Symmetric Computer Systems, Robert Elz. © 1980, 1981, 1982, 1983, 1985, 1986, 1987, 1988, 1989 Regents of the University of California. Printed in the US
  • HP NonStop Pathway/iTS Web Client Programming Manual Index Examples Figures Tables Legal Notices What’s New in This Manual vii Manual Information vii New and Changed Information vii About This Manual xi Who Should Read This Manual xi Related Documentation xi Notation Conventions xiii 1. Introduction to Pathway/iTS Web Clients Development Process for Web Clients 1-2 Run-Time Environment for Web Clients 1-3 Java Import Package 1-3 Router Process 1-4 Terminal Control Process (TCP) 1-4 Gateway Threads 1-5 Pathway/iTS 1.1 1-5 2. How to Compile, Build, and Maintain a Pathway/iTS Web Client 1. Prepare the SCREEN COBOL Object File 2-2 2. Create a Configuration File 2-2 3. Run the Converter 2-3 4. Modify Java or SCREEN COBOL Code as Needed 2-4 5. Run PROFDBM to Set Up the User Profile Database 2-4 6. Build the Converted Client 2-5 Set Up the Build Environment in an OSS Environment 2-5 Set Up the Build Environment in a Windows Environment 2-6 Build (Compile) the Application in an OSS Environment 2-8 Build (Compile) the Application in a Windows Environment 2-9 Hewlett-Packard Company —520270-003 i
  • Contents 2. How to Compile, Build, and Maintain a Pathway/iTS Web Client (continued) 2. How to Compile, Build, and Maintain a Pathway/iTS Web Client (continued) 7. Deploy the Web Client 2-9 Deploy the Web Client on an OSS Environment 2-9 Deploy the Web Client on a Windows Environment 2-11 8. Customize the Screens 2-12 Copy the HTML Files to be Customized 2-12 Modify the HTML Files 2-13 Redeploy Customized HTML Files 2-13 9. Specify the Port Number of the Router Process 2-13 10. Configure Pathway Servers for User Profiles and User Conversion Routines 2-14 11. Tune the Application for Performance by Changing the Session-Length Parameter 2-14 12. Maintain the Client 2-16 Modify SCREEN COBOL Source Code 2-16 Modify Java Source Code Only 2-17 3. Logon Security and User Profiles Logon Security 3-1 User Profiles 3-1 Actions of the Web Client 3-2 Contents of the User Profile Database 3-2 User Profile Options in the Control File 3-3 Use the PROFDBM Utility 3-5 Configure the User Profile Server Class 3-6 4. User-Written User Conversion Procedures for Web Clients Build Your User Conversion Library 4-2 Configure the User Conversion Server Class 4-2 5. SCREEN COBOL-to-Web Conversion Mappings Components of the Web Client 5-2 Main Java Applet 5-2 Starting Page 5-2 Initial Page 5-2 Control Page 5-3 Java Classes for the Program Units 5-3 User HTML Pages for the Screen Sections 5-3 Conversion Mappings 5-3 Mappings to Java Classes 5-3 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 ii
  • Contents 5. SCREEN COBOL-to-Web Conversion Mappings (continued) 5. SCREEN COBOL-to-Web Conversion Mappings (continued) Mappings to User HTML Pages 5-7 6. Java Import Package Reference Host Connectivity Classes 6-2 Class Gateway 6-2 Class ServerReplyCode 6-11 HTML Screen Interaction Classes 6-13 Class ScreenFieldIdentifier 6-13 Class ScreenField 6-13 Class ScreenFieldArray 6-22 Class ScreenFieldGroup 6-30 Class HTMLHandler 6-32 Class FunctionKey 6-43 Data-Type Classes 6-44 Class ScobolType 6-44 Class ScobolGroupType 6-53 Class Pic9 6-60 Class Pic9P 6-72 Class Pic9V 6-84 Class PicN 6-97 Class PicX 6-103 Transform Class 6-113 Class Transform 6-113 ProgramUnit Class 6-117 Class ProgramUnit 6-117 Special-Register Classes 6-120 Class ScobolLib 6-120 Class Cursor 6-123 Exception Classes 6-126 Class ExitProgramException 6-126 Class ScobolException 6-126 Class ScobolSendException 6-127 Class ScobolTxnException 6-128 Class StopRunException 6-129 Class TransformException 6-129 User Conversion Classes 6-131 Class UserConversion 6-131 Class ScLibUserConversion 6-132 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 iii
  • Contents 7. Introduction to Pathway/iTS 1.1 7. Introduction to Pathway/iTS 1.1 Architecture of Pathway/iTS 1.1 7-2 SCOBOL Verbs and Special Register 7-3 Web Clients in Pathway/iTS 1.1 7-4 Difference Between Pathway/iTS 1.0 and Pathway/iTS 1.1 7-4 Server Process Opener and Timeouts on Send to Servers 7-4 TCP Checkpoint Strategy 7-4 Special Registers 7-5 FREEZE SERVER Command Changes 7-6 Statistics Collected by Pathway/iTS 1.1 7-7 Fault Tolerance in Pathway/iTS 1.1 7-7 Error Handling in Pathway/iTS 1.1 7-8 A. Client Error Messages General Information A-1 Message Descriptions A-1 B. SCREEN COBOL Features Not Supported for Web Conversion Index Examples Example 2-1. Sample Configuration File for mycfg 2-3 Example 2-2. Sample CONTROL.html File 2-16 Example 5-1. SCREEN COBOL Working-Storage Code Fragment 5-4 Example 5-2. Java Code Resulting From Conversion of Working-Storage Code 5-4 Example 5-3. SCREEN COBOL Paragraph 5-5 Example 5-4. Java Code Resulting From Conversion of SCREEN COBOL Paragraph 5-5 Example 5-5. SCREEN COBOL Input-Output Element 5-6 Example 5-6. Java Code Resulting From Conversion of SCREEN COBOL Input- Output Element 5-6 Example 5-7. SCREEN COBOL Screen Section 5-8 Example 5-8. HTML Code Resulting From Conversion of SCREEN COBOL Screen Section 5-8 Example 7-1. Sample TCP Statistics for QUEUE INFO. 7-7 Figures Figure 1-1. Development of a Pathway/iTS Web Client 1-2 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 iv
  • Contents Figures (continued) Figures (continued) Figure 1-2. Run-Time Environment for a Pathway/iTS Web Client 1-3 Figure 7-1. Architecture of Pathway/iTS 1.1 7-2 Tables Table B-1. Web Conversion Support Limitations B-2 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 v
  • Contents HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 vi
  • What’s New in This Manual Manual Information HP NonStop Pathway/iTS Web Client Programming Manual Abstract This manual describes how to convert SCREEN COBOL requesters to web clients and explains how to build and deploy those clients. It also provides the information Java developers and web designers need to modify and enhance the Java and HTML portions of the converted clients. Product Version Pathway/iTS 1.1 Supported Release Version Updates (RVUs) This publication supports J06.03 and all subsequent J-series RVUs and H06.03 and all subsequent H-series RVUs, until otherwise indicated by its replacement publications. Part Number Published 520270-003 May 2008 Document History Part Number Product Version Published 426746-001 Pathway/iTS 1.0 October 2000 520270-001 Pathway/iTS 1.0 Update June 2001 520270-002 Pathway/iTS 1.1 May 2007 520270-003 Pathway/iTS 1.1 May 2008 New and Changed Information Changes in the H06.14/J06.03 manual: • Supported release statements have been updated to include J-series RVUs. • Added an overview of Pathway/iTS 1.1 on page 1-5. • Added four delegation methods to the list of Class Gateway on page 6-3 and added their descriptions on page 6-6. • Added a data member to Class ScobolLib on page 6-121. • Added Section 7, Introduction to Pathway/iTS 1.1. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 vii
  • What’s New in This Manual Product Changes in G06.27 • Added these error messages: • 3115 on page A-8 • 3231 on page A-11 • 3246 on page A-11 • 3247 on page A-12 • 3248 on page A-12 • 3249 on page A-13 • 3250 on page A-13 • 3251 on page A-14 • 3252 on page A-14 • 3253 on page A-15 • 3308 on page A-18 • 3312 on page A-19 • 3313 on page A-19 Product Changes in G06.27 The Pathway/iTS product, formerly called Pathway/TS, was renamed to conform to current HP product naming standards and to reflect the internet (web client) capabilities of the product. After the first reference to the product name in each manual section, subsequent references use the shortened form of the name, Pathway/iTS. • Section 2: How to Compile, Build, and Maintain a Pathway/iTS Web Client • Added a Deployment Environment section toSample Configuration File for mycfg on page 2-3. • Reorganized and added detailed information and examples to 6. Build the Converted Client on page 2-5 7. Deploy the Web Client on page 2-9 8. Customize the Screens on page 2-12. • Changed the step for setting up the user profile database from optional to required. See 5. Run PROFDBM to Set Up the User Profile Database on page 2-4. • Section 4: User-Written User Conversion Procedures for Web Clients • Corrected the nld utility command description in Build Your User Conversion Library on page 4-2. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 viii
  • What’s New in This Manual Corrections and Enhancements to the Manual • Section 5: SCREEN COBOL-to-Web Conversion Mappings • Added a description of the Initial page in Initial Page on page 5-2. • Modified the name of the starting page file from name_PAGE1.html to name_START.html in Starting Page on page 5-2. • Corrected the code in Example 5-2 on page 5-4 Example 5-6 on page 5-6 Example 5-7 on page 5-8 Example 5-8 on page 5-8 • Updated information in Mappings to User HTML Pages on page 5-7. • Section 6: Java Import Package Reference • Updated the Method send on page 6-10. • Added the pow method to the ScobolLib class. See Method pow on page 6-122 • Modified the displayOverlay method in the HTMLHandler class. See Method displayOverlay on page 6-37. • Added the displayOverlaySpaces method to the HTMLHandler class. See Method displayOverlaySpaces on page 6-38. • Added the addScobolData method to the ScobolGroupType calss. See Method addScobolData on page 6-54. • Removed the Class Overlay Manager, Method addOverlay (single overlay screen), and Method addOverlay (multiple overlay screens). • General, throughout the manual • Removed references to the Unix operating system. • Corrected several examples Corrections and Enhancements to the Manual These enhancements have been made to the material in this manual: • References to Compaq trademarks have been updated. • Miscellaneous terminology changes and editorial corrections have been made. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 ix
  • What’s New in This Manual Corrections and Enhancements to the Manual HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 x
  • About This Manual This manual describes how to convert SCREEN COBOL requesters to web clients and explains how to build and deploy those clients. It also provides the information Java developers and web designers need to modify and enhance the Java and HTML portions of the converted clients. Who Should Read This Manual This manual is intended for these types of readers: • Application developers who are converting SCREEN COBOL requesters to web clients • Java developers who are modifying and enhancing the Java portion of converted web clients • Web designers who are modifying the HTML output of converted web clients The primary focus of this manual is on describing the unmodified converted clients and how to use them, rather than on how to enhance the clients after conversion. However, this manual provides information about the structure and content of the converted Java code and HTML pages so that developers and web designers can modify them if desired. Related Documentation The Pathway environment is supported by three products: HP NonStop™ Pathway/iTS HP NonStop™ Transaction Services/MP (NonStop™ TS/MP) HP NonStop™ Pathway/XM HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 xi
  • About This Manual Related Documentation These manuals may be useful: Pathway/iTS SCUP Describes the utility program that enables SCREEN Reference Manual COBOL application programmers to control and manipulate SCREEN COBOL object files. This manual includes detailed syntax for the CONVERT command, used to convert SCREEN COBOL object files to web clients. Pathway/iTS SCREEN Describes the SCREEN COBOL programming COBOL Reference language, which is used for writing programs that Manual define and control terminal displays or intelligent devices for online transaction processing applications running in a PATHMON environment. Pathway/iTS TCP and A guide for programmers who are writing SCREEN Terminal Programming COBOL requesters to be used in Pathway Guide applications. Pathway/iTS System Describes the interactive management interface to Management Manual the Pathway/iTS product and describes how to configure and manage Pathway/iTS objects. NonStop™ TS/MP Describes the interactive management interface to System Management the NonStop TS/MP product and describes how to Manual configure and manage NonStop TS/MP objects. This interface is used together with the Pathway/iTS management interface to configure and manage a Pathway environment. Pathway/XM System Describes the higher-level management interface Management Manual provided by the Pathway/XM product, which you might want to use to configure and manage your Pathway environment rather than use the management interfaces provided by Pathway/iTS and NonStop TS/MP. Pathway/iTS Describes the management programming interface Management for Pathway/iTS objects in the PATHMON Programming Manual environment. Pathway Products Defines technical terms used in this manual and in Glossary other manuals for the Pathway products: Pathway/iTS, NonStop TS/MP, and Pathway/XM. Operator Messages Describes all messages that are distributed by the Manual Event Management Service (EMS), including those generated by NonStop TS/MP and Pathway/iTS processes. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 xii
  • About This Manual Notation Conventions Notation Conventions Hypertext Links Blue underline is used to indicate a hypertext link within text. By clicking a passage of text with a blue underline, you are taken to the location described. For example: This requirement is described under Backup DAM Volumes and Physical Disk Drives on page 3-2. General Syntax Notation The following list summarizes the notation conventions for syntax presentation in this manual. UPPERCASE LETTERS. Uppercase letters indicate keywords and reserved words; enter these items exactly as shown. Items not enclosed in brackets are required. For example: MAXATTACH lowercase italic letters. Lowercase italic letters indicate variable items that you supply. Items not enclosed in brackets are required. For example: file-name [ ] Brackets. Brackets enclose optional syntax items. For example: TERM [system-name.]$terminal-name INT[ERRUPTS] A group of items enclosed in brackets is a list from which you can choose one item or none. The items in the list may be arranged either vertically, with aligned brackets on each side of the list, or horizontally, enclosed in a pair of brackets and separated by vertical lines. For example: FC [ num ] [ -num] [ text] K [ X | D ] address-1 { } Braces. A group of items enclosed in braces is a list from which you are required to choose one item. The items in the list may be arranged either vertically, with aligned braces on each side of the list, or horizontally, enclosed in a pair of braces and separated by vertical lines. For example: LISTOPENS PROCESS { $appl-mgr-name } { $process-name } ALLOWSU { ON | OFF } HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 xiii
  • About This Manual General Syntax Notation | Vertical Line. A vertical line separates alternatives in a horizontal list that is enclosed in brackets or braces. For example: INSPECT { OFF | ON | SAVEABEND } … Ellipsis. An ellipsis immediately following a pair of brackets or braces indicates that you can repeat the enclosed sequence of syntax items any number of times. For example: M address-1 [ , new-value ]... [ - ] {0|1|2|3|4|5|6|7|8|9}... An ellipsis immediately following a single syntax item indicates that you can repeat that syntax item any number of times. For example: "s-char..." Punctuation. Parentheses, commas, semicolons, and other symbols not previously described must be entered as shown. For example: error := NEXTFILENAME ( file-name ) ; LISTOPENS SU $process-name.#su-name Quotation marks around a symbol such as a bracket or brace indicate the symbol is a required character that you must enter as shown. For example: "[" repetition-constant-list "]" Item Spacing. Spaces shown between items are required unless one of the items is a punctuation symbol such as a parenthesis or a comma. For example: CALL STEPMOM ( process-id ) ; If there is no space between two items, spaces are not permitted. In this example, there are no spaces permitted between the period and any other items: $process-name.#su-name Line Spacing. If the syntax of a command is too long to fit on a single line, each continuation line is indented three spaces and is separated from the preceding line by a blank line. This spacing distinguishes items in a continuation line from items in a vertical list of selections. For example: ALTER [ / OUT file-spec / ] CONTROLLER [ , attribute-spec ]... HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 xiv
  • About This Manual Notation for Messages Notation for Messages The following list summarizes the notation conventions for the presentation of displayed messages in this manual. Bold Text. Bold text in an example indicates user input typed at the terminal. For example: ENTER RUN CODE ?123 CODE RECEIVED: 123.00 The user must press the Return key after typing the input. Nonitalic text. Nonitalic letters, numbers, and punctuation indicate text that is displayed or returned exactly as shown. For example: Backup Up. lowercase italic letters. Lowercase italic letters indicate variable items whose values are displayed or returned. For example: p-register process-name [ ] Brackets. Brackets enclose items that are sometimes, but not always, displayed. For example: Event number = number [ Subject = first-subject-value ] A group of items enclosed in brackets is a list of all possible items that can be displayed, of which one or none might actually be displayed. The items in the list might be arranged either vertically, with aligned brackets on each side of the list, or horizontally, enclosed in a pair of brackets and separated by vertical lines. For example: proc-name trapped [ in SQL | in SQL file system ] { } Braces. A group of items enclosed in braces is a list of all possible items that can be displayed, of which one is actually displayed. The items in the list might be arranged either vertically, with aligned braces on each side of the list, or horizontally, enclosed in a pair of braces and separated by vertical lines. For example: obj-type obj-name state changed to state, caused by { Object | Operator | Service } process-name State changed from old-objstate to objstate { Operator Request. } { Unknown. } | Vertical Line. A vertical line separates alternatives in a horizontal list that is enclosed in brackets or braces. For example: Transfer status: { OK | Failed } HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 xv
  • About This Manual Change Bar Notation % Percent Sign. A percent sign precedes a number that is not in decimal notation. The %þnotation precedes an octal number. The %Bþnotation precedes a binary number. The %Hþnotation precedes a hexadecimal number. For example: %005400 P=%p-register E=%e-register Change Bar Notation Change bars are used to indicate substantive differences between this manual and its preceding version. Change bars are vertical rules placed in the right margin of changed portions of text, figures, tables, examples, and so on. Change bars highlight new or revised information. For example: The message types specified in the REPORT clause are different in the COBOL85 environment and the Common Run-Time Environment (CRE). The CRE has many new message types and some new message type codes for old message types. In the CRE, the message type SYSTEM includes all messages except LOGICAL-CLOSE and LOGICAL-OPEN. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 xvi
  • 1 Introduction to Pathway/iTS Web Clients The web client feature of HP NonStop Pathway/iTS lets you convert a SCREEN COBOL application (a group of related compiled program units within an object library) to a web client and then build and deploy the resulting client in a Pathway environment. The converted web client consists of a combination of Java code and HTML pages. These can be deployed on any web server hosted on the HP NonStop Kernel operating system. The Java client, working with a standard web browser, communicates with existing Pathway servers by means of router processes, a run-time web gateway, and the terminal control process (TCP). Any valid block-mode requester programs for terminal types T16-6520, T16-6530, T16-6540, and IBM-3270 can be converted. (Intelligent device support (IDS) requesters cannot be converted.) The specified program units are converted in such a way that most of the functionality of the original SCREEN COBOL program remains unchanged. The conversion feature allows you to maintain the same SCREEN COBOL source code for both terminals and web clients. Thus you can migrate terminals to the web gradually. Alternatively, you can fully migrate your terminal requesters to the web and then use standard web publishing tools to modify and enhance the Java code and the HTML presentation. You can configure and manage Pathway applications containing converted web clients by using either HP NonStop Pathway/XM or PATHCOM. However, HP recommends using Pathway/XM for this purpose; Pathway/XM provides fuller and easier-to-use management capabilities for web client configurations, including configuration and management of router processes. Information about configuring and managing Pathway/iTS web clients through Pathway/XM is provided in the Pathway/XM System Management Manual. Information about configuring and managing Pathway/iTS web clients through PATHCOM is given in the Pathway/iTS System Management Manual. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 1 -1
  • Introduction to Pathway/iTS Web Clients Development Process for Web Clients Development Process for Web Clients The process of creating a Pathway/iTS web client is shown in Figure 1-1. To convert a SCREEN COBOL object program to a web client, you invoke the Pathway/iTS converter utility through the CONVERT command in the SCREEN COBOL Utility Program (SCUP). The converter scans the compiled SCREEN COBOL object code and generates an equivalent web client. Figure 1-1. Development of a Pathway/iTS Web Client TM Compaq NonStop System SCREEN COBOL SCREEN COBOL Source Compiler SCREEN Symbol COBOL Directory Table Object Code SCUP Utility Standard Web Java HTML optional Publishing Source Pages with Tools Code JavaScript Web Server VST001.vsd The web client consists of a combination of Java code and HTML pages. Requester- based business logic is converted to Java classes. Screen components are converted to HTML pages with embedded JavaScript code to link them to the Java business logic. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 1 -2
  • Introduction to Pathway/iTS Web Clients Run-Time Environment for Web Clients Optionally, before deployment you can customize the converted HTML pages by using standard web publishing tools. Run-Time Environment for Web Clients The run-time environment for a Pathway/iTS web client is shown in Figure 1-2. Figure 1-2. Run-Time Environment for a Pathway/iTS Web Client Java Import Package Residing on Browser-Based Web Client Internet Proxy Proxy Compaq NonStopTM System Router Gateway Threads TCP Pathway Server Class VST002.vsd Java Import Package Pathway/iTS provides a Java import package used by the converted web clients. This package consists of classes that enable Java-based clients to interact with Pathway applications. The Java import package includes public classes in these categories: • Host connectivity (gateway) classes, which define the connectivity protocol with the host HP NonStop system and also delegate certain host processing on behalf of the clients. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 1 -3
  • Introduction to Pathway/iTS Web Clients Router Process • HTML screen interaction classes, which define the attributes and structures associated with SCREEN COBOL screen fields and the SCREEN COBOL statements associated with displaying and accepting screens. • Data-type classes, which define the storage and casting rules associated with SCREEN COBOL alphanumeric (PIC X), numeric integer (PIC 9), and numeric non-integer (PIC 9P and PIC 9V) data types. • The Transform class, which provides methods to implement the SCREEN COBOL TRANSFORM statement • The Program Unit class, which provides methods for setting attributes for a program unit—for example, the currency symbol and the decimal-point character • Special-register classes, which define the Java equivalents of the SCREEN COBOL special registers • Exception classes, which provide handling for SCREEN COBOL exceptions • User conversion classes, which define the Java equivalent of the standard user conversion routines in PATHTCPL The classes and methods in the Java import package are described in detail in Section 6, Java Import Package Reference. Note. Although the Pathway/iTS router processes, described in the following subsection, support both HTTP and raw sockets protocols, the Java import package requires the use of the HTTP protocol. Router Process The Java client, working with a standard web browser, communicates with existing Pathway servers by sending connection requests to a Pathway/iTS router process residing on a NonStop system. The router processes listen and distribute connection requests for servicing. Each router process is configured with a TCP/IP port used to associate an application with connection requests. The router processes support converted web clients that use the HTTP or the raw sockets protocol and user-written intelligent device support (IDS) requesters that use the raw sockets protocol. The router processes distribute connection requests from web clients or intelligent devices to started TERM objects within the TCPs in such a way that the connection load is optimally balanced among all the TCPs in the Pathway environment. When all the TERM objects in all the configured TCPs are in use, the router queues new connection requests until a TERM object is available. The router also queues the TERM objects that are ready for a connection until a connection request arrives. Terminal Control Process (TCP) In support of web clients, the TCPs perform link management and line handling, as they do for SCREEN COBOL terminal requesters. Within a TCP, each TERM object HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 1 -4
  • Introduction to Pathway/iTS Web Clients Gateway Threads that handles a web client is configured with its FILE attribute pointing to a router process. Each such TERM object sends a message to the router process indicating that it is available to service a connection. When a client requests a connection, the request is sent to the router and the router passes the client information to the TCP. The TCP then establishes a socket connection to the client, verifies access rights, and passes control to the gateway thread. The combination of the router and TCP processes provides general load balancing for gateway threads. TERM objects within multiple TCP processes are associated with a given router process. This enables the router process to identify the gateway thread that will process the connection request. Multiple routers can thus be used to support more than one gateway application. Gateway Threads The run-time web gateway is implemented as a Pathway/iTS intelligent device support (IDS) requester running on the NonStop system under control of the TCP. This requester program is provided as part of Pathway/iTS. It handles requests from the browser-based web client, treating the client as an intelligent device. The gateway validates user access and performs certain functions on behalf of the client including beginning and ending transactions, user conversion routines, and send operations to Pathway server processes. Client communications with the Pathway/iTS web gateway can use the standard HTTP protocol to allow optional use of Internet proxy servers. Alternatively, for intranet applications, a client can use the raw sockets protocol. The protocol is specified by the system manager when starting the router process. Pathway/iTS 1.1 PATHTCP4, the TCP component uses SERVERCLASS_SEND_* APIs to process the existing SEND verb for SCOBOL requesters and converted Java clients. The features are: • PATHTCP4 does not communicate with either owner or external PATHMON process for link management activities. Instead of performing Guardian WRITEREAD on Pathway server processes to communicate with them, PATHTCP4 becomes a Pathsend requester and uses Pathsend APIs to communicate with Pathway servers. Therefore, any existing Pathway/iTS 1.0 application can be used with Pathway/iTS 1.1 with minimal changes to the applications. • PATHTCP4 provides four SCOBOL verbs, DIALOG-ABORT, DIALOG-BEGIN, DIALOG-END, and DIALOG-SEND to enable SCOBOL requesters and converted Java clients to establish context-sensitive communication with Pathway servers. The context-sensitive communication allows SCOBOL requesters and converted Java clients to send more than 32,000 bytes of data to the same Pathway server process. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 1 -5
  • Introduction to Pathway/iTS Web Clients Pathway/iTS 1.1 The SCUP and Web client components of Pathway/iTS 1.1 product are changed to support these functionalities. For compatibility reasons, Pathway/iTS 1.1 package includes PATHTCP3, the legacy TCP component. For more information, see Section 7, Introduction to Pathway/iTS 1.1. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 1 -6
  • 2 How to Compile, Build, and Maintain a Pathway/iTS Web Client This section describes the steps you need to take to convert a SCREEN COBOL program into a Pathway/iTS web client and to compile, build, deploy, and maintain the resulting web client. The steps are: 1. Prepare the SCREEN COBOL Object File 2. Create a Configuration File 3. Run the Converter 4. Modify Java or SCREEN COBOL Code as Needed 5. Run PROFDBM to Set Up the User Profile Database 6. Build the Converted Client 7. Deploy the Web Client 8. Customize the Screens 9. Specify the Port Number of the Router Process 10. Configure Pathway Servers for User Profiles and User Conversion Routines 11. Tune the Application for Performance by Changing the Session-Length Parameter 12. Maintain the Client For each step, a generic description of the step is followed by an example that refers to a sample SCREEN COBOL application. The sample application used in this section consists of four program units: LOG1, LOG2, INV1, and INV2. Program units LOG1 and LOG2 are located in the program file LGINCOD and program units INV1 and INV2 are located in the program file INVYCOD. Program units LOG1 and LOG2 perform the login and user authentication functions for the application. If the login is successful, the program unit INV1 is called, which in turn calls INV2 to begin process user requests. The initial program unit for this sample application (as specified in the INITPROG parameter) is LOG1. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 2 -1
  • How to Compile, Build, and Maintain a Pathway/iTS 1. Prepare the SCREEN COBOL Object File Web Client 1. Prepare the SCREEN COBOL Object File Before you run the converter, organize the SCREEN COBOL object (POBJ) file so that repeated conversions can be done easily. First, copy the SCREEN COBOL object file to be converted to the desired volume and subvolume. If the SCREEN COBOL object program has its symbols stripped, rebuild the object file with symbols. The converter uses the symbols when creating equivalent Java variable names. The equivalent symbolic names the converter creates when symbols are available help make the converted code readable and maintainable. If the converter cannot locate symbols, it generates an error and does not convert that program unit. For each application, verify that all the program units that make up this application are in a single SCREEN COBOL object file, including the program that is specified in the INITPROG parameter. Doing this enables you to convert the entire application in a single invocation of the converter. In addition, this organization of the SCREEN COBOL object code makes it easier to regenerate the Java and HTML files when you do future enhancements in SCREEN COBOL. In the sample application, you would move the program units LOG1, LOG2, INV1, and INV2 into a single SCREEN COBOL object file. 2. Create a Configuration File Create a configuration file to contain the default values the converter will use. By creating a configuration file, you can avoid having to repeatedly specify frequently used values. In addition, because the default compile (build) environment is the HP NonStop™ Kernel operating system OSS, you must specify a configuration file if your compile environment is the Microsoft® Windows NT® operating system. Example 2-1 shows a sample configuration file called mycfg. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 2 -2
  • How to Compile, Build, and Maintain a Pathway/iTS 3. Run the Converter Web Client Example 2-1. Sample Configuration File for mycfg [Screen Section] Background = mylogo.gif; Foreground = Black; Font Type = Courier; Font Size = 12; [Convert Environment] Java Location = system.$java.appa; HTML Location = system.$html.appa; [Compile Environment] OS = NSK; [Deployment Environment] Web Root = /usr/webserver/root; [Limits Section] To provide a common look and feel for all the web pages, the example provides default values for background color, foreground color, font type, and font size. For the background parameter, you could choose a color or a .gif file that contains the company logo. Specifying default locations for Java and HTML files in the Convert Environment section allows you to save the converted files in a well-known location. Details about the converter configuration file are given in the description of the CONVERT command in the Pathway/iTS SCUP Reference Manual. 3. Run the Converter Next, convert the SCREEN COBOL files to a web client. You invoke the converter by bringing up the SCREEN COBOL Utility Program (SCUP) from a HP Tandem Advanced Command Language (TACL) prompt: TACL> SCUP SCUP displays its starting banner followed by a question-mark prompt. Optionally, you can redirect the output of the SCUP program to a file by using the OUT command or by specifying the OUT option while invoking the SCUP program. If OUT is specified, messages from the converter will be redirected to that file. At the question-mark prompt, you enter the SCUP CONVERT command, which is described in detail in the Pathway/iTS SCUP Reference Manual. For the sample application, you could enter this CONVERT command: ?CONVERT invy (*(1)), INITPROG LOG1, CONFIGFILE mycfg, & APPNAME inventory HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 2 -3
  • How to Compile, Build, and Maintain a Pathway/iTS 4. Modify Java or SCREEN COBOL Code as Web Client Needed This command converts version 1 of all the program units in the Inventory application (stored in invy* object files) and generates the equivalent Java source and HTML files. The converted files are created in the subvolumes specified in the configuration file mycfg. The look and feel of the generated HTML files are based on the values specified in the Screen Section of the configuration file. Because all the program units are already in the INVYCOD program file, the converter does not generate a warning message. If the converter encounters any error or warning conditions, messages are displayed on the SCUP terminal (or if the OUT command or option was specified, written to the specified OUT file). For the user's convenience, a conversion summary is displayed after each individual Program Unit is converted and at the end of CONVERT command. Detailed syntax for the CONVERT command, the CONVERT summary, and message text, cause, effect, and recovery information for all converter error messages are provided in the Pathway/iTS SCUP Reference Manual. 4. Modify Java or SCREEN COBOL Code as Needed When you run the converter, it returns error or warning messages if it finds any problems or any unsupported SCREEN COBOL statements. In such cases, comments or error messages may also appear in the resulting Java code. If unsupported statement error messages are returned, you must do one of these: • Analyze the impact of the unsupported statement and replace it with appropriate Java code. • Modify the SCREEN COBOL source code by removing the unsupported SCOBOL statement and then run the converter again. For detailed information about the error and warning messages that can be returned by the converter, see the Pathway/iTS SCUP Reference Manual. Also, if you plan to use the user profile feature described in Section 3, Logon Security and User Profiles, you must add Java code to the converted code to check the user profile field in the logon screen and then use the information in the USERPROF user profile data base to take appropriate action in accordance with the needs of your application. 5. Run PROFDBM to Set Up the User Profile Database If you are using the user profile feature for web clients, you must set up the user profile database using the user profile database manager utility, PROFDBM. For detailed instructions, see Contents of the User Profile Database on page 3-2 and Use the PROFDBM Utility on page 3-5. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 2 -4
  • How to Compile, Build, and Maintain a Pathway/iTS 6. Build the Converted Client Web Client 6. Build the Converted Client You can build (compile) the converted client either on the NonStop system under the Open System Services (OSS) environment of the NonStop Kernel operating system or on another machine running the Windows NT operating system. Doing this involves three steps: 1. Set up the build environment 2. Transfer files to the build environment (if the build environment is Windows NT) 3. Build (compile) the application Set Up the Build Environment in an OSS Environment Pathway/iTS provides a TACL MACRO utility named JMAKENV, which is used to set up the build environment for the converted web client. This utility uses the MAP file that is created at the time of conversion to generate the build environment. The MAP file is created at the same location ($volume.subvolume) from which the CONVERT command was run. The MAP file name is composed of the first four or five SCOBOL object file characters plus the characters MAP. For example, if the SCOBOL objects are named MYAPPCOD, MYAPPDIR, and MYAPPSYM, then the MAP file name is MYAPPMAP. If the build environment is on a NonStop system under the OSS environment, JMAKENV creates the application home directory under OSS, copies the converted files to this directory and creates a make file for building and deploying the application. You must set the CLASSPATH variable to point to the itsjlib.jar file (the Java import package) and to the current directory. export CLASSPATH=/usr/tandem/Pathway-iTS/itsjlib.jar:$CLASSPATH The itsjlib.jar file must be available on the local machine. If it is not available, copy the file from the installation CD. Set other environment variables for Java compilation: for example: • Add /usr/tandem/java/bin to $PATH • Add /usr/tandem/java/lib/classes.zip to $CLASSPATH • Add /usr/tandem/java/lib/tandemvm.zip to $CLASSPATH From the TACL prompt on a NonStop system, run JMAKENV as: RUN JMAKENV file-name application-home makefile-name file-name is the name of the SCREEN COBOL object-file (the POBJ file). HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 2 -5
  • How to Compile, Build, and Maintain a Pathway/iTS Set Up the Build Environment in a Windows Web Client Environment application-home is the full path name of the OSS directory from which the application will be run. makefile-name is the name of the make file to be created that is used when building and running the application int he OSS environment. JMAKENV does these: • Creates a directory named application-home/build. • Creates a directory named application-home/bin where the built objects will be stored. • Copies all the appropriate files from the Java and HTML location (specified at the time of the conversion) to the application-home/build directory. The files are copied with the appropriate .java and .html extensions. • Creates a make file for building the application. The name of the make file is specified in the JMAKENV command and is copied to the application- home/build directory as make-file.mk. • Sets up the environment variables used by the make file. Note. The user running JMAKENV must have permission to create and copy files to the application-home directory in the OSS environment. For example, you would run the JMAKENV file for the sample application as: TACL> JMAKENV invy /usr/test/inventory invymk JMAKENV in the sample application does these: • Creates the directory /usr/test/inventory/build. • Creates the directory /usr/test/inventory/bin where the built objects will be stored. • Copies all the necessary files from the specified Java and HTML location (in this example, the volumes default to the same volume and subvolume as mycfg) to the NonStop Kernel OSS directory /usr/test/inventory/build. • Creates a make file named invymk for building the application. • Sets up the environment variables used by invymk. • Copies invymk to the directory /usr/test/inventory/build as invymk.mk. Set Up the Build Environment in a Windows Environment Pathway/iTS provides a TACL MACRO utility named JMAKENV, which is used to set up the build environment for the converted web client. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 2 -6
  • How to Compile, Build, and Maintain a Pathway/iTS Set Up the Build Environment in a Windows Web Client Environment This utility uses the MAP file that is created at the time of conversion to generate the build environment. The MAP file is created at the same location ($volume.subvolume) from which the CONVERT command was run. The MAP file name is composed of the first four or five SCOBOL object file characters plus the characters MAP. For example, if the SCOBOL objects are named MYAPPCOD, MYAPPDIR, and MYAPPSYM, then the MAP file name is MYAPPMAP. If the build environment is on a Windows NT server, JMAKENV creates two batch files to move the converted files to the desired environment and copy the Java class and HTML files to a directory under OSS for deployment. From the TACL prompt on a NonStop, run JMAKENV as: RUN JMAKENV file-name NT file-name is the name of the SCREEN COBOL object-file. JMAKENV does this when run with the NT option: Creates two batch files (JGETFILE and JPUTFILE) in the same location from which JMAKENV was run. JGETFILE includes FTP commands to move files from the OSS environment to the Windows NT platform. JPUTFILE includes FTP commands to move files from a Windows NT environment to the OSS deployment directory. For example, you would run the JMAKENV file for the sample application as: TACL> JMAKENV invy NT JMAKENV in the sample application does these: Creates the JGETFILE and JPUTFILE files in the same location from which JMAKENV was run. To move the generated Java and HTML files from a NonStop to a Windows environment, run JGETFILE from the Windows environment. To move the JGETFILE file onto a Windows environment, use these steps: 1. At the Windows DOS prompt, execute the command ftp host-address where host-address is the IP address of the NonStop where the Java and HTML files are generated. 2. At the FTP prompt: • Logon to the system. • Set the remote directory to the location where JGETFILE is located. • Set the local directory to location where JGETFILE is to be transferred. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 2 -7
  • How to Compile, Build, and Maintain a Pathway/iTS Build (Compile) the Application in an OSS Web Client Environment • Set the transfer mode to ASCII . 3. Transfer JGETFILE then exit the FTP session using the commands ftp> ASCII ftp> get JGETFILE JGETFILE.BAT ftp> bye 4. When JGETFILE.BAT is copied to the Windows NT environment, copy the generated Java and HTML files using the command JGETFILE host-name user-ID password host-name is the IP address or name of the NonStop containing the generated Java and HTML files. user-ID is a valid userid on the NonStop server. The userid must have the authority to read Java and HTML files. password is the password for the userid. This command copies the Java and HTML files to the local directory from where this batch file was run and automatically assigns the appropriate names to the files. After all the files have been transferred, build the application. Build (Compile) the Application in an OSS Environment The JMAKENV utility you run to set up the build environment generates the make file that you use to build the converted application code. To build the converted application, you invoke the make file with this command: make -f makefile-name all To clean up the build environment (that is, to delete any previously built components), you invoke the make file with this command: make -f makefile-name clean For example, you could build the sample application by running the make file from the OSS environment by using a command sequence such as: TACL> OSS % cd /usr/test/inventory % make -f invymk.mk all This is an example of a make file generated by JMAKENV: BUILDHOME = $(APPHOME)build CLASSPATH = $(APPHOME);$(CLASSPATH) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 2 -8
  • How to Compile, Build, and Maintain a Pathway/iTS Build (Compile) the Application in a Windows Web Client Environment OUTDIR = $(APPHOME)bin WEBROOT = /usr/tandem/webserver/root JAVAC = Javac -d $(OUTDIR) .SUFFIXES: .java.class PROGRAM_FILES = abc.java xyz.java main.java HTML_FILES = start.html Ctrl.html GIF_FILES = background.gif all: $(PROGRAM_FILES) clean: del /f/q $(BUILDHOME)*.class .java.class: $(JAVAC) -classpath $(CLASSPATH) $? publish: all html gif Build (Compile) the Application in a Windows Environment Once the Java files are transferred to a Windows environment, you can use the Java compiler available on the machine to compile the Java source. A typical Java compilation on a Windows environment is as: DOS> javac *.java 2> error.txt This compiles all Java files in the current directory and creates one or more class files. Compilation errors are stored in the error.txt file. 7. Deploy the Web Client You are now ready to deploy and test the converted application on the web server. Two parameters are needed for deployment: • The location (under the specified web root) where the files are to be published • The TCP/IP port number of the router process Deploy the Web Client on an OSS Environment Transfer the application files to the web server If you built the client on a Windows platform, you must first transfer the application files to the web server on the NonStop and then deploy the client. If you built the client on a NonStop, you can skip the file transfer step and deploy the client immediately. Use the make file to deploy it on the web server by issuing this command from the OSS prompt: make -f makefile-name DEPLOY = path-name publish HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 2 -9
  • How to Compile, Build, and Maintain a Pathway/iTS Deploy the Web Client on an OSS Environment Web Client makefile-name is the name of the make file generated by JMAKENV path-name is the relative pathname (under web-root) from which the web pages are served. To deploy the sample application, execute the make file with this command: make -f invymk.mk DEPLOY=testapp publish Executing this make file does these: • Copies all the HTML files from the /usr/test/inventory/bin directory to the usr/webserver/root/testapp directory, where /usr/webserver/root is obtained from the WEBROOT variable in the make file . • Copies all the compiled Java files from the /usr/test/inventory/bin directory to the /usr/webserver/root/testapp directory, where /usr/webserver/root is obtained from the WEBROOT variable in the make file. Move installation files to the web server Before running the application, you must move these files to the application directory on the web server (these files were created when Pathway/iTS was installed): ITSJLIB.jar, BPathwayiTS.js, OVPathwayiTS.js, and blank.html. Copy these files to the application directory in the root using these commands: cp /usr/tandem/Pathway-iTS/itsjlib.jar /usr/tandem/webserver/root/application-dir/itsjlib.jar cp /usr/tandem/Pathway-iTS/BPathwayiTS.js /usr/tandem/webserver/root/application-dir/BPathwayiTS.js cp /usr/tandem/Pathway-iTS/OVPathwayiTS.js /usr/tandem/webserver/root/application-dir/OVPathwayiTS.js cp /usr/tandem/Pathway-iTS/blank.html /usr/tandem/webserver/root/application-dir/blank.html In addition, HP recommends you also move the file end.html to the application directory on the server. This file is displayed when the application terminates and can be modified. Copy the file using this command: cp /usr/tandem/Pathway-iTS/end.html /usr/tandem/webserver/root/application-dir/end.html Test the converted application If the URL for the default page on the web server is http://intraweb.mycompany.com, you can now test the converted application by using this URL: http://intraweb.mycompany.com/testapp/INVENTORY_START.html HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 2- 10
  • How to Compile, Build, and Maintain a Pathway/iTS Deploy the Web Client on a Windows Environment Web Client Additional options available in the make file are as: • Publish only the HTML files from /usr/test/inventory/build -f invymk.mk DEPLOY=testapp html • Publish only the class files from /usr/test/inventory/bin -f invymk.mk DEPLOY=testapp class • Delete all the class files from /usr/test/inventory/bin -f invymk.mk clean • Compile all the Java source files and create the class files in /usr/test/inventory/bin -f invymk.mk all • Publish all the gif files (which must be in /usr/tandem/webserver/root) -f invymk.mk DEPLOY=testapp gif Deploy the Web Client on a Windows Environment To deploy the compiled Java class files and the HTML files from a Windows environment to an OSS directory under the webroot directory, run the JPUTFILE from the Windows environment. To get the JPUTFILE onto a Windows environment, use these steps: 1. From the Windows DOS prompt, execute the command: ftp host-address where host-address is the IP address of the NonStop Server where the Java and HTML files are generated 2. At the FTP prompt: • Logon to the system. • Set the remote directory to the location where JGETFILE is located; this the same directorywhere all the class files are generated and the HTML files are located • Set the transfer mode to ASCII . 3. Transfer JGETFILE then exit the FTP session using the commands ftp> ASCII ftp> get JPUTFILE JPUTFILE.BAT ftp> bye Once JPUTFILE.BAT is copied to a Windows environment, deploy the compiled Java files and HTML files using this command: JPUTFILE hostname user-ID password application-home HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 2- 11
  • How to Compile, Build, and Maintain a Pathway/iTS 8. Customize the Screens Web Client hostname is the IP address or name of the NonStop server where the application is to be deployed user-ID is the valid user ID on the NonStop server password is the password for the user ID. application-home is the full path name of the OSS directory where the application is to be deployed. This directory should be subdirectory to the root directory of the web server. If the URL for the default page on the web server is http://intraweb.mycompany.com, you can now test the converted application by using this URL: http://intraweb.mycompany.com/testapp/INVENTORY_START.html 8. Customize the Screens Copy the HTML Files to be Customized After you deploy the converted application, you can customize the HTML files. Because most of the standard HTML editors run on a Windows platform, you probably need to copy the HTML files from the deployment directory to some directory on Windows, as: 1. At the Windows DOS prompt, execute ftp host-address where host-address is the IP address of the NonStop server where the files are deployed. 2. Logon to the NonStop server then specify the remote OSS directory where the HTML files are deployed. Specify local directory to which the files will get copied. Set the transfer mode to ASCII. ftp > user x.y password ftp > cd /usr/webserver/root/testapp ftp > lcd c:htmledit ftp > ASCII 3. Use the get or mget command to get one or more HTML files. When the files are transferred, exit the ftp session. ftp > prompt off ftp > mget *.html ftp > bye HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 2- 12
  • How to Compile, Build, and Maintain a Pathway/iTS Modify the HTML Files Web Client Modify the HTML Files Using a standard web editor, open the HTML files, make any modifications, and save the file in the directory. You might also want to save the modified file in your source change control database for future use. Redeploy Customized HTML Files Once the pages are changed, they need to be deployed again. Use ftp to put the files back into a OSS deployment directory. 1. At the Windows DOS prompt, execute ftp host-address where host-address is the IP address of the NonStop server where the files are to be deployed. 2. Logon to the NonStop server then specify the remote OSS directory where the HTML files are deployed. Specify local directory to which the files will get copied. Set the transfer mode to ASCII. ftp > user x.y password ftp > cd /usr/webserver/root/testapp ftp > lcd c:htmledit ftp > ASCII 3. Use the get or mput command to put one or more HTML files. When the files are transferred, exit the ftp session. ftp > prompt off ftp > mput *.html ftp > bye 9. Specify the Port Number of the Router Process After you deploy the converted application on the web server, you must configure the converted Java applet to communicate with a router process running on the NonStop system. You do this by using the SETPORT utility, provided with the Pathway/iTS software, to specify an IP port number that matches the port number specified for the router process. Run the SETPORT utility on the NonStop system by issuing this command from the /usr/tandem/Pathway-iTS/ directory in the OSS environment: SETPORT port-num control-name HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 2- 13
  • How to Compile, Build, and Maintain a Pathway/iTS 10. Configure Pathway Servers for User Profiles and Web Client User Conversion Routines port-num is the TCP/IP port number assigned to this application. This number must match the port number specified when the router process was started, as described in the Pathway/iTS System Management Manual. control-name is either the program-id specified in the INITPROG parameter or the app-name specified in the APPNAME parameter when the application was converted with the SCUP CONVERT command that included the full OSS path. If both the INITPROG and the APPNAME parameters were specified in the CONVERT command, the app-name from the APPNAME parameter must be used for control-name. For example, in the sample application you could use this command: SETPORT 2500 /usr/tandem/webserver/root/deploy- directory/INVENTORY This command configures the converted Java application to send messages to the router started with port number 2500 on the host NonStop system. 10. Configure Pathway Servers for User Profiles and User Conversion Routines Whether an end user is required to enter a password or a user profile is controlled by the userAuthenticate and getProfile parameters in the control file that is generated by the CONVERT command. To use the user profile feature, set the getProfile parameter to true, as described in User Profile Options in the Control File on page 3-3, and configure the Pathway server class for the user profile server as detailed in Configure the User Profile Server Class on page 3-6. If your application uses user-written conversion routines running on the NonStop host, you must configure the Pathway server class for USER-LIB-SERVER as described in Configure the User Conversion Server Class on page 4-2. 11. Tune the Application for Performance by Changing the Session-Length Parameter The Java applet portion of the converted SCREEN COBOL application communicates with the TCP so that the required tasks can be performed on the NonStop host system. Such tasks include: • Send operations to server classes • Beginning, ending, and aborting transactions HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 2- 14
  • How to Compile, Build, and Maintain a Pathway/iTS 11. Tune the Application for Performance by Web Client Changing the Session-Length Parameter • Accept day/date/time operations • User conversion routines These tasks are delegated to the Pathway/iTS web gateway requester threads under the control of the TCP. Each task involves one complete socket communication cycle (a write and a read) or one I/O operation in a session. A session begins when the applet opens the communication channel with the host NonStop by establishing a socket connection with the TCP. The session ends when the connection is closed by the applet after the task delegated to the gateway thread is completed. While opening a session, the applet sends a connection request to the router process on the NonStop. The router process assigns the connection request to a waiting gateway thread associated with a TERM object. The gateway thread then establishes a socket connection with the applet. The router distributes client connection requests to the waiting gateway threads while balancing the load optimally among the TCP processes in the Pathway environment. The number of I/O operations in a session affects the performance of the application environment. For example, if this number is specified as 5, then the session with the client will be kept alive until 5 socket communication cycles are done. In other words, one gateway thread, with which the connection was established at the beginning of the session, will be dedicated to that client (applet) until it has performed 5 delegated tasks. After the 5 tasks are completed, the socket connection is broken, the session is closed, and the gateway thread is freed to service another connection request from an applet. There is one case where the specified number of I/O operations is ignored: the BT-ET block. After a begin-transaction operation, the session is kept alive, regardless of the specified number of I/O operations, until the end-transaction operation is done. After the end-transaction operation, the session is closed. The length of the session is important in view of the response times when several hundreds of applets are running. One gateway thread should not be tied to one client for a long duration. Neither should the length be too small, as each beginning of a session incurs a fixed overhead of time and resources. Pathway/iTS provides a default value for the number of I/O operations in a session. You can modify this value to tune the application for optimal performance. The value is specified in the sessionlength parameter in the file named app-name_CONTROL.html generated during the conversion process. The contents of this file are shown in Example. In this example, the INITPROG of the application is named LOGON, and the name of the control file is LOGON_CONTROL.html. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 2- 15
  • How to Compile, Build, and Maintain a Pathway/iTS 12. Maintain the Client Web Client Example 2-2. Sample CONTROL.html File <HTML> <HEAD> <META HTTP-EQUIV="Content-Type" content="text/html; charset=iso- 8859-1"> <TITLE> Control Frame </TITLE> <SCRIPT LANGUAGE="JavaScript"> </SCRIPT> </HEAD> <BODY> <applet code="LOGON_MAINAPP.class", name="PathwayiTS", archive="itsjlib.jar" width=10, height=10, MAYSCRIPT> <param name=portnumber value="2500"> <param name=sessionlength value="20"> <param name=userAuthenticate value="true"> <param name=getProfile value="true"> <param name=encoding value="8859_1"> </applet> </BODY> </HTML> To modify the number of I/O operations in a session, replace the param sessionlength default value (within the double quotes; 20 in the example) with the desired integer value. 12. Maintain the Client You can maintain the client by modifying either the SCREEN COBOL source files or the Java source files. If both terminal clients and web clients access the converted application, you might want to make future modifications in the SCREEN COBOL files to avoid maintaining two sets of source-code files. On the other hand, if all the clients accessing the application are web clients, modifying the Java source might be a better option. Modify SCREEN COBOL Source Code Enhancements and maintenance changes to the SCREEN COBOL source code fall into one of these categories: • Changes to business logic only • Changes to business logic and display • Changes to display section only Changes to Business Logic Only If only the business logic changes, all the corresponding changes to the web clients are in the Java code. In this case, to generate a newer version of the web client, do these: 1. Reconvert the SCREEN COBOL application. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 2- 16
  • How to Compile, Build, and Maintain a Pathway/iTS Modify Java Source Code Only Web Client 2. Build the converted application. 3. Discard the generated HTML files and copy the previously customized HTML files to the /usr/test/inventory/bin directory. 4. Deploy and test the application. Changes to Business Logic and Display If the business logic changes and also new display fields are added or existing fields are changed or removed, the corresponding changes for the web clients will be in both the Java code and the HTML files. To generate a newer version of the web clients, do these: • Reconvert the SCREEN COBOL application. • Build the converted application. • Customize the generated HTML files. • Deploy and test the application. This situation requires you to reapply the screen customizations that were done before the last deployment. If this kind of change occurs frequently, you might want to limit the amount of customization you do to the screens. Changes to Display Section Only In this scenario, no new fields are added or existing fields deleted. The changes are cosmetic and involve moving fields around or adding new or modifying existing literal text. To generate a newer version of the web clients, the only changes you need to make are to the HTML files. Modify the HTML files as described under 8. Customize the Screens and then deploy and test the modified application. Modify Java Source Code Only To enhance or maintain the Java source files, use your choice of commercially available Java development environments on a platform of your choosing, or use the NonStop Kernel environment. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 2- 17
  • How to Compile, Build, and Maintain a Pathway/iTS Modify Java Source Code Only Web Client HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 2- 18
  • 3 Logon Security and User Profiles This section describes the logon security and user profile features presented to the user whenever a Pathway/iTS web client is first started. It also describes how to set up the user profile database. Logon Security Whenever an end user opens the browser and goes to the URL for a Pathway/iTS web client application, a logon screen may be displayed, if required. This screen requires the user to enter a user name and password and a profile name. The user name and password must be a Guardian user name and password that is valid on the NonStop system where the Pathway/iTS software runs. Pathway/iTS validates the entered user name and password. If the validation fails, the logon screen reappears. This cycle continues until the user gives a valid user name and password combination. The user can get out of this loop by clicking Cancel on the logon screen. User Profiles The logon screen also provides a third field for the user to enter a user profile keyword, which typically identifies a user role such as admin. As the application programmer, you decide whether to use this feature, and if you use it, you customize it to the needs of your application. To set up your application for user profiles, you do these steps as part of the sequence described in Section 2, How to Compile, Build, and Maintain a Pathway/iTS Web Client: • Specify the userAuthenticate and getProfile parameters in the control file generated by the CONVERT command. • If you set the getProfile parameter to false, you do not need to complete the additional user profile configuration steps. • If you set the getProfile parameter to true, you must: • Use the PROFDBM utility to set special-register values for each user profile you want to define. • Add Java code to the applet to use the values of the special registers, in accordance with the needs of your application. • Configure the Pathway server that retrieves values from the user profile database. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 3 -1
  • Logon Security and User Profiles Actions of the Web Client Actions of the Web Client If the logon is successful (that is, if the end user enters a valid user name/password combination), the client application begins to run. However, before the browser displays the starting page of the client application, the application communicates with the host NonStop to retrieve information associated with the profile entered by the end user. This information resides in a database (with the Guardian file name USERPROF) on the NonStop. A Pathway server program supplied as part of Pathway/iTS reads the database and obtain the profile information on behalf of the application. The applet stores this information in various special registers for later use. Then the browser displays the starting page—that is, the HTML page corresponding to the INITIAL program unit in the SCREEN COBOL source program—and the client application continues to run. If the end user does not enter a profile (that is, if the entered profile is null), the user ID and password are validated, but no values are retrieved or set for any of the special registers. If the end user enters a valid profile, the profile is sent via the web gateway to the server. The server retrieves from the database and returns to the application the values of the seven special registers associated with user profiles (defined in the following subsection), and also returns values for the PW-TCP-PROCESS-NAME, PW-TCP-SYSTEM-NAME, and TERMINAL-FILENAME special registers. (All other SCREEN COBOL special registers have no meaning for web clients; these special registers always have default values in the converted Java code.) If the end user enters an invalid profile (one that is not in the user profile database), a “Profile Not Found” popup message appears. In this case, no values are returned to the application for the seven special registers associated with user profiles, but values are returned for the other three special registers. Contents of the User Profile Database The USERPROF database is a key-sequenced database with the profile name as the key. Each record of the user profile database consists of the key and seven fields; the values of the seven fields are stored in corresponding special registers in the Java applet. The fields are as: Corresponding Special Field Name Type and Length Register in Applet TERMINAL-PRINTER PIC X(36) TerminalPrinter LOGICAL-TERMINAL-NAME PIC X(16) logicalTerminalName USER-PROFILE-1 PIC X(36) userProfile1 USER-PROFILE-2 PIC X(36) userProfile2 USER-PROFILE-3 PIC X(36) userProfile3 USER-PROFILE-4 PIC X(36) userProfile4 USER-PROFILE-5 PIC X(36) userProfile5 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 3 -2
  • Logon Security and User Profiles User Profile Options in the Control File The TERMINAL-PRINTER and LOGICAL-TERMINAL-NAME fields correspond to the SCREEN COBOL special registers of the same names. The five USER-PROFILE-n fields are new special registers in the applet; these fields have no corresponding special registers in SCREEN COBOL programs. Java definitions of the special registers are given under Special-Register Classes on page 6-120. After the applet has received the values of these special registers from the NonStop host, the applet uses the values during execution, just as a SCREEN COBOL requester does. User Profile Options in the Control File Whether an end user is required to enter a password or a user profile is controlled by the userAuthenticate and getProfile parameters in the control file that is generated by the CONVERT command. The encoding parameter specifies which byte-to-string conversion scheme the applet should use. The control file is named appname_CONTROL.html or initprog_CONTROL.html and contains these: <HTML> <HEAD> <META HTTP-EQUIV="Content-Type" content="text/html; charset=iso-8859-1"> <TITLE> Control Frame </TITLE> <SCRIPT LANGUAGE="JavaScript"> </SCRIPT> </HEAD> <BODY> <applet code="APPNAME_MAINAPP.class", name="PathwayiTS", archive="itsjlib.jar", width=10, height=10, MAYSCRIPT > <param name=portnumber value="PORT_NUMBER" > <param name=sessionlength value="20" > <param name=userAuthenticate value="true" > <param name=getProfile value="true" > <param name=encoding value="8859_1" > </applet> </BODY> </HTML> HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 3 -3
  • Logon Security and User Profiles User Profile Options in the Control File Parameter Values Description userAuthenticate=true Specifies that the user must enter a valid Guardian user getProfile = true name, password, and the profile name. The user is authenticated and the profile data from the profile server is retrieved. In addition to the values of the registers in the profile database, values for the PW-TCP-PROCES-SNAME, PW-TCP-SYSTEM-NAME, and TERMINAL-FILENAME special registers are also retrieved from the GATEWAY TERM object. userAuthenticate=true Specifies that the user must enter a valid Guardian user getProfile = false name and password only. The user is authenticated and the values for the PW-TCP-PROCESS-NAME, PW-TCP- SYSTEM-NAME, and TERMINAL-FILENAME special registers are retrieved from the GATEWAY TERM object. The registers of the profile database are set to spaces. userAuthenticate Specifies that the user must enter a valid profile name only. =false No authentication is performed. The values of the registers getProfile = true in the profile database, and the values for the PW-TCP- PROCESS-NAME, PW-TCP-SYSTEM-NAME, and TERMINAL-FILENAME special registers are retrieved from the GATEWAY TERM object. userAuthenticate Specifies that no logon screen is displayed. When the user =false opens the browser and goes to the URL for the Pathway/iTS getProfile = false web application, the application's first screen loads in the browser. However, before the first screen loads, the values for the PW-TCP-PROCES-SNAME, PW-TCP-SYSTEM- NAME, and TERMINAL-FILENAME special registers are retrieved from the GATEWAY TERM object, and the registers of the profile database are set to spaces. encoding Specifies which encoding scheme the applet is to use when converting the byte-format data it receives from the host to a string format; valid for single-byte character sets only. The default value is 8859_1, which supports applications using the US ASCII character set. To support applications that use a European character-set, you must specify the appropriate encoding scheme. To specify the encoding scheme for applications that use a Japanese double-byte Kanji-Katakana character set, use the CHARSET SJIS parameter in the CONVERT command instead of the encoding parameter in the user profile. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 3 -4
  • Logon Security and User Profiles Use the PROFDBM Utility Use the PROFDBM Utility The user profile database manager (PROFDBM) utility allows you to add, update, search for, and delete records in the USERPROF database. Before using PROFDBM, create the database as: TACL> FUP CREATE USERPROF, TYPE K, REC 248, KEYLEN 16 Note. You must use the name USERPROF for this database; do not use any other name. Then run USERPROF from the TACL prompt: TACL> RUN PROFDBM The starting banner for the user profile database manager appears and prompts you to enter a number corresponding to the action you want to take. Add a Record To add a record to the database: 1. Enter the number 1. 2. When prompted, enter the user profile name and press ENTER. This is the name (maximum 16 characters) that the end user will enter in the logon screen. 3. Then, as prompted, enter the desired special-register values, starting with the value for TERMINAL-PRINTER (“user printer name”). Press ENTER to enter each value and go on to the next one. To enter a null value, just press ENTER. 4. After you have entered all values, “1 RECORD ADDED” will be displayed, and PROFDBM prompts you to select another command. Update a Record To update one or more values in an existing record in the database: 1. Enter the number 2. 2. When prompted, enter the user profile name for the record and press ENTER. 3. PROFDBM displays the current value of the first special register and then prompts you to enter a new value. To change the value, enter the desired new value and then press ENTER. To leave that value the same and go to the next value, just press ENTER. Proceed the same way with the other special registers. 4. After you have entered all values, “1 RECORD UPDATED” is displayed, and PROFDBM prompts you to select another command. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 3 -5
  • Logon Security and User Profiles Configure the User Profile Server Class Search for a Record To search for an existing record in the database: 1. Enter the number 3. 2. When prompted, enter the user profile name for the record and press ENTER. 3. PROFDBM displays the current values of all the special registers in that record. A blank after the equals sign for a register indicates a null value. 4. After the values are displayed, PROFDBM prompts you to select another command. Delete a Record To delete a record from the database: 1. Enter the number 4. 2. When prompted, enter the user profile name for the record and press ENTER. 3. “1 RECORD DELETED” is displayed, and PROFDBM prompts you to select another command. Exit the PROFDBM Utility To exit and return to the TACL prompt, enter any character other than 1, 2, 3, or 4. Configure the User Profile Server Class Pathway/iTS provides a Pathway server program for the server that retrieves values from the user profile database. To configure the server class for this server, add these lines to your Pathway/XM configuration source file or your PATHCOM configuration file: RESET SERVER SET SERVER AUTORESTART 0 SET SERVER DEBUG OFF SET SERVER HIGHPIN OFF SET SERVER LINKDEPTH 1 SET SERVER MAXSERVERS 5 SET SERVER NUMSTATIC 2 SET SERVER PRI 115 SET SERVER PROGRAM PROFSERV SET SERVER SECURITY "N" SET SERVER TMF ON SET SERVER VOLUME $vol.userprof-subvol ADD SERVER USR-PROF-SERVER Note. The name of the server class specified in the ADD SERVER command must be USR-PROF-SERVER. User profiles will be retrieved correctly only if this name is used. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 3 -6
  • Logon Security and User Profiles Configure the User Profile Server Class Note. For performance tuning in large applications, you might want to change some of the specified configuration values later. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 3 -7
  • Logon Security and User Profiles Configure the User Profile Server Class HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 3 -8
  • 4 User-Written User Conversion Procedures for Web Clients If the SCREEN COBOL application you are converting to a web client includes USER CONVERSION clauses and user-written user conversion procedures, Pathway/iTS supports your existing pTAL user conversion routines running on a NonStop. User conversion procedures used with web clients are bound to a special user conversion server class called USER-LIB-SERVER. This server class is then configured to run in the Pathway environment. When user conversion is needed, the converted Java code sends a message to the USER-LIB-SERVER server class, and the appropriate user conversion procedure services the request. The server then sends its the reply to the browser. Because the USER CONVERSION clause is associated with each screen field item, multiple messages to the USER-LIB-SERVER server class would ordinarily be needed if the screen has multiple screen fields with a USER CONVERSION clause specified. Pathway/iTS optimizes the number of messages sent to USER-LIB-SERVER by collecting all user conversion information in a given screen and sending the message once to USER-LIB-SERVER. If a SCREEN COBOL field has a USER CONVERSION clause specified, the ScreenField class in the converted code will have the user conversion attribute set. Whenever the converted Java application needs to communicate with the NonStop (for example, to perform an accept or server-class send operation), the Gateway class packages the information for all the fields needing user conversion and sends one message to USER-LIB-SERVER to perform the user conversion. To use your existing user conversion procedures on the NonStop, you perform two steps: • Build your existing user conversion library by binding it with the special user conversion server class • Configure the user conversion server class This section explains only what you need to do to use existing user conversion routines that are installed and running correctly. For information on maintaining or modifying your existing user conversion routines, see the Pathway/iTS TCP and Terminal Programming Guide. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 4 -1
  • User-Written User Conversion Procedures for Web Build Your User Conversion Library Clients Build Your User Conversion Library Assuming that the appropriate SLIB, ILIB, and TLIB files are in place and your user conversion object file has been compiled without errors, build the user conversion library, binding it to the USER-LIB-SERVER server class, by invoking the nld utility from the TACL prompt as: NLD user-conversion-object $volume.ZPITS.SCUSERO -SET RUNNAMED ON -O scmyuser user-conversion-object is the pTAL object file for your user conversion library. $volume is the volume where the installation subvolume ZPATHWAY resides. SCUSERO is the skeleton server-class object file provided by Pathway/iTS for use with the USER-LIB-SERVER server class. scmyuser is the name to be used for the final server-class program file. You will use this name in the SET SERVER PROGRAM attribute when you configure the server class. For example, the folowing command binds the user conversion object file MYCONV with the skeleton object file SCUSERO to generate a program object file named SCUSRCNV for the special server class: TACL> NLD MYCONV $volume.ZPITS.SCUSERO -SET RUNNAMED ON -O SCUSRCNV Configure the User Conversion Server Class To configure the USER-LIB-SERVER server class, add these lines to your Pathway/XM configuration source file or your PATHCOM configuration file: RESET SERVER SET SERVER AUTORESTART 0 SET SERVER DEBUG OFF SET SERVER HIGHPIN OFF SET SERVER LINKDEPTH 1 SET SERVER MAXSERVERS 5 SET SERVER NUMSTATIC 2 SET SERVER PRI 115 SET SERVER PROGRAM scmyuser SET SERVER SECURITY "N" HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 4 -2
  • User-Written User Conversion Procedures for Web Configure the User Conversion Server Class Clients SET SERVER TMF ON ADD SERVER USER-LIB-SERVER where scmyuser is the program file name you specified when you built your user conversion library. If you are using a PATHCOM configuration file, also include this command in the list of SET SERVER commands: SET SERVER PROCESSTYPE GUARDIAN Note. The name of the server class specified in the ADD SERVER command must be USER-LIB-SERVER. The converted code will work correctly only if this name is used. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 4 -3
  • User-Written User Conversion Procedures for Web Configure the User Conversion Server Class Clients HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 4 -4
  • 5 SCREEN COBOL-to-Web Conversion Mappings This section describes the structure and content of a Pathway/iTS Web client as generated by the converter invoked by the SCUP CONVERT command. It also describes how the elements of the SCREEN COBOL program map into the corresponding elements of the client Java and HTML code. The information in this section can be useful to you if you are modifying portions of the Java or HTML code after conversion. The converter generates a Web client from a SCREEN COBOL application (a set of program units within a SCREEN COBOL object file) as: • The Working-Storage Section and Procedure Division components are converted to Java classes, which call and include the necessary classes from the Pathway/iTS Java import package. • The Screen Section, Screen Description entry, and other screen components are converted to HTML pages. • The HTML pages include embedded JavaScript code to link them to the Java code. This section includes these topics: Components of the Web Client Main Java Applet Starting Page Initial Page Control Page Java Classes for the Program Units User HTML Pages for the Screen Sections Conversion Mappings Mappings to Java Classes Mappings to User HTML Pages HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 5 -1
  • SCREEN COBOL-to-Web Conversion Mappings Components of the Web Client Components of the Web Client For each SCREEN COBOL application, the converter generates these Java classes and HTML files: • Main Java applet • Starting page • Initial page • Control page • Java classes for the program units • User HTML pages for the Screen Sections Main Java Applet The main applet is contained in a file named initprog_MAINAPP.java, where initprog is the Program Unit name specified in the INITPROG parameter of the CONVERT command. If the APPNAME parameter is specified in the CONVERT command, then the file name has the format appname.java. The main applet contains the generic applet code, which acts as a container for individual program unit classes. It starts an execution thread for the program units and retains the context across program units during CALL processing. It also provides methods to be called from HTML pages on completion of HTML events. Starting Page The starting page is an HTML page. This is the first application component to be loaded by the client’s browser. This page defines a START button. When the user clicks the START button, a new browser window is created and the Initial page is loaded . The name of the HTML file is derived from the user-specified INITPROG or APPPNAME parameter followed by _START; hyphens in the user-specified parameter are replaced with underscores (_) in the generated name. For example, if the name of the INITIAL program unit is MY-SCOBOL-APP, the name of the generated starting page is MY_SCOBOL_APP_START.html. Initial Page The initial page is an HTML page. This is the second application component to be loaded by the client's browser. This page defines the frames on the browser window. The name of the HTML file is derived from the user-specified INITPROG or APPNAME parameter followed by _PAGE1; hyphens in the user-specified parameter are replaced with underscores (_) in the generated name. For example, if the name of the INITIAL program unit is MY-SCOBOL-APP, the name of the generated initial page is MY_SCOBOL_APP_PAGE1.html. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 5 -2
  • SCREEN COBOL-to-Web Conversion Mappings Control Page Control Page Each converted SCREEN COBOL application is managed through a control page. This HTML page is loaded into a control frame that is created by the starting page. The control page contains a MainApp applet. This page is not visible to the end user. It remains active throughout the execution of the application. The name of the control page is derived from the user-specified INITIAL program unit followed by _CONTROL. For example, if the name of the INITIAL program unit is MY- SCOBOL-APP, the name of the generated control page will be called MY_SCOBOL_APP_CONTROL.html. Java Classes for the Program Units For each program unit, the converter creates a Java class. The name of the Java file for the class is derived from the name of the program unit. The conversion mappings are described under Mappings to Java Classes later in this section. User HTML Pages for the Screen Sections The Screen Section of the SCREEN COBOL program is converted into a set of HTML pages. The conversion mappings are described under Mappings to User HTML Pages later in this section. Conversion Mappings This section describes how the various elements of a SCREEN COBOL program are converted to elements of Java classes or user HTML pages. Mappings to Java Classes For each program unit in the SCREEN COBOL program, the converter creates a Java class. The name of the Java file is derived from the name of the corresponding program unit. The conversion mapping is as: • The Working-Storage section is converted to Java classes. • Each paragraph in the program unit is converted to methods within the Java class. • Input-output elements in the Screen Section are converted to ScreenField objects in the Java class. The Java code files are generated at the location specified by the JAVAVOL parameter in the CONVERT command or at the Java location specified in the configuration file. Conversion of Working-Storage Section Each group-level item in the SCREEN COBOL program unit is represented as a nested class within the Java class. Each such nested class implements the necessary HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 5 -3
  • SCREEN COBOL-to-Web Conversion Mappings Mappings to Java Classes methods defined in the ScobolType base class in the Pathway/iTS Java import package, as described in Section 6, Java Import Package Reference. The name of the nested Java class is derived by prefixing the name of the group item with c_. Each data item in the Working-Storage Section is mapped to a Java object. Hyphens in the SCREEN COBOL names are replaced by underscores in the Java names. An instance of each elementary item is created by using the data-type objects provided in the Java import package. Example 5-1 shows a fragment of SCREEN COBOL Working-Storage code, and Example 5-2 illustrates the corresponding Java code. Example 5-1. SCREEN COBOL Working-Storage Code Fragment 01 WS-NAME. 05 FIRST-NAME PIC X (10). 05 LAST-NAME PIC X (20). Example 5-2. Java Code Resulting From Conversion of Working-Storage Code class c_WS_NAME extends ScobolType{ public PicX FIRST_NAME; PicX LAST_NAME; // Constructor of the group class public c_WS_NAME{ FIRST_NAME = new PicX (10); addScobolData(FIRST_NAME); LAST_NAME = new PicX (20); addScobolData(LAST_NAME); } // Implementation of other methods } c_WS_NAME WS_NAME; In Example 5-2, these conversion mappings occur: • The group item WS-NAME is converted to the class name c_WS_NAME. • The data items FIRST-NAME and LAST-NAME, of type PIC X (), are converted respectively to the Java objects FIRST_NAME and LAST_NAME, of type PicX. • The data items are instantiated in the constructor of c_WS_NAME and added to the ScobolGroupType class using addScobolData API. For details about the various library classes used, see Class PicX in Section 6, Java Import Package Reference. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 5 -4
  • SCREEN COBOL-to-Web Conversion Mappings Mappings to Java Classes Conversion of Paragraphs Each program unit class has a method named eXecute. This method provides the starting point for executing that class. Each paragraph in the SCREEN COBOL program is converted to a method in the Java code. The names of these methods are derived from the names of the corresponding paragraphs, with hyphens replaced by underscores. In addition to the methods created for each paragraph, the converter creates extra methods in the program unit class to perform tasks such as handling level-88 data items and handling parameter passing between calling and called program units. The names for these methods are generated internally by the converter. The converter generates one or more Java statements for each SCREEN COBOL statement. The converter uses the HTMLHandler class from the Pathway/iTS Java import package to manage the screen-related functions. Similarly, all SCREEN COBOL functions related to the NonStop Kernel, such as the BEGIN-TRANSACTION and SEND statements, are implemented by calling methods in the Gateway class in the Java import package. Example 5-3 shows a sample SCREEN COBOL paragraph, and Example 5-4 illustrates the corresponding Java code. Example 5-3. SCREEN COBOL Paragraph MAIN-PARA. PERFORM PROCESS-PARA. PROCESS-PARA. MOVE SPACES TO FIRST-NAME, LAST-NAME. DISPLAY BASE NAME-SCREEN. Example 5-4. Java Code Resulting From Conversion of SCREEN COBOL Paragraph public void eXecute () { PROCESS_PARA ("PROCESS-PARA"); } public void PROCESS_PARA (String ret_func) throws ScobolTxnException { FIRST_NAME.setSpaces(); LAST_NAME.setSpaces(); HTMLHandler.displayBase("TEST_SCRN0000.html", "SCRFORM", "UFrame", "Action"); } In Example 5-4, this conversion mappings occur: • The statement PERFORM PROCESS-PARA is converted to a call to the method PROCESS_PARA(). HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 5 -5
  • SCREEN COBOL-to-Web Conversion Mappings Mappings to Java Classes • In PROCESS-PARA, the MOVE SPACES statement is converted to calls to the setSpaces() methods in the FIRST_NAME and LAST_NAME data objects. • To display the NAME-SCREEN base screen, the converted code invokes the displayBase method in the HTMLHandler object, passing the name of the related HTML file. Conversion of Screen Fields Each input-output element used in the Screen Section of the SCREEN COBOL program is converted into a ScreenField object in the Java class. The name of this ScreenField object is derived by prefixing the name of the SCREEN COBOL data object with s_. The ScreenField objects in the Java classes are related to their corresponding HTML fields by means of this name attribute. The same name is used to set the name attribute in the corresponding field in the HTML pages. Example 5-5 shows a sample SCREEN COBOL input-output element that is related to a Working-Storage item. Example 5-6 illustrates the corresponding Java code. Example 5-5. SCREEN COBOL Input-Output Element 10 EMP-FIRST-NAME at 10, 20 PIC X(10) using FIRST-NAME. Example 5-6. Java Code Resulting From Conversion of SCREEN COBOL Input- Output Element s_FIRST_NAME = new ScreenField("s_FIRST_NAME", WS_NAME.FIRST_NAME, WS_NAME.FIRST_NAME 10, 20, “XXXXXXXXXX”); The name of the screen field object s_FIRST_NAME is obtained by prefixing with s_ the name of the FIRST_NAME data object that represents the Working-Storage item FIRST-NAME. Differences in Behavior Between SCREEN COBOL Statements and Their Java Implementations The SCREEN COBOL ACCEPT statement and its Java implementation have somewhat different behavior. In SCREEN COBOL, the displayed value of a screen- field item is not moved into the corresponding working-storage data item unless it has been modified by the user or unless the MDTON (Modified Data Tag On) attribute is specified for that screen-field item. However, in Java the displayed value of the screen-field item is always moved to the corresponding working-storage data item. But if the length of the screen-field value is zero, the corresponding working-storage data item remains unmodified. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 5 -6
  • SCREEN COBOL-to-Web Conversion Mappings Mappings to User HTML Pages For example, suppose that these declarations appear in the SCREEN COBOL source code: WORKING-STORAGE SECTION. 01 WS-ITEM1 PIC 9(4) VALUE 4444. 01 WS-ITEM2 PIC 9(4) VALUE 8888. SCREEN SECTION. ... 05 SCR-ITEM1 AT 10,10 PIC 9(4) FROM WS-ITEM1 TO WS-ITEM2. Then this statement will display 4444 on the screen: DISPLAY SCR-ITEM1. This statement will move a value to WS-ITEM2 only when it is changed on the screen: ACCEPT SCR-ITEM1 UNTIL F1. The value of WS-ITEM2 retains its initial value ( 8888) until SCR-ITEM1 is modified on the screen. However, in the Java implementation, the corresponding working-storage item is immediately modified with the displayed value. In the Java implementation of this example, WS-ITEM2 will contain the value 4444. Mappings to User HTML Pages The converter converts the Screen Section of the SCREEN COBOL program into a set of HTML pages. Each Base and Overlay screen gets converted into an HTML page. The overlay areas within the Base Screen get converted to IFRAME elements. Each HTML page has one HTML form, named SCRFORM. The names for the screen HTML pages are derived from the names of the program units. The screen files are generated at the location specified by the HTMLVOL parameter in the CONVERT command or at the HTML location specified in the configuration file. Screen fields that are part of the corresponding base and overlay screen are converted to HTML fields of INPUT TYPE. Each HTML field has Name, MaxLength, and Size attributes. The Name attributes associate each HTML field with one ScreenField object in the Java class. During the processing of Accept statements, you can click any of the function buttons that are displayed near the bottom of the browser window. When you finish interacting with the HTML page, click the desired function key button. The Termination Status is updated according to the button that you click. The HTML page also has two JavaScript functions, onLoadFunc and onOkBtnFunc. These functions are called, respectively, when the page is loaded in UFrame and when you click the OK button. Indirectly these functions call methods of the MainApp applet and resume the execution of the applet. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 5 -7
  • SCREEN COBOL-to-Web Conversion Mappings Mappings to User HTML Pages Example 5-7 shows a sample Screen Section in a SCREEN COBOL program. Example 5-7. SCREEN COBOL Screen Section 01 NAME-SCREEN BASE SIZE 24, 80. 05 FILLER AT 05, 10 VALUE "ENTER FIRST NAME". 05 EMP-FIRST-NAME AT 05, 30 PIC X(10) USING FIRST-NAME. 05 FILLER AT 10, 10 VALUE "ENTER LAST NAME". 05 EMP-LAST-NAME AT 10, 30 PIC X(30) USING LAST-NAME. 05 OV-AREA AREA AT 12, 10 SIZE 5, 50 Example 5-8 illustrates the corresponding HTML code. Example 5-8. HTML Code Resulting From Conversion of SCREEN COBOL Screen Section <HTML><HEAD><TITLE>Base screen for TESTPROGRAM </TITLE> <STYLE TYPE="text/css"> INPUT {font-family:Courier; font-size:12; color:BLACK; border-style:none; border-bottom-style:inset; } BODY {font-family:Courier; font-size:12; color:BLACK; } </STYLE> <SCRIPT TYPE="text/javascript" LANGUAGE="JavaScript" SRC="BPathwayiTS.js"> </SCRIPT> </HEAD> <BODY OnLoad= "onLoadFunc()" BGColor="WHITE" onContextMenu="return false"> <FORM NAME="SCRFORM"> <SPAN STYLE="position:absolute; top:98; left:87; ">ENTER FIRSTNAME</SPAN> <INPUT STYLE="position:absolute; top:98; left:267;" type="text" name="s_FIRST_NAME01" value = "" MAXLENGTH = "010" SIZE = "010" onFocus="saveFieldName('s_FIRST_NAME01')" > <SPAN STYLE="position:absolute; top:208; left:87; ">ENTER LASTNAME</SPAN> <INPUT STYLE="position:absolute; top:208; left:267;" type="text" name="s_LAST_NAME01" value = "" MAXLENGTH = "030" SIZE = "030" onFocus="saveFieldName('s_LAST_NAME01')" > <IFRAME STYLE="position:absolute; top:252; left:87;" id="OA0000" name="OA0000" width="450" height="110" marginWidth="0" frameborder="0" > </IFRAME> </FORM></BODY></HTML> HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 5 -8
  • 6 Java Import Package Reference This section defines the public classes and methods in the Pathway/iTS Java import package, pathway.its. This package enables Java-based clients to interact with Pathway applications. The Java import package includes public classes in these categories: Host Connectivity Classes Class Gateway on page 6-2 Class ServerReplyCode on page 6-11 HTML Screen Interaction Class ScreenFieldIdentifier on page 6-13 Classes Class ScreenField on page 6-13 Class ScreenFieldArray on page 6-22 Class ScreenFieldGroup on page 6-30 Class HTMLHandler on page 6-32 Class FunctionKey on page 6-43 Data-Type Classes Class ScobolType on page 6-44 Class ScobolGroupType on page 6-53 Class Pic9 on page 6-60 Class Pic9P on page 6-72 Class Pic9V on page 6-84 Class PicN on page 6-97 Class PicX on page 6-103 Transform Class Class Transform on page 6-113 ProgramUnit Class Class ProgramUnit on page 6-117 Special-Register Classes Class ScobolLib on page 6-120 Class Cursor on page 6-123 Exception Classes Class ExitProgramException on page 6-126 Class ScobolException on page 6-126 Class ScobolSendException on page 6-127 Class ScobolTxnException on page 6-128 Class StopRunException on page 6-129 Class TransformException on page 6-129 User Conversion Classes Class UserConversion on page 6-131 Class ScLibUserConversion on page 6-132 Descriptions of the methods for these classes identify the corresponding statements and data types in the SCREEN COBOL source program. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -1
  • Java Import Package Reference Host Connectivity Classes Host Connectivity Classes The host connectivity (gateway) classes define the connectivity protocol with the host NonStop and also delegate certain host processing on behalf of the clients. Class Gateway The Gateway class encapsulates the connectivity protocol with the host NonStop and also delegates certain host processing on behalf of the clients. Package pathway.its Syntax public pathway.its.Gateway Description This class has these responsibilities: • Handles communication with the host NonStop • Forwards (delegates) certain processing tasks to the host Examples of delegated tasks are server-class send operations and transaction management (begin transaction, end transaction, and abort transaction). Member Summary Constructor Gateway() HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -2
  • Java Import Package Reference Class Gateway Delegation Methods abortTransaction() Aborts the current transaction on the NonStop; equivalent to the SCREEN COBOL ABORT- TRANSACTION statement. acceptDate() Gets the NonStop date; equivalent to the SCREEN COBOL ACCEPT DATE statement. acceptDay() Gets the NonStop Julian day; equivalent to the SCREEN COBOL ACCEPT DAY statement. acceptTime() Gets the NonStop time; equivalent to the SCREEN COBOL ACCEPT TIME statement. beginTransaction() Initiates a transaction on the NonStop; equivalent to the SCREEN COBOL BEGIN-TRANSACTION statement. dialogAbort() Aborts the current dialog in the terminal; equivalent to the SCREEN COBOL DIALOG-ABORT statement. dialogBegin() Does a server-class dialog begin operation; equivalent to the SCREEN COBOL DIALOG-BEGIN statement. dialogEnd() Ends the current dialog in the terminal after the server ends it; equivalent to the SCREEN COBOL DIALOG-END statement. dialogSend() Does a server-class dialog send operation; equivalent to the SCREEN COBOL DIALOG-SEND statement. endTransaction() Ends the current transaction on the NonStop; equivalent to the SCREEN COBOL END-TRANSACTION statement. send() Does a server-class send operation; equivalent to the SCREEN COBOL SEND statement. Method Constructor Syntax public Gateway (String address, int port) Description Constructor for the Gateway class. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -3
  • Java Import Package Reference Class Gateway Parameters hostAddress The TCP/IP host name for the NonStop (the n.n.n.n form is also valid) port The TCP/IP port number on which the router process is configured Method abortTransaction Purpose Aborts a transaction on the NonStop on behalf of this client. Syntax public void abortTransaction () throws ScobolTxnException Description Equivalent to the SCREEN COBOL ABORT-TRANSACTION statement. Method acceptDate Purpose Gets the date from the NonStop. Syntax public void acceptDate (ScobolType date, boolean yyyymmdd) throws ScobolTxnException Description Equivalent to the SCREEN COBOL ACCEPT DATE statement. Parameters date The object that will receive the date. yyyymmdd If true, the date will be returned in yyyymmdd format; otherwise, it will be in yymmdd format. Method acceptDay Purpose Gets the Julian day from the NonStop. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -4
  • Java Import Package Reference Class Gateway Syntax public void acceptDay (ScobolType day, boolean yyyyddd) throws ScobolTxnException Description Equivalent to the SCREEN COBOL ACCEPT DAY statement. Parameters day The object that will receive the Julian day. yyyyddd If true, the day will be returned in yyyyddd format; otherwise, it will be in yyddd format. Method acceptTime Purpose Gets the time from the NonStop. Syntax public void acceptTime (ScobolType time) throws ScobolTxnException Description Equivalent to the SCREEN COBOL ACCEPT TIME statement. Parameters time The object that will receive the time Method beginTransaction Purpose Initiates a transaction on the NonStop on behalf of this client. Syntax public void beginTransaction () throws ScobolTxnException Description Equivalent to the SCREEN COBOL BEGIN-TRANSACTION statement. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -5
  • Java Import Package Reference Class Gateway Side Effects Sets the values of ScobolLib.terminationStatus, ScobolLib.transactionId, and ScobolLib.restartCounter. Method beginTransaction (for ON ERROR clause) Purpose Initiates a transaction on the NonStop on behalf of this client. Syntax public void beginTransaction (String onTxnErrorMethod, Object param) throws ScobolTxnException Description Equivalent to the ON ERROR clause associated with the SCREEN COBOL BEGIN- TRANSACTION statement. The signature of onTxnErrorMethod() must be: void onTxnErrorMethod (Object arg) Parameters onTxnErrorMethod The name of the transaction error-handling method. If null or if the method name is not found, then no method is invoked if a transaction error occurs. param The object that will be the parameter to the onTxnErrorMethod() call. Side Effects Sets the values of ScobolLib.terminationStatus, ScobolLib.transactionId, and ScobolLib.restartCounter. Method dialogAbort Purpose Forcibly aborts the dialog from the client side that was initiated by a previous dialogBegin() call. Syntax Public void dialogAbort ( ) throws ScobolSendException HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -6
  • Java Import Package Reference Class Gateway Description Equivalent to the SCREEN COBOL DIALOG-ABORT statement. The Exception class, ScobolSendException, is defined in the pathway.its package. Side Effects Sets the values of ScobolLib.terminationStatus, ScobolLib.terminationSubStatus, and ScobolLib.dialogInfo. Method dialogBegin Purpose Performs a server-class dialog begin operation to the specified server class. Syntax Public void dialogBegin (ScobolType() sendItems, String serverclassName, String pathmonName, String systemName, ServerReplyCode replyMap) throws ScobolTxnException, ScobolSendException Description Equivalent to the SCREEN COBOL DIALOG-BEGIN statement. The data types ScobolType and ServerReplyCode are already defined in the pathway.its package. Similarly, the Exception classes ScobolTxnException and ScobolSendException are also defined in the pathway.its package. Parameters sendItems An array of data items to be sent to the server. serverclassName Identifies the server class with which the dialog needs to be established. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -7
  • Java Import Package Reference Class Gateway pathmonName Identifies the Pathmon process for which the server class is configured. If this value is not specified, the value is NULL. This parameter is optional; if the server class is monitored by the same Pathmon process as the gateway terminal, then this parameter is not necessary. If the server class is remote, you must specify the name of the server class Pathmon process. systemName Identifies the system on which the Pathmon process is running. If this value is not specified, the value is NULL. This parameter is optional; if the server class is monitored by the same Pathmon process as the gateway terminal, then this parameter is not necessary. If the server class is remote, then you must specify the name of the system on which the server class Pathmon process is running. replyMap Object encapsulating the REPLY CODE and YIELDS clause values of the DIALOG-BEGIN statement. Side Effects Sets the values of ScobolLib.terminationStatus, ScobolLib.terminationSubStatus, and ScobolLib.dialogInfo. Method dialogEnd Purpose Ends the dialog from the client side that was initiated by a previous dialogBegin() call. Syntax Public void dialogEnd ( ) throws ScobolSendException Description Equivalent to the SCREEN COBOL DIALOG-END statement. The Exception class, ScobolSendException, is defined in the pathway.its package. Side Effects Sets the value of ScobolLib.terminationStatus, and ScobolLib.dialogInfo. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -8
  • Java Import Package Reference Class Gateway Method dialogSend Purpose Continues to perform the send operation to a server class identified by a previously initiated dialogBegin () call. Syntax Public void dialogSend (ScobolType() sendItems, ServerReplyCode replyMap) throws ScobolTxnException, ScobolSendException Description Equivalent to the SCREEN COBOL DIALOG-SEND statement. Note that ScobolType and ServerReplyCode data types are already defined in pathway.its package. Similarly, ScobolTxnException and ScobolSendException are Exception classes already defined in pathway.its package. Parameters sendItems An array of data items to be sent to the server. replyMap Object encapsulating the REPLY CODE and YIELDS clause values of the DIALOG-SEND statement. Side Effects Sets the values of ScobolLib.terminationStatus, ScobolLib.terminationSubStatus, and ScobolLib.dialogInfo. Method endTransaction Purpose Ends a transaction on the NonStop on behalf of this client. Syntax public void endTransaction () throws ScobolTxnException Description Equivalent to the SCREEN COBOL END-TRANSACTION statement. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -9
  • Java Import Package Reference Class Gateway Method send Purpose Performs a server-class send operation to the specified server class. Syntax public void send (ScobolType[] sendItems, String serverclassName, String pathmonName, String systemName, ServerReplyCode replyMap) throws ScobolTxnException, ScobolSendException Description Equivalent to the SCREEN COBOL SEND statement. Parameters sendItems An array of data items to be sent to the server serverclassName Identifies the server class for which the message is intended pathmonName Identifies the Pathmon process for which the server class is configured. If this value is not specified, the value is null. This parameter is optional; if the server class is monitored by the same Pathmon process as the gateway terminal, then this parameter is not necessary. If the server class is remote, you must specify the name of the server class Pathmon process. systemName Identifies the system on which the Pathmon process is running. If this value is not specified, the value is null. This parameter is optional; if the server class is monitored by the same Pathmon process as the gateway terminal, then this parameter is not necessary. If the server class is remote, you must specify the name of the system in which the server class Pathmon process is running. replyMap Object encapsulating the REPLY CODE and YIELDS clause values of the SEND statement Side Effects Sets the values of ScobolLib.terminationStatus and ScobolLib.terminationSubStatus. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 10
  • Java Import Package Reference Class ServerReplyCode Class ServerReplyCode The ServerReplyCode class allows the user to specify the server reply code in a SCREEN COBOL SEND statement. The ServerReplyCode object is a required parameter in the Gateway.send method. Package pathway.its Syntax public pathway.its.ServerReplyCode Description This class contains methods that allow the user to specify a server reply code. Member Summary Constructor ServerReplyCode() Methods addReplyCode() Equivalent to the YIELDS clause of the SCREEN COBOL SEND statement Method Constructor Syntax public ServerReplyCode () Description Constructor for the ServerReplyCode class. Method addReplyCode (Single Data Identifier) Syntax public void addReplyCode (Integer replyCode, int terminationStatus, ScobolType identifier) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 11
  • Java Import Package Reference Class ServerReplyCode Description Equivalent to the REPLY CODE reply-code-value YIELDS identifier-2 clause of the SCREEN COBOL SEND statement. This method is called once for each reply-code-value in the YIELDS clause. Parameters replyCode Equivalent to reply-code-value in the YIELDS clause of the SEND statement. If null, this is the same as REPLY CODE OTHER. terminationStatus The value to which ScobolLib.terminationStatus is to be set when the server’s reply code matches the value of replyCode. identifier Equivalent to identifier-2 in the YIELDS clause. Side Effects Sets the value of ScobolLib.terminationStatus. Method addReplyCode (Multiple Data Identifiers) Syntax public void addReplyCode (Integer replyCode, int terminationStatus, ScobolType[] identifier) Description Equivalent to the REPLY CODE reply-code-value YIELDS {identifier-2}... clause of the SCREEN COBOL SEND statement. This method is called once for each reply-code-value in the YIELDS clause. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 12
  • Java Import Package Reference HTML Screen Interaction Classes Parameters replyCode Equivalent to reply-code-value in the YIELDS clause of the SEND statement. If null, this is the same as REPLY CODE OTHER. terminationStatus The value to which ScobolLib.terminationStatus is to be set when the server’s reply code matches the value of replyCode. identifier An array of identifier values; equivalent to identifier-2 in the YIELDS clause. Side Effects Sets the value of ScobolLib.terminationStatus. HTML Screen Interaction Classes The HTML screen interaction classes define the attributes and structures associated with SCREEN COBOL screen fields and the SCREEN COBOL statements associated with displaying and accepting screens. Class ScreenFieldIdentifier The ScreenFieldIdentifier class is an interface class for the ScreenField, ScreenFieldArray, and ScreenFieldGroup classes. Package pathway.its Syntax public interface ScreenFieldIdentifier Description This interface class allows the API to treat objects of the classes ScreenField, ScreenFieldArray, and ScreenFieldGroup polymorphically. Class ScreenField The ScreenField class is the Java representation of the SCREEN COBOL screen fields. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 13
  • Java Import Package Reference Class ScreenField Package pathway.its Syntax public pathway.its.ScreenField implements ScreenFieldIdentifier Description This class provides methods to set the various attributes associated with a screen field. Member Summary Data Members public static final int ATTR_BELL public static final int ATTR_BLINK public static final int ATTR_DEFAULT public static final int ATTR_HIDDEN public static final int ATTR_MDTON public static final int ATTR_OUTLINE public static final int ATTR_PROTECTED public static final int ATTR_RVIDEO public static final int ATTR_UNDERLINE public static final int CLEAR public static final int SKIP public static final int UPSHIFT_INPUT public static final int UPSHIFT_INPUTOUTPUT public static final int UPSHIFT_OUTPUT Constructor ScreenField() HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 14
  • Java Import Package Reference Class ScreenField Methods setADVISORY() Equivalent to the ADVISORY field-characteristic clause setCONTROLLEDBY() Equivalent to the CONTROLLED [BY] field- characteristic clause setCONVERTBLANKS() Equivalent to the CONVERT BLANKS field- characteristic clause setFILL() Equivalent to the FILL field-characteristic clause setInitAttribute() Sets the initial attributes of a screen field setLENGTH() Equivalent to the LENGTH [MUST BE] field- characteristic clause setMUSTBE() Equivalent to the MUST [BE] field-characteristic clause setSHADOWED() Equivalent to the SHADOWED [BY] field- characteristic clause setUPSHIFT() Equivalent to the UPSHIFT field-characteristic clause setUSERCONVERSION() Equivalent to the USER [CONVERSION] field- characteristic clause setVALUE() Equivalent to the VALUE field-characteristic clause setWhenAbsent() Equivalent to the WHEN ABSENT field-characteristic clause setWhenBlank() Equivalent to the WHEN BLANK field-characteristic clause Method Constructor Syntax public ScreenField (String name, ScobolType from, ScobolType to, int row, int col, String validationPic) Description Equivalent to this SCREEN COBOL data description entry: screen-field-name [AT] line-spec, column-spec TO data-name FROM data-name PIC [IS] character-string HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 15
  • Java Import Package Reference Class ScreenField Parameters name The value of the name attribute of the HTML control element. For example, for <INPUT TYPE="TEXT" NAME="WS-ITEM1">, name = new String ("WS-ITEM1"). from Corresponds to the data item in the FROM clause in the SCREEN COBOL field description. This parameter can be null. to Corresponds to the data item in the TO clause in the SCREEN COBOL field description. This parameter can be null. row Corresponds to the numeric literal line-spec in the AT clause in the SCREEN COBOL field description. col Corresponds to the numeric literal column-spec in the AT clause in the SCREEN COBOL field description. validationPic Corresponds to the string literal in the PIC clause in the SCREEN COBOL field description. Method setADVISORY Syntax public void setADVISORY() Description Equivalent to the ADVISORY field-characteristic clause, as in: screen-field-name [AT] line-spec, column-spec PIC [IS] character-string ADVISORY Method setCONTROLLEDBY Syntax public void setCONTROLLEDBY (ScobolType controlObject) Description Equivalent to the CONTROLLED [BY] field-characteristic clause, as in: screen-field-name [AT] line-spec, column-spec PIC [IS] character-string CONTROLLED [BY] data-name-1 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 16
  • Java Import Package Reference Class ScreenField Parameters controlObject Corresponds to data-name-1 in the CONTROLLED [BY] clause Method setCONVERTBLANKS Syntax public void setCONVERTBLANKS() Description Equivalent to the CONVERT BLANKS field-characteristic clause, as in: screen-field-name [AT] line-spec, column-spec PIC [IS] character-string USER [CONVERSION] numeric-literal CONVERT BLANKS Method setFILL Syntax public void setFILL (char fillChar) Description Equivalent to the FILL field-characteristic clause, as in: screen-field-name [AT] line-spec, column-spec PIC [IS] character-string FILL nonnumeric-literal Parameters fillChar Corresponds to the one-character nonnumeric-literal in the FILL clause Method setInitAttribute Syntax public void setInitAttribute (int attribute) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 17
  • Java Import Package Reference Class ScreenField Description This method sets the initial attributes of a screen field. For example, the SCREEN COBOL data description entry screen-field-name [AT] line-spec, column-spec PIC [IS] character-string PROTECTED, MDTON has this Java equivalent: screenfieldObject.setInitAttribute (ScreenField.ATTR_PROTECTED | ScreenField.ATTR_MDTON) Parameters attribute Represents the initial screen-field attributes to be set at run time, constructed by bitwise ORing of the attribute literals to be set Method setLENGTH Syntax public void setLENGTH (int[] lengthArray) Description Equivalent to the LENGTH [MUST BE] field-characteristic clause. For example, the SCREEN COBOL data description entry screen-field-name [AT] line-spec, column-spec PIC [IS] character-string LENGTH 6 THRU 8, 10 has this Java equivalent: int[] lengthArray = {6,8,10,10}; screenfieldObject.setLENGTH (lengthArray); HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 18
  • Java Import Package Reference Class ScreenField Parameters lengthArray Corresponds to the literal-n values in the LENGTH [MUST BE] clause. The array must be of the form {minLen1,maxLen1,minLen2, maxLen2,...}. Each maxLenx must be >= minLenx. If a value is to be discrete rather than a range, then set minLenx and maxLenx to the same discrete value. Method setMUSTBE Syntax public void setMUSTBE (String[] valueMustBe) Description Equivalent to the MUST [BE] field-characteristic clause. For example, the SCREEN COBOL data description entry screen-field-name [AT] line-spec, column-spec PIC [IS] character-string MUST BE 10 THRU 20, HELLO has this Java equivalent: String[] valueMustBe = {"10","20","HELLO","HELLO"}; screenfieldObject.setMUSTBE (valueMustBe); Parameters valueMustBe Corresponds to the literal-n values in the MUST [BE] clause. The array must be of the form {minVal1,maxVal1,minVal2, maxVal2,...}. Each maxValx must be >= minValx. If a value is to be discrete rather than a range, then set minValx and maxValx to the same discrete value. Method setSHADOWED Syntax public void setSHADOWED (ScobolType shadowByte, boolean isReturnBitAlwaysSet) Description Equivalent to the SHADOWED [BY] field-characteristic clause, as in: screen-field-name [AT] line-spec, column-spec PIC [IS] character-string SHADOWED [BY] data-name-1 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 19
  • Java Import Package Reference Class ScreenField Parameters shadowByte Corresponds to data-name-1 in the SHADOWED [BY] clause isReturnBitAlwaysSet Must be TRUE if the modified data tag (MDT) for the screen field is set to ON; otherwise, must be FALSE Method setUPSHIFT Syntax public void setUPSHIFT (int i) Description Equivalent to the UPSHIFT field-characteristic clause, as in: screen-field-name [AT] line-spec, column-spec PIC [IS] character-string UPSHIFT { INPUT | OUTPUT | INPUT-OUTPUT } Parameters i Must be ScreenField.UPSHIFT_INPUT, ScreenField.UPSHIFT_OUTPUT, or ScreenField.UPSHIFT_INPUTOUTPUT; otherwise, the parameter is ignored Method setUSERCONVERSION Syntax public void setUSERCONVERSION (int userCode, Object contextObject) Description Equivalent to the USER [CONVERSION] field-characteristic clause, as in: screen-field-name [AT] line-spec, column-spec PIC [IS] character-string USER [CONVERSION] numeric-literal HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 20
  • Java Import Package Reference Class ScreenField Parameters userCode Corresponds to the routine number (numeric-literal) in the USER [CONVERSION] clause. contextObject A user-defined object returned by calling screenFieldObject.getcontextObject(). This parameter can be null. Method setVALUE Syntax public void setVALUE (String initialValue) Description Equivalent to the VALUE field-characteristic clause, as in: screen-field-name [AT] line-spec, column-spec PIC [IS] character-string VALUE nonnumeric-literal Parameters initialValue Corresponds to nonnumeric-literal in the VALUE clause Method setWhenAbsent Syntax public void setWhenAbsent (int whenAbsent) Description Equivalent to the WHEN ABSENT field-characteristic clause, as in: screen-field-name [AT] line-spec, column-spec PIC [IS] character-string USING data-name-1 WHEN ABSENT { CLEAR | SKIP } Parameters whenAbsent Must be either CLEAR or SKIP Method setWhenBlank Syntax public void setWhenBlank (int whenBlank) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 21
  • Java Import Package Reference Class ScreenFieldArray Description Equivalent to the WHEN BLANK field-characteristic clause, as in: screen-field-name [AT] line-spec, column-spec PIC [IS] character-string USING data-name-1 WHEN BLANK { CLEAR | SKIP } Parameters whenBlank Must be either CLEAR or SKIP Class ScreenFieldArray The ScreenFieldArray class is the Java representation of the OCCURS clause for screen fields. Package pathway.its Syntax public pathway.its.ScreenFieldArray implements ScreenFieldIdentifier Description This class implements the equivalent of the OCCURS field-characteristic clause. It is essentially a container for all the screen field objects that are part of an OCCURS clause. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 22
  • Java Import Package Reference Class ScreenFieldArray Member Summary Data Members public static final int ATTR_BELL public static final int ATTR_BLINK public static final int ATTR_DEFAULT public static final int ATTR_HIDDEN public static final int ATTR_MDTON public static final int ATTR_OUTLINE public static final int ATTR_PROTECTED public static final int ATTR_RVIDEO public static final int ATTR_UNDERLINE public static final int CLEAR public static final int SKIP public static final int UPSHIFT_INPUT public static final int UPSHIFT_INPUTOUTPUT public static final int UPSHIFT_OUTPUT Constructor ScreenFieldArray() HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 23
  • Java Import Package Reference Class ScreenFieldArray Methods addField() Adds a screen field to the array setADVISORY() Equivalent to the ADVISORY field-characteristic clause setCONTROLLEDBY() Equivalent to the CONTROLLED [BY] field- characteristic clause setCONVERTBLANKS() Equivalent to the CONVERT BLANKS field- characteristic clause setFILL() Equivalent to the FILL field-characteristic clause setInitAttribute() Sets the initial attributes of the screen fields setLENGTH() Equivalent to the LENGTH [MUST BE] field- characteristic clause setMUSTBE() Equivalent to the MUST [BE] field-characteristic clause setSHADOWED() Equivalent to the SHADOWED [BY] field- characteristic clause setUPSHIFT() Equivalent to the UPSHIFT field-characteristic clause setUSERCONVERSION() Equivalent to the USER [CONVERSION] field- characteristic clause setVALUE() Equivalent to the VALUE field-characteristic clause setWhenAbsent() Equivalent to the WHEN ABSENT field-characteristic clause setWhenBlank() Equivalent to the WHEN BLANK field-characteristic clause Method Constructor Syntax public ScreenFieldArray (long maxOccurs, Pic9 dependingOn) Description Constructs the equivalent of an OCCURS field-characteristic clause. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 24
  • Java Import Package Reference Class ScreenFieldArray Parameters maxOccurs The value of columns-literal* lines-literal in the field- characteristic clause OCCURS IN columns-literal COLUMNS ON lines-literal LINES. dependingOn Corresponds to data-name-1 in the field-characteristic clause OCCURS IN columns-literal COLUMNS ON lines-literal LINES DEPENDING [ON] data-name-1. This parameter can be null. Method addField Syntax public void addField (ScreenField field) Description This method is invoked once for each ScreenField object in the OCCURS clause. Parameters field A ScreenField object that is part of the OCCURS clause Method setADVISORY Syntax public void setADVISORY() Description Equivalent to the ADVISORY field-characteristic clause, as in: OCCURS IN columns-literal COLUMNS ON lines-literal LINES ADVISORY Method setCONTROLLEDBY Syntax public void setCONTROLLEDBY (ScobolType controlObject) Description Equivalent to the CONTROLLED [BY] field-characteristic clause, as in: OCCURS IN columns-literal COLUMNS ON lines-literal LINES CONTROLLED [BY] data-name-1 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 25
  • Java Import Package Reference Class ScreenFieldArray Parameters controlObject Corresponds to data-name-1 in the CONTROLLED [BY] clause Method setCONVERTBLANKS Syntax public void setCONVERTBLANKS() Description Equivalent to the CONVERT BLANKS field-characteristic clause, as in: OCCURS IN columns-literal COLUMNS ON lines-literal LINES USER [CONVERSION] numeric-literal CONVERT BLANKS Method setFILL Syntax public void setFILL (char fillChar) Description Equivalent to the FILL field-characteristic clause, as in: OCCURS IN columns-literal COLUMNS ON lines-literal LINES FILL nonnumeric-literal Parameters fillChar Corresponds to the one-character nonnumeric-literal in the FILL clause Method setInitAttribute Syntax public void setInitAttribute (int attribute) Description This method sets the initial attributes of a screen field. For example, the SCREEN COBOL clause OCCURS IN columns-literal COLUMNS ON lines-literal LINES PROTECTED, MDTON HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 26
  • Java Import Package Reference Class ScreenFieldArray has this Java equivalent: screenfieldArrayObject.setInitAttribute (ScreenFieldArray.ATTR_PROTECTED | ScreenFieldArray.ATTR_MDTON) Parameters attribute Represents the initial screen-field attributes to be set at run time, constructed by bitwise ORing of the attribute literals to be set Method setLENGTH Syntax public void setLENGTH (int[] lengthArray) Description Equivalent to the LENGTH [MUST BE] field-characteristic clause. For example, the SCREEN COBOL clause OCCURS IN columns-literal COLUMNS ON lines-literal LINES LENGTH 6 THRU 8, 10 has this Java equivalent: int[] lengthArray = {6,8,10,10}; screenfieldArrayObject.setLENGTH (lengthArray); Parameters lengthArray Corresponds to the literal-n values in the LENGTH [MUST BE] clause. The array must be of the form {minLen1,maxLen1,minLen2, maxLen2,...}. Each maxLenx must be >= minLenx. If a value is to be discrete rather than a range, then set minLenx and maxLenx to the same discrete value. Method setMUSTBE Syntax public void setMUSTBE (String[] valueMustBe) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 27
  • Java Import Package Reference Class ScreenFieldArray Description Equivalent to the MUST [BE] field-characteristic clause. For example, the SCREEN COBOL clause OCCURS IN columns-literal COLUMNS ON lines-literal LINES MUST BE 10 THRU 20, HELLO has this Java equivalent: String[] valueMustBe = {"10","20","HELLO","HELLO"}; screenfieldArrayObject.setMUSTBE (valueMustBe); Parameters valueMustBe Corresponds to the literal-n values in the MUST [BE] clause. The array must be of the form {minVal1,maxVal1,minVal2, maxVal2,...}. Each maxValx must be >= minValx. If a value is to be discrete rather than a range, then set minValx and maxValx to the same discrete value. Method setSHADOWED Syntax public void setSHADOWED (ScobolType shadowByte, boolean isReturnBitAlwaysSet) Description Equivalent to the SHADOWED [BY] field-characteristic clause, as in: OCCURS IN columns-literal COLUMNS ON lines-literal LINES SHADOWED [BY] data-name-1 Parameters shadowByte Corresponds to data-name-1 in the SHADOWED [BY] clause isReturnBitAlwaysSet Must be TRUE if the modified data tag (MDT) for the screen field is set to ON; otherwise, must be FALSE Method setUPSHIFT Syntax public void setUPSHIFT (int i) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 28
  • Java Import Package Reference Class ScreenFieldArray Description Equivalent to the UPSHIFT field-characteristic clause, as in: OCCURS IN columns-literal COLUMNS ON lines-literal LINES UPSHIFT { INPUT | OUTPUT | INPUT-OUTPUT } Parameters i Must be ScreenFieldArray.UPSHIFT_INPUT, ScreenFieldArray.UPSHIFT_OUTPUT, or ScreenFieldArray.UPSHIFT_INPUTOUTPUT; otherwise, the parameter is ignored Method setUSERCONVERSION Syntax public void setUSERCONVERSION (int userCode, Object contextObject) Description Equivalent to the USER [CONVERSION] field-characteristic clause, as in: OCCURS IN columns-literal COLUMNS ON lines-literal LINES USER [CONVERSION] numeric-literal Parameters userCode Corresponds to the routine number (numeric-literal) in the USER [CONVERSION] clause. contextObject A user-defined object returned by calling screenFieldObject.getcontextObject(). This parameter can be null. Method setVALUE Syntax public void setVALUE (String initialValue) Description Equivalent to the VALUE field-characteristic clause, as in: OCCURS IN columns-literal COLUMNS ON lines-literal LINES VALUE nonnumeric-literal Parameters initialValue Corresponds to nonnumeric-literal in the VALUE clause HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 29
  • Java Import Package Reference Class ScreenFieldGroup Method setWhenAbsent Syntax public void setWhenAbsent (int whenAbsent) Description Equivalent to the WHEN ABSENT field-characteristic clause, as in: OCCURS IN columns-literal COLUMNS ON lines-literal LINES USING data-name-1 WHEN ABSENT { CLEAR | SKIP } Parameters whenAbsent Must be either CLEAR or SKIP Method setWhenBlank Syntax public void setWhenBlank (int whenBlank) Description Equivalent to the WHEN BLANK field-characteristic clause, as in: OCCURS IN columns-literal COLUMNS ON lines-literal LINES USING data-name-1 WHEN BLANK { CLEAR | SKIP } Parameters whenBlank Must be either CLEAR or SKIP Class ScreenFieldGroup The ScreenFieldGroup class is the Java representation of a SCREEN COBOL screen group. Package pathway.its Syntax public pathway.its.ScreenFieldGroup implements ScreenFieldIdentifier HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 30
  • Java Import Package Reference Class ScreenFieldGroup Description This class implements the equivalent of a SCREEN COBOL screen group. It is essentially a container for all the screen field objects that are part of a screen group. Member Summary Constructor ScreenFieldGroup() Methods addField() Adds a screen field to this object addFieldArray() Adds a screen field array (that is, a screen field associated with an OCCURS clause) to this object Method Constructor Syntax public ScreenFieldGroup () Description Constructs the equivalent of a SCREEN COBOL screen group. Method addField Syntax public void addField (ScreenField field) Description Adds a screen field to this object. Parameters field A previously instantiated ScreenField object that is part of this ScreenFieldGroup object Method addFieldArray Syntax public void addFieldArray (ScreenFieldArray fieldArray) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 31
  • Java Import Package Reference Class HTMLHandler Description Adds a screen field array to this object. Parameters field A previously instantiated ScreenFieldArray object (that is, a screen field associated with an OCCURS clause) that is part of this ScreenFieldGroup object Class HTMLHandler The HTMLHandler class encapsulates the SCREEN COBOL statements associated with displaying and accepting SCREEN COBOL screens. Examples of such statements are DISPLAY BASE, DISPLAY, and ACCEPT. Package pathway.its Syntax public pathway.its.HTMLHandler Description This class provides methods for rendering an HTML page as well as setting HTML field values and getting HTML field values from corresponding working-storage items. Member Summary Constructor HTMLHandler() HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 32
  • Java Import Package Reference Class HTMLHandler UI Interaction Methods accept() Equivalent to the SCREEN COBOL ACCEPT statement clearInput() Equivalent to the SCREEN COBOL CLEAR INPUT statement display() Equivalent to the SCREEN COBOL DISPLAY statement displayBase() Equivalent to the SCREEN COBOL DISPLAY BASE statement displayOverlay() Equivalent to the SCREEN COBOL DISPLAY OVERLAY statement displayOverlaySpaces() Equivalent to the SCREEN COBOL DISPLAY OVERLAY SPACES AT statement resetAttribute() Equivalent to the SCREEN COBOL RESET ATTR statement resetData() Equivalent to the SCREEN COBOL RESET DATA statement setNewCursor() Equivalent to the SCREEN COBOL SET NEW- CURSOR statement turn() Equivalent to the SCREEN COBOL TURN statement Method Constructor Syntax public HTMLHandler (Applet anApplet) Description Constructor for the HTML Handler class. Parameters anApplet The instance of the applet object that is present in the control frame Method accept Purpose Gets the HTML field values and updates the corresponding working storage for the respective ScreenField objects. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 33
  • Java Import Package Reference Class HTMLHandler Syntax public void accept (ScreenFieldIdentifier[] fieldIds, FunctionKey[] untilFuncKeys, FunctionKey[] escFuncKeys public void accept (ScreenFieldIdentifier[] fieldIds, FunctionKey[] untilFuncKeys, FunctionKey[] escFuncKeys, int timeout, int timeoutTerminationStatus) Description The first form of the syntax is equivalent to the SCREEN COBOL statement: ACCEPT {screen-identifier}... UNTIL comp-condition-1 ESCAPE [ON] comp-condition-2 where comp-condition-2 has no timeout value. The second form is equivalent to the SCREEN COBOL statement: ACCEPT {screen-identifier}... UNTIL comp-condition-1 ESCAPE [ON] comp-condition-2 where comp-condition-2 specifies a timeout value. Parameters fieldIDs An array of ScreenIdentifier objects; corresponds to screen-identifiers in the ACCEPT statement untilFuncKeys An array of FunctionKey objects corresponding to the function keys associated with the UNTIL clause of the ACCEPT statement escFuncKeys An array of FunctionKey objects corresponding to the function keys associated with the ESCAPE clause of the ACCEPT statement timeout The value corresponding to the TIMEOUT clause of the ACCEPT statement timeoutTerminationStatus The value to which ScobolLib.terminationStatus is set in the event of a timeout HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 34
  • Java Import Package Reference Class HTMLHandler Method clearInput Purpose Clears the HTML field values. Syntax public void clearInput() Description Equivalent to the SCREEN COBOL CLEAR INPUT statement. Method display Purpose Displays the corresponding HTML field values for ScreenField objects. Syntax public void display (ScreenFieldIdentifier[] fieldIds) public void display (ScreenFieldIdentifier[] fieldIds, boolean isTemporary, String literal, Pic9 dependingOn) public void display (ScreenFieldIdentifier[] fieldIds, boolean isTemporary, String literal, boolean isShadowed) Description The first form of the syntax is equivalent to the SCREEN COBOL statement: DISPLAY {screen-identifier},... The second form is equivalent to the SCREEN COBOL statement: DISPLAY [TEMP] [nonnumeric-literal IN] {screen-identifier},... [DEPENDING [ON] identifier] The third form is equivalent to the SCREEN COBOL statement: DISPLAY [TEMP] [nonnumeric-literal IN] {screen-identifier},... [SHADOWED] HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 35
  • Java Import Package Reference Class HTMLHandler Parameters fieldIDs An array of ScreenIdentifier objects; corresponds to screen-identifiers in the DISPLAY statement isTemporary If true, corresponds to the presence (and if false, to the absence) of the TEMP clause of the DISPLAY statement literal If non-null, corresponds to the presence (and if null, to the absence) of the IN clause of the DISPLAY statement dependingOn If non-null, corresponds to the presence (and if null, to the absence) of the DEPENDING [ON] clause of the DISPLAY statement isShadowed If true, corresponds to the presence (and if false, to the absence) of the SHADOWED clause of the DISPLAY statement Method displayBase Purpose Sets the context of the HTML page on which subsequent methods such as display() and accept() work. Syntax public void displayBase (String htmlFilename, String formName, String frameName, String selectCtrlName) Description This method is equivalent to the SCREEN COBOL statement DISPLAY BASE base- screen-name. It must be called before calling display(). This method does not display an HTML page; the actual display is done during the call to display(). HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 36
  • Java Import Package Reference Class HTMLHandler Parameters htmlFilename The name of the HTML file to be displayed; for example, page.html. It is assumed that this HTML file is in the same directory as the HTML file containing the applet (cframe.html in the example). formName The value of the NAME attribute in the <FORM> tag present in the page.html document. frameName The value of the NAME attribute in the <FRAME> tag present in the frameset.html document. selectCtrlName The value of the NAME attribute in the <SELECT> tag present in the page.html document. Example For example, suppose frameset.html is the frameset document and page.html is the page that must be displayed in the frame named UFRAME. Then this HTML code would be present in frameset.html: <FRAMESET COLS="*,*"> <FRAME SRC="cframe.html", NAME="CFrame"> <FRAME SRC="page.html", NAME="UFrame"> </FRAMESET> And this code would be present in page.html: <FORM NAME="THEFORM"> <SELECT NAME="SELECTCTRL"> <OPTION> </SELECT> </FORM> This call would invoke the method for this example: displayBase ("page.html", "THEFORM", "UFRAME", "SELECTCTRL"); Method displayOverlay Purpose Sets the context of the HTML page on which subsequent methods such as display() and accept() work. Syntax void displayOverlay (String overlayScreenName, String overlayArea, String screenIdentifier, int rowOffset, int colOffset) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 37
  • Java Import Package Reference Class HTMLHandler Description This method is equivalent to the SCREEN COBOL statement DISPLAY OVERLAY overlay-area-name. It must be called before calling display(). This method does not display an HTML page; the actual display is done during the call to display(). Parameters overlayScreenName The name of the HTML file that contains the overlay screen to be displayed overlayArea The name of the Overlay Area on the screen. screenIdentifier Identifiers assigned to the overlay screens. rowOffset The row number of the Overlay Area at which the overlay screen is to be displayed. colOffset The column number of the Overlay Area at which the overlay screen is to be displayed. Example displayOverlay("scrn0000.html”,”ovarea”,”ov0000”,5,34"); displayOverlay(“LOGON_SCRN0001.html”,”OA0000”,”OVLAYSCR01”,5,1); Method displayOverlaySpaces Purpose Implements the SCREEN COBOL statement DISPLAY OVERLAY SPACES AT Syntax void displayOverlaySpaces (String overlayArea) Description This method is equivalent to the SCREEN COBOL statement DISPLAY OVERLAY SPACES AT overlay-area-name, which clears an overlay screen by writing spaces to it. This method does not display an HTML page; the actual display is done during the call to display(). Parameters overlayArea The name of the Overlay Area on the screen. Example displayOverlaySpaces("ovarea"); displayOverlaySpaces(“OA0000”); HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 38
  • Java Import Package Reference Class HTMLHandler Method resetAttribute Purpose Resets the HTML field attributes for a selected number of fields. Syntax public void resetAttribute (ScreenFieldIdentifier[] fieldIds, boolean isTemporary) public void resetAttribute (ScreenFieldIdentifier[] fieldIds, boolean isTemporary, ScobolType dependingOn) public void resetAttribute (ScreenFieldIdentifier[] fieldIds, boolean isTemporary, boolean isShadowed) Description The first form of the syntax is equivalent to the SCREEN COBOL statement: RESET ATTR {screen-identifier},... The second form is equivalent to the SCREEN COBOL statement: RESET [TEMP] ATTR {screen-identifier},... [DEPENDING [ON]] identifier The third form is equivalent to the SCREEN COBOL statement: RESET [TEMP] ATTR {screen-identifier},... [SHADOWED] HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 39
  • Java Import Package Reference Class HTMLHandler Parameters fieldIDs An array of ScreenIdentifier objects; corresponds to screen-identifiers in the RESET ATTR statement isTemporary If true, corresponds to the presence (and if false, to the absence) of the TEMP clause of the RESET ATTR statement dependingOn If non-null, corresponds to the presence (and if null, to the absence) of the DEPENDING [ON] clause of the RESET ATTR statement isShadowed If true, corresponds to the presence (and if false, to the absence) of the SHADOWED clause of the RESET ATTR statement Method resetData Purpose Clears the corresponding HTML field values for a selected number of fields. Syntax public void resetData (ScreenFieldIdentifier[] fieldIds, boolean isTemporary) public void resetData (ScreenFieldIdentifier[] fieldIds, boolean isTemporary, ScobolType dependingOn) public void resetData (ScreenFieldIdentifier[] fieldIds, boolean isTemporary, boolean isShadowed) Description The first form of the syntax is equivalent to the SCREEN COBOL statement: RESET DATA {screen-identifier},... The second form is equivalent to the SCREEN COBOL statement: RESET [TEMP] DATA {screen-identifier},... [DEPENDING [ON]] identifier The third form is equivalent to the SCREEN COBOL statement: RESET [TEMP] DATA {screen-identifier},... [SHADOWED] HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 40
  • Java Import Package Reference Class HTMLHandler Parameters fieldIDs An array of ScreenIdentifier objects; corresponds to screen-identifiers in the RESET DATA statement isTemporary If true, corresponds to the presence (and if false, to the absence) of the TEMP clause of the RESET DATA statement dependingOn If non-null, corresponds to the presence (and if null, to the absence) of the DEPENDING [ON] clause of the RESET DATA statement isShadowed If true, corresponds to the presence (and if false, to the absence) of the SHADOWED clause of the RESET DATA statement Method setNewCursor Purpose Stores the position of the indicated HTML field in ScobolLib.newCursor. (The position is the row and column number as specified in the constructor of the ScreenField object.) Syntax public void setNewCursor (ScreenFieldIdentifier[] fieldIds) public void setNewCursor (ScreenFieldIdentifier[] fieldIds, ScobolType dependingOn) public void setNewCursor (ScreenFieldIdentifier[] fieldIds, boolean isShadowed) Description The first form of the syntax is equivalent to the SCREEN COBOL statement: SET NEW-CURSOR AT {screen-identifier},... The second form is equivalent to the SCREEN COBOL statement: SET NEW-CURSOR AT {screen-identifier},... [DEPENDING [ON]] identifier The third form is equivalent to the SCREEN COBOL statement: SET NEW-CURSOR AT {screen-identifier},... [SHADOWED] HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 41
  • Java Import Package Reference Class HTMLHandler Parameters fieldIDs An array of ScreenIdentifier objects; corresponds to screen-identifiers in the SET NEW-CURSOR statement dependingOn If non-null, corresponds to the presence (and if null, to the absence) of the DEPENDING [ON] clause of the SET NEW-CURSOR statement isShadowed If true, corresponds to the presence (and if false, to the absence) of the SHADOWED clause of the SET NEW- CURSOR statement Method turn Purpose Changes the display attributes of a selected number of HTML fields. Syntax public void turn (ScreenFieldIdentifier[] fieldIds, boolean isTemporary, int attrFlag) public void turn (ScreenFieldIdentifier[] fieldIds, boolean isTemporary, int attrFlag, ScobolType dependingOn) public void turn (ScreenFieldIdentifier[] fieldIds, boolean isTemporary, int attrFlag, boolean isShadowed) Description The first form of the syntax is equivalent to the SCREEN COBOL statement: TURN [TEMP] {...} IN {screen-identifier},... The second form is equivalent to the SCREEN COBOL statement: TURN [TEMP] {...} IN {screen-identifier},... [DEPENDING [ON]] identifier The third form is equivalent to the SCREEN COBOL statement: TURN [TEMP] {...} IN {screen-identifier},... [SHADOWED] HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 42
  • Java Import Package Reference Class FunctionKey Parameters fieldIDs An array of ScreenIdentifier objects; corresponds to screen-identifiers in the TURN statement isTemporary If true, corresponds to the presence (and if false, to the absence) of the TEMP clause of the TURN statement attrFlag If 0, implies the DYNAMIC clause of the TURN statement; otherwise, the value is the ORed combination of attributes from the DisplayAttribute class dependingOn If non-null, corresponds to the presence (and if null, to the absence) of the DEPENDING [ON] clause of the TURN statement isShadowed If true, corresponds to the presence (and if false, to the absence) of the SHADOWED clause of the TURN statement Class FunctionKey The FunctionKey class is the Java representation of the function keys in SCREEN COBOL programs. Package pathway.its Syntax public pathway.its.FunctionKey Description This class encapsulates the SCREEN COBOL function key settings. Member Summary Constructor FunctionKey() Method Constructor Syntax public FunctionKey (String keyLabel, int terminationStatusValue) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 43
  • Java Import Package Reference Data-Type Classes Description Constructor for the FunctionKey class. Parameters keyLabel The literal that appears in the function-key drop- down box on the HTML page terminationStatusValue The value to which ScobolLib.terminationStatus is to be set if this function key is selected during “accept” processing Data-Type Classes The SCREEN COBOL data-type classes encapsulate the storage and casting rules associated with SCREEN COBOL alphanumeric (PIC X), numeric integer (PIC 9), and numeric non-integer (PIC 9V and PIC 9P) data types. Class ScobolType Package pathway.its Syntax public abstract pathway.its.ScobolType Description This abstract class is the super-class for all SCREEN COBOL data types implemented in Java. Member Summary Data Members public static final char HIGHVALUES public static final char LOWVALUES public static final char QUOTES public static final char SPACES public static final char ZEROS Constructor ScobolType() HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 44
  • Java Import Package Reference Class ScobolType Abstract Methods getHostLength() Returns the number of bytes required to store the NonStop Kernel representation of the data getHostValue() Returns the NonStop Kernel representation of the data as a byte array setHostValue() Updates the value of the object with the given byte array Non-Abstract Methods isEqualTo() Equivalent to the SCREEN COBOL relation condition IS [NOT] EQUAL [TO] isEqualToAll() Equivalent to the SCREEN COBOL relation condition IS [NOT] EQUAL [TO] ALL isGreaterThan() Equivalent to the SCREEN COBOL relation condition IS [NOT] GREATER [THAN] isGreaterThanAll() Equivalent to the SCREEN COBOL relation condition IS [NOT] GREATER [THAN] ALL isLessThan() Equivalent to the SCREEN COBOL relation condition IS [NOT] LESS [THAN] isLessThanAll() Equivalent to the SCREEN COBOL relation condition IS [NOT] LESS [THAN] ALL isValueNumeric() Equivalent to the SCREEN COBOL class condition IS [NOT] NUMERIC Method Constructor Syntax public ScobolType() Method getHostLength Purpose Returns the number of bytes required to store the NonStop Kernel representation of the data. Syntax public abstract int getHostLength() HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 45
  • Java Import Package Reference Class ScobolType Return Value Returns the number of bytes required to represent the data item in the NonStop Kernel. Method getHostValue Purpose Returns the NonStop Kernel representation of the data as a byte array. Syntax public abstract byte [] getHostValue() Description The NonStop Kernel defines the data representation (bit pattern) for representing variables of a given type. The getHostValue() method returns the identical bit pattern, independent of its internal storage representation. In other words, this method implements a mapping from the way data is represented in the class to the way the same data is represented in the NonStop Kernel. Method setHostValue Purpose Updates the value of the object with the given byte array. Syntax public abstract void setHostValue (byte[] data) Description This method provides a mechanism by which the data value corresponding to the NonStop Kernel data representation can be stored. data.length() must be greater than or equal to ScobolType.getHostLength(). After calling setHostValue(data1), if you call data2=getHostValue(), then data1 must be equal to data2. Parameters data Corresponds to the NonStop Kernel byte representation of the data Method isEqualTo (double data) Syntax public boolean isEqualTo (double data) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 46
  • Java Import Package Reference Class ScobolType Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] noninteger-numeric-literal. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise. Method isEqualTo (long data) Syntax public boolean isEqualTo (long data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] integer-numeric-literal. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise. Method isEqualTo (ScobolType data) Syntax public boolean isEqualTo (ScobolType data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] ws-item-2. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 47
  • Java Import Package Reference Class ScobolType Method isEqualTo (String data) Syntax public boolean isEqualTo (String data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] string-literal. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise. Method isEqualToAll Syntax public boolean isEqualToAll (char ch) Description Equivalent to the SCREEN COBOL relation condition value-1 IS [NOT] EQUAL [TO] ALL character-literal, where character-literal represents an alphanumeric character. Parameters ch The character to be compared with the value of this object Return Value Returns TRUE if all the characters in this object are [not] the same as ch, or FALSE otherwise. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 48
  • Java Import Package Reference Class ScobolType Method isGreaterThan (double data) Syntax public boolean isGreaterThan (double data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] noninteger-numeric-literal. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise. Method isGreaterThan (long data) Syntax public boolean isGreaterThan (long data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] integer-numeric-literal. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise. Method isGreaterThan (ScobolType data) Syntax public boolean isGreaterThan (ScobolType data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] ws-item-2. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 49
  • Java Import Package Reference Class ScobolType Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise. Method isGreaterThan (String data) Syntax public boolean isGreaterThan (String data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] string-literal. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise. Method isGreaterThanAll Syntax public boolean isGreaterThanAll (char ch) Description Equivalent to the SCREEN COBOL relation condition value-1 IS [NOT] GREATER [THAN] ALL character-literal, where character-literal represents an alphanumeric character. Parameters ch The character to be compared with the value of this object Return Value Returns TRUE if all the characters in this object have [do not have] ASCII values greater than ch, or FALSE otherwise. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 50
  • Java Import Package Reference Class ScobolType Method isLessThan (double data) Syntax public boolean isLessThan (double data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] noninteger-numeric-literal. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. Method isLessThan (long data) Syntax public boolean isLessThan (long data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] integer-numeric-literal. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. Method isLessThan (ScobolType data) Syntax public boolean isLessThan (ScobolType data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] ws-item-2. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 51
  • Java Import Package Reference Class ScobolType Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. Method isLessThan (String data) Syntax public boolean isLessThan (String data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] string-literal. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. Method isLessThanAll Syntax public boolean isLessThanAll (char ch) Description Equivalent to the SCREEN COBOL relation condition value-1 IS [NOT] LESS [THAN] ALL character-literal, where character-literal represents an alphanumeric character. Parameters ch The character to be compared with the value of this object Return Value Returns TRUE if all the characters in this object have [do not have] ASCII values less than ch, or FALSE otherwise. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 52
  • Java Import Package Reference Class ScobolGroupType Method isValueNumeric Syntax public boolean isValueNumeric() Description Equivalent to the SCREEN COBOL class condition IS [NOT] NUMERIC. Return Value Returns TRUE if the value of this object is [not] numeric, or FALSE otherwise. Class ScobolGroupType Package pathway.its Syntax public abstract pathway.its.ScobolGroupType extends ScobolType Description This abstract class is the super-class for all SCREEN COBOL group data types implemented in Java. This class is extended by all classes that represent the group items in SCREEN COBOL. Member Summary Constructor ScobolGroupType() Abstract Methods getHostLength() Returns the number of bytes required to store the NonStop Kernel representation of the data getHostValue() Returns the NonStop Kernel representation of the data as a byte array setHostValue() Updates the value of the object with the given byte array HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 53
  • Java Import Package Reference Class ScobolGroupType Non-Abstract Methods isValueAlphabetic() Equivalent to the SCREEN COBOL class condition IS [NOT] ALPHABETIC isValueNumeric() Equivalent to the SCREEN COBOL class condition IS [NOT] NUMERIC moveAll() Equivalent to the SCREEN COBOL MOVE ALL statement setHighValues() Equivalent to the SCREEN COBOL MOVE HIGH- VALUES statement setLowValues() Equivalent to the SCREEN COBOL MOVE LOW- VALUES statement setQuotes() Equivalent to the SCREEN COBOL MOVE QUOTES statement setSpaces() Equivalent to the SCREEN COBOL MOVE SPACES statement setValue() Equivalent to the SCREEN COBOL statement MOVE data-name-1 TO group-2 setZeroes() Equivalent to the SCREEN COBOL MOVE ZEROS statement Method Constructor Syntax public ScobolGroupType() Method addScobolData Purpose Adds to the group SCREEN COBOL data objects in a group item. Syntax void addScobolData (ScobolType ScobolDataObject) Description This method is used in the constructor of the group item subclass. It adds the group items to the group. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 54
  • Java Import Package Reference Class ScobolGroupType Parameters ScobolDataObject An object of type ScobolType in the group that that is being added. Example This is an example SCREEN COBOL group data item: 01 CURRENT-TIME. 05 TIME-AT-START PIC 9(8). 05 DATE-AT-START PIC 9(8). 05 TIME-NOW PIC 9(8). The corresponding Java code for this gorup data item is as: class c_CURRENT_TIME extends ScobolGroupType { Pic9 TIME_AT_START; Pic9 DATE_AT_START; Pic9 TIME_NOW; public c_CURRENT_TIME() { TIME_AT_START = new Pic9(8,Pic9.DISPLAY,Pic9.UNSIGNED); addScobolData(TIME_AT_START); DATE_AT_START = new Pic9(8,Pic9.DISPLAY,Pic9.UNSIGNED); addScobolData(DATE_AT_START); TIME_NOW = new Pic9(8,Pic9.DISPLAY,Pic9.UNSIGNED); addScobolData(TIME_NOW); } public int getHostLength() { return(24); } public void setInitValue() { } } c_CURRENT_TIME CURRENT_TIME ; Method getHostLength Purpose Returns the number of bytes required to store the NonStop Kernel representation of the data in the group. Syntax public abstract int getHostLength() Return Value Returns the number of bytes required to represent the data item in the NonStop Kernel. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 55
  • Java Import Package Reference Class ScobolGroupType Method getHostValue Purpose Returns the NonStop Kernel representation of the data as a byte array. Syntax public abstract byte [] getHostValue() Description The NonStop Kernel defines the data representation (bit pattern) for representing variables of a given type. The getHostValue() method returns the identical bit pattern, independent of its internal storage representation. In other words, this method implements a mapping from the way data is represented in the class to the way the same data is represented in the NonStop Kernel. Method setHostValue Purpose Updates the value of the object with the given byte array. Syntax public abstract void setHostValue (byte[] data) Description This method provides a mechanism by which the data value corresponding to the NonStop Kernel data representation can be stored. data.length() must be greater than or equal to ScobolGroupType.getHostLength(). After calling setHostValue(data1), if you call data2=getHostValue(), then data1 must be equal to data2. Parameters data Corresponds to the NonStop Kernel byte representation of the data Method isValueAlphabetic Syntax public boolean isValueAlphabetic() Description Equivalent to the SCREEN COBOL class condition IS [NOT] ALPHABETIC. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 56
  • Java Import Package Reference Class ScobolGroupType Return Value Returns TRUE if the value of this object is [not] alphabetic, or FALSE otherwise. Method isValueNumeric Syntax public boolean isValueNumeric() Description Equivalent to the SCREEN COBOL class condition IS [NOT] NUMERIC. Return Value Returns TRUE if the value of this object is [not] numeric, or FALSE otherwise. Method moveAll Syntax public void moveAll (String s) Description Equivalent to the SCREEN COBOL statement MOVE ALL string-literal TO group-item. Parameters s The string literal to be moved into this object Method setHighValues Syntax public void setHighValues() Description Equivalent to the SCREEN COBOL statement MOVE HIGH-VALUES TO group-item. Method setLowValues Syntax public void setLowValues() HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 57
  • Java Import Package Reference Class ScobolGroupType Description Equivalent to the SCREEN COBOL statement MOVE LOW-VALUES TO group-item. Method setQuotes Syntax public void setQuotes() Description Equivalent to the SCREEN COBOL statement MOVE QUOTES TO group-item. Method setSpaces Syntax public void setSpaces() Description Equivalent to the SCREEN COBOL statement MOVE SPACES TO group-item. Method setValue (double data) Syntax public void setValue (double data) Description Equivalent to the SCREEN COBOL statement MOVE noninteger-numeric- literal TO group-2, where group-2 is this object. Parameters data The data used to set the value of this object Method setValue (long data) Syntax public void setValue (long data) Description Equivalent to the SCREEN COBOL statement MOVE integer-numeric-literal TO group-2, where group-2 is this object. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 58
  • Java Import Package Reference Class ScobolGroupType Parameters data The data used to set the value of this object Method setValue (ScobolType data) Syntax public void setValue (ScobolType data) Description Equivalent to the SCREEN COBOL statement MOVE data-name-1 TO group-2, where data-name-1 is the parameter to this method and group-2 is this object. Parameters data The data used to set the value of this object Method setValue (String data) Syntax public void setValue (String data) Description Equivalent to the SCREEN COBOL statement MOVE string-literal TO group-2, where group-2 is this object. Method setZeroes Syntax public void setZeroes() Description Equivalent to the SCREEN COBOL statement MOVE ZEROS TO ws-item, where ws-item is a group name. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 59
  • Java Import Package Reference Class Pic9 Class Pic9 Package pathway.its Syntax public pathway.its.Pic9 extends ScobolType Description This class is the Java representation of the SCREEN COBOL numeric integer (both computational and display) data types. SCREEN COBOL numeric integer data types are those that are described by the PIC 9 clauses. Member Summary Constructor Pic9() Abstract Method Implementation getHostLength() Returns the number of bytes required to store the NonStop Kernel representation of the data getHostValue() Returns the NonStop Kernel representation of the data as a byte array setHostValue() Updates the value of the object with the given byte array HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 60
  • Java Import Package Reference Class Pic9 Class-Specific Methods getValue() Returns the value in native Java type isEqualTo() Equivalent to the SCREEN COBOL relation condition IS [NOT] EQUAL [TO] isGreaterThan() Equivalent to the SCREEN COBOL relation condition IS [NOT] GREATER [THAN] isLessThan() Equivalent to the SCREEN COBOL relation condition IS [NOT] LESS [THAN] isValueNumeric() Equivalent to the SCREEN COBOL class condition IS [NOT] NUMERIC setValue() Equivalent to the SCREEN COBOL statement MOVE data-name-1 TO data-name-2 setZeroes() Equivalent to the SCREEN COBOL MOVE ZEROS statement Literals COMP DISPLAY SIGNED SIGNLEADING SIGNLEADINGSEPARATE SIGNTRAILING SIGNTRAILINGSEPARATE UNSIGNED Method Constructor (Computational or Display) Syntax public Pic9 (int numDigits, boolean computational, boolean signed) Description This form is used to construct these SCREEN COBOL types: SCREEN COBOL Type Java Type PIC 9(n) COMP new Pic9 (n, Pic9.COMP, Pic9.UNSIGNED) PIC S9(n) COMP new Pic9 (n, Pic9.COMP, Pic9.SIGNED) PIC 9(n) new Pic9 (n, Pic9.DISPLAY, Pic9.UNSIGNED) PIC S9(n) new Pic9 (n, Pic9.DISPLAY, Pic9.SIGNED) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 61
  • Java Import Package Reference Class Pic9 Parameters numDigits The number of digits in the integer; must be between 1 and 18, inclusive computational Must be either Pic9.COMP or Pic9.DISPLAY signed Must be either Pic9.SIGNED or Pic9.UNSIGNED Method Constructor (Sign Leading or Trailing) Syntax public Pic9 (int numDigits, int signFlag) Description This form is used to construct these SCREEN COBOL types: SCREEN COBOL Type Java Type PIC S9(n) sign lead new Pic9 (n, Pic9.SIGNLEADING) PIC S9(n) sign trail new Pic9 (n, Pic9.SIGNTRAILING) PIC S9(n) sign lead separate new Pic9 (n, Pic9.SIGNLEADINGSEPARATE) PIC S9(n) sign trail separate new Pic9 (n, Pic9.SIGNTRAILINGSEPARATE) Parameters numDigits The number of digits in the integer; must be between 1 and 18, inclusive signFlag Must be one of Pic9.SIGNLEADING, Pic9.SIGNTRAILING, Pic9.SIGNLEADINGSEPARATE, or Pic9.SIGNTRAILINGSEPARATE Method getHostLength Purpose Returns the number of bytes required to store the NonStop Kernel representation of the data. Syntax public int getHostLength() HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 62
  • Java Import Package Reference Class Pic9 Return Value Returns the number of bytes required to represent the equivalent SCREEN COBOL data item in the NonStop Kernel. Method getHostValue Purpose Returns the NonStop Kernel representation of the data as a byte array. Syntax public byte [] getHostValue() Description The byte array does not necessarily represent an actual numeric item. Any arbitrary byte pattern can be stored in this object with the setHostValue() method. However, if setValue(long data) is used to set this object, the byte array will be a replica of the byte array used to represent the same numeric value in the NonStop Kernel. The length of the returned byte array will be the same as that returned by getHostLength(). Return Value Returns the byte array used to represent the numeric value in the NonStop Kernel. Method setHostValue Purpose Updates the value of the object with the given byte array. Syntax public void setHostValue (byte[] data) Description This method is used to store a byte pattern in this object. Whether the byte array represents a valid numeric value is not verified. (In SCREEN COBOL, a numeric variable can hold nonnumeric data if the variable is part of a group and the group is the target of a group move.) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 63
  • Java Import Package Reference Class Pic9 Parameters data The byte array whose contents will be the new value of this object. The length of the array must be greater than or equal to getHostLength(). Method getValue Syntax public long getValue() Description If the object is non-computational, the byte contents must be ASCII 0 through ASCII 9 (except for the sign byte). Return Value Returns the numeric value stored in the object. Method isEqualTo (double data) Syntax public boolean isEqualTo (double data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] noninteger-numeric-literal, where ws-item-1 is a PIC 9 identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise. Method isEqualTo (long data) Syntax public boolean isEqualTo (long data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] integer-numeric-literal, where ws-item-1 is a PIC 9 identifier. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 64
  • Java Import Package Reference Class Pic9 Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise. Method isEqualTo (ScobolType data) Syntax public boolean isEqualTo (ScobolType data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] ws-item-2, where ws-item-1 is a PIC 9 identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise. Method isEqualTo (String data) Syntax public boolean isEqualTo (String data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] string-literal, where ws-item-1 is a PIC 9 identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 65
  • Java Import Package Reference Class Pic9 Method isGreaterThan (double data) Syntax public boolean isGreaterThan (double data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] noninteger-numeric-literal, where ws-item-1 is a PIC 9 identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise. Method isGreaterThan (long data) Syntax public boolean isGreaterThan (long data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] integer-numeric-literal, where ws-item-1 is a PIC 9 identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise. Method isGreaterThan (ScobolType data) Syntax public boolean isGreaterThan (ScobolType data) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 66
  • Java Import Package Reference Class Pic9 Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] ws-item-2, where ws-item-1 is a PIC 9 identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise. Method isGreaterThan (String data) Syntax public boolean isGreaterThan (String data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] string-literal, where ws-item-1 is a PIC 9 identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise. Method isLessThan (double data) Syntax public boolean isLessThan (double data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] noninteger-numeric-literal, where ws-item-1 is a PIC 9 identifier. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 67
  • Java Import Package Reference Class Pic9 Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. Method isLessThan (long data) Syntax public boolean isLessThan (long data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] integer-numeric-literal, where ws-item-1 is a PIC 9 identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. Method isLessThan (ScobolType data) Syntax public boolean isLessThan (ScobolType data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] ws-item-2, where ws-item-1 is a PIC 9 identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. Method isLessThan (String data) Syntax public boolean isLessThan (String data) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 68
  • Java Import Package Reference Class Pic9 Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] string-literal, where ws-item-1 is a PIC 9 identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. Method isValueNumeric Syntax public boolean isValueNumeric() Description Equivalent to the SCREEN COBOL class condition IS [NOT] NUMERIC. Return Value Returns TRUE if the value of this object is [not] numeric, or FALSE otherwise. Method setValue (double data) Syntax public void setValue (double data) Description Equivalent to the SCREEN COBOL statement MOVE noninteger-numeric- literal TO ws-item, where ws-item is a PIC 9 identifier. Parameters data The data used to set the value of this object Method setValue (long data) Syntax public void setValue (long data) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 69
  • Java Import Package Reference Class Pic9 Description Equivalent to the SCREEN COBOL statement MOVE integer-numeric-literal TO ws-item, where ws-item is a PIC 9 identifier. Parameters data The data used to set the value of this object Method setValue (Pic9 data) Syntax public void setValue (Pic9 data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-item- dest, where both ws-item-src and ws-item-dest are PIC 9 identifiers. Parameters data The data used to set the value of this object Method setValue (Pic9P data) Syntax public void setValue (Pic9P data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-item- dest, where ws-item-src is a PIC 9P identifier and ws-item-dest is a PIC 9 identifier. Parameters data The data used to set the value of this object Method setValue (Pic9V data) Syntax public void setValue (Pic9V data) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 70
  • Java Import Package Reference Class Pic9 Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-item- dest, where ws-item-src is a PIC 9V identifier and ws-item-dest is a PIC 9 identifier. Parameters data The data used to set the value of this object Method setValue (PicX data) Syntax public void setValue (PicX data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-item- dest, where ws-item-src is a PIC X identifier and ws-item-dest is a PIC 9 identifier. Parameters data The data used to set the value of this object Method setValue (ScobolGroupType data) Syntax public void setValue (ScobolGroupType data) Description Equivalent to the SCREEN COBOL statement MOVE ws-group-item TO ws- item-dest, where ws-group-item is a group item identifier and ws-item-dest is a PIC 9 identifier. Parameters data The data used to set the value of this object Method setValue (String data) Syntax public void setValue (String data) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 71
  • Java Import Package Reference Class Pic9P Description Equivalent to the SCREEN COBOL statement MOVE string-numeric-literal TO ws-item, where ws-item is a PIC 9 identifier. Parameters data The data used to set the value of this object Method setZeroes Syntax public void setZeroes() Description Equivalent to the SCREEN COBOL statement MOVE ZEROS TO data-name-1, where data-name-1 is this object. Class Pic9P Package pathway.its Syntax public pathway.its.Pic9P extends ScobolType Description This class is the Java representation of the SCREEN COBOL numeric (both computational and display) data types having the P character-string symbol. Member Summary Constructor Pic9P() HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 72
  • Java Import Package Reference Class Pic9P Abstract Method Implementation getHostLength() Returns the number of bytes required to store the NonStop Kernel representation of the data getHostValue() Returns the NonStop Kernel representation of the data as a byte array setHostValue() Updates the value of the object with the given byte array Class-Specific Methods getValue() Returns the value in native Java type isEqualTo() Equivalent to the SCREEN COBOL relation condition IS [NOT] EQUAL [TO] isGreaterThan() Equivalent to the SCREEN COBOL relation condition IS [NOT] GREATER [THAN] isLessThan() Equivalent to the SCREEN COBOL relation condition IS [NOT] LESS [THAN] isValueNumeric() Equivalent to the SCREEN COBOL class condition IS [NOT] NUMERIC setValue() Equivalent to the SCREEN COBOL statement MOVE data-name-1 TO data-name-2 setZeroes() Equivalent to the SCREEN COBOL MOVE ZEROS statement Literals COMP DISPLAY SIGNED SIGNLEADING SIGNLEADINGSEPARATE SIGNTRAILING SIGNTRAILINGSEPARATE UNSIGNED Method Constructor (Computational or Display) Syntax public Pic9P (int numDigits, int scalingFactor, boolean computational, boolean signed) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 73
  • Java Import Package Reference Class Pic9P Description This form is used to construct these SCREEN COBOL types: SCREEN COBOL Type Java Type PIC 9(m)P(n) COMP new Pic9P (m, n, Pic9P.COMP, Pic9P.UNSIGNED) PIC S9(m)P(n) COMP new Pic9P (m, n, Pic9P.COMP, Pic9P.SIGNED) PIC 9(m)P(n) new Pic9P (m, n, Pic9P.DISPLAY, Pic9P.UNSIGNED) PIC S9(m)P(n) new Pic9P (m, n, Pic9P.DISPLAY, Pic9P.SIGNED) PIC P(n)9(m) COMP new Pic9P (m, -(m+n), Pic9P.COMP, Pic9P.UNSIGNED) PIC SP(n)9(m) COMP new Pic9P (m, -(m+n), Pic9P.COMP, Pic9P.SIGNED) PIC P(n)9(m) new Pic9P (m, -(m+n), Pic9P.DISPLAY, Pic9P.UNSIGNED) PIC SP(n)9(m) new Pic9P (m, -(m+n), Pic9P.DISPLAY, Pic9P.SIGNED) Parameters numDigits The number of digits in the integer; must be between 1 and 16, inclusive scalingFactor Indicates scaling of digits; must be between -16 and 15, inclusive; the sum of numDigits and scalingFactor must be between -15 and 16, inclusive computational Must be either PicP9.COMP or PicP.DISPLAY signed Must be either Pic9P.SIGNED or Pic9P.UNSIGNED Method Constructor (Sign Leading or Trailing) Syntax public Pic9P (int numDigits, int scalingFactor, int signFlag) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 74
  • Java Import Package Reference Class Pic9P Description This form is used to construct these SCREEN COBOL types: SCREEN COBOL Type Java Type PIC S9(m)P(n) sign lead new Pic9P (m, n, Pic9P.SIGNLEADING) PIC S9(m)P(n) sign trail new Pic9P (m, n, Pic9P.SIGNTRAILING) PIC S9(m)P(n) sign lead new Pic9P (m, n, separate Pic9P.SIGNLEADINGSEPARATE) PIC S9(m)P(n) sign trail new Pic9P (m, n, separate Pic9P.SIGNTRAILINGSEPARATE) PIC SP(n)9(m) sign lead new Pic9P (m, -(m+n), Pic9P.SIGNLEADING) PIC SP(n)9(m) sign trail new Pic9P (m, -(m+n), Pic9P.SIGNTRAILING) PIC SP(n)9(m) sign lead new Pic9P (m, -(m+n), separate Pic9P.SIGNLEADINGSEPARATE) PIC SP(n)9(m) sign trail new Pic9P (m, -(m+n), separate Pic9P.SIGNTRAILINGSEPARATE) Parameters numDigits The number of digits in the integer; must be between 1 and 16, inclusive scalingFactor Indicates scaling of digits; must be between -16 and 15, inclusive; the sum of numDigits and scalingFactor must be between -15 and 16, inclusive signFlag Must be one of PicP.SIGNLEADING, Pic9P.SIGNTRAILING, PicP.SIGNLEADINGSEPARATE, or PicP.SIGNTRAILINGSEPARATE Method getHostLength Purpose Returns the number of bytes required to store the NonStop Kernel representation of the data. Syntax public int getHostLength() Return Value Returns the number of bytes required to represent the equivalent SCREEN COBOL data item in the NonStop Kernel. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 75
  • Java Import Package Reference Class Pic9P Method getHostValue Purpose Returns the NonStop Kernel representation of the data as a byte array. Syntax public byte [] getHostValue() Description The byte array does not necessarily represent an actual numeric item. Any arbitrary byte pattern can be stored in this object with the setHostValue() method. However, if setValue(double data) is used to set this object, the byte array will be a replica of the byte array used to represent the same numeric value in the NonStop Kernel. The length of the returned byte array will be the same as that returned by getHostLength(). Return Value Returns the byte array used to represent the numeric value in the NonStop Kernel. Method setHostValue Purpose Updates the value of the object with the given byte array. Syntax public void setHostValue (byte[] data) Description This method is used to store a byte pattern in this object. Whether the byte array represents a valid numeric value is not verified. (In SCREEN COBOL, a numeric variable can hold nonnumeric data if the variable is part of a group and the group is the target of a group move.) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 76
  • Java Import Package Reference Class Pic9P Parameters data The byte array whose contents will be the new value of this object. The length of the array must be greater than or equal to getHostLength(). Method getValue Syntax public double getValue() Description If the object is non-computational, the byte contents must be ASCII 0 through ASCII 9 (except for the sign byte). Return Value Returns the numeric value stored in the object. Method isEqualTo (double data) Syntax public boolean isEqualTo (double data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] noninteger-numeric-literal, where ws-item-1 is a PIC 9P identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise. Method isEqualTo (long data) Syntax public boolean isEqualTo (long data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] integer-numeric-literal, where ws-item-1 is a PIC 9P identifier. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 77
  • Java Import Package Reference Class Pic9P Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise. Method isEqualTo (ScobolType data) Syntax public boolean isEqualTo (ScobolType data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] ws-item-2, where ws-item-1 is a PIC 9P identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise. Method isEqualTo (String data) Syntax public boolean isEqualTo (String data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] string-literal, where ws-item-1 is a PIC 9P identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise. Method isGreaterThan (double data) Syntax public boolean isGreaterThan (double data) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 78
  • Java Import Package Reference Class Pic9P Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] noninteger-numeric-literal, where ws-item-1 is a PIC 9P identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise. Method isGreaterThan (long data) Syntax public boolean isGreaterThan (long data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] integer-numeric-literal, where ws-item-1 is a PIC 9P identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise. Method isGreaterThan (ScobolType data) Syntax public boolean isGreaterThan (ScobolType data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] ws-item-2, where ws-item-1 is a PIC 9P identifier. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 79
  • Java Import Package Reference Class Pic9P Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise. Method isGreaterThan (String data) Syntax public boolean isGreaterThan (String data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] string-literal, where ws-item-1 is a PIC 9P identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise. Method isLessThan (double data) Syntax public boolean isLessThan (double data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] noninteger-numeric-literal, where ws-item-1 is a PIC 9P identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 80
  • Java Import Package Reference Class Pic9P Method isLessThan (long data) Syntax public boolean isLessThan (long data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] integer-numeric-literal, where ws-item-1 is a PIC 9P identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. Method isLessThan (ScobolType data) Syntax public boolean isLessThan (ScobolType data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] ws-item-2, where ws-item-1 is a PIC 9P identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. Method isLessThan (String data) Syntax public boolean isLessThan (String data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] string-literal, where ws-item-1 is a PIC 9P identifier. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 81
  • Java Import Package Reference Class Pic9P Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. Method isValueNumeric Syntax public boolean isValueNumeric() Description Equivalent to the SCREEN COBOL class condition IS [NOT] NUMERIC. Return Value Returns TRUE if the value of this object is [not] numeric, or FALSE otherwise. Method setValue (double data) Syntax public void setValue (double data) Description Equivalent to the SCREEN COBOL statement MOVE noninteger-numeric- literal TO ws-item, where ws-item is a PIC 9P identifier. Parameters data The data used to set the value of this object Method setValue (Pic9 data) Syntax public void setValue (Pic9 data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-item- dest, where ws-item-src is a PIC9 identifier and ws-item-dest is a PIC 9P identifier. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 82
  • Java Import Package Reference Class Pic9P Parameters data The data used to set the value of this object Method setValue (Pic9P data) Syntax public void setValue (Pic9P data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-item- dest, where both ws-item-src and ws-item-dest are PIC 9P identifiers. Parameters data The data used to set the value of this object Method setValue (Pic9V data) Syntax public void setValue (Pic9V data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-item- dest, where ws-item-src is a PIC 9V identifier and ws-item-dest is a PIC 9P identifier. Parameters data The data used to set the value of this object Method setValue (PicX data) Syntax public void setValue (PicX data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-item- dest, where ws-item-src is a PIC X identifier and ws-item-dest is a PIC 9P identifier. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 83
  • Java Import Package Reference Class Pic9V Parameters data The data used to set the value of this object Method setValue (String data) Syntax public void setValue (String data) Description Equivalent to the SCREEN COBOL statement MOVE string-literal TO ws-item, where ws-item is a PIC 9P identifier. Parameters data The data used to set the value of this object Method setZeroes Syntax public void setZeroes() Description Equivalent to the SCREEN COBOL statement MOVE ZEROS TO data-name-1, where data-name-1 is this object. Class Pic9V Package pathway.its Syntax public pathway.its.Pic9V extends ScobolType Description This class is the Java representation of the SCREEN COBOL numeric real data types (both computational and display). SCREEN COBOL numeric real data types are those that are described by the PIC 9V clauses. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 84
  • Java Import Package Reference Class Pic9V Member Summary Constructor Pic9V() Abstract Method Implementation getHostLength() Returns the number of bytes required to store the NonStop Kernel representation of the data getHostValue() Returns the NonStop Kernel representation of the data as a byte array setHostValue() Updates the value of the object with the given byte array Class-Specific Methods getValue() Returns the value in native Java type isEqualTo() Equivalent to the SCREEN COBOL relation condition IS [NOT] EQUAL [TO] isGreaterThan() Equivalent to the SCREEN COBOL relation condition IS [NOT] GREATER [THAN] isLessThan() Equivalent to the SCREEN COBOL relation condition IS [NOT] LESS [THAN] isValueNumeric() Equivalent to the SCREEN COBOL class condition IS [NOT] NUMERIC setValue() Equivalent to the statement MOVE data-name-1 TO data-name-2 setZeroes() Equivalent to the SCREEN COBOL MOVE ZEROS statement Literals COMP DISPLAY SIGNED SIGNLEADING SIGNLEADINGSEPARATE SIGNTRAILING SIGNTRAILINGSEPARATE UNSIGNED HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 85
  • Java Import Package Reference Class Pic9V Method Constructor (Signed or Unsigned) Syntax public Pic9V (int numIntegerDigits, int numFractionDigits, boolean computational, boolean signed) Description This form is used to construct these SCREEN COBOL types: SCREEN COBOL Type Java Type PIC 9(m)V9(n) COMP new Pic9V (m, n, Pic9V.COMP, Pic9V.UNSIGNED) PIC S9(m)V9(n) COMP new Pic9V (m, n, Pic9V.COMP, Pic9V.SIGNED) PIC 9(m)V9(n) new Pic9V (m, n, Pic9V.DISPLAY, Pic9V.UNSIGNED) PIC S9(m)V9(n) new Pic9V (m, n, Pic9V.DISPLAY, Pic9V.SIGNED) Parameters numIntegerDigits The number of digits in the integer portion of the number; must be between 0 and 16, inclusive numFractionDigits The number of digits in the fractional portion of the number; must be between 0 and 16, inclusive; the sum of numIntegerDigits and numFractionDigits must be between 1 and 16, inclusive computational Must be either Pic9V.COMP or Pic9V.DISPLAY signed Must be either Pic9V.SIGNED or Pic9V.UNSIGNED Method Constructor (Sign Leading or Trailing) Syntax public Pic9V (int numIntegerDigits, int numFractionDigits, int signFlag) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 86
  • Java Import Package Reference Class Pic9V Description This form is used to construct these SCREEN COBOL types: SCREEN COBOL Type Java Type PIC S9(m)V9(n) sign lead new Pic9V (m, n, Pic9V.SIGNLEADING) PIC S9(m)V9(n) sign trail new Pic9V (m, n, Pic9V.SIGNTRAILING) PIC S9(m)V9(n) sign lead new Pic9V (m, n, separate Pic9V.SIGNLEADINGSEPARATE) PIC S9(m)V9(n) sign trail new Pic9V (m, n, separate Pic9V.SIGNTRAILINGSEPARATE) Parameters numIntegerDigits The number of digits in the integer portion of the number; must be between 0 and 16, inclusive numFractionDigits The number of digits in the fractional portion of the number; must be between 0 and 16, inclusive; the sum of numIntegerDigits and numFractionDigits must be between 1 and 16, inclusive signFlag Must be one of Pic9V.SIGNLEADING, Pic9V.SIGNTRAILING, Pic9V.SIGNLEADINGSEPARATE, or Pic9V.SIGNTRAILINGSEPARATE Method getHostLength Purpose Returns the number of bytes required to store the NonStop Kernel representation of the data. Syntax public int getHostLength() Return Value Returns the number of bytes required to represent the equivalent SCREEN COBOL data item in the NonStop Kernel. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 87
  • Java Import Package Reference Class Pic9V Method getHostValue Purpose Returns the NonStop Kernel representation of the data as a byte array. Syntax public byte [] getHostValue() Description The byte array does not necessarily represent an actual numeric item. Any arbitrary byte pattern can be stored in this object with the setHostValue() method. However, if setValue(double data) is used to set this object, the byte array will be a replica of the byte array used to represent the same numeric value in the NonStop Kernel. The length of the returned byte array will be the same as that returned by getHostLength(). Return Value Returns the byte array used to represent the numeric value in the NonStop Kernel. Method setHostValue Purpose Updates the value of the object with the given byte array. Syntax public void setHostValue (byte[] data) Description This method is used to store a byte pattern in this object. Whether the byte array represents a valid numeric value is not verified. (In SCREEN COBOL, a numeric variable can hold nonnumeric data if the variable is part of a group and the group is the target of a group move.) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 88
  • Java Import Package Reference Class Pic9V Parameters data The byte array whose contents will be the new value of this object. The length of the array must be greater than or equal to getHostLength(). Method getValue Syntax public double getValue() Description If the object is non-computational, the byte contents must be ASCII 0 through ASCII 9 (except for the sign byte). Return Value Returns the numeric value stored in the object. Method isEqualTo (double data) Syntax public boolean isEqualTo (double data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] noninteger-numeric-literal, where ws-item-1 is a PIC 9V identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise. Method isEqualTo (long data) Syntax public boolean isEqualTo (long data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] integer-numeric-literal, where ws-item-1 is a PIC 9V identifier. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 89
  • Java Import Package Reference Class Pic9V Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise. Method isEqualTo (ScobolType data) Syntax public boolean isEqualTo (ScobolType data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] ws-item-2, where ws-item-1 is a PIC 9V identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise. Method isEqualTo (String data) Syntax public boolean isEqualTo (String data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] string-literal, where ws-item-1 is a PIC 9V identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise. Method isGreaterThan (double data) Syntax public boolean isGreaterThan (double data) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 90
  • Java Import Package Reference Class Pic9V Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] noninteger-numeric-literal, where ws-item-1 is a PIC 9V identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise. Method isGreaterThan (long data) Syntax public boolean isGreaterThan (long data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] integer-numeric-literal, where ws-item-1 is a PIC 9V identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise. Method isGreaterThan (ScobolType data) Syntax public boolean isGreaterThan (ScobolType data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] ws-item-2, where ws-item-1 is a PIC 9V identifier. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 91
  • Java Import Package Reference Class Pic9V Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise. Method isGreaterThan (String data) Syntax public boolean isGreaterThan (String data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] string-literal, where ws-item-1 is a PIC 9V identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise. Method isLessThan (double data) Syntax public boolean isLessThan (double data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] noninteger-numeric-literal, where ws-item-1 is a PIC 9V identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 92
  • Java Import Package Reference Class Pic9V Method isLessThan (long data) Syntax public boolean isLessThan (long data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] integer-numeric-literal, where ws-item-1 is a PIC 9V identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. Method isLessThan (ScobolType data) Syntax public boolean isLessThan (ScobolType data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] ws-item-2, where ws-item-1 is a PIC 9V identifier. Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. Method isLessThan (String data) Syntax public boolean isLessThan (String data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] string-literal, where ws-item-1 is a PIC 9V identifier. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 93
  • Java Import Package Reference Class Pic9V Parameters data The value to be compared with the value of this object Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. Method isValueNumeric Syntax public boolean isValueNumeric() Description Equivalent to the SCREEN COBOL class condition IS [NOT] NUMERIC. Return Value Returns TRUE if the value of this object is [not] numeric, or FALSE otherwise. Method setValue (double data) Syntax public void setValue (double data) Description Equivalent to the SCREEN COBOL statement MOVE noninteger-numeric- literal TO ws-item, where ws-item is a PIC 9V identifier. Parameters data The data used to set the value of this object Method setValue (Pic9 data) Syntax public void setValue (Pic9 data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-item- dest, where ws-item-src is a PIC 9 identifier and ws-item-dest is a PIC 9V identifier. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 94
  • Java Import Package Reference Class Pic9V Parameters data The data used to set the value of this object Method setValue (Pic9P data) Syntax public void setValue (Pic9P data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-item- dest, where ws-item-src is a PIC 9P identifier and ws-item-dest is a PIC 9V identifier. Parameters data The data used to set the value of this object Method setValue (Pic9V data) Syntax public void setValue (Pic9V data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-item- dest, where both ws-item-src and ws-item-dest are PIC 9V identifiers. Parameters data The data used to set the value of this object Method setValue (PicX data) Syntax public void setValue(PicX data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-item- dest, where ws-item-src is a PIC X identifier and ws-item-dest is a PIC 9V identifier. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 95
  • Java Import Package Reference Class Pic9V Parameters data The data used to set the value of this object Method setValue (ScobolGroupType data) Syntax public void setValue (ScobolGroupType data) Description Equivalent to the SCREEN COBOL statement MOVE ws-group-item TO ws-item-dest, where ws-group-item is a group item identifier and ws-item-dest is a PIC 9V identifier. Parameters data The data used to set the value of this object Method setValue (String data) Syntax public void setValue (String data) Description Equivalent to the SCREEN COBOL statement MOVE string-literal TO ws-item, where ws-item is a PIC 9V identifier. Parameters data The data used to set the value of this object Method setZeroes Syntax public void setZeroes() Description Equivalent to the SCREEN COBOL statement MOVE ZEROS TO data-name-1, where data-name-1 is this object. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 96
  • Java Import Package Reference Class PicN Class PicN Package pathway.its Syntax public pathway.its.PicN extends ScobolType Description This class is the Java representation of the SCREEN COBOL double-byte data types; that is, those that are described by the PIC N clause. Member Summary Constructor PicN() Abstract Method Implementation getHostLength() Returns the number of bytes required to store the NonStop Kernel representation of the data getHostValue() Returns the NonStop Kernel representation of the data as a byte array setHostValue() Updates the value of the object with the given byte array HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 97
  • Java Import Package Reference Class PicN Class-Specific Methods getValue() Returns the value in native Java type isDoubleByte() Equivalent to the SCREEN COBOL clause IS [NOT] DOUBLEBYTE in the IF ... DOUBLEBYTE statement moveAll() Equivalent to the SCREEN COBOL MOVE ALL statement setSpaces() Equivalent to the SCREEN COBOL MOVE SPACES statement setValue() Equivalent to the statement MOVE data-name-1 TO data-name-2 Literals LEFTJUSTIFIED RIGHTJUSTIFIED Method Constructor Syntax public PicN (int size) Description In this form, data is left-justified. Upon construction, the object will contain blanks. Parameters size The number of double-byte characters this object can hold HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 98
  • Java Import Package Reference Class PicN Method Constructor (Justification Specified) Syntax public PicN (int size, boolean justification) Description Upon construction, the object will contain blanks. Parameters size The number of double-byte characters this object can hold justification Must be either PicN.LEFTJUSTIFIED or PicN.RIGHTJUSTIFIED Method Constructor (Initialized Data, Left-Justified) Syntax public PicN (int size, String data) Description In this form, data is left justified. If the number of characters is less than the specified size, the data will be padded with blanks in accordance with SCREEN COBOL rules. If the number of characters is more than the specified size, the data will be truncated in accordance with SCREEN COBOL rules. Parameters size The number of double-byte characters this object can hold data The initial value for this object Method Constructor (Initialized Data, Justification Specified) Syntax public PicN (int size, boolean justification, String data) Description If the number of characters is less than the specified size, the data will be padded with blanks in accordance with SCREEN COBOL rules. If the number of characters is more than the specified size, the data will be truncated in accordance with SCREEN COBOL rules. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6- 99
  • Java Import Package Reference Class PicN Parameters size The number of double-byte characters this object can hold justification Must be either PicN.LEFTJUSTIFIED or PicN.RIGHTJUSTIFIED data The initial value for this object Method getHostLength Purpose Returns the number of bytes required to store the NonStop Kernel representation of the data. Syntax public int getHostLength() Return Value Returns the number of bytes required to represent the equivalent SCREEN COBOL (PIC N) data item in the NonStop Kernel. This will be double the size with which the data was declared in the SCREEN COBOL program. For example, for a PIC N (10) item, this method will return 20. Method getHostValue Purpose Returns the NonStop Kernel representation of the alphanumeric data as a byte array. Syntax public byte [] getHostValue() Description The length of the returned byte array will be the same as that returned by getHostLength(), which is double the size of the PIC N item. Return Value Returns the byte array used to represent the double-byte value in the NonStop Kernel. This will be a pure byte stream. For example, for PIC N (5), this method will return an array of 10 bytes. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -100
  • Java Import Package Reference Class PicN Method setHostValue Purpose Updates the value of the object with the given byte array. Syntax public void setHostValue (byte[] data) Description This method is used to store a byte pattern in this object. Parameters data The byte array whose contents will be the new value of this object. The length of the array must be greater than or equal to getHostLength(). Method getValue Syntax public String getValue() Return Value Returns the object as a Java string. Method isDoubleByte Syntax public boolean isDoubleByte() Description Equivalent to the SCREEN COBOL clause IS [NOT] DOUBLEBYTE in the statement IF ws-item IS [NOT] DOUBLEBYTE, where ws-item is a PIC N identifier. Return Value Returns TRUE if all the characters in this object are double-byte characters, or FALSE if at least one of them is a single-byte character. If negated, returns FALSE if all the characters in this object are double-byte characters, or TRUE if at least one of them is a single-byte character. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -101
  • Java Import Package Reference Class PicN Method moveAll Syntax public void moveAll (String str) Description Equivalent to the SCREEN COBOL statement MOVE ALL string-literal TO ws-item, where ws-item is a PIC N identifier. Parameters str The string literal to be moved into this object Method setSpaces Syntax public void setSpaces() Description Equivalent to the SCREEN COBOL statement MOVE SPACES TO ws-item, where ws-item is a PIC N identifier. Method setValue (PicN data) Syntax public void setValue (PicN data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-item- dest, where both ws-item-src and ws-item-dest are PIC N identifiers. Parameters data The data used to set the value of this object Method setValue (PicX data) Syntax public void setValue (PicX data) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -102
  • Java Import Package Reference Class PicX Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-item- dest, where ws-item-src is a PIC X identifier and ws-item-dest is a PIC N identifier. The PIC X identifier can contain a combination of double-byte and single- byte characters. Parameters data The data used to set the value of this object Method setValue (ScobolGroupType data) Syntax public void setValue (ScobolGroupType data) Description Equivalent to the SCREEN COBOL statement MOVE ws-group-item TO ws-item-dest, where ws-group-item is a group item identifier and ws-item-dest is a PIC N identifier. Parameters data The data used to set the value of this object Method setValue (String data) Syntax public void setValue (String data) Description Equivalent to the SCREEN COBOL statement MOVE string-literal TO ws-item, where ws-item is a PIC N identifier. Parameters data The data used to set the value of this object Class PicX Package pathway.its HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -103
  • Java Import Package Reference Class PicX Syntax public pathway.its.PicX extends ScobolType Description This class is the Java representation of the SCREEN COBOL alphanumeric data types; that is, those that are described by the PIC X clause. Member Summary Constructor PicX() Abstract Method Implementation getHostLength() Returns the number of bytes required to store the NonStop Kernel representation of the data getHostValue() Returns the NonStop Kernel representation of the data as a byte array setHostValue() Updates the value of the object with the given byte array HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -104
  • Java Import Package Reference Class PicX Class-Specific Methods getValue() Returns the value in native Java type isDoubleByte() Equivalent to the SCREEN COBOL clause IS [NOT] DOUBLEBYTE in the IF ... DOUBLEBYTE statement isValueAlphabetic() Equivalent to the SCREEN COBOL class condition IS [NOT] ALPHABETIC isValueNumeric() Equivalent to the SCREEN COBOL class condition IS [NOT] NUMERIC moveAll() Equivalent to the SCREEN COBOL MOVE ALL statement setHighValues() Equivalent to the SCREEN COBOL MOVE HIGH-VALUES statement setLowValues() Equivalent to the SCREEN COBOL MOVE LOW-VALUES statement setQuotes() Equivalent to the SCREEN COBOL MOVE QUOTES statement setSpaces() Equivalent to the SCREEN COBOL MOVE SPACES statement setValue() Equivalent to the statement MOVE data-name-1 TO data-name-2 setZeroes() Equivalent to the SCREEN COBOL MOVE ZEROS statement Literals LEFTJUSTIFIED RIGHTJUSTIFIED Method Constructor Syntax public PicX (int size) Description In this form, data is left-justified. Upon construction, the object will contain blanks. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -105
  • Java Import Package Reference Class PicX Parameters size The number of characters this object can hold Method Constructor (Justification Specified) Syntax public PicX (int size, boolean justification) Description Upon construction, the object will contain blanks. Parameters size The number of characters this object can hold justification Must be either PicX.LEFTJUSTIFIED or PicX.RIGHTJUSTIFIED Method Constructor (Initialized Data, Left-Justified) Syntax public PicX (int size, String data) Description In this form, data is left justified. If the number of characters is less than the specified size, the data will be padded with blanks in accordance with SCREEN COBOL rules. If the number of characters is more than the specified size, the data will be truncated in accordance with SCREEN COBOL rules. Parameters size The number of characters this object can hold data The initial value for this object Method Constructor (Initialized Data, Justification Specified) Syntax public PicX (int size, boolean justification, String data) Description If the number of characters is less than the specified size, the data will be padded with blanks in accordance with SCREEN COBOL rules. If the number of characters is more HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -106
  • Java Import Package Reference Class PicX than the specified size, the data will be truncated in accordance with SCREEN COBOL rules. Parameters size The number of characters this object can hold justification Must be either PicX.LEFTJUSTIFIED or PicX.RIGHTJUSTIFIED data The initial value for this object Method getHostLength Purpose Returns the number of bytes required to store the NonStop Kernel representation of the data. Syntax public int getHostLength() Return Value Returns the number of bytes required to represent the equivalent SCREEN COBOL data item in the NonStop Kernel. Method getHostValue Purpose Returns the NonStop Kernel representation of the alphanumeric data as a byte array. Syntax public byte [] getHostValue() Description The length of the returned byte array will be the same as that returned by getHostLength(). Return Value Returns the byte array used to represent the alphanumeric value in the NonStop Kernel. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -107
  • Java Import Package Reference Class PicX Method setHostValue Purpose Updates the value of the object with the given byte array. Syntax public void setHostValue (byte[] data) Description This method is used to store a byte pattern in this object. Parameters data The byte array whose contents will be the new value of this object. The length of the array must be greater than or equal to getHostLength(). Method getValue Syntax public String getValue() Return Value Returns the object as a Java string. Method isDoubleByte Syntax public boolean isDoubleByte() Description Equivalent to the SCREEN COBOL clause IS [NOT] DOUBLEBYTE in the statement IF ws-item IS [NOT] DOUBLEBYTE, where ws-item is a PIC X identifier. Return Value Returns TRUE if all the characters in this object are double-byte characters, or FALSE if at least one of them is a single-byte character. If negated, returns FALSE if all the characters in this object are double-byte characters, or TRUE if at least one of them is a single-byte character. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -108
  • Java Import Package Reference Class PicX Method isValueAlphabetic Syntax public boolean isValueAlphabetic() Description Equivalent to the SCREEN COBOL class condition IS [NOT] ALPHABETIC. Return Value Returns TRUE if the value of this object is [not] alphabetic, or FALSE otherwise. Method isValueNumeric Syntax public boolean isValueNumeric() Description Equivalent to the SCREEN COBOL class condition IS [NOT] NUMERIC. Return Value Returns TRUE if the value of this object is [not] numeric, or FALSE otherwise. Method moveAll Syntax public void moveAll (String s) Description Equivalent to the SCREEN COBOL statement MOVE ALL string-literal TO ws-item, where ws-item is a PIC X identifier. Parameters s The string literal to be moved into this object Method setHighValues Syntax public void setHighValues() HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -109
  • Java Import Package Reference Class PicX Description Equivalent to the SCREEN COBOL statement MOVE HIGH-VALUES TO ws-item, where ws-item is a PIC X identifier. Method setLowValues Syntax public void setLowValues() Description Equivalent to the SCREEN COBOL statement MOVE LOW-VALUES TO ws-item, where ws-item is a PIC X identifier. Method setQuotes Syntax public void setQuotes() Description Equivalent to the SCREEN COBOL statement MOVE QUOTES TO ws-item, where ws-item is a PIC X identifier. Method setSpaces Syntax public void setSpaces() Description Equivalent to the SCREEN COBOL statement MOVE SPACES TO ws-item, where ws-item is a PIC X identifier. Method setValue (double data) Syntax public void setValue (double data) Description Equivalent to the SCREEN COBOL statement MOVE noninteger-literal TO ws-item, where ws-item is a PIC X identifier. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -110
  • Java Import Package Reference Class PicX Parameters data The data used to set the value of this object Method setValue (long data) Syntax public void setValue (long data) Description Equivalent to the SCREEN COBOL statement MOVE integer-literal TO ws-item, where ws-item is a PIC X identifier. Parameters data The data used to set the value of this object Method setValue (Pic9 data) Syntax public void setValue (Pic9 data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-item- dest, where ws-item-src is a PIC 9 identifier and ws-item-dest is a PIC X identifier. Parameters data The data used to set the value of this object Method setValue (Pic9P data) Syntax public void setValue (Pic9P data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-item- dest, where ws-item-src is a PIC 9P identifier and ws-item-dest is a PIC X identifier. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -111
  • Java Import Package Reference Class PicX Parameters data The data used to set the value of this object Method setValue (Pic9V data) Syntax public void setValue (Pic9V data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-item- dest, where ws-item-src is a PIC 9V identifier and ws-item-dest is a PIC X identifier. Parameters data The data used to set the value of this object Method setValue (PicX data) Syntax public void setValue (PicX data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-item- dest, where both ws-item-src and ws-item-dest are PIC X identifiers. Parameters data The data used to set the value of this object Method setValue (ScobolGroupType data) Syntax public void setValue (ScobolGroupType data) Description Equivalent to the SCREEN COBOL statement MOVE ws-group-item TO ws-item-dest, where ws-group-item is a group item identifier and ws-item-dest is a PIC X identifier. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -112
  • Java Import Package Reference Transform Class Parameters data The data used to set the value of this object Method setValue (String data) Syntax public void setValue (String data) Description Equivalent to the SCREEN COBOL statement MOVE string-literal TO ws-item, where ws-item is a PIC X identifier. Parameters data The data used to set the value of this object Method setZeroes Syntax public void setZeroes() Description Equivalent to the SCREEN COBOL statement MOVE ZEROS TO ws-item, where ws-item is a PIC X identifier. Transform Class The Transform class implements the SCREEN COBOL TRANSFORM statement. Class Transform Package pathway.its Syntax public pathway.its.Transform Description This class implements the SCREEN COBOL TRANSFORM statement. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -113
  • Java Import Package Reference Class Transform Member Summary Constructor Transform() Methods doTransform() Implements the TRANSFORM statement yields() Equivalent to the YIELDS clause of the TRANSFORM statement Method Constructor (no select code field) Syntax public Transform (ScobolType[] inRec) Description This form instantiates an object to implement a TRANSFORM statement without the SELECT CODE FIELD [IS] clause. Parameters inRec An array of ScobolType objects, each of which corresponds to a working-storage item specified in trans-rec-out in the TRANSFORM statement Method Constructor (with select code field) Syntax public Transform (ScobolType[] inRec, ScobolType selectCode, int offset) Description This form instantiates an object to implement a TRANSFORM statement with the SELECT CODE FIELD [IS] clause. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -114
  • Java Import Package Reference Class Transform Parameters inRec An array of ScobolType objects, each of which corresponds to a working-storage item specified in trans-rec-out in the TRANSFORM statement selectCode The ScobolType object corresponding to the working-storage item specified in the SELECT CODE FIELD [IS] clause in the TRANSFORM statement offset Indicates the position of the selectCode value within trans-rec-out in the TRANSFORM statement Method doTransform Syntax public void doTransform() throws TransformException Description Implements the SCREEN COBOL statement TRANSFORM. This method must be preceded by one or more calls to the yields() method. Method yields (no select code) Syntax public void yields (ScobolType[] outRec) Description This form is equivalent to the YIELDS trans-rec-in clause of the SCREEN COBOL TRANSFORM statement. It instantiates a Pic9 object as the code-field. Parameters outRec An array of ScobolType objects, each one corresponding to a trans-rec-in value in the YIELDS clause Method yields (select code with integer value) Syntax public void yields (int selectCode, ScobolType[] outRec) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -115
  • Java Import Package Reference Class Transform Description This form is equivalent to this clause of the SCREEN COBOL TRANSFORM statement: [SELECT CODE FIELD [IS] code-field] CODE select-code YIELDS trans-rec-in where the select-code value is specified as an integer depending on the business logic. This form instantiates a Pic9 object as the code-field. This method is called once for each select-code value in the YIELDS clause. Parameters selectCode The select-code value in the YIELDS clause, specified as an integer outRec An array of ScobolType objects, each one corresponding to a trans-rec-in value in the YIELDS clause Method yields (select code with string value) Syntax public void yields (String selectCode, ScobolType[] outRec) Description This form is equivalent to this clause of the SCREEN COBOL TRANSFORM statement: [SELECT CODE FIELD [IS] code-field] CODE select-code YIELDS trans-rec-in where the select-code value is specified as a string literal depending on the business logic. This form instantiates a PicX object as the code-field. This method is called once for each select-code value in the YIELDS clause. Parameters selectCode The select-code value in the YIELDS clause, specified as a string literal outRec An array of ScobolType objects, each one corresponding to a trans-rec-in value in the YIELDS clause Method yields (select code with working-storage value) Syntax public void yields (ScobolType selectCode, ScobolType[] outRec) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -116
  • Java Import Package Reference ProgramUnit Class Description This form is equivalent to this clause of the SCREEN COBOL TRANSFORM statement: [SELECT CODE FIELD [IS] code-field] CODE select-code YIELDS trans-rec-in where the select-code value is specified as a working-storage item. This form instantiates a ScobolType object as the code-field. This method is called once for each select-code value in the YIELDS clause. Parameters selectCode The select-code value in the YIELDS clause, specified as a working-storage item outRec An array of ScobolType objects, each one corresponding to a trans-rec-in value in the YIELDS clause ProgramUnit Class The ProgramUnit class provides methods to perform actions that apply to a program unit. Class ProgramUnit Package pathway.its Syntax public abstract pathway.its.ProgramUnit Description This abstract class provides methods for these actions: • Setting the currency and decimal point symbols • Exiting and stopping a program • Obtaining a handle to an instance of the OverlayManager class The Java representation of each SCREEN COBOL program unit must extend this class. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -117
  • Java Import Package Reference Class ProgramUnit Member Summary Data Members public static final char Represents the character ',' COMMA public PicX Equivalent to the DIAGNOSTIC-ALLOWED diagnosticAllowed special register public static final char Represents the character '.' PERIOD public PicX tellAllowed Equivalent to the TELL-ALLOWED special register Constructor ProgramUnit() Methods exitProgram() Equivalent to the EXIT PROGRAM statement getNewOverlayManager() Returns a handle to an OverlayManager object setCurrencySign() Equivalent to the CURRENCY[ SIGN] IS clause setDecimalPointCharacter() Equivalent to the DECIMAL-POINT IS clause stopRun() Equivalent to the STOP RUN statement Method Constructor Syntax public ProgramUnit() Method exitProgram Syntax public void [] exitProgram() throws ExitProgramException Description Equivalent to the SCREEN COBOL statement EXIT PROGRAM. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -118
  • Java Import Package Reference Class ProgramUnit Method getNewOverlayManager Syntax public OverlayManager getNewOverlayManager (String baseHTMLFileName) Description Obtains a handle to an OverlayManager object that is local to this program unit. Parameters baseHTMLFileName The file name of the HTML page that corresponds to the base screen Return Value Returns a handle to an object of type OverlayManager. Method setCurrencySign Purpose Sets the character to be used as the currency symbol. Syntax public final void [] setCurrencySign (char currencyChar) Description Equivalent to the CURRENCY [SIGN] IS clause in the SPECIAL-NAMES paragraph of a SCREEN COBOL program. Parameters currencyChar The character that is to represent the currency symbol Method setDecimalPointCharacter Purpose Sets the character to be used as the decimal point. Syntax public final void [] setDecimalPointCharacter (char decimalChar) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -119
  • Java Import Package Reference Special-Register Classes Description Equivalent to the DECIMAL-POINT IS clause in the SPECIAL-NAMES paragraph of a SCREEN COBOL program. Parameters decimalChar The character that is to represent the decimal point Method stopRun Syntax public void [] stopRun() throws StopRunException Description Equivalent to the SCREEN COBOL statement STOP RUN. Special-Register Classes The special-register classes define the Java equivalents of the SCREEN COBOL special registers, plus five additional special registers to support user profiles in converted web clients. Class ScobolLib Package pathway.its Syntax public pathway.its.ScobolLib Description This class defines the Java equivalents of all the SCREEN COBOL special registers, plus five additional special registers to support user profiles in converted web clients. It also provides a method to specify the character set. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -120
  • Java Import Package Reference Class ScobolLib Member Summary Data Members public static final int ASCII public static Pic9 dialogInfo public static final int KANJI_KATAKANA public static PicX logicalTerminalName public static Cursor newCursor public static Cursor OldCursor public static PicX pwQueueFkeyTimeout public static PicX pwQueueFkeyUmp public static PicX pwTCPProcessName public static PicX pwTCPSystemName public static PicX pwTerminalErrorOccurred public static PicX pwUnsolicitedMessageQueued public static PicX pwUseNewCursor public static PicX redisplay public static Pic9 restartCounter public static Pic9 stopMode public static PicX terminalFilename public static PicX terminalPrinter public static Pic9 terminationStatus public static Pic9 terminationSubStatus public static PicX transactionId public static PicX userProfile1 public static PicX userProfile2 public static PicX userProfile3 public static PicX userProfile4 public static PicX userProfile5 Constructor None. Methods delay() Equivalent to the SCREEN COBOL DELAY statement setCharSet() Equivalent to the SCREEN COBOL CHARACTER-SET IS statement in the OBJECT-COMPUTER paragraph of the Environment Division Method delay Purpose Delays program execution for a specified period of time. Syntax public static void delay (long delayTime) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -121
  • Java Import Package Reference Class ScobolLib Description Equivalent to the SCREEN COBOL DELAY statement. Parameters delayTime The value to delay, in seconds Method setCharSet Purpose Specifies the character set. Syntax public static void setCharSet (int charSetValue) Description Equivalent to the SCREEN COBOL CHARACTER-SET IS statement in the OBJECT- COMPUTER paragraph of the Environment Division. No special character-set values are required for European-language character sets, as Java takes care of those character sets. Parameters charSetValue Must be either KANJI_KATAKANA or ASCII Method pow Purpose Calculates the result of an exponentiation operation between two items. Use this method only when the result of the operation is intermediate in an arithmetic expression. The number of decimal places in the result is equal to the number of decimal places in the first operand. This method has four types as given below in the Syntax. Syntax public static double pow (ScobolType operand1, ScobolType operand2) public static double pow (ScobolType operand1, double operand2) public static double pow (double operand1, ScobolType operand2) public static double pow (double operand1, double operand2) Description Equivalent to the SCOBOL statement operand1 ** operand2 in an arithmetic expression.. The result of this operation is an intermediate result. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -122
  • Java Import Package Reference Class Cursor Parameters operand1 The first operand in the intermediate operation of exponentiation. operand2 The second operand; an integer. Class Cursor Package pathway.its Syntax public pathway.its.Cursor extends ScobolType Description This abstract class is the Java representation of the SCREEN COBOL special registers NEW-CURSOR and OLD-CURSOR. Member Summary Data Members Pic9 cursorCol Object representation of the field NEW-CURSOR-COL or OLD-CURSOR-COL Pic9 cursorRow Object representation of the field NEW-CURSOR-ROW or OLD-CURSOR-ROW Constructor Cursor() HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -123
  • Java Import Package Reference Class Cursor Abstract Method Implementation getHostLength() Returns the number of bytes required to store the NonStop Kernel representation of the data getHostValue() Returns the NonStop Kernel representation of the data as a byte array setHostValue() Updates the value of the object with the given byte array Class-Specific Methods initialize() Equivalent to the SCREEN COBOL statement MOVE ZEROS to NEW-CURSOR or MOVE ZEROS TO OLD-CURSOR Method Constructor Syntax public Cursor() Method getHostLength Purpose Returns the number of bytes required to store the NonStop Kernel representation of the data. Syntax public int getHostLength() Return Value Returns the number of bytes required to represent the equivalent SCREEN COBOL data item in the NonStop Kernel. Method getHostValue Purpose Returns the NonStop Kernel representation of the data as a byte array. Syntax public byte [] getHostValue() HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -124
  • Java Import Package Reference Class Cursor Description The length of the returned byte array will be the same as that returned by getHostLength(). Return Value Returns the byte array used to represent the numeric value in the NonStop Kernel. Method setHostValue Purpose Updates the value of the object with the given byte array. Syntax public void setHostValue (byte[] data) Description This method is used to store a byte pattern in this object. Parameters data The byte array whose contents will be the new value of this object. The length of the array must be greater than or equal to getHostLength(). Method initialize Purpose Sets the values of the cursorRow and cursorCol objects to zeros. Syntax public void initialize() Description Equivalent to the SCREEN COBOL statement MOVE ZEROS TO NEW-CURSOR or MOVE ZEROS TO OLD-CURSOR. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -125
  • Java Import Package Reference Exception Classes Exception Classes The exception classes provide handling for the Java equivalents of SCREEN COBOL exceptions. Class ExitProgramException Package pathway.its Syntax public pathway.its.ExitProgramException extends RunTimeException Description This class represents the exception that is thrown when an error is encountered during processing of an EXIT PROGRAM statement. Member Summary Constructor ExitProgramException() Method Constructor Syntax public ExitProgramException() Class ScobolException Package pathway.its Syntax public pathway.its.ScobolException extends java.lang.RuntimeException Description This class represents the exception that is thrown when an unrecoverable error is encountered. In general, this exception is thrown in cases where the terminal executing the SCREEN COBOL program would be suspended. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -126
  • Java Import Package Reference Class ScobolSendException Member Summary Constructor ScobolException() Method Constructor (int argument) Syntax public ScobolException (int errorNum) Description A string corresponding to the error number is passed to the parent class (RuntimeException) and is then available through a call to toString(). Parameters errorNum The error number that caused the exception to be thrown Method Constructor (String argument) Syntax public ScobolException (String exceptionString) Parameters exceptionString A string that is passed to the parent class (RuntimeException) and is then available through a call to toString() Class ScobolSendException Package pathway.its Syntax public pathway.its.ScobolSendException extends java.lang.Exception Description This class represents the exception that is thrown when an error is encountered during a SEND operation to a server class. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -127
  • Java Import Package Reference Class ScobolTxnException Member Summary Constructor ScobolSendException() Method Constructor (int argument) Syntax public ScobolSendException (int errorNum) Description A string corresponding to the error number is passed to the parent class (Exception) and is then available through a call to toString(). Parameters errorNum The error number that caused the exception to be thrown Method Constructor (String argument) Syntax public ScobolSendException (String exceptionString) Parameters exceptionString A string that is passed to the parent class (Exception) and is then available through a call to toString() Class ScobolTxnException Package pathway.its Syntax public pathway.its.ScobolTxnException extends java.lang.Exception Description This class represents the exception that is thrown when an error is encountered during processing of a transactional operation (BeginTransaction, EndTransaction, or AbortTransaction). HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -128
  • Java Import Package Reference Class StopRunException Member Summary Constructor ScobolTxnException() Method Constructor Syntax public ScobolTxnException() Class StopRunException Package pathway.its Syntax public pathway.its.StopRunException extends RunTimeException Description This class represents the exception that is thrown when an error is encountered during processing of a STOP RUN statement. Member Summary Constructor StopRunException() Method Constructor Syntax public StopRunException() Class TransformException Package pathway.its Syntax public pathway.its.TransformException extends RunTimeException HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -129
  • Java Import Package Reference Class TransformException Description This class represents the exception that is thrown when an error is encountered during processing of a TRANSFORM statement. Member Summary Constructor TransformException() Method Constructor Syntax public TransformException() HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -130
  • Java Import Package Reference User Conversion Classes User Conversion Classes The user conversion classes define the Java equivalent of the standard user conversion routines in PATHTCPL. Class UserConversion Package pathway.its Syntax public interface pathway.its.UserConversion Description This interface class is used by the ScLibUserConversion class. Member Summary Constructor UserConversion() Methods doInputUserConversion() Interface to the screen input user conversion routines doOutputUserConversion() Interface to the screen output user conversion routines Method Constructor Syntax public UserConversion() Method doInputUserConversion Syntax public boolean doInputUserConversion (ScreenField[] fldArray) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -131
  • Java Import Package Reference Class ScLibUserConversion Parameters fldArray An array of ScreenField objects for which user conversion is to be done; corresponds to screen fields having the USER CONVERSION clause in SCREEN COBOL Description This method is automatically invoked during execution of the accept() method. It is called before the data is moved from the screen fields to the associated TO objects. It is equivalent to the USER^ALPHA^INPUT^CONVERSION and USER^NUMERIC^INPUT^CONVERSION procedures in the TCP user library object file, PATHTCPL. Method doOutputUserConversion Syntax public boolean doOutputUserConversion (ScreenField[] fldArray) Parameters fldArray An array of ScreenField objects for which user conversion is to be done; corresponds to screen fields having the USER CONVERSION clause in SCREEN COBOL Description This method is automatically invoked during execution of the display() method. It is called before the data is updated in the HTML fields. It is equivalent to the USER^ALPHA^OUTPUT^CONVERSION and USER^NUMERIC^OUTPUT^CONVERSION procedures in the TCP user library object file, PATHTCPL. Class ScLibUserConversion Package pathway.its Syntax public pathway.its.ScLibUserConversion Description This class provides the Java equivalent of the standard user conversion routines provided in the TCP user library object file, PATHTCPL. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -132
  • Java Import Package Reference Class ScLibUserConversion Member Summary Constructor ScLibUserConversion() Methods doInputUserConversion() Implementation of the standard screen input user conversion routines doOutputUserConversion() Implementation of the standard screen output user conversion routines getServerClassName() Returns the name of the server class that performs the user conversion Method Constructor Syntax public ScLibUserConversion (String serverClass, Gateway gateway) Description Constructor for the ScLibUserConversion class. Parameters serverClass Name of the user conversion server class gateway Gateway object to be used for server-class send operations to the user conversion server Method doInputUserConversion Purpose Performs input user conversion. Syntax public boolean doInputUserConversion (ScreenField[] fldArray) HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -133
  • Java Import Package Reference Class ScLibUserConversion Parameters fldArray An array of ScreenField objects for which user conversion is to be done; corresponds to screen fields having the USER CONVERSION clause in SCREEN COBOL Description This method is automatically invoked during execution of the accept() method. It is called before the data is moved from the screen fields to the associated TO objects. It is equivalent to the USER^ALPHA^INPUT^CONVERSION and USER^NUMERIC^INPUT^CONVERSION procedures in the TCP user library object file, PATHTCPL. Method doOutputUserConversion Purpose Performs output user conversion. Syntax public boolean doOutputUserConversion (ScreenField[] fldArray) Parameters fldArray An array of ScreenField objects for which user conversion is to be done; corresponds to screen fields having the USER CONVERSION clause in SCREEN COBOL Description This method is automatically invoked during execution of the display() method. It is called before the data is updated in the HTML fields. It is equivalent to the USER^ALPHA^OUTPUT^CONVERSION and USER^NUMERIC^OUTPUT^CONVERSION procedures in the TCP user library object file, PATHTCPL. Method getServerClassName Syntax public String getServerClassName() Return Value Returns the name of the server class used for user conversion. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 6 -134
  • 7 Introduction to Pathway/iTS 1.1 Pathway/iTS 1.1 provides large message (more than 32,000 bytes) communication support between SCOBOL requesters (and converted Java clients) and Pathway servers. Today, support for large message communication is available to TS/MP Pathsend requesters in the form of context-sensitive APIs (SERVERCLASS_DIALOG_* APIs). Pathway/iTS 1.1 intends to support large message communication by introducing a new TCP process called PATHTCP4. The new TCP component of Pathway/iTS 1.1 is a Pathsend requester and uses Pathsend APIs to forward the application message to Pathway servers. Four new SCOBOL verbs (DIALOG-ABORT, DIALOG-BEGIN, DIALOG-END, and DIALOG-SEND) are introduced in Pathway/iTS 1.1 to support large message communication. To process the SEND verb in SCOBOL program (and in converted Java clients), PATHTCP4 makes SERVERCLASS_SEND_ API call, and to process the DIALOG-* verbs, PATHTCP4 makes SERVERCLASS_DIALOG_* API calls. PATHTCP4 never communicates to any PATHMON process directly for link management activities. The SCUP and Web Client components of Pathway/iTS 1.1 are also changed to support the new functionalities. Any existing Pathway/iTS 1.0 application can be used along with PATHTCP4 component of Pathway/iTS 1.1 with minimal changes or no changes to the applications. However, for compatibility reasons, Pathway/iTS 1.1 package also includes PATHTCP3, the legacy TCP component. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 7 -1
  • Introduction to Pathway/iTS 1.1 Architecture of Pathway/iTS 1.1 Architecture of Pathway/iTS 1.1 Figure 7-1. Architecture of Pathway/iTS 1.1 NonStop TS/MP Environment SERVER CLASS Application Database Server COMMAND TERM Processes PATHCOM PATHMON $zlnn TERM (Temporary, from RUN Program) PATHTCP4 APPLICATION TERM Screen Program TERM (Configured) WEB CLIENT Router Pathway/iTS 1.1 Environment VST003.VSD HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 7 -2
  • Introduction to Pathway/iTS 1.1 SCOBOL Verbs and Special Register Pathway/iTS 1.1 contains two TCP components, PATHTCP4 and the legacy TCP component PATHTCP3. PATHTCP4 serves the same Java clients and the SCREEN COBOL applications but with a different architecture. It does not perform the link management activities and therefore does not communicate with the target PATHMON process directly. It acts as a Pathsend requester and calls SERVERCLASS_* APIs for the LINKMON/ROUT process to forward the request to the server process. The LINKMON/ROUT process supports context-sensitive communication by enabling transfer of more than 32,000 bytes of data between the client process and the same server process. Hence, PATHTCP4 component can use this feature to support data transfer of more than 32,000 bytes between the SCREEN COBOL programs or the converted Java clients and the same Pathway server process. In Pathway/iTS 1.0, the PATHTCP3 component communicates with the target Pathmon process to act as a link manager and then forwards the application message by doing WRITEREAD call on the server process. PATHTCP4 does not communicate with the target Pathmon process. In PATHTCP4, the owning Pathmon process opens the PATHTCP4 process to send or receive the configuration or operational messages. The LINKMON/ROUT process plays the real link manager role by communicating to the target Pathmon. While the TCP process collects the terminal statistics, the LINKMON/ROUT process reports the server side statistics. SCOBOL Verbs and Special Register The data item sent to a server process from TCP of Pathway/iTS 1.0 (PATHTCP2 or PATHTCP3) cannot exceed 32,000 bytes. Also, there is no guarantee that a second SEND verb to the same server class will enter to the same server process as the previous one. Pathway/iTS 1.1 address this issue by a context sensitive or dialog- based communication model. The dialog-based communication between a SCOBOL requester or Java client and a Pathway server involves establishing a dialog between the requester and server process in a server class, and then sending messages within the dialog. After a dialog is established, the same server process is used for all the messages in the dialog and thus the server can retain the context between the SEND operations. For a dialog-based communication, Pathway/iTS 1.1 includes: • Four SCOBOL verbs, DIALOG-ABORT, DIALOG-BEGIN, DIALOG-END, and DIALOG-SEND • A special register, DIALOG-INFO A terminal starts a dialog (and optionally sends data) with a server process in a server class by making a DIALOG-BEGIN statement. The successful execution of the DIALOG-BEGIN statement starts a dialog for the terminal. The terminal continues to send messages to the same server by making DIALOG-SEND statements. At any point of time, either the terminal or the server can abort the dialog, but only the server can end it. The server aborts the dialog by returning the file-system error 1 (FEEOF) in HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 7-3
  • Introduction to Pathway/iTS 1.1 Web Clients in Pathway/iTS 1.1 its reply. It ends the dialog by returning the file-system error 0 (FEOK). The server replies with the file-system error 70 (FECONTINUE) to continue with the dialog. The requester calls DIALOG-ABORT to abort the dialog. The requester calls DIALOG-END to clean up resources after the server has ended or aborted the dialog. Only one active dialog per requester terminal is allowed at any given time. Under such condition, a maximum of 256 active dialogs per TCP (from all terminals managed under it) are allowed. A dialog-based communication also requires that the requester and server must be designed to work together. For details on how to write context sensitive Pathway servers, see the TS/MP Pathsend and Server Programming Manual. Web Clients in Pathway/iTS 1.1 The web client feature of Pathway/iTS 1.1 enables users to convert the DIALOG verbs in addition to the old SCOBOL features to a Web client and then, build and deploy the resulting client in a Pathway environment. Also, Pathway/iTS 1.1, the Session-length parameter is ignored as long as the dialog is outstanding. After a successful DIALOG- BEGIN operation, the session will be active like the BT-ET block until the DIALOG- END or DIALOG-ABORT operation is complete, regardless of the specified number of I/O operations. After the DIALOG-END or DIALOG-ABORT operation, the session will be closed if required. Difference Between Pathway/iTS 1.0 and Pathway/iTS 1.1 PATHTCP4, a Pathsend requester, uses the Pathsend APIs to process the SEND/DIALOG-BEGIN/DIALOG-SEND/DIALOG-END/DIALOG-ABORT statements. There are certain differences between Pathway/iTS 1.0 and Pathway/iTS 1.1. Server Process Opener and Timeouts on Send to Servers PATHTCP3 and PATHTCP4 differ in opening the server processes while processing a SEND or DIALOG-BEGIN verb. PATHTCP4 being a Pathsend requester does not open the server process. Instead, it uses a Pathsend call. This causes the TS/MP ROUT ($ZLnn) process running on the CPU of primary TCP to open the server process. Pathway/iTS 1.0 users who plan to migrate to PATHTCP4 are required to check if their server programs do any validation in terms of who opens the server process. Under such condition, with PATHTCP4, the servers will receive the cancel message (incase there is a server timeout when the SEND or DIALOG-BEGIN or DIALOG-SEND to server is outstanding) from the TS/MP ROUT process rather than the TCP process. TCP Checkpoint Strategy PATHTCP4 adopts these checkpoint strategies: • If a SEND verb is being performed under transaction (BEGIN-TRANSACTION is performed before executing the SEND statement), PATHTCP4 does not perform checkpoint before and after the SEND statement. If the primary TCP fails while HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 7-4
  • Introduction to Pathway/iTS 1.1 Special Registers SEND is outstanding, the backup TCP, after takeover, aborts the current transaction and restarts interpretation of SCOBOL code from the BEGIN- TRANSACTION statement. • If a SEND verb is being performed under NO transaction (BEGIN-TRANSACTION is not performed before executing the SEND statement), PATHTCP4 always performs checkpoint before and after SEND statement. If the primary TCP fails while SEND is outstanding, one of these happens: ° If the requester specifies the ON ERROR phrase, backup TCP, after take over, logs a message to PATHMON and then returns error to the requester program to leave it to the application to handle it. ° If the requester does not specify the ON ERROR phrase, backup TCP, after take over, logs a message to PATHMON and then aborts the terminal. In this case, the status of the last SEND is not known to TCP. • If a dialog is initiated under transaction, PATHTCP4 does not perform a checkpoint for dialog verbs. If the primary TCP abends before the dialog is ended or aborted, the backup TCP, after take over, aborts the current transaction and restarts the interpretation of SCOBOL code from the BEGIN-TRANSACTION statement. • If a dialog is initiated under NO transaction, PATHTCP4 always performs checkpoint before and after the dialog statements (DIALOG-BEGIN/DIALOG- SEND/DIALOG-END/DIALOG-ABORT). If the primary TCP fails while executing these verbs, one of these happens: ° If the requester specifies the ON ERROR phrase, backup TCP, after take over, logs a message to PATHMON and then returns error to the requester program to leave it to the application to handle it. ° If the requester does not specify the ON ERROR phrase, backup TCP, after take over, logs a message to PATHMON and then aborts the terminal. In this case, the status of the last verb is not known to TCP. Special Registers Special registers are data items defined automatically by the SCREEN COBOL compiler, not by the program. Each special register has a particular purpose and is used in the manner outlined in its description in the Pathway/iTS TCP and Terminal Programming Guide. STOP-MODE is the only special register that differs in PATHTCP3 and PATHTCP4. In PATHTCP3, when the value of STOP-MODE special register is nonzero, several PATHCOM commands, like STOP TERM, SUSPEND TERM, and FREEZE SERVER when used without a ‘!’ (Bang) specified, used to be delayed until the register value becomes zero. In PATHTCP4 while the SUSPEND TERM and STOP TERM commands obey the effect of ‘!’ and STOP MODE register value, the FREEZE SERVER command ignores these effects. In other words, FREEZE SERVER command in Pathway/iTS 1.1, when using PATHTCP4, takes effect immediately (irrespective of whether the ‘!’ command is used or not and the value of STOP MODE HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 7-5
  • Introduction to Pathway/iTS 1.1 FREEZE SERVER Command Changes register) and prohibits the link managers (LINKMON processes) from sending requests to a server class. If a server process has incomplete requests or is in active dialog, the PATHMON process cannot freeze the server class until these requests are completed. While waiting for the requests to complete, the server class goes into a FREEZE- PENDING state. If no incomplete or outstanding requests exist for any server in the server class, the PATHMON process immediately freezes the server class. In addition to supporting the special registers in Pathway/iTS 1.0, Pathway/iTS 1.1 includes a special register for providing information about the dialog verbs. DIALOG-INFO Special Register The DIALOG-INFO special register communicates with the dialog status of a requester program. In other words, this special register helps to communicate whether a terminal is under active dialog or not. A copy of this register is available to each terminal. The register is initialized to 65535 each time the requester program is called and can contain only three possible values. Here is a summary of the possible values for this special register, their meanings and action to be taken by the requester program. DIALOG-INFO Register Value Meaning/Actions to be Taken 65535 The term is not under any active dialog. Either the term has not started any dialog at all or the dialog has been ended or aborted by the terminal. 0 (FEOK) The term is under active dialog. The last call to either DIALOG- BEGIN or DIALOG-SEND was successful but the server has ended the dialog from its end. The requester must end the dialog now. 70 (FECONTINUE) The term is under active dialog. The last call to either DIALOG- BEGIN or DIALOG-SEND was successful and the server has expressed interest in continuing the dialog. FREEZE SERVER Command Changes As PATHTCP4 is a Pathsend requester and does not execute any link management operation, the SCREEN COBOL STOP-MODE special register value is ignored for the FREEZE SERVER command. This behavior also implies that the bang command ‘!’ in FREEZE SERVER command does not have any effect in PATHTCP4. PATHTCP3 queues all the SEND tasks targeted at a frozen server class. The queued tasks are processed once the server class is thawed. PATHTCP4 behaves differently in the above case. If a SCREEN COBOL requester, running under PATHTCP4, attempts to send to a frozen serverclass and the SEND/DIALOG-BEGIN/DIALOG-SEND statement is coded without an ON ERROR clause, PATHTCP4 will abort the terminal. If the terminal is in transaction mode, the associated transaction will also be aborted. If ON ERROR clause is specified when PATHTCP4 hits this error, the SCOBOL execution will continue according to the error handling logic specified in the program. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 7-6
  • Introduction to Pathway/iTS 1.1 Statistics Collected by Pathway/iTS 1.1 Statistics Collected by Pathway/iTS 1.1 In PATHTCP4, the statistics collected are different from PATHTCP3. PATHTCP4 does not generate statistics for SERVER objects. TS/MP ROUT processes generate SERVER object statistics. For details on how the TS/MP ROUT processes generate SERVER object statistics, see the TS/MP System Management Manual, or TS/MP Supplement for Limits Relief Manual depending on the ROUT process running on your system. TCP STATS ON attributes to collect server statistics are ignored in PATHTCP4. TCP object statistics collected by PATHTCP4 are different from those of PATHTCP3. In PATHTCP4, the QUEUE INFO statistics collection for TCP object has changed. PATHTCP4 does not perform any link management activity and hence the LINK and DELINK statistics are not collected. No value will be displayed for LINK and DELINK fields. All other fields in QUEUE INFO continue to be displayed as in PATHTCP3. Example 7-1. Sample TCP Statistics for QUEUE INFO. TCP TCPX2 02 DEC 2006, 14:03:02 INTERVAL 5 SECS COUNT 2/5 . . . QUEUE INFO: REQ CNT %WAIT MAX WAITS AVG WAITS TERMPOOL 816 0.0 0 0.00 SERVERPOOL 3095 0.0 0 0.00 MEMMAN 1176 1.3 1 0.01 LINK -- -- -- -- DELINK -- -- -- -- CHECKPOINT 320 0.0 0 0.00 Fault Tolerance in Pathway/iTS 1.1 In terms of the level of fault tolerance, there is a difference in behavior in PATHTCP4 compared to PATHTCP3 in case TCP runs as process pair and the primary TCP fails while a SEND or a Dialog is outstanding. HP suggests the PATHTCP3 users to recognize this change in behavior and change the application, if required, before migrating to the new environment. When PATHTCP4 is configured as a process pair and the primary TCP fails, the terminals controlled by the TCP can still be used. However, if a SEND or a dialog to a server class is outstanding when the primary TCP fails then the recovery procedure depends on whether or not TMF subsystem was used for database consistency, that is whether or not the SEND was done after a successful call to BEGIN-TRANSACTION. If the SEND is being done under TMF transaction, backup TCP, after take over, logs a message to PATHMON, aborts the current transaction and reissues the entire transaction from BEGIN-TRANSACTION statement in SCOBOL program. If the SEND is not protected under TMF, the backup TCP, after take over, logs an error message to PATHMON and then reports another error (TERMINATION-STATUS 24) to HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 7-7
  • Introduction to Pathway/iTS 1.1 Error Handling in Pathway/iTS 1.1 the SCOBOL program provided the ON ERROR clause is specified. The processing of SCOBOL program continues in this case depending on the error handling logic of the program. If the ON ERROR clause is not specified, the backup TCP after take over aborts the terminal. In most cases, this requires an operator intervention to correct the situation. If this situation happens at any time, PATHTCP4 does not have any status about the state of the initiated SEND operation. Manual intervention is required to find the state of the last SEND and to see if duplicate SENDs can be reissued by restarting the terminal. PATHTCP4 strongly suggests SCOBOL programs to wrap up non-retryable database operations under TMF. This would help in maintaining database consistency and in normal operation of PATHTCP4. Similarly, if a dialog is active under TMF transaction and primary TCP abends before the dialog could end, the back up TCP after take over logs a message to PATHMON, aborts the current transaction, and reissues the whole transaction from the BEGIN- TRANSACTION statement in SCOBOL program. If the dialog is not protected under TMF, back up TCP, after take over, logs an error message to PATHMON and reports an error (TERMINATION-STATUS 24) to SCOBOL program provided the ON ERROR clause is specified. The processing of SCOBOL program continues in this case depending on the error handling logic of the program. If the ON ERROR clause is not specified, back up TCP after take over aborts the terminal. In most cases, this requires an operator intervention to correct the situation. If this situation occurs at any time, PATHTCP4 does not have any status about the state of the initiated dialog. Manual intervention is required to find the state of the dialog and to see if duplicate dialogs can be reissued by restarting the terminal. Error Handling in Pathway/iTS 1.1 TERMINATION STATUS or SUB-STATUS register values are set by PATHTCP4 for the SEND verb. These values are generated for the DIALOG-BEGIN, DIALOG-SEND, DIALOG-END and DIALOG-ABORT verbs also. For the termination status values, see the Pathway/iTS SCREEN COBOL Reference Manual. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 7-8
  • A Client Error Messages This appendix describes the pop-up messages that end users can receive while running a Pathway/iTS web client. General Information Messages with numbers in the range 3000 through 3299 are analogous to the corresponding, same-numbered terminal control process (TCP) messages issued when screen programs are running on the NonStop system. These messages are generated by the Pathway/iTS gateway threads and passed to the Java applet portion of the web client. Messages with numbers 3300 and higher are specific to web clients and are generated by the Java applet. All client messages include a stack trace, indicated by the error-loc variable following the message text. For some messages, this stack trace contains additional information about the location of the error within the Java code. The text in a displayed message with stack trace appears as in this example: pathway.its.ScobolException: Error 3015: Arithmetic Overflow at pathway/its/Pic9.<init> at pathway/its/Pic9.<init> at ITSDEMO1.<init> at SCThread.run Message Descriptions The following pages give displayed message text, cause, effect, and recovery information about each client error message. 3002 *3002* DEPENDING VARIABLE VALUE TOO BIG error-loc Cause. A DEPENDING ON data item was larger than the limit specified in the OCCURS clause. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A- 1
  • Client Error Messages Message Descriptions 3003 *3003* INVALID SUBSCRIPT VALUE error-loc Cause. The value of a subscript expression was either zero or larger than the limit implied by the OCCURS clause. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3005 *3005* CALL: ACTUAL NUMBER OF PARAMETERS MISMATCHES FORMAL error-loc Cause. The number of parameters passed in the USING clause of a CALL statement was not equal to the number of parameters given in the Procedure Division header of the called program. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3006 *3006* CALL: ACTUAL PARAMETER SIZE MISMATCHES FORMAL error-loc Cause. The maximum size of a parameter passed in the USING clause of a CALL statement was not equal to the maximum size of the corresponding parameter given in the Procedure Division header of the called program. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A- 2
  • Client Error Messages Message Descriptions 3007 *3007* SCREEN OPERATION DONE WITHOUT BASE DISPLAYED error-loc Cause. A screen-manipulation operation was attempted before a DISPLAY BASE statement was executed. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3013 *3013* OVERLAY SCREEN DISPLAYED IN TWO AREAS error-loc Cause. The program attempted to display an overlay screen in more than one overlay area at the same time. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3015 *3015* ARITHMETIC OVERFLOW error-loc Cause. A data-related error occurred during numeric manipulation. The error could be caused by an overflow, by dividing by zero, by an invalid value in a numeric data item (for example, blank spaces in a USAGE DISPLAY item), or by attempting to move a value into a data item that is not large enough to hold it. Effect. The operation fails and the applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A- 3
  • Client Error Messages Message Descriptions 3020 *3020* CALLED PROGRAM UNIT NOT FOUND error-loc Cause. The program unit specified in a CALL statement was not found in the TCLPROG files. Effect. The operation fails. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3022 *3022* SEND: SERVER CLASS NAME INVALID error-loc Cause. The value passed to the gateway requester program for a SCREEN COBOL SEND statement did not have the format of a valid server-class name. Effect. The operation fails. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application 3027 *3027* TRANSACTION MODE VIOLATION error-loc Cause. The server-class SEND operation did not match the transaction-mode state. A SEND operation to a server not using the Transaction Management Facility (TMF) was attempted while the gateway requester thread was in transaction mode. Effect. The operation fails. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3030 *3030* TMF NOT CONFIGURED error-loc Cause. An attempt to use the Transaction Management Facility (TMF) failed because TMF auditing was not configured in the host NonStop system. Effect. If the ON ERROR clause of the BEGIN-TRANSACTION statement is present in the SCREEN COBOL source code—that is, if the onTxnErrorMethod method is HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A- 4
  • Client Error Messages Message Descriptions present in the Java code—then the ON ERROR branch is taken. Otherwise, the applet stops. Recovery. Either configure TMF auditing or isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3031 *3031* TMF NOT RUNNING error-loc Cause. An attempt to use the Transaction Management Facility (TMF) failed because the TMF software was not running on the host NonStop system. Effect. If the ON ERROR clause of the BEGIN-TRANSACTION statement is present in the SCREEN COBOL source code—that is, if the onTxnErrorMethod method is present in the Java code—then the ON ERROR branch is taken. Otherwise, the applet stops. Recovery. Either configure TMF auditing or isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3037 *3037* ILLEGAL ACCEPT VARIABLE TIMEOUT VALUE error-loc Cause. An illegal timeout value was used in an ACCEPT statement. The value was either less than zero or too large to be represented in an INT(32) field. Effect. The operation fails and the applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3040 *3040* INVALID NUMERIC ITEM error-loc Cause. The screen field referenced in a verb does not contain numeric data. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A- 5
  • Client Error Messages Message Descriptions 3049 *3049* EXIT PROGRAM ENCOUNTERED error-loc Cause. The applet stopped because it encountered an exit through an EXIT PROGRAM statement in the highest-level (main) program unit. Effect. The applet stops. Recovery. Informational message only; no corrective action is needed. 3052 *3052* TERMINAL STOPPED BY PROGRAM error-loc Cause. The applet stopped because it encountered an exit through a STOP RUN statement in the highest-level (main) program unit. Effect. The applet stops. Recovery. Informational message only; no corrective action is needed. 3053 *3053* INVALID NUMERIC ITEM error-loc Cause. An operation that does not involve screen representation, such as an ADD or MOVE operation, attempted to perform a numeric operation using nonnumeric data. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3068 *3068* FIELD CONTAINS OTHER THAN DBCS DATA error-loc Cause. An attempt was made to display mixed or single-byte characters in a PIC N only screen field. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A- 6
  • Client Error Messages Message Descriptions 3072 *3072* RUN-TIME DYNAMIC ATTRIBUTE SETTING INVALID error-loc Cause. An invalid attribute setting was detected, or the specified attribute setting would cause an out-of-bounds condition to occur during the run-time processing of the control structure. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3074 *3074* ILLEGAL DELAY VALUE error-loc Cause. An illegal DELAY variable timeout value was used. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3110 *3110* NO ROOM FOR NEW SERVER CLASS IN TCP error-loc Cause. The terminal control process (TCP) attempted to communicate with more server classes than defined for the MAXSERVERCLASSES attribute. Effect. The operation fails. Recovery. Redefine the value of the MAXSERVERCLASSES attribute or restart the application. 3112 *3112* REPLY NUMBER NOT KNOWN TO PROGRAM error-loc Cause. A server replied with a message containing a reply code not listed in the SEND statement of the program. Effect. The operation fails and the applet stops. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A- 7
  • Client Error Messages Message Descriptions Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3113 *3113* TRANSACTION MESSAGE SIZE EXCEEDS LIMIT error-loc Cause. The size of a message for a SEND operation to a server exceeded that allowed by the SERVERPOOL attribute in the terminal control process (TCP) configuration. Effect. The operation fails. Recovery. Redefine the value of the SERVERPOOL attribute, or isolate and correct the problem within the Java program, and restart the application. Use the stack trace information in error-loc to locate the problem within the program. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3114 *3114* MAXIMUM REPLY SIZE EXCEEDS LIMIT error-loc Cause. The size of either the largest SEND message or the longest possible reply exceeded the size defined for the MAXREPLY attribute. Effect. The operation fails. Recovery. Redefine the MAXREPLY attribute, or isolate and correct the problem within the Java program, and restart the application. Use the stack trace information in error-loc to locate the problem within the program. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3115 *3115* REPLY LENGTH INVALID Cause. The size of the reply received from the server did not correspond to the size of the selected YIELDS list given in the SEND or DIALOG statement of the program. If a reply exceeds the largest number of bytes allowed, the terminal control process (TCP) reports the byte count as the maximum length allowed plus 1. Effect. The operation fails. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A- 8
  • Client Error Messages Message Descriptions 3116 *3116* ERROR DURING SERVER I/O (errnum) error-loc Cause. The file-system error errnum occurred during an I/O operation to a server process. Effect. The I/O operation fails. The terminal control process (TCP) unlinks from the server class. Recovery. See the Guardian Procedure Errors and Messages Manual for information regarding the specified file-system error. 3117 *3117* object-name SERVER CLASS UNDEFINED error-loc Cause. The server class specified in a SEND statement was not defined for this PATHMON environment. Effect. The operation fails. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3118 *3118* REQUEST INVALID FOR SERVER STATE error-loc Cause. The state of the specified server did not allow the requested operation to occur. The server might have been frozen, or an internal error might have occurred. Effect. The operation fails. Recovery. Contact your service provider and provide all relevant information as: • Descriptions of the problem and accompanying symptoms • Details from the message(s) generated • Your PATHMON configuration file and PATHMON process version • A description of the application task that was in progress when the error occurred • Supporting documentation such as Event Management Service (EMS) logs, trace files, and dump files, if applicable If your local operating procedures require contacting the HP Global Customer Support Center (GCSC), supply your NonStop system number and the numbers and versions of all related products as well. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A- 9
  • Client Error Messages Message Descriptions 3119 *3119* NO SPACE FOR NEW SERVER PROCESS error-loc Cause. The terminal control process (TCP) attempted to link with more server processes than were defined for the MAXSERVERPROCESSES attribute. Effect. The operation fails. Recovery. Redefine the MAXSERVERPROCESSES attribute and restart the application. 3164 *3164* CODE OF RECEIVED MESSAGE UNDEFINED error-loc Cause. During execution of a TRANSFORM operation, the message code did not match any of the reply codes specified in the select list. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, remove the unsupported function from the SCREEN COBOL program and reconvert the application. 3179 *3179* DATA LEFT OVER ON SCATTER TO WORKING STORAGE error-loc Cause. A program unit attempted to execute a TRANSFORM operation, but there was data left unprocessed from the source data stream. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, remove the unsupported function from the SCREEN COBOL program and reconvert the application. 3180 *3180* NOT ENOUGH DATA FOR SCATTER TO WORKING STORAGE error-loc Cause. A program unit attempted to execute a TRANSFORM operation, but there was not enough data in the source data stream to satisfy the destination data items. Effect. The applet stops. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A-10
  • Client Error Messages Message Descriptions Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, remove the unsupported function from the SCREEN COBOL program and reconvert the application. 3203 *3203* FUNCTION UNIMPLEMENTED error-loc Cause. The SCREEN COBOL program included a function that is not supported for conversion. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, remove the unsupported function from the SCREEN COBOL program and reconvert the application. 3231 *3231* SEND: ERROR DURING I/O TO EXTERNAL PATHMON Cause. A file-system error occurred during an OPEN or WRITEREAD operation to an external PATHMON process. Effect. The operation fails. Recovery. For information regarding the specified file-system error, see the Guardian Procedure Errors and Messages Manual. 3246 *3246* SERVER CLASS IS EITHER IN FREEZE PENDING OR IN FROZEN STATE Note. This error does not appear in the RETCODE token or in an error list; it appears only in response to the STATUS TCP or STATUS TERM command. Cause. The server class to which a send or a dialog was targeted, is either in freeze- pending or in frozen state. Effect. The operation fails. If ON ERROR clause is mentioned, then error is reported against the term but the term continues to run depending on the error-handling logic in the SCREEN COBOL program. If ON ERROR clause is not mentioned, then TCP suspends the terminal after logging the error against the term; however, the term can be resumed to restart processing at the last verb. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A-11
  • Client Error Messages Message Descriptions Recovery. Isolate the server class within the SCREEN COBOL program and make sure the server class is in STARTED mode before applying SEND/DIALOG to it. For instructions on how to isolate the server class within the program, see Additional Error Information on page 13-1 in the Pathway/iTS System Management Manual. 3247 *3247* A NON-RETRYABLE LINKMON CONNECT ERROR OCCURED (errnum) Note. This error does not appear in the RETCODE token or in an error list; it appears only in response to the STATUS TCP or STATUS TERM command. Cause. A non-retryable LINKMON connect error occured on both primary and backup CPU of the TCP. The associated file error gives the file-system error occured with the LINKMON process. Effect. The operation fails. TCP, after reporting the error, aborts the terminal irrespective of ON ERROR clause mentioned or not. Recovery. Although other file-system errors are also possible, most typical file-system errors are error 14 (FENOSUCHDEV) and 201 (FEPATHDOWN). File-system error 14 indicates that the LINKMON process is not up on the CPU. File-system error 201 indicates that the LINKMON process had abended due to some reason. Correct the LINKMON problem and then restart the term. 3248 *3248* A RETRYABLE LINKMON CONNECT ERROR OCCURRED (errnum) Note. This error does not appear in the RETCODE token or in an error list; it appears only in response to the STATUS TCP or STATUS TERM command. Cause. A retryable LINKMON connect error occurred on primary CPU of the TCP. The associated file error gives the file-system error occurred with the LINKMON process. Typical file-system errors are 100 (FENOTRDY), 28(FETOOMANY) and 30 (FENOLCB). Here are the possible causes for this error. • The LINKMON process on the CPU is just started and is not yet initialized (Error #100). • More than 255 sends are being attempted by the same TCP process (Error #28). • More than 4K sends are being attempted on the same CPU (Error #30). Effect. The operation fails. If ON ERROR clause is mentioned, then error is reported against the term but the term continues to run depending on the error-handling logic in HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A-12
  • Client Error Messages Message Descriptions the SCREEN COBOL program. If ON ERROR clause is not mentioned, TCP suspends the terminal after logging the error against the term; however, the term can be resumed to restart processing at the last verb. Recovery. If the associated file-system error is 100 then it means that the LINKMON process is just started on the CPU and is not yet ready to accept the Pathsend requests. The term must retry the operation after a time delay. If associated file-system error is 30, then it means that the outstanding incoming requests to the LINKMON process have been reached. This is also a transient error and the term must retry the operation. 3249 *3249* TCP FAILED WHEN A SEND/DIALOG TO SERVER WAS OUTSTANDING Note. This error does not appear in the RETCODE token or in an error list; it appears only in response to the STATUS TCP or STATUS TERM command. Cause. TCP abended while a SEND or a DIALOG I/O to server process was outstanding and the term was not under transaction. Effect. The operation fails. The server might or might not have received the message. If ON ERROR clause is mentioned, error is reported against the term but the term continues to run depending on the error-handling logic in the SCREEN COBOL program. If ON ERROR clause is not mentioned, TCP aborts the terminal after logging the error against the term. If the term is associated with any dialog, the dialog is also aborted. Recovery. Recovery is application specific. Since TCP does not know the status of the last I/O hence the SEND/DIALOG operation can be retried if it is OK to send duplicate message to the server class. Pathway/iTS 1.1 strongly recommends that the send and dialog operations to server classes that do not allow duplicate messages must be wrapped under TMF transactions. 3250 *3250* DIALOG MODE VIOLATION Note. This error does not appear in the RETCODE token or in an error list; it appears only in response to the STATUS TCP or STATUS TERM command. Cause. The context sensitive programming protocol has been violated by the SCREEN COBOL program. The possible causes of this error are: HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A-13
  • Client Error Messages Message Descriptions • A second DIALOG-BEGIN was attempted when the term is already under active dialog. • A DIALOG-SEND was attempted without the term being under active dialog. • A DIALOG-END was attempted without the term being under active dialog. • A DIALOG-ABORT was attempted without the term being under active dialog. Effect. The operation fails. If ON ERROR clause is mentioned, then error is reported against the term but the term continues to run depending on the error-handling logic in the SCREEN COBOL program. If ON ERROR clause is not mentioned, then TCP aborts the terminal after logging the error against the term. If the term is associated with any dialog the dialog is also aborted. Recovery. There is no recovery action on this. Correct the SCREEN COBOL program and restart the term. For instructions on how to isolate the problem within the program, see Additional Information for Terminal Errors at the beginning of this section. 3251 *3251* DIALOG HAS NOT BEEN ENDED BY THE SERVER Note. This error does not appear in the RETCODE token or in an error list; it appears only in response to the STATUS TCP or STATUS TERM command. Cause. A DIALOG-END statement is called when the server has not yet ended the dialog. Effect. The operation fails. If ON ERROR clause is mentioned, then error is reported against the term but the term continues to run depending on the error-handling logic in the SCREEN COBOL program. If ON ERROR clause is not mentioned, then TCP aborts the terminal after logging the error against the term. If the term is associated with any dialog the dialog is also aborted. Recovery. There is no recovery action on this. Correct the SCREEN COBOL program to make sure that the DIALOG-END is called only after the server has ended the dialog. For instructions on how to isolate the problem within the program, see Additional Information for Terminal Errors at the beginning of this section. 3252 *3252* DIALOG HAS BECOME INVALID DUE TO A PRIMARY TCP FAILURE Cause. A DIALOG-SEND, DIALOG-END or DIALOG-ABORT statement is called and it was found that the dialog has been aborted by the LINKMON process due to the primary TCP failure. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A-14
  • Client Error Messages Message Descriptions Effect. The operation fails. If ON ERROR clause is mentioned, then error is reported against the term but the term continues to run depending on the error-handling logic in the SCREEN COBOL program. If ON ERROR clause is not mentioned, then TCP aborts the terminal after logging the error against the term. Recovery. Clean up the requester portion of dialog by calling DIALOG-END and initiate a new dialog if required. 3253 *3253* ERROR OCCURRED DURING DIALOG VERB EXECUTION (errnum) Cause. A dialog statement has hit a dialog related error. Possible causes of this error are: • A DIALOG-BEGIN or DIALOG-SEND statement failed because either the server requested a dialog abort or the server abended before replying to the transaction request. • A DIALOG-SEND statement failed because the dialog has already been ended or aborted. • A DIALOG-BEGIN or DIALOG-SEND statement failed because the associated transaction has been aborted which caused the dialog to be aborted as well. Effect. The operation fails. If ON ERROR clause is mentioned, then error is reported against the term but the term continues to run depending on the error-handling logic in the SCREEN COBOL program. If ON ERROR clause is not mentioned, then TCP aborts the terminal after logging the error against the term. Recovery. Clean up the requester portion of dialog by calling DIALOG-END and initiate a new dialog if required. 3300 *3300* CONNECTION NOT ESTABLISHED WITH GATEWAY REQUESTER THREAD error-loc Cause. The TCP/IP socket connection was not established by invoking the GatewayInitateConnection class before sending a request to the terminal control process (TCP). Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A-15
  • Client Error Messages Message Descriptions 3301 *3301* TRANSACTION ERROR error-loc Cause. A transaction error occurred on the NonStop system—for example, a unilateral abort of a transaction. Effect. If the ON ERROR clause of the BEGIN-TRANSACTION statement is present in the SCREEN COBOL source code—that is, if the onTxnErrorMethod method is present in the Java code—then the ON ERROR branch is taken. Otherwise, the applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3302 *3302* INTERNAL ERROR error-loc Cause. A internal error occurred. Effect. The applet stops. Recovery. Contact your service provider and provide all relevant information as: • Descriptions of the problem and accompanying symptoms • A description of the application task that was in progress when the error occurred • The stack trace of the Java program (from error-loc) If your local operating procedures require contacting the HP Global Customer Support Center (GCSC), supply your NonStop system number and the numbers and versions of all related products as well. 3303 *3303* THE ON ERROR METHOD OF BEGIN-TRANSACTION IS NOT PUBLIC error-loc Cause. The method OnTxnErrorMethod, which implements the ON ERROR clause of the BEGIN-TRANSACTION statement in the SCREEN COBOL program, is not a public method. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A-16
  • Client Error Messages Message Descriptions 3304 *3304* INVALID PARAMETER error-loc Cause. An invalid parameter value was passed. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3305 *3305* UNKNOWN HOST error-loc Cause. The program attempted to communicate with a host NonStop system that was unknown. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3306 *3306* ERROR DURING I/O ON SOCKET error-loc Cause. A TCP/IP I/O exception occurred during a read or write on a socket. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3307 *3307* FATAL ERROR DURING BEGIN TRANSACTION error-loc Cause. A fatal error occurred while the terminal control process (TCP) was attempting to start a transaction. Effect. If the ON ERROR clause of the BEGIN-TRANSACTION statement is present in the SCREEN COBOL source code—that is, if the onTxnErrorMethod method is present in the Java code—then the ON ERROR branch is taken. Otherwise, the applet stops. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A-17
  • Client Error Messages Message Descriptions Recovery. Check the Pathway log file for any error message related to failure in the start of a transaction. Isolate and correct the problem within the Java program, using the Pathway log file and the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3308 *3308* SPECIFIED URL FORMAT IS INVALID Cause. The applet got error while loading an HTML page for already loaded base screen. Effect. The operation fails. Recovery. Check the stack trace to find where the URL path got corrupted. 3310 *3310* EXPECT DISPLAY USAGE error-loc Cause. The IS NUMERIC clause was called for a computational data item. The data item cannot be computational. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3311 *3311* USER PROFILE SERVER COMMUNICATION ERROR Cause. An error occurred while retrieving user profile data from the profile database server. Effect. The applet does not start. Recovery. Check the Java console for additional information the problem. Isolate and correct the problem within the Java program. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. Follow the guidelines in Section 3, Logon Security and User Profiles, on how to set up the user profile database and server. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A-18
  • Client Error Messages Message Descriptions 3312 *3312* CHARACTER-SET SHOULD BE KANJI-KATAKANA Cause. The CHARACTER-SET IS clause of SCREEN COBOL upon conversion specifies character set other than KANJI-KATAKANA or ASCII. Note that special character set values is not required for European language character-sets as Java takes care of them. Effect. The operation fails. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3313 *3313* IS NUMERIC CLAUSE NOT APPLICABLE TO PIC N DATA Cause. The IS NUMERIC clause in SCOBOL is used for a data member, which is PIC N and is converted. Effect. The operation fails. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A-19
  • Client Error Messages Message Descriptions HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A-20
  • B SCREEN COBOL Features Not Supported for Web Conversion Certain SCREEN COBOL features are either not supported for conversion to web clients or have a modified representation in the converted code. In some cases, this is because the features are not applicable in a web environment or because of limitations imposed by Java. Table B-1 lists the SCREEN COBOL statements and clauses that are not supported or have limited support for conversion. For each feature, the table explains the action taken by the converter when it encounters this feature and what you can do to correct the situation. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 B- 1
  • SCREEN COBOL Features Not Supported for Web Conversion Table B-1. Web Conversion Support Limitations (page 1 of 4) Recommended SCREEN COBOL Feature Converter Action Corrective Action CHECKPOINT Because the web client does not No corrective action run with a backup process, this needed. statement is not meaningful in a web environment. The converter generates a warning and continues converting the rest of the program. The converted Java code contains the warning statement as a comment. The converted code will compile, but the effect of the CHECKPOINT statement is not provided by the converted code. DEVICEINFO The converter generates an error Either remove the non- and continues converting the rest of compilable statement the program. The converted Java from the converted code contains a non-compilable code or remove the statement. DEVICEINFO statement from the SCREEN COBOL source program. DISPLAY RECOVERY, The converter generates a warning No corrective action EXIT RECOVERY and continues converting the rest of needed. the program. The converted Java code contains the warning statement as a comment. The converted code will compile, but the effect of the DISPLAY RECOVERY and EXIT RECOVERY statements is not provided by the converted code. DYNAMIC Dynamic changes of attributes are Dynamic attributes not supported. The converter depend on the generates equivalent calls that do browser. Modify the nothing. converted code based on the browsers to be used. MDT (modified data tag) In the converted code, input No corrective action use in ACCEPT statement validations are applied to all screen needed. fields that participate in the ACCEPT operation, regardless of the MDT setting (that is, whether or not the fields were modified). HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 B- 2
  • SCREEN COBOL Features Not Supported for Web Conversion Table B-1. Web Conversion Support Limitations (page 2 of 4) Recommended SCREEN COBOL Feature Converter Action Corrective Action PIC9V data items with The precision of the converted code Either modify the more than 16-digit is limited to the most significant 16 converted code or edit precision digits after the decimal point. The the SCREEN COBOL converter generates an error and source program to continues converting the remaining reduce the size of the program units. The converted Java data item. code contains a non-compilable error message. PRINT SCREEN The converter generates a warning No corrective action and continues converting the rest of needed. the program. The converted Java code contains the warning statement as a comment. The converted code will compile, but the effect of the PRINT SCREEN statement is not provided by the converted code. RECEIVE UNSOLICITED Unsolicited-message processing is Either remove the non- MESSAGE, not currently supported for compilable statement REPLY UNSOLICITED conversion. The converter from the converted MESSAGE generates an error and continues code or remove the converting the rest of the program. RECEIVE The converted Java code contains a UNSOLICITED non-compilable statement. MESSAGE or REPLY UNSOLICITED MESSAGE statement from the SCREEN COBOL source program. RECONNECT MODEM Because the converted application No corrective action is running within the context of a needed. browser and not over a dial-up ine, this statement is not meaningful in a web environment. The converter generates a warning and continues converting the rest of the program. The converted Java code contains the warning statement as a comment. The converted code will compile, but the effect of the RECONNECT MODEM statement is not provided by the converted code. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 B- 3
  • SCREEN COBOL Features Not Supported for Web Conversion Table B-1. Web Conversion Support Limitations (page 3 of 4) Recommended SCREEN COBOL Feature Converter Action Corrective Action RESTART-TRANSACTION The converter generates an error Either remove the non- and continues converting the rest of compilable statement the program. The converted Java from the converted code contains a non-compilable code or remove the statement. RESTART- TRANSACTION statement from the SCREEN COBOL source program. SCROLL This statement applies only to 6510 No corrective action terminals, which are not supported needed. for conversion. The converter generates a warning and continues converting the rest of the program. The converted Java code contains the warning statement as a comment. The converted code will compile, but the effect of the USE statement is not provided by the converted code. SEND MESSAGE The Intelligent Device Support (IDS) Either remove the non- feature is not currently supported for compilable statement conversion. The converter from the converted generates an error and continues code or remove the converting the rest of the program. SEND MESSAGE The converted Java code contains a statement from the non-compilable statement. SCREEN COBOL source program. TERMINAL IS Conversion is supported only for The program unit unsupported-type program units with terminal types cannot be converted. T16-6520, T16-6530, T16-6540, and IBM-3270. The converter generates an error and continues converting the rest of the program. The converted Java code contains a non-compilable statement. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 B- 4
  • SCREEN COBOL Features Not Supported for Web Conversion Table B-1. Web Conversion Support Limitations (page 4 of 4) Recommended SCREEN COBOL Feature Converter Action Corrective Action TERMINALINFO The converter generates an error Evaluate the use of the and continues converting the rest of TERMINALINFO the program. The converted Java statement and modify code contains a non-compilable the converted code or statement. the SCREEN COBOL source program accordingly. TRANSFORM statement Statements involving the Message Either remove the non- involving transfer of data to Section are not supported. The compilable statement or from a Message Section converter generates an error and from the converted data item continues converting the rest of the code or remove the program. The converted Java code TRANSFORM contains a non-compilable statement from the statement. SCREEN COBOL source program. USE FOR SCREEN These statements are not No corrective action RECOVERY, meaningful in a web environment. needed. USE FOR The converter generates a warning TERMINAL-ERRORS and continues converting the rest of the program. The converted Java code contains the warning statement as a comment. The converted code will compile, but the effect of the USE statement is not provided by the converted code. HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 B- 5
  • SCREEN COBOL Features Not Supported for Web Conversion HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 B- 6
  • Index A Architecture of Pathway/iTS 1.1 7-2 Arithmetic overflow (message 3015) A-3 abortTransaction method 6-4 ABORT-TRANSACTION statement, Java implementation of 6-4 B abstract class base screen 5-7 for actions applying to program beginTransaction method 6-5 units 6-117 BEGIN-TRANSACTION statement, Java for NEW-CURSOR and OLD-CURSOR implementation of 6-5 special registers 6-123 build environment for web client for SCREEN COBOL data types 6-44 setting up in OSS environment 2-5 for SCREEN COBOL group data setting up in Windows environment 2-6 types 6-53 building ACCEPT DATE statement, Java converted application 2-8 implementation of 6-4 user conversion library 4-2 ACCEPT DAY statement, Java web client in OSS environment 2-5 implementation of 6-4 web client in Windows environment 2-6 accept method 6-33 ACCEPT statement, Java implementation web client, overview of 2-5 of 5-6, 6-33 ACCEPT TIME statement, Java implementation of 6-5 C Called program unit not found acceptDate method 6-4 (message 3020) A-4 acceptDay method 6-4 Call: actual number of parameters acceptTime method 6-5 mismatches formal (message 3005) A-2 Action (Select item in HTML form) 5-7 Call: actual parameter size mismatches Actual number of parameters mismatches formal (message 3006) A-2 formal (message 3005) A-2 character set, specifying 6-122 Actual parameter size mismatches formal CHECKPOINT statement, not (message 3006) A-2 supported B-2 addField method classes and methods for web in ScreenFieldArray class 6-25 clients 6-1/6-134 in ScreenFieldGroup class 6-31 CLASSPATH variable, setting 2-5 addFieldArray method 6-31 CLEAR INPUT statement, Java adding group items to a group 6-54 implementation of 6-35 addReplyCode method 6-11 clearInput method 6-35 addScobolData method 6-54 Code of received message undefined (message 3164) A-10 ADVISORY clause, Java implementation of 6-16, 6-25 code, modifying for web clients 2-4 alphanumeric data types, Java comments in Java code, from converter 2-4 implementation of 6-103 communications protocols supported by router process 1-4 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 Index-1
  • Index D compiling a converted application constructor (continued) OSS environment 2-8 for Transform class 6-114 Windows environment 2-9 for TransformException class 6-130 computational data types, Java for UserConversion class 6-131 implementation of control page, HTML 5-3 integer 6-60 CONTROLLED [BY] clause, Java noninteger 6-72, 6-84 implementation of 6-16, 6-25 real 6-84 control.html file configuration file, for converting SCREEN example 2-15 COBOL programs 2-2 overview 5-3 configuring user profile options in 3-3 Pathway applications with web conversion environment, specifying 2-3 clients 1-1 CONVERT BLANKS clause, Java user conversion server class 4-2 implementation of 6-17, 6-26 user profile server class 3-6 CONVERT command, SCUP 1-2, 2-3 Connection not established with gateway… converting SCREEN COBOL requesters to (message 3300) A-15 web clients constructor CONVERT command 2-3 for Cursor class 6-124 overview of steps 2-1 for ExitProgramException class 6-126 currency sign, setting 6-119 for FunctionKey class 6-43 Cursor class for Gateway class 6-3 constructor 6-124 for HTMLHandler class 6-33 data members 6-123 for Pic9 class 6-61 details 6-123 for Pic9P class 6-73 methods 6-124 for Pic9V class 6-86 customizing the screens 2-12 for PicN class 6-98 customizing user profiles 3-1 for PicX class 6-105 for ProgramUnit class 6-118 D for ScLibUserConversion class 6-133 data items in Working-Storage Section, for ScobolException class 6-127 mapping to Java objects 5-4 for ScobolGroupType class 6-54 Data left over on scatter to working storage (message 3179) A-10 for ScobolSendException class 6-128 data members for ScobolTxnException class 6-129 in Cursor class 6-123 for ScobolType class 6-45 in ProgramUnit class 6-118 for ScreenField class 6-15 in ScobolLib class 6-121 for ScreenFieldArray class 6-24 in ScobolType class 6-44 for ScreenFieldGroup class 6-31 in ScreenField class 6-14 for ServerReplyCode class 6-11 in ScreenFieldArray class 6-23 for StopRunException class 6-129 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 Index-2
  • Index E database for user profiles 3-2 doInputUserConversion method data-type classes 6-44 in ScLibUserConversion class 6-133 decimal point character, setting 6-119 in UserConversion class 6-131 delay method 6-121 doOutputUserConversion method delaying program execution 6-121 in ScLibUserConversion class 6-134 DEPENDING variable value too big in UserConversion class 6-132 (message 3002) A-1 doTransform method 6-115 deploying web clients double-byte character encoding 3-4 OSS environment 2-9 double-byte data, Java implementation Windows environment 2-11 of 6-97 developing web clients DYNAMIC modifier, not supported B-2 diagram 1-2/1-3 steps in process 2-1/2-17 E DEVICEINFO statement, not supported B-2 encoding parameter 3-4 DIALOG-ABORT statement, Java endTransaction method 6-9 implementation of 6-6 END-TRANSACTION statement, Java DIALOG-BEGIN statement, Java implementation of 6-9 implementation of 6-7 Error during dialog verb execution DIALOG-END statement, Java (message 3253) A-15 implementation of 6-8 Error during I/O on socket (message DIALOG-INFO Special Register 7-6 3306) A-17 DIALOG-SEND statement, Java Error during I/O to external PATHMON implementation of 6-9 (message 3231) A-11 display data types, Java implementation of Error during server I/O (message 3116) A-9 integer 6-60 Error Handling Pathway/iTS 1.1 7-8 noninteger 6-72, 6-84 Error in dialog mode (message 3250) A-13 real 6-84 Error in non-retryable linkmon connect display method 6-35 (message 3247) A-12 DISPLAY OVERLAY SPACES statement, Error in server class (message 3246) A-11 Java implementation of 6-38 Error in TCP (message 3249) A-13 DISPLAY OVERLAY statement, Java implementation of 6-37 Error messages from web clients A-1/A-18 display parameters, specifying 2-3 error messages from web clients A-1/A-19 DISPLAY RECOVERY statement, not Error when dialog is invalid due to primary supported B-2 TCP failure (message 3252) A-14 DISPLAY statement, Java implementation Error when dialog is not ended by server of 6-35 (message 3251) A-14 displayBase method 6-36 exception classes 6-126 displayOverlay method 6-37 exceptions displayOverlaySpaces method 6-38 for EXIT PROGRAM statement 6-126 for server-class send operations 6-127 for STOP RUN statement 6-129 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 Index-3
  • Index F exceptions (continued) gateway program for transaction errors 6-128 illustrated 1-3 for TRANSFORM statement 6-129 role of, in supporting web clients 1-5 for unrecoverable terminal errors 6-126 getHostLength method eXecute method 5-5 in Cursor class 6-124 Exit program encountered (message in Pic9 class 6-62 3049) A-6 in Pic9P class 6-75 EXIT PROGRAM statement, Java in Pic9V class 6-87 implementation of 6-118 in PicN class 6-100 EXIT RECOVERY statement, not supported B-2 in PicX class 6-107 exitProgram method 6-118 in ScobolGroupType class 6-55 ExitProgramException class in ScobolType class 6-45 constructor 6-126 getHostValue method details 6-126 in Cursor class 6-124 Expect display usage (message in Pic9 class 6-63 3310) A-18 in Pic9P class 6-76 in Pic9V class 6-88 F in PicN class 6-100 Fatal error during BEGIN TRANSACTION in PicX class 6-107 (message 3307) A-17 in ScobolGroupType class 6-56 Fault Tolerance in ScobolType class 6-46 Pathway/iTS 1.1 7-7 getNewOverlayManager method 6-119 Field contains other than DBCS data getProfile parameter 3-1, 3-4 (message 3068) A-6 getServerClassName method 6-134 FILL clause, Java implementation of 6-17, getValue method 6-26 in Pic9 class 6-64 FREEZE SERVER Command Changes 7-6 in Pic9P class 6-77 Function unimplemented (message 3203) A-11 in Pic9V class 6-89 FunctionKey class in PicN class 6-101 constructor 6-43 in PicX class 6-108 details 6-43 group-level items, mapping to nested Java classes 5-3 Guardian user name and password, G entering 3-1 Gateway class constructor 6-3 H details 6-2 host connectivity classes 6-2 methods 6-3 HTML files, customizing 2-12 use of by converter 5-5 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 Index-4
  • Index I HTML pages Invalid parameter (message 3304) A-17 control page 5-3 Invalid subscript value (message 3003) A-2 initial page 5-2 IP port number, setting for router mapping of Screen section to 5-3, 5-7 process 2-13 IS [NOT] ALPHABETIC condition, Java starting page 5-2 implementation of HTML screen interaction classes 6-13 for group data types 6-56 HTMLHandler class for PIC X data types 6-109 constructor 6-33 IS [NOT] DOUBLEBYTE clause, Java details 6-32 implementation of methods 6-33 for PIC N data types 6-101 use of by converter 5-5 for PIC X data types 6-108 HTMLVOL parameter, in CONVERT IS [NOT] EQUAL TO ALL condition, Java command 5-7 implementation of 6-48 HTTP protocol, support for 1-4 IS [NOT] EQUAL TO condition, Java implementation of I for PIC 9 data types 6-64 for PIC 9P data types 6-77 Illegal ACCEPT variable timeout value (message 3037) A-5 for PIC 9V data types 6-89 Illegal delay value (message 3074) A-7 generic 6-46 import package IS [NOT] GREATER THAN ALL condition, See Java import package for web Java implementation of 6-50 clients IS [NOT] GREATER THAN condition, Java implementation of initial attributes of screen field, setting 6-17, 6-26 for PIC 9 data types 6-66 initial page, HTML 5-2 for PIC 9P data types 6-78 initialize method, in Cursor class 6-125 for PIC 9V data types 6-90 input user conversion methods, Java generic 6-49 implementation of 6-131, 6-133 IS [NOT] LESS THAN ALL condition, Java input-output elements, mapping to implementation of 6-52 ScreenField objects 5-6 IS [NOT] LESS THAN condition, Java Integer data types, Java implementation implementation of of 6-60 for PIC 9 data types 6-67 Intelligent Device Support (IDS), not for PIC 9P data types 6-80 supported B-4 for PIC 9V data types 6-92 Intelligent Device Support (IDS), not supported for web clients 1-1 generic 6-51 interface class IS [NOT] NUMERIC condition, Java for screen field identifiers 6-13 implementation of for group data types 6-57 for user conversion routines 6-131 for PIC 9 data types 6-69 Internal error (message 3302) A-16 Invalid numeric item (message 3040) A-5 for PIC 9P data types 6-82 Invalid numeric item (message 3053) A-6 for PIC 9V data types 6-94 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 Index-5
  • Index J S [NOT] NUMERIC condition, Java implementation of (continued) J for PIC X data types 6-109 Japanese kanji-katana character set 3-4 generic 6-53 Java applet, main 5-2 isDoubleByte method Java classes in PicN class 6-101 in Java import package 6-1 in PicX class 6-108 mapping of program units to 5-3 isEqualTo method Java code, modifying for web clients 2-4 in Pic9 class 6-64 Java import package for web clients in Pic9P class 6-77 contents of 6-1/6-134 in Pic9V class 6-89 defined 1-3 in ScobolType class 6-46 use of by converter 5-5 isEqualToAll method 6-48 Java objects, mapping of Working-Storage data items to 5-4 isGreaterThan method JavaScript functions, embedded in HTML in Pic9 class 6-66 pages 5-1, 5-7 in Pic9P class 6-78 JAVAVOL parameter, in CONVERT in Pic9V class 6-90 command 5-3 in ScobolType class 6-49 JGETFILE and JPUTFILE files 2-7 isGreaterThanAll method 6-50 JMAKENV utility isLessThan method functions in a Windows in Pic9 class 6-67 environment 2-7 in Pic9P class 6-80 functions in an OSS environment 2-6 in Pic9V class 6-92 when in OSS environment 2-5 in ScobolType class 6-51 isLessThanAll method 6-52 K isValueAlphabetic method kanji-katakana character set 3-4 in PicX class 6-109 in ScobolGroupType class 6-56 L isValueNumeric method LENGTH [MUST BE] clause, Java in Pic9 class 6-69 implementation of 6-18, 6-27 in Pic9P class 6-82 level-88 data items 5-5 in Pic9V class 6-94 literals in PicX class 6-109 in Pic9 class 6-61 in ScobolGroupType class 6-57 in Pic9P class 6-73 in ScobolType class 6-53 in Pic9V class 6-85 I/O operations, changing number of, in a in PicN class 6-98 TCP/IP session 2-14 in PicX class 6-105 load balancing, by router process and TCP 1-4, 1-5 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 Index-6
  • Index M LOGICAL-TERMINAL-NAME special modified data tag (MDT), not used by web register 3-2 clients 5-6 logon security 3-1 modifying HTML files 2-12 M modifying code for web clients 2-4 MOVE ALL statement, Java implementation main applet, Java 5-2 of 6-57, 6-102, 6-109 maintaining code for web clients 1-1, 2-16 MOVE HIGH-VALUES statement, Java make file, for building converted implementation of 6-57, 6-109 application 2-8 MOVE LOW-VALUES statement, Java managing Pathway applications with web implementation of 6-57, 6-110 clients 1-1 MOVE QUOTES statement, Java Maximum reply size exceeds limit implementation of 6-58, 6-110 (message 3114) A-8 MOVE SPACES statement, Java MDT, not used by web clients 5-6, B-2 implementation of 6-58, 6-102, 6-110 Message Section, not supported B-5 MOVE statement, Java implementation of methods for group data types 6-58 extra, to perform special tasks 5-5 for PIC 9 data types 6-69 in Cursor class 6-124 for PIC 9P data types 6-82 in Gateway class 6-3 for PIC 9V data types 6-94 in HTMLHandler class 6-33 for PIC N data types 6-102 in Pic9 class 6-60 for PIC X data types 6-110 in Pic9P class 6-73 MOVE ZEROS statement, Java in Pic9V class 6-85 implementation of in PicN class 6-97 for group data types 6-59 in PicX class 6-104 for PIC 9 data types 6-72 in ProgramUnit class 6-118 for PIC 9P data types 6-84 in ScLibUserConversion class 6-133 for PIC 9V data types 6-96 in ScobolGroupType class 6-53 for PIC X data types 6-113 in ScobolLib class 6-121 MOVE ZEROS TO NEW-CURSOR|OLD- in ScobolType class 6-45 CURSOR statement, Java implementation of 6-125 in ScreenField class 6-15 moveAll method in ScreenFieldArray class 6-24 in PicN class 6-102 in ScreenFieldGroup class 6-31 in PicX class 6-109 in ServerReplyCode class 6-11 in ScobolGroupType class 6-57 in Transform class 6-114 MUST [BE] clause, Java implementation in UserConversion class 6-131 of 6-19, 6-27 mapping of SCREEN COBOL paragraphs to 5-5 Modified data tag (MDT), not used by web clients B-2 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 Index-7
  • Index N N onLoadFunc, use of 5-7 onOkBtnFunc, use of 5-7 names Open System Services (OSS) operating of Java objects for Working-Storage environment 2-5 data items 5-4 output user conversion methods, Java of methods for SCREEN COBOL implementation of 6-132, 6-134 paragraphs 5-5 overlay areas 5-7 of nested Java classes for group-level Overlay screen displayed in two areas items 5-3 (message 3013) A-3 of ScreenField objects for SCREEN overlay screens COBOL input-output objects 5-6 clearing an overlay screen 6-38 of user HTML pages 5-7 mapping to HTML pages 5-7 NEW-CURSOR special register, Java setting context for display 6-37 implementation of 6-123 nld utility 4-2 No room for new server class in TCP P (message 3110) A-7 paragraphs, mapping to methods 5-5 No space for new server process parameter passing 5-5 (message 3119) A-10 password, Guardian, entering 3-1 noninteger numeric data types, Java PATHTCPL, Java implementation of user implementation of 6-72, 6-84 conversion routines in 6-132 NonStop™ Himalaya system pathway.its package See also NonStop™ Kernel operating See Java import package for web system clients building web clients on 2-8 performance, tuning for 2-14 setting up build environment on 2-5, PIC 9 data types with P symbol, Java 2-6 implementation of Not enough data for scatter to working See Pic9P class storage (message 3180) A-10 PIC 9 data types with V symbol, Java numeric data types, Java implementation of implementation of integer 6-60 See Pic9V class noninteger 6-72, 6-84 PIC 9 data types, Java implementation of real 6-84 See Pic9 class PIC N data types, Java implementation of O See PicN class PIC X data types, Java implementation of OCCURS clause, Java implementation of 6-22 See PicX class OLD-CURSOR special register, Java Pic9 class implementation of 6-123 constructor 6-61 ON ERROR clause, Java implementation details 6-60 of 6-6 literals 6-61 ON ERROR method of BEGIN- methods 6-60 TRANSACTION… (message 3303) A-16 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 Index-8
  • Index Q Pic9P class (continued) constructor 6-73 Q queuing, by router process 1-4 details 6-72 literals 6-73 methods 6-73 R constructor 6-86 raw sockets protocol, support for 1-4 data precision limit B-3 real data types, Java implementation of 6-84 details 6-84 RECEIVE UNSOLICITED MESSAGE literals 6-85 statement, not supported B-3 methods 6-85 RECONNECT MODEM statement, not PicN class supported B-3 constructor 6-98 REPLY CODE… YIELDS clause, Java details 6-97 implementation of 6-11 literals 6-98 Reply Length Invalid (message 3115) A-8 methods 6-97 Reply number not known to program (message 3112) A-7 PicX class REPLY UNSOLICITED MESSAGE constructor 6-105 statement, not supported B-3 details 6-103 Request invalid for server state (message literals 6-105 3118) A-9 methods 6-104 RESET ATTR statement, Java implementation of 6-39 port number, setting for router process 2-13 RESET DATA statement, Java PRINT SCREEN statement, not implementation of 6-40 supported B-3 resetAttribute method 6-39 PROFDBM utility 2-4, 3-5 resetData method 6-40 profiles, user RESTART-TRANSACTION statement, not See user profiles supported B-4 program units, mapping to Java Retryable linkmon error (message classes 5-3 3248) A-12 ProgramUnit class router process constructor 6-118 defined 1-4 data members 6-118 illustrated 1-3 details 6-117 setting port number for 2-13 methods 6-118 Run-time dynamic attribute setting invalid protocols supported by router process 1-4 (message 3072) A-7 proxy servers, internet run-time environment for web clients 1-3 illustrated 1-3 support for 1-5 PW-TCP-PROCESSNAME special register 3-2 PW-TCP-SYSTEM-NAME special register 3-2 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 Index-9
  • Index S S SCREEN COBOL (continued) program units, mapping to Java ScLibUserConversion class classes 5-3 constructor 6-133 requesters, converting to web details 6-132 clients 2-3 methods 6-133 types of programs supported for SCOBOL 7-3 conversion 1-1 SCOBOL Verbs and Special Register 7-3 screen field, setting initial attributes of 6-17, ScobolException class 6-26 constructor 6-127 screen group, Java implementation of 6-30 details 6-126 Screen operation done without base displayed (message 3007) A-3 ScobolGroupType class Screen section, mapping to HTML constructor 6-54 pages 5-7 details 6-53 ScreenField class methods 6-53 constructor 6-15 ScobolLib class data members 6-14 data members 6-121 details 6-13 details 6-120 methods 6-15 methods 6-121 ScreenField objects ScobolSendException class mapping from input-output constructor 6-128 elements 5-6 details 6-127 relationship to HTML fields 5-6 ScobolTxnException class ScreenFieldArray class constructor 6-129 constructor 6-24 details 6-128 data members 6-23 ScobolType class details 6-22 constructor 6-45 methods 6-24 data members 6-44 ScreenFieldGroup class details 6-44 constructor 6-31 methods 6-45 details 6-30 SCREEN COBOL methods 6-31 data-type classes 6-44 ScreenFieldIdentifier class, details 6-13 features not supported for web SCRFORM 5-7 clients B-1/B-5 SCROLL statement, not supported B-4 modifying code for web clients 2-4 SCUP CONVERT command 1-2, 2-3 modifying source code 2-16 security, logon 3-1 object files, preparing for SEND MESSAGE statement, not conversion 2-2 supported B-4 paragraphs, mapping to Java send method 6-10 methods 5-5 SEND statement, Java implementation of 6-10 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 Index-10
  • Index S Send: server class name invalid (message setHostValue method (continued) 3022) A-4 in Pic9 class 6-63 server class in Pic9P class 6-76 for user conversion routines, in Pic9V class 6-88 configuring 4-2 in PicN class 6-101 for user profiles, configuring 3-6 in PicX class 6-108 Server class name invalid (message 3022) A-4 in ScobolGroupType class 6-56 Server class undefined (message in ScobolType class 6-46 3117) A-9 setInitAttribute method ServerReplyCode class in ScreenField class 6-17 constructor 6-11 in ScreenFieldArray class 6-26 details 6-11 setLENGTH method methods 6-11 in ScreenField class 6-18 server-class send operation, Java in ScreenFieldArray class 6-27 implementation of 6-10 setLowValues method sessionlength parameter in control.html in PicX class 6-110 file 2-15 in ScobolGroupType class 6-57 session, TCP/IP, changing number of I/O operations in 2-14 setMUSTBE method SET NEW-CURSOR statement, Java in ScreenField class 6-19 implementation of 6-41 in ScreenFieldArray class 6-27 setADVISORY method setNewCursor method 6-41 in ScreenField class 6-16 SETPORT utility 2-13 in ScreenFieldArray class 6-25 setQuotes method setCharSet method 6-122 in PicX class 6-110 setCONTROLLEDBY method in ScobolGroupType class 6-58 in ScreenField class 6-16 setSHADOWED method in ScreenFieldArray class 6-25 in ScreenField class 6-19 setCONVERTBLANKS method in ScreenFieldArray class 6-28 in ScreenField class 6-17 setSpaces method in ScreenFieldArray class 6-26 in PicN class 6-102 setCurrencySign method 6-119 in PicX class 6-110 setDecimalPointCharacter method 6-119 in ScobolGroupType class 6-58 setFILL method setUPSHIFT method in ScreenField class 6-17 in ScreenField class 6-20 in ScreenFieldArray class 6-26 in ScreenFieldArray class 6-28 setHighValues method setUSERCONVERSION method in PicX class 6-109 in ScreenField class 6-20 in ScobolGroupType class 6-57 in ScreenFieldArray class 6-29 setHostValue method setVALUE method in Cursor class 6-125 in ScreenField class 6-21 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 Index- 11
  • Index T setVALUE method (continued) in ScreenFieldArray class 6-29 T TCP Checkpoint Strategy 7-4 setValue method TCP/IP in Pic9 class 6-69 port number, setting for router in Pic9P class 6-82 process 2-13 in Pic9V class 6-94 session, changing number of I/O in PicN class 6-102 operations in 2-14 in PicX class 6-110 terminal control process (TCP) in ScobolGroupType class 6-58 illustrated 1-3 setWhenAbsent method role of, in supporting web clients 1-4 in ScreenField class 6-21 Terminal stopped by program (message in ScreenFieldArray class 6-30 3052) A-6 setWhenBlank method Terminal types supported B-4 in ScreenField class 6-21 TERMINALINFO statement, not in ScreenFieldArray class 6-30 supported B-5 TERMINAL-FILENAME special register 3-2 setZeroes method TERMINAL-PRINTER special register 3-2 in Pic9 class 6-72 TMF not configured (message 3030) A-4 in Pic9P class 6-84 TMF not running (message 3031) A-5 in Pic9V class 6-96 Transaction error (message 3301) A-16 in PicX class 6-113 Transaction message size exceeds limit in ScobolGroupType class 6-59 (message 3113) A-8 SHADOWED [BY] clause, Java Transaction mode violation implementation of 6-19, 6-28 (message 3027) A-4 sockets protocol, support for 1-4 Transform class Special Registers 7-5 constructor 6-114 special registers details 6-113 Java classes for 6-120 methods 6-114 user profiles 3-2 TRANSFORM statement specifying the character set 6-122 Java implementation of 6-113 starting page, HTML 5-2 with Message Section data, not Statistics Collected supported B-5 Pathway/iTS 1.1 7-7 TransformException class STOP RUN statement, Java constructor 6-130 implementation of 6-120 details 6-129 stopRun method 6-120 turn method 6-42 StopRunException class TURN statement, Java implementation constructor 6-129 of 6-42 details 6-129 symbols, use in conversion 2-2 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 Index-12
  • Index U U user profiles (continued) updating 3-5 Unix operating system USER [CONVERSION] clause, Java building web clients on 2-8 implementation of 6-20, 6-29 specifying as build environment 2-2 userAuthenticate parameter 3-4 Unknown host (message 3305) A-17 UserConversion class Unsolicited-message processing, not constructor 6-131 supported B-3 details 6-131 UPSHIFT clause, Java implementation methods 6-131 of 6-20, 6-28 USERPROF database 3-2 USE FOR SCREEN-RECOVERY statement, not supported B-5 USE FOR TERMINAL-ERRORS statement, V not supported B-5 validating Guardian user name and user conversion routines password 3-1 building library for 4-2 VALUE clause, Java implementation configuring server class for 2-14, 4-2 of 6-21, 6-29 getting server-class name for 6-134 Java classes for 6-131 W setting up for use with web web clients clients 4-1/4-3 building in OSS environment 2-5 standard, Java equivalent of 6-132 building in Windows environment 2-6 user HTML pages mapped to Screen Sections 5-3 building, overview of 2-5 user name, Guardian, entering 3-1 configuring and managing Pathway applications with 1-1 User profile server communication error (message 3311) A-18 deploying in OSS environment 2-9 user profiles deploying in Windows actions of web client with 3-2 environment 2-11 adding 3-5 development process for 1-2/1-3, 2-1/2-17 adding Java code to web client 2-4 error messages from A-1/A-18 configuring server class for 2-14 Java import package for 1-3, 6-1/6-134 configuring user profile server class 3-6 maintaining 1-1, 2-16 control file options 3-3 modifying code for 2-4 control file parameters for 2-14 run-time environment for 1-3 database for 3-2 tuning for performance 2-14 defined 3-1 types of SCREEN COBOL programs definition and logging on 3-1 supported for conversion 1-1 deleting 3-6 Web Clients in Pathway/iTS 1.1 7-4 searching for 3-6 WHEN ABSENT clause, Java setting up the database 2-4 implementation of 6-21, 6-30 special registers for 3-2 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 Index-13
  • Index Y WHEN BLANK clause, Java implementation of 6-21, 6-30 Windows NT operating system building web clients on 2-9 specifying as build environment 2-2 Working-Storage section, mapping to Java classes 5-3 Y YIELDS clause of TRANSFORM statement, Java implementation of 6-115 yields method 6-115 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 Index-14
  • Content Feedback First Name: __________________ Last Name: _________________ Phone: _____________________ e-mail address: ______________ Company: ___________________ (All contact information fields are required.) If you’re reporting an error or omission, is your issue: Minor: I can continue to work, but eventual resolution is requested. Major: I can continue to work, but prompt resolution is requested. Critical: I cannot continue to work without immediate response. Comments (give sufficient detail to help us locate the text): ______________________________________________________________________________ ______________________________________________________________________________ ______________________________________________________________________________ ______________________________________________________________________________ ______________________________________________________________________________ Thank you for taking the time to provide us with your comments. You can submit this form online, e-mail it as an attachment to pubs.comments@hp.com, fax it to 408-285-5520, or mail it to: Hewlett-Packard Company NonStop Enterprise Division 19333 Vallco Parkway, MS 4421 Cupertino, CA 95014-2599 Attn.: Product Manager, Software Publications