Install a payment plug-in written by a third party

If you want to use a payment plug-in that is not provided in WebSphere Commerce (such as one you create or have received through some other channel), you should first confirm with the provider that the plug-in was written to the payment plug-in specification (1.0) for WebSphere Commerce.

To install the plug-in, perform the following steps:

1. Ensure that WebSphere Commerce is installed and a WebSphere Commerce instance is created.
2. Stop WebSphere Commerce.
3. Copy the plug-in JAR file to the following location:
   • WC_eardir/plugin_name.jar
   • WC_eardir/plugin_name.jar
4. Add the EJB module to the EAR project. You can do this by using the WebSphere Application Server Toolkit, or by manually deploying files into the WebSphere Application Server installation directory. Refer to the WebSphere Application Server documentation for more information.
5. Copy the plug-in deployment descriptor file to the following location, where plugin_name represents the name of the plug-in. (Be sure to create a subdirectory with the plug-in name.)
   • WC_eardir/xml/config/ payments/ppc/plugins/plugin_name/PluginDeployment.xml
   • WC_eardir/xml/config/ payments/ppc/plugins/plugin_name/PluginDeployment.xml

   For example: WC_eardir/xml/config/ payments/ppc/plugins/SamplePlugin/PluginDeployment.xml

6. Ensure that the name of the plug-in inside the deployment descriptor matches the name of the directory in which you placed the deployment descriptor.
7. Add the following lines to the PaymentSystemPluginMapping.xml file as shown. The file location is: WC_eardir/xml/config/
   payments/ppc/plugins/PaymentSystemPluginMapping.xml. This example uses the payment system name 'SampleSystem'.

   <PaymentSystemName name="SampleSystem" >
     <Mapping paymentConfigurationId="default"
     PluginName="SamplePlugin" >
     </Mapping>
     </PaymentSystemName> 
   

   This will create a mapping between a system name called 'SampleSystem' to the plug-in 'SamplePlugin' you just imported into your directory.

8. If the plug-in came as source code, build it.
9. If you used the WebSphere Application Server Toolkit, the deployment code is automatically generated. If not, generate the deployment code for the plug-in and rebuild it.
10. Update the Payment Rules configuration so that a payment method is mapped into the payment system name 'SampleSystem', as you have defined in step 7. Follow instructions in Configure payment plug-ins for Payment Rules to edit the payment method configuration and specify the payment system name. The payment system name should map to the payment plug-in in the PaymentSystemPluginMapping.xml file. The payment system name should be reflected in the PaymentMethodConfigurations.xml and RefundMethodConfigurations.xml files.
11. Ensure that the plug-in project is in the EAR file and that the EAR file is in your server. Step 4 should have already done this for you automatically. If you are using the WebSphere Application Server Toolkit, you can skip this step.
12. Follow any documentation provided by the plug-in provider to complete any remaining installation or configuration steps.
13. Restart WebSphere Commerce.

Related concepts

• Payment plug-ins

Related tasks

• Uninstall a payment plug-in
• Start and stop WebSphere Commerce

(C) Copyright IBM Corporation 1996, 2006. All Rights Reserved.