Configuring the LOC plug-in

Use the LOC plug-in when a credit line is used as the payment method and an external accounting system is responsible for processing the payment transaction.

About this task

Registration with a payment service provider is not required with this plug-in; however, to communicate directly with an external accounting system, you must make provisions for enabling that connection with the provider of the system.

Procedure

  1. Optional: Configure the payment system to use synchronous processing

    In either the offline payment plug-in or the online payment plug-in, when communication speed is high, using the synchronous payment event makes the order flow simpler because the orders do not depend on the asynchronous event processing. However, when your online payment plug-in has low communication speed, you might need to configure your payment system to use asynchronous payment event so that the order flow can be completed sooner to gain better customer satisfaction and to release the system resources used by the order flow. By default, the payment system is configured as synchronous.

    1. Open the EDPGlobalConfigs XML file file. The file is located in the following directory:
      • workspace_dir/WC/xml/config/payments/edp
    2. Specify the appropriate value for the AlwaysExecuteProcessBGInFG element.
      • true = synchronous payment event
      • false = asynchronous payment event
      Asynchronous payment event
      The asynchronous payment event is normally used to accelerate the transaction of order commands. The order command does not need to wait the finish of the payment transaction. The shopper will wait less time for the order commands but the payment result is unknown.
      Synchronous payment event
      By default, payment rules uses the synchronous payment event. The synchronous payment event is normally to used for real-time payment result for an order. The order command must wait until the payment transaction is complete.
    3. Save the file.
  2. Optional: Create a payment configuration group

    HCL Commerce provides a ready-to-use payment configuration group named "default" that you can use for your store. If you want two different configurations for the same payment method in different stores, you must create another payment configuration group. The payment configuration group is uniquely configured for one combination of payment method and the store. Such a combination can have only one payment configuration group configured. This mapping is configured in the POLICY table for payment business policy.

    1. In the workspace_dir/WC/xml/config/payments/edp/groups directory, copy the "default" subdirectory.
    2. Rename the copied directory.
      You have now created your new payment configuration group. This group now has the same configuration as the "default" group.
  3. Map the payment system to a payment plug-in.
    For example:
       <PaymentSystemName 
              name="LOCSystem" >
              <Mapping 
                    paymentConfigurationId="default"
                    PluginName="LOCPlugin" >
              </Mapping>          
       </PaymentSystemName>  
    
    1. In a text editor or XML editor, open your copy of the PaymentSystemPluginMapping XML file.
    2. Specify the payment system name, payment configuration ID, plug-in name, and any specific plug-in properties that should be used for that payment system name mapping.

      Since a plug-in can be associated with more than one payment system name, you can specify properties that are unique to a particular payment system name. For example, PaymentSystemName ABC can use property XXX, and PaymentSystemName DEF can use property YYY even though the same plug-in is used for both.

      When the payment system name is used, the set of properties defined in the PaymentSystemPluginMapping.xml file is applied. These properties are different from the plug-in properties specified in the deployment descriptor. The properties specified in the deployment descriptor apply to the plug-in itself and remain constant in memory as the plug-in is used, regardless of the payment system name being used.

    3. Save the file.
  4. Configure payment methods.
    1. In a text editor or XML editor, open the PaymentMethodConfigurations XML file which is in the following directory:
      • workspace_dir/WC/xml/config/payments/edp/groups/default
      • HCL Commerce Developerworkspace_dir/wc/xml/config/payments/edp/groups/default
    2. Specify a configuration for the payment method. Supply values for the following parameters:
      • payment method
      • paymentRule
      • paymentSystemName
      • systemEditable
      • humanEditable
      • refundAllowed
      • minimumAmount
      • maximumAmount
      • priority
      • dependentCreditRequired
      Refer to the description of the file for more information about these parameters. Multiple payment methods can be configured in this file.
    3. Save the file.
  5. Configure refund methods.
    1. In a text editor or XML editor, open the RefundMethodConfigurations XML file which is in the following directory:
      • workspace_dir/WC/xml/config/payments/edp/groups/default
      • HCL Commerce Developerworkspace_dir/wc/xml/config/payments/edp/groups/default
    2. Specify a configuration for the refund method. Supply values for the following parameters:
      • refund method
      • paymentSystemName
      Refer to the description of the file for more information about these parameters. Multiple refund methods can be configured in this file.
    3. Save the file.
  6. Update for v9.
  7. Update for v9.

Results

If a credit line is enabled for an account, the LOC plug-in can be called to handle financial transactions.