Dynamically installing the WEBSERVICE and URIMAP resources

Each function that is exposed as a web service requires a WEBSERVICE resource to map between the incoming XML of the SOAP BODY and the COMMAREA interface of the program, and a URIMAP resource that routes incoming requests to the correct pipeline and web service. Although you can use resource definition online (RDO) to define and install your WEBSERVICE and URIMAP resources, you can also have CICS® create them dynamically when you install a pipeline resource.

About this task

Optional: Those users that do not use CICS Explorer can use the CEDA transaction to amend and install the resources contained in groups DFH$EXBS and DFH$EXWS.

Procedure

  1. Use the CICS Explorer® to install the PIPELINE resources.
    1. Select Definitions > Pipeline Definitions. Right-click the EXPIPE01 PIPELINE definition in the Pipeline Definitions view and select Install. Select your target CICS region by selecting the check box. Click OK to install the PIPELINE.
      Note: If you created Java-based pipeline definitions in Creating the pipeline definition then right-click EXPIPE03 PIPELINE definition in the Pipeline Definitions view.
    2. Repeat this process for the EXPIPE02 PIPELINE definition or EXPIPE04 for Java-based pipelines.

      When you install each PIPELINE resource, CICS scans the directory specified in the PIPELINE WSDIR attribute (the pickup directory). For each WEBSERVICE binding file in the directory, that is for each file with the .wsbind suffix, CICS installs a WEBSERVICE resource and one URIMAP resource if these resources do not exist.

      The URIMAP resource provides CICS with the information to associate the WEBSERVICE resource with a specific URI. Existing resources are replaced if the information in the binding file is newer than the existing resources.

      A second optional URIMAP resource is installed if a WSDL file or WSDL archive file has been copied to the pickup directory. This URIMAP resource provides CICS with the information to associate the WSDL archive file or WSDL document with a specific URI so that external requesters can use the URI to discover the WSDL archive file or WSDL document.

      When the PIPELINE is later disabled and discarded, all associated WEBSERVICE and URIMAP resources are also discarded.

  2. If you have already installed the PIPELINE resource, use the PERFORM PIPELINE SCAN command to initiate the scan of the PIPELINE pickup directory.
    When you have installed the PIPELINE resources, the following WEBSERVICE resources and the associated URIMAP resources for the provider pipeline are installed in your system:
    • dispatchOrder
    • dispatchOrderEndpoint
    • inquireCatalog
    • inquireCatalogClient
    • inquireCatalogWrapper
    • inquireSingle
    • inquireSingleClient
    • inquireSingleWrapper
    • placeOrder
    • placeOrderClient
    • placeOrderWrapper
    The names of the WEBSERVICE resources are derived from the names of the WEBSERVICE binding files; the names of the URIMAP resources are generated dynamically. An additional URIMAP is generated for each WSDL document that exists in the pickup directory of the pipeline. You can view the resources by selecting Operations > Web Services to open the Web Services view. Right-click the WEBSERVICE resource and select Open Related > URI Map.

    The CICS Explorer view shows the names of the PIPELINE resource, the URIMAP resource, and the target program that is associated with each web service. In this example, there is no URIMAP or target program for WEBSERVICE(dispatchOrder) because the WEBSERVICE resource is for an outbound request.

    WEBSERVICE(dispatchOrderEndpoint) represents the local CICS implementation of the dispatch order service.