Toggling between visualized and installed endpoints

Once you generate endpoints for an installed product, you have two sets of endpoints:

  • One set corresponds to the visualized version of the product. These endpoints were created automatically when the product template is imported.
  • The other set corresponds to the installed version of the product. These are the endpoints you generated manually.

For a given product, there can only be one set of active endpoints at a given time. The active endpoints are the ones used for incoming calls from a third-party application. For the purposes of testing and development, PolicyCenter gives you the ability to toggle which set is active. This toggle is controlled by the Enabled for REST API field on the APD Managed tab of the Product Management screen.

When there are two sets of endpoints, then:

  • Setting Enabled for REST API to Enabled enables the visualized product's endpoints. This is the default for every product.
  • Setting Enabled for REST API to Disabled enables the installed product's endpoints.

This is depicted in the following diagram:


Enabled for REST APIs switches between visualized and installed products

Which set of endpoints are active?

If a given product exists only as a visualized product or only as an installed product, Cloud API uses the endpoints for that one version of the product. (However, if the only version of the product has been disabled, Cloud API throws an error. For more information on disabling products, see Disable a visualized product's endpoints and Disable an installed product's endpoints.)

If a given product exists as both a visualized product and an installed product, and both versions have endpoints, then Cloud API checks the product's Enabled for REST API flag.

  • If the flag is set to Enabled, the visualized product is used.
  • If the flag is set to Disabled (and there is a product access file for the product in the /installedlobs directory), the installed product is used.

PolicyCenter also supports the following actions related to visualized and installed products.

Action More Information
Toggle the active endpoints through the PolicyCenter user interface Toggling between visualized and installed endpoints
Toggle the active endpoints through Cloud API Toggle a product's endpoints
Remove a visualized product Remove a visualized product
Disable an installed product's endpoints Disable an installed product's endpoints

Toggle a product's active endpoints through the user interface

About this task

You can also toggle a product's endpoints through Cloud API. For more information, see Toggle a product's endpoints.

Procedure

  1. On the Product Management screen's APD Managed tab, select the product.
  2. Click Edit Product.
  3. In the Enabled for REST API field, select the appropriate option:
    1. Enabled toggles on the visualized product's endpoints.
    2. Disabled toggles on the installed product's endpoints.
  4. Click Save. The change becomes effective immediately. You do not need to restart PolicyCenter.

Results

For more information on toggling a product's endpoints through Cloud API, see Toggle a product's endpoints.

Determining which set of endpoints is active

You can determine which set of endpoints are active by checking the Enabled for REST API flag in PolicyCenter. You can also use the following endpoint:

  • GET /productdefinition/v1/products/{productId}

The response object has a Boolean visualized field. When set to true, the visualized endpoints are active. When set to false, the installed endpoints are active. For example, the following request determines which set of endpoints are active for the WorkersComp product.

Command
GET /productdefinition/v1/products/WorkersComp
Response body
{
    "data": {
        "attributes": {
            "abbreviation": "WC",
            "description": "Workers' Compensation",
            "id": "WorkersComp",
            "name": "Workers' Compensation",
            "productType": {
                "code": "Commercial",
                "name": "Commercial"
            },
            "visualized": false
        },

The visualized field is set to false. Therefore, the installed product's endpoints are active.