Reference > Payments subsystem > WCPayments plug-in

WCPayments plug-in deployment descriptor

TheWCPayments plug-in integrates with the WebSphere Commerce Payments by using the plug-in deployment descriptor, PluginDeployment.xml.

<?xml version="1.0" encoding="UTF-8"?>
<Plugin xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:noNamespaceSchemaLocation="../PaymentPlugin.xsd">  
<PluginInformation 
        jndi="ejb/com/ibm/commerce/payments/plugin/WCPayments /bean/WCPaymentsPluginHome" 
        home="com.ibm.commerce.payments.plugin.WCPayments .bean.WCPaymentsPluginHome"
                name="WCPaymentsPlugin" 
                version="1.0.0" 
                vendor="IBM"
                independentCredit="true" 
                virtualTerminal="http://host:5432/webapp/PaymentManager">        
<PluginProperty name="hostName" value="host"/>        
<PluginProperty name="port" value="5433"/>        
<PluginProperty name="useSSL" value="true"/>        
       
<PluginProperty name="userid" value="wcsadmin"/>        
<PluginProperty name="maxWCOrderCreationRetries" value="5"/>    
</PluginInformation>
</Plugin>

In addition to the common plug-in parameters (such as jndi and home), theWCPayments plug-in requires the following properties that are unique to this plug-in:

jndi

The Java Naming and Directory Interface (JNDI) lookup name for the home of the plug-in's stateless session bean.

home

The fully qualified name of the home class for the plug-in's stateless session bean

name

The name of the plug-in implementation.

vendor

The vendor providing the plug-in implementation.

version

The version of the plug-in implementation.

independentCredit

Indication of whether the plug-in supports independent credits.

virtualTerminal

The URL of the payment back-end system administration user interface.

PluginProperty

(Optional) The name of a property to be used with this plug-in and its value.

host_name

The fully qualified host name for the WebSphere Commerce Payments Web server. The host name can be a virtual host name on the Web server. Specify the actual host name for the environment when configuring this plug-in.

port

The port number WebSphere Commerce Payments is running on as shown in the Configuration Manager WebServer information for the Payments instance. Value 5432 indicates a WebSphere Commerce Payments non-secure server; 5433 indicates a secure server and requires the useSSL property value of "true."

useSSL

Indicator of whether the Secure Sockets Layer is used with the WebSphere Commerce Payments instance.

true

SSL is used.

false

SSL is not used.

userid

The user ID associated with the WebSphere Commerce user. Specify the Payment Administrator's user ID.

(Optional) maxWCorderCreationRetries

The maximum number of times the plug-in should attempt to create an order ID before throwing an exception. Order IDs are generated randomly because multiple payment instructions can exist for one order, multiple payments can exist for one payment instruction, and one payment corresponds to an order. An order ID is generated randomly for each payment. If the order already exists, the creation of the order is retried.

For example, the maxWCorderCreationRetries value is set to 3. An attempt is made to create an order with a randomly generated order ID of "14" but that order ID already exists. A second attempt is made to create the order with the random ID of "27." That order ID already exists. A third attempt is made to create an order with a random ID of "50." If that order ID already exists, the maximum retries was achieved and the plug-in throws an exception.

ProtocolProperty

(Optional) The name of the keyword that should be retained in the database. Protocol properties are specified inside a <ProtocolProperties> element (more than one can be specified). Include the optional attribute keep="true" to retain the data for this keyword in the database. For example:

<ProtocolProperties>
<ProtocolProperty name="cc_brand" keep="true" />
</ProtocolProperties>

In this example, the brand of credit card used by the customer is kept in the database. If keep="false" is specified, no data is retained for that property. If no keep attribute is specified, the default is keep="true". When a retention is specified here, it takes priority over any global retention specified in the PaymentSystemPluginMapping XML file.

Related concepts

WCPayments plug-in

Related tasks

Configure the WCPayments plug-in

+

Search Tips   |   Advanced Search