Add xC configuration information

Use the UEConfig keyword to register extension code.

Definitions

UEConfigId

(Integer) Required: The unique ID of the xC extension code. You use the UEConfigId when you assign the extension code to an extension point in the CmdReg.csv file.

Url

(String) Required: The relative URL of the xC extension resource method from the context root. You are assigning this URL to the UEConfigId specified above. For example, in the URL, https://hostname:9443/commerceue/extension/order/validate_quantity, enter /extension/order/validate_quantity as the URL value.

commerceue

The context root of the Customization server.

extension

The base URL of the JAX-RS application.

order

The path of the resource class.

validate_quantity

The extension point.

Maximum number of characters, 512.

HttpMethod

(String) The HTTP request method for the extension. Always set the value to POST.

Description

The description of the extension.

Maximum number of characters, 254.

Properties

(String) An ampersand (&) separated list of properties in the form of URL encoded name value pairs. Supported properties include:

• useBridgeClient: Set this property to true if the extension code makes calls to transaction server REST APIs (useBridgeClient=true)

• Content-Type: Set this property to application/json or text/plain. The property is used by the Customization server to locate the matching resource method.

Maximum number of characters, 512.

FilterId

(Integer) The FilterId of a filter to use. The FilterId can be null to indicate that filtering is not required. The FilterId is loaded with a Filter.csv file.

Retriable

Indicates whether the extension request is retried when the request fails. Valid values:

0

False

1

True

Timeout

(Integer) The amount of time to wait (in milliseconds) for a request before it is considered failed. If null, a default value is used.

Delete

(String) Indicates whether to delete the record. Specify 1 to delete the record.

Example

UEConfig,,,,,,,
UEConfigId,Url,HttpMethod,Description,Properties,FilterId,Timeout,Retriable
136068101,extension/order/tax_integration_custom,POST,Tax Integration UEenablement,Content-Type=application/json,,1200,1

The example registers the extension code URL extension/order/tax_integration_custom to a UEConfigId 136068101. The extension code is a POST method that retries if fails and times out after 1200 milliseconds.