Install the app

Follow these steps to install the SAP Commerce Cloud app.

Step 1: Download the app

  1. Get the app pack from Digital River.

  2. Unpack the app pack and copy the folders digitalriveraddon, digitalriverbackoffice, and digitalriverservices to a custom folder named archive for the SAP Commerce Suite (<HYBRIS_HOME>/bin/custom).

Step 2: Update the localextension.xml

  1. Verify the presence of <extension name=”addonsupport” /> in the localextensions.xml file.

  2. Add the following extensions:

    • <extension name=” digitalriveraddon” />.

    • <extension name=” digitalriverbackoffice” />.

    • <extension name=” digitalriverservices” />.

  3. Verify the presence of the target storefront extension.

  4. Add other required OOB (Out-of-Box) extensions mentioned in the localextension.xml that are available in the archive.

Step 3: Run the installation command

  1. Stop the Hybris server if it is already running. Depending on the server start mode, you can use one of the following methods to stop the Hybris server.

    • If you started the Hybris server using embedded mode, press Ctrl+C to stop the Hybris server.

    • If you started the Hybris server with service mode, use the command appropriate for your system to stop it: Windows: hybrisserver.bat stop Unix: ./hybrisserver.sh stop

  2. Go to <HYBRIS_HOME>/bin/platform and run the following command if you did not apply it previously to this terminal:

    • Windows: setantenv.bat

    • Unix: ./setantenv.sh

  3. Go to <HYBRIS_HOME>/bin/platform and run the installation app with the following command:

    • ant addoninstall -Daddonnames="digitalriveraddon"–DaddonStorefront.yacceleratorstorefront="yacceleratorstorefront"

    • Depending on the project, the storefront name may differ from the default storefront name that is provided by Hybris.

Step 4: OOB code changes

The list of files which changed as a part of the Digital River payment integration, tax management, and Order Management System (OMS) will be available in the OOB folder in the archive (custom folder). The following list shows the modified extensions that will appear in the archive:

  • yacceleratorstorefront

  • consignmenttrackingaddon

  • yacceleratorordermanagement

  • orderselfserviceaddon

Storefront changes

yacceleratorstorefront files

OOB yacceleratorstorefront is a template storefront that is used for Digital River app development. The following files are updated for tax and payment integration. If the merchant application uses any custom files, update them with the changes for Digital River from this file list:

  • addressFormElements.tag

  • addressFormSelector.tag

  • billAddressFormSelector.tag

  • billingAddressFormElements.tag

  • orderTotals.tag

  • orderUnconsignedEntries.tag

  • master.tag

  • accountOrderDetailShippingInfo.jsp

  • accountProfileEditPage.jsp

  • addEditDeliveryAddressPage.jsp

  • checkoutSummaryPage.jsp

  • silentOrderPostPage.jsp

  • spring-filter-config

  • base_en

consignmenttrackingaddon files

  • orderUnconsignedEntries.tag: This tag, in consignmenttrackingaddon and yacceleratorstorefront, has changed to display the status for the Digital River product. The Merchant application should make the necessary changes in custom implementation for the Digital River product if there are any.

orderselfserviceaddon files

For Digital River product cancellation, these files are changed:

  • CancelOrderPageController.java

  • extensioninfo.xml

Order Management System (OMS) file changes

The files below are added/modified in yacceleratorordermanagement for Digital River OMS support:

  • extensioninfo.xml

  • order-process-spring

  • projectdata-dynamic-business-process-order.impex

  • projectdata-dynamic-business-process-return.impex

  • ConfirmShipConsignmentAction.java

  • CheckOrderAction.java

  • CheckAuthorizeOrderPaymentAction.java

  • SendAuthorizationFailedNotificationAction.java

  • FulFillDigitalAction.java

  • SourceOrderAction.java

  • VerifyOrderCompletionAction.java

  • ProcessOrderCancellationAction.java

  • FraudCheckOrderAction.java

  • SendOrderPlacedNotificationAction.java

  • TakePaymentAction.java

  • CaptureRefundAction.java

  • DefaultCheckOrderService.java

Step 5: Rebuild the system

Go to <HYBRIS_HOME>/bin/platform and rebuild the system with the following command: ant clean all.

Step 6: Update the system

After you rebuild the system, you may need to perform full initialization through the Hybris Administration Console (HAC) if this is the first installation of Hybris.

If you have already performed full initialization, then you need to update your Hybris system as follows:

  1. From your web browser, select HAC, select Platform, and then click Update.

  2. Select the following check boxes under General Settings:

    • Update running system

    • Clear the HMC configuration from the database

    • Create essential data

    • Localize types

  3. Select the digitalriveraddon, digitalriverbackoffice, digitalriverservices check box further down under Project data settings.

  4. Click the Update button to update the Hybris system.

  5. After you finish updating the system, if the changes do not appear in Backoffice, run the projectdata-dynamic-business-process-order.impex and projectdata-dynamic-business-process-return.impex . To verify the content from Backoffice, select System, select Business process, select Dynamic Processes Definitions, and then click order-process/return-process and check the content.