Custom Actions

Customer Service Center supports custom actions with a Business Manager extension cartridge.

  • A controller represents each action
  • The cartridge must be added to the BM cartridge path
  • Every action is secured with a permission in the Customer Service Center permissions tab in the Roles & Permissions view.

Customizable actions can be registered for CSC UI pages:

  • Customer
  • Basket
  • Order

The actions are registered with a bm_extensions.xml file.

  • Every action is represented with a MenuAction of type CSC
  • The menupath determines the page that the action is assigned. The following menu paths are supported.
    • customer action is registered for the customer page
    • basket action is registered for the basket page
    • order action is registered for the order page
  • All custom actions can be localized

Example 

The following is an example bm_extensions.xml file:

1<?xml version="1.0" encoding="ISO-8859-1" ?>
2<!-- =============================================================== -->
3<!-- ==  CSC EXTENSIONS                                        == -->
4<!-- =============================================================== -->
5<extensions xmlns="http://www.demandware.com/xml/bmmodules/2007-12-11" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.demandware.com/xml/bmmodules/2007-12-11 bmext.xsd">
6    <menuitem id="basket" site="true" type="CSC">
7        <name xml:lang="x-default" >CSC Basket</name>
8        <short_description xml:lang="x-default">Customer Service Center Basket</short_description>
9        <description xml:lang="x-default">Customer Service Center Basket</description>
10    </menuitem>
11    <menuaction id="basket_gift_messaging" menupath="basket" type="CSC" site="true" position="3">
12        <name xml:lang="x-default">Make it a Gift</name>
13        <name xml:lang="fr-FR">Make it a gift (fr-FR)</name>
14        <short_description xml:lang="x-default">Gift Messaging</short_description>
15        <description xml:lang="x-default">Gift Messaging</description>
16        <exec pipeline="CSCGiftMessaging" node="Start"/>
17        <sub-pipelines>
18            <pipeline name="CSCGiftMessaging" />
19        </sub-pipelines>
20        <parameters>
21            <parameter name="basket_id" value="/basket_id"/>
22        </parameters>
23        <icon>csc_basket.png</icon>
24    </menuaction>
25    <menuaction id="basket_address_verification" menupath="basket" type="CSC" site="true" position="1">
26        <name xml:lang="x-default">Verify addresses</name>
27        <short_description xml:lang="x-default">Verifies all cart addresses</short_description>
28        <description xml:lang="x-default">Verifies all cart addresses</description>
29        <exec pipeline="CSCVerifyCartAddresses" node="Start"/>
30        <sub-pipelines>
31            <pipeline name="CSCVerifyCartAddresses" />
32        </sub-pipelines>
33        <parameters>
34            <parameter name="basket_id" value="/basket_id"/>
35        </parameters>
36        <icon>check_address.png</icon>
37    </menuaction>
38    <menuitem id="order" site="true" type="CSC">
39        <name xml:lang="x-default" >CSC Order</name>
40        <short_description xml:lang="x-default">Customer Service Center Order</short_description>
41        <description xml:lang="x-default">Customer Service Center Order</description>
42    </menuitem>
43    <menuaction id="order_payment_details" menupath="order" type="CSC" site="true" position="1">
44        <name xml:lang="x-default">Review Payment details</name>
45        <short_description xml:lang="x-default">Review Payment details</short_description>
46        <description xml:lang="x-default">Review Payment details</description>
47        <exec pipeline="CSCReviewPaymentDetails" node="Start"/>
48        <sub-pipelines>
49            <pipeline name="CSCReviewPaymentDetails" />
50        </sub-pipelines>
51        <parameters>
52            <parameter name="order_no" value="/order_no"/>
53        </parameters>
54        <icon>check_address.png</icon>
55    </menuaction>
56    <menuitem id="customer" site="true" type="CSC">
57        <name xml:lang="x-default" >CSC Customer</name>
58        <short_description xml:lang="x-default">Customer Service Center Customer</short_description>
59        <description xml:lang="x-default">Customer Service Center Customer</description>
60    </menuitem>
61    <menuaction id="customer_show_customer_groups" menupath="customer" type="CSC" site="true" position="1">
62        <name xml:lang="x-default">Display Customer Groups</name>
63        <short_description xml:lang="x-default">Display Customer Groups.</short_description>
64        <description xml:lang="x-default">Display Customer Groups.</description>
65        <exec pipeline="CSCCustomerGroups" node="Start"/>
66        <sub-pipelines>
67            <pipeline name="CSCCustomerGroups"/>
68        </sub-pipelines>
69        <parameters>
70        </parameters>
71        <icon>check_address.png</icon>
72    </menuaction>
73</extensions>