Web Services Employee Demonstration

The CA IDMS Web Services demonstration combines the use of both the Consumer and Provider Web service components. The demonstration is designed to work completely within CA IDMS on the mainframe, eliminating any network security issues or the need to establish a more complicated Web server environment. It can be implemented to work on a single CA IDMS CV, or may be configured to use multiple CA IDMS CVs (one for the Consumer and one for the Provider).
idms19
The CA IDMS Web Services demonstration combines the use of both the Consumer and Provider Web service components. The demonstration is designed to work completely within CA IDMS on the mainframe, eliminating any network security issues or the need to establish a more complicated Web server environment. It can be implemented to work on a single CA IDMS CV, or may be configured to use multiple CA IDMS CV's (one for the Consumer and one for the Provider).
2
2
The Web Services Employee demonstration application consists of a single CA ADS Consumer Dialog (IDMSWSDM), which makes Web Services API calls to invoke a Provider implementation program (IDMSWSPI).  The Provider implementation program is written in COBOL and also runs within CA IDMS, either within the same CV as the Consumer Dialog or on a second IDMS CV.
The following diagram outlines the Web services demonstration components in relation to the CA IDMS Web Services interface modules:
Web Services Demo Architecture Diagram
Customizing the Employee Demonstration
Complete source code is provided for all components of the CA IDMS Web Services Demonstration application. Users may modify or clone the demonstration programs to become familiar with the development of Web services within CA IDMS.
The following table lists the components that comprise the demonstration programs. These components are installed with the CA IDMS Web Services feature:
Item Name
Description
Location
IDMSWSMP
Map Definition (RHDCMAP1 syntax)
CAGJSAMP library
IDMSCAPI
Copybook used in COBOL Consumer (DDDL Syntax)
CAGJSAMP library
IDMSDAPI
Dialog Processes and Records (DDDL Syntax)
CAGJSAMP library
IDMSWSDM
Dialog Definition (ADSOBCOM syntax)
CAGJSAMP library
IDMSWSPI
COBOL Provider Implementation Program Source
CAGJSAMP library
IDMSWSCI
COBOL Consumer Demo Program Source
CAGJSAMP library
IDMSWSP1
PL/I Consumer Demo Program Source
CAGJSAMP library
IDMSWSDL
WSDL Definition for the IDMSPROV Service
CAGJSAMP library
Running the Web Service Employee Demonstration
The Web Services demo components are all provided and installed as part of the CA IDMS software installation. The demonstration uses the CA IDMS Employee Demo database to retrieve detail information on a specific Employee, using an Employee-ID provided by the Consumer service.
To invoke the Consumer demo ADS Dialog, type the task code 'IDMSWSDM' within CA IDMS. The Premap process dialog populates the map with default values for the required fields.
You may need to modify one or more of the required input fields for your IDMS environment.
Follow these steps:
  1. Specify the Employee ID you want to report on.  The pre-seeded value of 0472 should be present on your Employee Demo Database.
  2. Specify the Employee Demo DBNAME of your database on the Provider service CV.  The pre-seeded value of EMPDEMO is typically valid.
  3. Specify the IP Address and Port designations of the CV where your Employee Demo Provider service is running.
    The IP Address provided infers that the Provider service resides on the same CV as the Consumer.
    The Port Address 3850 reflects the default listener specification for the IDMS Web Services listener.
    Note: The IP address, 127.0.0.1, is a TCP/IP loop-back designation that resolves to the IP address of the caller.  You do not need to change this address if you want to invoke the Provider service on the same CV as the Consumer Demo Dialog.
  4. Specify the User ID and Password, if necessary, for the invocation of the Provider service implementation program (IDMSWSPI) on the targeted CV.
    The sign-on requirement is determined on the Provider service CV, based on the setting of the Require Signon option within the Web Services configuration task (WEBC).
  5. Press Enter.
The following example shows the result of the invocation of the Dialog's 'Enter' Response. The APPLICATION-LEVEL OUTPUT DATA fields are automatically filled in as a result of the service request made to the IDMSWSPI Provider service.
COBOL Demonstration Consumer Service
As an alternative to using ADS/Online, a COBOL version of the demonstration Consumer service program, IDMSWSCI, is provided. IDMSWSCI uses the same Map as Dialog IDMSWSDM, and calls the same back-end service program, using the CA IDMS Web Services API. To view the source code for IDMSWSCI, select the following attachment:
250
A second Web Services COBOL program, IDMSWSCL, demonstrates how to use Web Services logging using the WSGETOPTION. To view the source code for IDMSWSCL, select the following attachment:
250
Note: The IDMSWSCL program is available only in the documentation.
PL/I Demonstration Consumer Service
For clients who prefer to code in PL/I, a PL/I version of the demonstration Consumer service program, IDMSWSP1, is also available. IDMSWSP1 uses the same Map as Dialog IDMSWSDM, and calls the same back-end service program, using the CA IDMS Web Services API. To view the source code for IDMSWSP1, select the following attachment:
250
Invoking the Employee Demonstration Externally
Users can develop their own external Consumer for the IDMSWSPI Employee Demo Provider implementation. To help facilitate this development effort, a WSDL (Web Services Development Language) file has been created for the Employee Demo Provider. This file can be found in the CAGJSAMP installation library, under member name IDMSWSDL.  For more information, see WSDL File for the CA IDMS Web Services Demonstration.