To customize the UI using the JSP targeting rules, one or more renderer component configuration must be added to in the dynamo component path. Each renderer component represents one variation, or one JSP, of the UI to display.
The following example describes the creation of a custom renderer for the SKU display and input area of the Product View panel. The following /atg/commerce/custsvc/ui/renderers components are involved in this example customization:
ProductSkuRenderer: The default renderer for the product SKU areaProductSkuPageData: A component that will contain data from the enclosing page, such as product or customer informationProductSkuSourceMap: The main component container used by the targeting rules. This component refers to thePageDatacomponent aboveProductSkuTargeter: The targeter configuration. This component refers to theSourceMapcomponent above, and one or more Renderer componentsTo create a targeting customization:
Create a new renderer component to represent the custom JSP. The basic properties of each renderer component properties should be made in the
/nucleus/file:
component/path/CustomRenderer.properties# The base class for renderer components.
$class=atg.commerce.csr.rendering.RenderInfo
# An ID that uniquely identifies this renderer component in the
# domain in which it is used. All renderers currently shipped by
# ATG use the value "default" as their ID.
id=custom
# The custom JSP that performs the actual content rendering
url=/file/system/path/customSkuDisplay.jspCreate a
RuleSetServiceconfiguration. This component identifies the rules file and contains settings for when that file is loaded. In the/nucleus/component/path/file, add the following:
RuleSetService.properties$class=atg.targeting.RuleSetService
# Path to rules file
rulesFilePath=/file/system/path/sku.rules
# Settings that control when/if rules files are loaded:
updatesEnabled=true
rulesFileCheckSeconds=0The values used for
updatesEnabledandrulesFileCheckSecondsabove are useful when testing targeting rules because they cause the rule file to be reloaded for every request. See the Targeting documentation for more information about these values.Note: If the
RuleSetServicehas been configured to always reload targeting rules, it is easier to experiment with rules by changing the file and causing the page to be redisplayed.Create the rules file for the
RuleSetServiceconfigured Step 2. In the/file/system/path/sku.rulesfile, add the following:<ruleset>
<accepts>
<rule op="and">
<rule op="eq">
<!-- pageData is obtained from the SourceMap component -->
<valueof bean="pageData.product.id">
<valueof constant="prod10001">
</rule>
<rule op=eq>
<!-- target (display) the custom JSP -->
<valueof target="id">
<valueof constant="custom">
</rule>
</rule>
</accepts>
</ruleset>In the example, the
sku.rulesfile will target the custom renderer only when the product being displayed has a value of “prod10001”. Only the first targeted component is displayed because theTargetingFirstDropletis used, so while multiple targets may match, only the first matching component’s JSP will be rendered.Update the existing
ProductSkuTargeterconfiguration to refer to the new Renderer component created in Step 1, and to theRuleSetServiceconfigured in Step 2.In
localconfig, or another suitable Nucleusconfigdirectory, configure the properties of the/atg/commerce/custsvc/ui/renderers/file with the following values:
ProductSkuTargeter/ProductSkuTarger.properties# The collection of renderer components to be targeted. The
# following configures two renderers, the renderer created in step
# #1, and the default renderer provided with the product.
collectionComponents=ProductSkuRenderer,
/nuclues/component/path/CustomRenderer
# The targeting RuleSetService created in step #2
ruleSetService=/nucleus/component/path/RuleSetServiceDepending on the state of your Dynamo instance, you may need to restart the server for the settings to take effect.
