The generic Extender is provided by all out of the box plugins as follows:

<extension-point id="Extender" name="Extender" schema="../com.elasticpath.cmclient.core/schema/extender.exsd"/commerce-legacy/>
        

The State Policy Extension Point is designed to handle specific information around extending and creating new state policy determiners. State Policy provides its own extension point and schema in all plugins' plugin.xml as follows:

<extension-point id="StatePolicyExtender" name="StatePolicyExtender" schema="../com.elasticpath.cmclient.core/schema/statePolicyExtender.exsd"/commerce-legacy/>
        

For more information, see State Policies.

The Promotions Extension Point is designed to handle specific information around extending and creating promotion rules. Promotions can only be extended from the com.elasticpath.cmclient.store plugin and also has its own extension point, defined within store's plugin.xml:

<extension-point id="PromotionExtender" name="PromotionExtender"   schema="../com.elasticpath.cmclient.core/schema/promotionExtender.exsd"/commerce-legacy/>
        

The following example defines an extension point for a new table column in the catalog plugin's BrowseProductListView table:

<extension point="com.elasticpath.cmclient.catalog.Extender">
  <TableColumn
      table="BrowseProductListView"
      className="com.elasticpath.extensions.table.ExampleTableColumn"/commerce-legacy/>
</extension>          
        

EpPageCreator and EpSectionCreator are all implemented as an inner class to your extension class, typically named Creator. The extension declaration for these therefore refers to the Creator class directly as follows:

<extension point="com.elasticpath.cmclient.pricelistmanager.Extender">
  <Page
    editorName="PriceListEditor"
    className="com.elasticpath.extensions.page.ExamplePage$Creator"/commerce-legacy/>
</extension>          
        

The Promotions extension point follows a slightly different pattern. Within an <extension>, you must define all of the following:

1. To extend BaseAmount. extend the following classes at extensons/core/:
   • ExtBaseAmountDTO: Extends the BaseAmountDTO.
   • ExtBaseAmountDTOCreator: Overrides the default DTO creator to use the ExtBaseAmountDTO.
   Note: Ensure that the plugin.xml and MANIFEST.MF files are updated as required. For more information see, META-INF/MANIFEST.MF and pom.xml sections.
2. To display the new fields from the ExtendedBaseAmountDTO, extend the dialogs and tables.

   For more information about extending tables and dialogs, see Extending Tables and Extending Dialogs.

Tables can be extended by adding a column heading and column values. You cannot add an entirely new table to Commerce Manager, only extend an existing table.

To extend a table, implement EPTableCreator and implement its methods:

ExampleTable implements EPTableCreator {
...
}
        

Sections should extend com.elasticpath.cmclient.core.editors.AbstractCmClientEditorPageSectionPart.

Section extensions should also implement com.elasticpath.cmclient.core.helpers.extenders.EpSectionCreator as a static inner class, Creator. Creator's one method, instantiateSection(), should return an instance of your extended section:

ExampleSection extends AbstractCmClientEditorPageSectionPart {
          
  ...
          
    public static class Creator implements EpSectionCreator {
          
    public AbstractCmClientFormSectionPart instantiateSection(FormPage formPage, AbstractCmClientFormEditor abstractCmClientFormEditor) {
          
      return new ExampleSection(...);
    }
  }
}
        

Pages should extend com.elasticpath.cmclient.core.editors.AbstractCmClientEditorPage.

Page extensions should also implement com.elasticpath.cmclient.core.helpers.extenders.EpPageCreator as a static inner class, Creator. Creator's one method, instantiatePage(), should return an instance of your extended page:

ExamplePage extends AbstractCmClientEditorPage {
          
  ...
          
    public static class Creator implements EpPageCreator {
    public AbstractCmClientEditorPage instantiatePage(AbstractCmClientFormEditor abstractCmClientFormEditor) {
          
      return new ExamplePage(...);
          
    }
  }          
}
        

Dialogs should implement com.elasticpath.cmclient.core.helpers.extenders.DialogExtension and its methods:

public class ExampleDialog implements DialogExtension {
  ...
}
        

State Policy Determiner extensions should implement com.elasticpath.cmclient.policy.StateDeterminer and its method, determineState(). determineState() accepts a PolicyActionContainer object and must return EpState.READ_ONLY, EpState.EDITABLE, or EpState.DISABLED:

 public class ExampleDeterminer implements StateDeterminer {
/**
 *  Determine the state.
 * @param policyActionContainer
 * @return the state.
 */
  public EpControlFactory.EpState determineState(PolicyActionContainer policyActionContainer) {
      return EpControlFactory.EpState.READ_ONLY;
  }
}
        

For more details on creating or extending new state policies, see Creating a State Policy Extension Point.

Rather than an outright extension of an existing promotion rule, promotions extensions typically take the form of adding a new kind of promotion rule to Commerce Manager. For more information on extending promotion rules, see Promotions.

In general, we do not recommend trying to directly consume anything from a Commerce Engine database via Commerce Manager extensions. Instead, feed in an extended domain object into one of the extension points described above.

As with all OSGi bundles, your plugin must have a MANIFEST.MF file whit the following properties defined:

Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: table-examples
Bundle-SymbolicName: pattern-catalog;singleton:=true
Bundle-Version: 0.0.0.qualifier
Bundle-Vendor: %providerName
Bundle-RequiredExecutionEnvironment: JavaSE-1.8
Bundle-ActivationPolicy: lazy
Bundle-Localization: plugin
Require-Bundle:  org.eclipse.core.runtime,
com.elasticpath.extensions.cm.ext-cm-libs,
com.elasticpath.cmclient.policy,
org.eclipse.core.databinding,
org.eclipse.rap.ui,
org.eclipse.rap.ui.forms
        

Your plugin should be listed in commerce-extensions/cm/ext-cm-plugins pom.xml file as a <module>:

<modules>
  <module>your-extended-plugin</module>
  ...
</modules>
        

Your plugin should be referenced in commerce-extensions/cm/ext-cm-webapp's feature.xml as follows:

<plugin id="your-extended-plugin" download-size="0" install-size="0" version="0.0.0" unpack="false"/commerce-legacy/>
        

Add your new plugin to commerce-extensions/cm/ext-cm-webapp's config.ini as follows:

your-extended-plugin@start
        

All extensible tables extend a class parented by com.elasticpath.cmclient.core.views.AbstractCmClientView.

All extensible sections extend a class parented by com.elasticpath.cmclient.core.editors.AbstractCmClientEditorPage.

All extensible pages extend a class parented by com.elasticpath.cmclient.core.editors.AbstractCmClientFormEditor.

All extensible dialogs extend a class parented by com.elasticpath.cmclient.core.ui.dialog.AbstractEpDialog.