Introduction

Welcome to the Intershop Computop Service Connector. The service connector adds Computop payment methods to your Intershop installation.

This document provides important product information, including version information and dependencies. It also outlines the basic setup and configuration steps.

References

• Concept - Payment Framework
• Cookbook - Payment
• Concept - Intershop Reference Payment Services

Version Information and Dependencies

This delivery and the accompanying documentation are valid for the following combinations of software versions:

The next table provides information about the cartridges included in the package. Not all of these cartridges are required.

Cartridge	Description	Required
ac_payment_computop	Includes all base functionality and business logic which is used.
as_responsive_computop	Enables the COMPUTOP payment connector for the following application types: intershop.B2CResponsive intershop.SMBResponsive The cartridge is optional, can be downloaded separately from Intershop Product Calendar and may be included if the project uses the responsive starter store. Unzip the file to your multi-project folder next to your responsive source files. It could be skipped if the custom project does not support these application types or COMPUTOP is not required in these application types.
app_sf_responsive_computop	Includes some additional functionality which is relevant for the responsive storefront reference application only, e.g., the integration of the hosted payment pages of the credit card. The cartridge is optional, can be downloaded separately from Intershop Product Calendar and may be included in case the project is based on the responsive storefront reference application. Unzip the file to your multi-project folder next to your responsive source files. The referenced cartridge app_sf_responsive may be renamed in the project and has to be referenced in the build.gradle file with the customized naming again.

The Computop Service Connector 5.+ is based on the Payment API introduced in IS 7.6.

The sources for as_responsive_computop and app_sf_responsive_computop are available here

...YOUR_REPOSITORY.../releases/com.intershop.public.source/s_payment_computop/5.0.0/zips/s_payment_computop-zip-src-5.0.0.zip

Supported Application Types

The Computop Service Connector can be used for the following application types:

Setup

This section outlines the basic setup and configuration steps, including

Precondition

The package is available via Intershop's Public Nexus.

Prerequisites are:

• A set up and configured CI environment
  See Cookbook - Setup CI Infrastructure for details.
  See Concept - Continuous Delivery Tools (valid to 7.10) for basic information about Continuous Integration.
• A running Intershop Commerce Management 7.10 installation that matches the system requirements
• Knowledge of how to add the delivered artifacts to the continuous integration environment
• Knowledge of how to deploy to a test or production environment

Setting Up the Assembly

To add the Computop Service Connector into your Intershop 7 system, there are two options:

• Incorporating the cartridge into an already existing assembly in the build.gradle file of the assembly. To do so, perform the following steps. 

  1. Add the following in the build.gradle file of the assembly:

     build.gradle

             
     ...
      
     cartridges {
             def storefrontCartridges = [
                 'app_sf_responsive',
                 'app_sf_responsive_cm',
                 'app_sf_responsive_b2c',
                 'app_sf_responsive_smb',
                 'as_responsive',
                 'app_sf_responsive_b2b',
                 'app_sf_responsive_costcenter',
                 'as_responsive_b2b',
     // these are the two cartridges, which we delivered in source code and you have to add these files to your responsive source project
                  'as_responsive_computop',
                 'app_sf_responsive_computop'
     
                ]
             include(*(storefrontCartridges.collect { project(":$it") }), in:[development, test, production])
     
     ...
     
          
             def computopPaymentProvider = [
                 'ac_payment_computop',
     
             ]
             include (*(computopPaymentProvider.collect {"com.intershop.services.payment_computop:$it"}), in: [development, test, production]) 
     ...
             order = listFromAssembly(<yourAssembly>) + computopPaymentProvider
     }

  2. Adapt the app_sf_responsive_computop/build.gradle file in the following way:

     app_sf_responsive_computop/build.gradle file

     apply plugin: 'static-cartridge'
     apply plugin: 'com.intershop.gradle.isml'
     
     intershop
     {
         displayName = 'Adapter Cartridge for Computop Payment'
         packages {
             cartridge {
                 srcDir(isml2classMain)
             }
         }
     }
     
     dependencies 
     {
         //compile project(':ac_payment_computop') --> will be replaced by
          compile group: 'com.intershop.services.payment_computop', name: 'ac_payment_computop'
     }

  3. Adjust the file as_responsive_computop/build.gradle in a similar way:

     as_responsive_computop/build.gradle file

     apply plugin: 'static-cartridge'
     
     intershop 
     {
         displayName = 'As_responsive_computop'
         staticLibs = fileTree(dir: staticCartridgeLibFolder, include: '*.jar')
     }
     
     dependencies {
         //compile project(':ac_payment_computop') --> will be replaced by
          compile group: 'com.intershop.services.payment_computop', name: 'ac_payment_computop'
         compile project(':app_sf_responsive_computop')
     }

  4. Insert the following lines into the file intershopBuild.version:


     intershopBuild.version

     com.intershop.services.payment_computop:ac_payment_computop = 5.0.0

• Alternatively, you can create a new assembly inheriting from an ICM-based assembly. For details about creating a new assembly, see Recipe: Create a New Assembly Inheriting From an Existing Assembly.

For details about managing assembly artifacts, see:

• Concept - Gradle Assembly Tools
• Reference - Gradle Assembly Tools
• Cookbook - Gradle Assembly Tools

Defining File-Based Configurations

Before deploying the new assembly to a test or production environment, you may have to adjust some file-based configurations required by the Computop Service Connector.

The Computop Service Connector requires the following settings:

This setting can be overridden within <IS_SHARE>/system/config/cartridges/ac_payment_computop.properties, see Recipe: Change Deployed File Content With Filters.

For details about adding new configuration files, see Recipe: Deploy Custom Files.

Deploying the Assembly

After creating and appropriately configuring the assembly, you must deploy it to the intended target environment.

For details about deploying an assembly, see Recipe: Run the Deployment (Initial Installation / Upgrade / Downgrade).

Customization

Changing the Values of Parameters Sent to Computop

Since version 4.4.1 of the connector it is possible to modify the values of some of the parameters sent to Computop. Those parameters are TransID, RefNr, PayID and ReqID.

To provide custom values of those parameters in one of the payment methods (e.g., Alipay):

1. Create a new class:

   CustomAlipayRequestParamsProvider

   public class CustomAlipayRequestParamsProvider implements Function<RequestParamContext, String>
   {
       @Override
       public String apply(RequestParamContext paramContext)
       {
   		switch(paramContext.getParamName())
           {
               case "RefNr": ...
   			...
   			default: return null;
   		}
       }
   }

   You retrieve the parameter name from the RequestParamContext class. This class also provides the current Payable and PaymentContext objects, which could help you generate a value for the parameter.

   If you wish to provide values only for a subset of the four supported parameters, return null for the rest - this way the default to the connector value will be used.
   
   

2. Bind your class in a custom Guice Module. In this case it will be something like this:

   bind(new TypeLiteral<Function<RequestParamContext, String>>()
   {
   }).annotatedWith(AlipayRequestParamsProvidier.class.getAnnotation(Named.class))
                .to(CustomAlipayRequestParamsProvider.class).in(Singleton.class);

3. Define this custom Guice Module as global.overrideModules in the associated resources file as described in Concept - Dependency Injection and ObjectGraphs.

Configuration

This section outlines the required post-deployment configuration steps, including

Adjusting Firewall Settings

Adjust your firewall settings to allow bidirectional HTTP and HTTPS traffic between the Intershop 7 and Computop systems.

Applying UI-Based Configuration

The Computop Service Connector requires some post-deployment configurations in the Organization Management application and in the Commerce Management application.

For details about enabling a payment service, see Recipe: Enable a Payment Service.

Assign Payment Services to a Sales Organization

Create a Managed Payment Service

The table below lists Computop-specific settings for configuring the payment service.

Configure the Payment Methods

Localization

The Computop Service Connector provides English and German localization files for payment-specific input field labels, error messages, etc.

You can find the existing localization files here: <IS.INSTANCE.SHARE>/system/cartridges/ac_payment_computop/release/localizations.

For details about localization, see:

• Concept - Localization
• Cookbook - Localization

Feature Overview

Payment Methods

The Computop Service Connector adds the following payment methods to your Intershop 7 system:

* only available if the corresponding payment method's Capture Mode is set to "manual" or "timed".

** Alipay Cancel is only available to the customer in the storefront and actually executes a full refund.

Payment Management Options

Data Handling

The following table describes transmitted data by the Computop Service Connector from ICM to Computop during the payment process:

Limitations

PayPal with Multiple Shipping Buckets

PayPal is not available for baskets with multiple shipping buckets.

Credit Card with Order Approval Service

Please be aware that Computop Credit Card uses redirect after checkout. Intershop's current demo shop inSPIRED does not support a redirect after checkout if an order approval service in channel type intershop.SMBResponsive is enabled.

Credit Card with IPv6 Addresses

The IP Zones feature requires an IPv4 address on the customer's side. In case the customer has an IPv6 address, the payment method Credit Card will not be displayed on the payment page.

Credit Card Timed Capture When Server Is Shut Down

Scheduled timed captures (with delay), which were not yet processed when the server was shut down for some reason, will not be captured automatically. These payments must be captured manually.

Changelog

Version COMPUTOP/5.0.0

• User Story 64005 - Upgrade Computop Connector to Tomcat-9-based ICM (≥7.10.31)
• User Story 69769 - Separate responsive content from connector cartridge