Registering custom xC extensions
Use the CmdReg keyword to assign registered extension code
(UEConfigId) to extension points.
Definitions
- StoreIdentifier
- (String) Required: The unique identifier of the store where you are
registering the extension point.Note:
- If you want to register the command for a particular store, then specify the unique identifier of the store.
- If you want to register the command for all stores, then specify NullEntity.
- Description
- (String) A description of the command.
Maximum number of characters, 254.
- InterfaceName
- (String) Required: The command interface extension point that
your extension code is extending.
Maximum number of characters, 254.
- ClassName
- (String) The implementation class for your custom xC extension
from the context root.
Maximum number of characters, 254.
- Properties
- (String) The default properties associated with this command. The
properties are in the "
property1=value1&property2=value2
" form, where the property is the name of the property, and the value is the value corresponding to the property.Valid properties:- preExecute
- (Boolean) Indicates whether the extension code runs before the command. The value true indicates that the extension code is to run before the command.
- replaceExecute
- (Boolean) Indicates whether the extension code runs instead of the command. The value true indicates that the extension code is to run instead of the command.
- postExecute
- (Boolean) Indicates whether the extension code runs after the command. The value true indicates that the extension code is to run after the command.
- preUEConfigId, replaceUEConfigId, or postUEConfigId
- When the preExecute, replaceExecute, or postExecute parameters are specified, the corresponding UEConfigId must also be given. The UEConfigId is loaded with a UEConfig.csv file. For more information, see UEConfig object input file definitions.
- restTarget
- Indicates whether the extension calls the remote REST service. Set the value to true
(
restTarget=true
).
Maximum number of characters, 254.
Delete
- (String) Indicates whether to delete the record. Specify
1
to delete the record.
Example
CmdReg
StoreIdentifier,Description,InterfaceName,ClassName,Properties
AuroraESite,'My cmdreg', com.ibm.commerce.isv.kit.tax.TaxIntegrationCustomCmd,com.ibm.commerce.isv.kit.tax.TaxIntegrationCustomCmdImpl,restTarget=true&replaceExecute=true&replaceUEConfigId=136068101&retriable=1
The
example assigns the UEConfigId 136068101 (which is associated with your extension code) to the
extension point interface name com.ibm.commerce.isv.kit.tax.TaxIntegrationCustomCmd. The extension
code is assigned as a replaceExecute command so your extension code will run as a replacement of the
default HCL Commerce code.