Product Documentation
Abstract
Host initiated display provides image enablement for text based line of business application (LOB) such as those that uses z/OS 3270 terminal display. LOB applications can query IBM Content Manager Version 8.5 for image objects (such as documents) and display those objects on a workstation terminal.
Content
A pre-existing solution to display documents requires the users to log into IBM Content Manager Client for Windows the first time that a host initiated display request is made. For details, see
http://www.ibm.com/support/knowledgecenter/SSLQWS_8.4.3/com.ibm.installingcmzos.doc/li1441.htm
The following new solution is similar (the host side of the solution remains essentially the same), except that the Client for Windows is now replaced with a purely Java based interface using IBM Content Manager viewer APIs. In this new Java based solution, the Content Manager user ID and password are entered when one starts up the listener. A host initiated request can then display the document automatically on the workstation.
In summary, the following host initiated display sample performs the following tasks:
- The LOB application uses TCP/IP to communicate with the workstation where the object is to be displayed.
- The workstation has a listener that waits for the LOB application to initiate a request for display. The request consist of specifying an item type and a IBM Content Manager query condition to search for the documents to be displayed.
- The sample uses the Content Manager CMBGenericDocViewer API to render the objects for display.
The host initiated display sample include the following programs:
- A sample COBOL LOB application that shows how to make a host initiated display request.
- A sample C program called by the COBOL LOB to communicate with the workstation listener.
- A sample Java listener program that runs on the workstation and waits for host initiated display request from the LOB application.
- Several sample Java programs that shows how to invoke the Content Manager APIs to search for documents and to use the CMBGenericDocViewer services to render the objects for display.
Restriction: The sample provided can only display objects on a Windows workstation. The supported environment for the host program is z/OS batch and CICS.
Software requirement: IBM Content Manager Enterprise Edition V8.5 or later Java APIs
Request string syntax
The request string contains the following four parameters separated by semi-colons:
1. ACTION - can be one of two values:
- S - Search for and display Content Manager documents.
X - Terminate the listener program.
3. ITEMTYPE - Item type to be searched or * for all item types.
4. QUERY – The query condition. It must not contain the forward slash character (/) at the beginning of the condiiton.
For example:
To display documents of itemtype NOINDEX with a SOURCE value that starts with “ABC” in the library server database DBCM85:
ACTION=S;LSDB=DBCM85;ITEMTYPE=NOINDEX;QUERY=@SOURCE LIKE “ABC%"
See the ICMHIDCB JCL for further example of the syntax. The ICMHIDCB JCL is packaged in the HID_host.zip file.
Setting up host initiated display
Use the following two zip file attachments, HID_workstation.zip and HID_host.zip, to set up host initiated display.
To install and configure host initiated display, complete the following steps:
1. Set up the Windows workstation component:
- a. Set up your Content Manager Java API environment by running the cmbenv81.bat file. The cmbenv81.bat file is located in the bin directory of your installed Content Manager product. For example, C:\Program Files (x86)\ibm\db2cmv8\bin\cmbenv81.bat
b. Unzip the HID_workstation.zip file on your Windows workstation. You should see several Java samples programs.
c. Compile the Java sample programs by: javac *.java
d. From an Administrator command prompt, start the ICMQueryItemListener program. Then run the host program: java ICMQueryItemListener
You will be prompted for the following information:
Port number
- This port number must match the port from the LOB host program. Enter no value to use the default (the host sample program uses the same default). The default value is 31015.
- This is the Content Manager user ID used to log on and search for the requested documents.
- This is the password for the Content Manager user ID.
2. Set up the z/OS host component:
a. Unzip the HID_host.zip file on your workstation. There are five JCLs that you will need to upload to your z/OS host machine.
b. Customize and run the following sample JCLs:
ICMDLLCO
- A sample JCL for compiling the C program (ICMHIDHC) that is used to communicate with the workstation listener.
- An example of a LOB COBOL program that sends a host initiated display request. A description of the request syntax is included in the prolog.
- A sample JCL for building the host initiated display executable module.
- A C sample program that demonstrates how to establish a connection with a listener program running on the client workstation.
3. Run the host initiated display sample program by completing either of the following steps:
- Run the following program in batch:
ICMCBLRN
JCL for running the sample LOB COBOL program (ICMHIDCB). - Or run the following programs under CICS:
- In your CICS region RDO definitions, define the program ICMHIDHC (C, RELoad: NO), the program ICMHIDCB (COBOL, RELoad: Yes), and a transaction that associates with the program ICMHIDCB.
- Log on to your CICS region, and start the transaction that is associated with the ICMHIDCB program.
Was this topic helpful?
Document Information
Modified date:
17 June 2018
UID
swg27045714