Enabling tax integration extensions

You can enable a tax integration extension by registering the command for the extension and configuring the extension. This registration and configuration must be loaded into the HCL Commerce service database.

The following procedure uses a sample tax integration externalized customization extension that is provided with HCL Commerce service to demonstrate how to enable an extension.

There are two methods that you can use to enable the extension.

Before you begin

Ensure that you completed Installing and configuring the tax integration interface.

Procedure

  • To load by using SQL, you can use the following statements as a reference and update with your values.
    INSERT INTO UECONFIG(UECONFIG_ID,URL,HTTPMETHOD,DESCRIPTION,TIMEOUT,RETRIABLE) VALUES (120570201,'extension/tax/tax_integration_custom','POST','Tax Integration',60000,1);
    
    And
    
    INSERT INTO CMDREG(storeent_id, interfacename, description, classname, properties, target) VALUES (0, 'com.ibm.commerce.isv.kit.tax.TaxIntegrationCustomCmd', 'Tax Integration Custom command default implementation', 'com.ibm.commerce.isv.kit.tax.TaxIntegrationCustomCmdImpl', 'replaceUEConfigId=120570201&replaceExecute=true&restTarget=true&retriable=1', 'Local');
    
  • TO load by using the Data Load utility, complete the following steps.
    1. Within the WCDE_installdir/samples/DataLoad/xC directory, create the following CSV input files to register the sample tax integration extension:

      If a CmdReg.csv or UEConfig.csv file already exists in the directory, update the files to include the rows in the following files.

      • CmdReg_taxenable.csv

        This file is used to load the data to register the command for the extension. This registration enables the extension for a store so that it can be called before or after or as a replacement for an existing command implementation. When a call for tax calculation occurs, the Transaction server makes the outbound call to the extension at the appropriate moment. The extension is registered and enabled for the store that is identified within this input file. If you want to register the extension for multiple stores, you must include the data for registering the extension for each store on a separate line in the file.

        Note: Currently, only the replacement of the externalized customization extensions for the TaxIntegrationCustomCmd command is supported.
      • UEConfig_taxenable.csv

        This file is used to configure the extension, such as to define the URL path to where the extension implementation is located, and to define any properties or filters for the extension. In the sample file, the Url column refers to a resource method on the Customization server, relative to https://hostname:9443/commerceue. For example, the URL /extension/order/validate_quantity refers to the resource method https://hostname:9443/commerceue/extension/order/validate_quantity.

        Where:
        commerceue
        The context root of commerceue-app
        extension
        The base URL of the JAX-RS application.
        order
        The path of the resource class.
      For more information about the type of data that can be included within these files, see xC object input file definitions.
    2. Load the CmdReg and UEConfig files to the database.

What to do next