Deploy web handler services

Use a custom web handler file to deploy named services

Use the ROOT.handlers file to deploy unnamed services

Migrate web handlers to OpenEdge 12.2

System administrators use the tcman export command to migrate web handlers from the old format of the openedge.properties file into the new web handlers JSON format Version 2.0. The migrated URLs remain compatible with the older version. To migrate web handlers, perform the following steps:

1. Obtain the r-code that supports the web handler service for the OpenEdge 12.1 or prior instance from the developer.
2. Create a target PAS for OpenEdge instance using OpenEdge 12.2. If you are not deploying to the ROOT ABL web application, deploy a supporting ABL web application to this instance.
3. Move the r-code to the PROPATH of the OpenEdge 12.2 instance, for example, instance-name/webapps/ROOT/WEB-INF/openedge or instance-name/webapps/webapp-name/WEB-INF/openedge.
4. From the /bin directory of the target OpenEdge 12.2 instance, run the tcman export command on the older instance to export the ABL application and all of its supporting web applications and services into an OpenEdge Application Archive file, for example:

   proenv>WRK122\oepas122\bin\tcman export -appName oepas1 -instanceDir C:\OpenEdge\WRK121\oepas1\

   This process reads the web handler configuration from openedge.properties, strips them from the file, and adds them to the WEB-INF/adapters/web/ROOT/ROOT.handlers file.

   If you had an ABL application called myABLApp with the web applications SportsWebApp and EntityWebApp, and each web application has the web handler configuration in the openedge.properties file. Then the exported OpenEdge Application Archive contains the following handler files:

   <CATALINA_BASE>/webapps/SportsWebApp/WEB-INF/adapters/web/ROOT/ROOT.handlers <CATALINA_BASE>/webapps/EntityWebApp/WEB-INF/adapters/web/ROOT/ROOT.handlers

5. Deploy this OpenEdge Application Archive package to the OpenEdge 12.2 instance using tcman import, for example:

   proenv>WRK122\oepas122\bin\tcman import C:\OpenEdge\oepas1.oear

6. Start the OpenEdge 12.2 instance.
7. Test the web handler service in a web browser. It can be accessed using the same URI as the previous version of the web handler service.

Deploy web handlers before OpenEdge 12.2

When deploying a new web handler service in OpenEdge 12.0 and 12.1, add the custom handlers that the developer defines in the order provided to the openedge.properties file.

Perform the following steps to deploy a web handler service to an instance:

1. Get the r-code that supports the web handler service and the defined handler names in the openedge.properties file from the developer.
2. Move the r-code to the PROPATH.
3. Run the PROEVMV utility and go to the /bin directory of the target instance.
4. Add the handler properties to the openedge.properties file using the OEPROP utility:

   oeprop +instance-name.webapp-name.WEB.handler1=CustomHandler

Reload web handlers online

System administrators can reload web handler contexts without restarting the PAS for OpenEdge instance so that web handlers can be updated or published dynamically online. Administrators can use the tcman jmx refreshWeb command to reload the web handler context whenever a web handler is published or updated.

For more information, see Refresh web handlers for an ABL web application (jmx refresh).

Supported JSON formats for web handler information file

OpenEdge 12.2 supports versions 1.0 and 2.0 of the web handlers file. Use version 2.0 of the web handlers file to keep current.

{
    "version": "1.0",
    "serviceName": "SportsSvc",
    "handlers": [{
        "className": "SportsSvc",
        "URIs": [
            "\/webHandlers",
            "\/some-data",
            "\/customers\/{custnum}\/orders\/{ordernum}",
            "\/customers\/{custnum}\/orders",
            "\/customers\/{custnum}",
            "\/customers"
        ]
    }]
}

{
  "version": "2.0",
  "serviceName": "",
  "handlers": [
    {
      "uri": "/WebHandlers",
      "class": "WebHandlersHandler",
      "enabled": true
    },
    {
      "uri": "/customers/{custnum}/orders/{ordernum}",
      "class": "CustomerService",
      "enabled": true
    }
  ]
}