Module Installation

Installation

Required Actions Prior to Installation:

• Log in to the Novalnet Admin Portal.
• Install Composer.
• Make sure that you have extracted the payment plugin package from the zip file you have received. If you have received only the installation guide without the payment plugin package (zip file), install the payment plugin via composer.
• Ensure that you have created Access Keys for your account. If not, click on Create a New Access Key to generate them. For more details, refer here.

To install the Novalnet Payment Module, please go to your shop system and follow the steps below.

Step 1: Upload the contents of the folder NovalnetGateway (which you have extracted from the payment module package/zip file) into your gitlab directory ${HYBRIS_BIN_DIR} -> Custom.

Step 2: To add the Novalnet payment module, in the manifest.json file in your root directory of SAP Commerce Cloud, include the below code within storefrontAddons section.

{
"addon":"novalnetcheckoutaddon",
"storefront":"yacceleratorstorefront",
"template":"yacceleratorstorefront"
}

Step 3: To add Novalnet extensions in the shop, open < Root_Directory >/hybris/config/localextensions.xml file and paste the following code.

<!-- Search the below line -->
</extensions>
<!-- Add the following code above the searched line -->
<extension name='novalnetcore' />
<extension name='novalnetcheckoutaddon' />
<extension name='novalnetbackoffice' />

Step 4: Navigate to Repository -> Repository URL, provide your SAP Commerce Cloud Git repository URL and click Save to confirm the changes.

Step 5: Then generate a new public key by clicking Regenerate and click Copy to Clipboard to copy the public key and past it into the configuration of your repository.

Step 6: Now, navigate to Builds -> Create in the SAP Cloud portal.

Step 7: In the Create Build page, provide the Name and Git Branch or Tag details in the fields and click Save to create the build.

Step 8: After the build is created, click Deploy to Environment under Builds.

Step 9: In the Deploy Build page, choose Initialize Database under Data migration mode. Finally, click Deploy to complete the installation.

Global Configuration in the SAP Commerce Cloud shop system

The main configuration occurs in your SAP commerce cloud shop system as well as in the Novalnet Admin Portal. In your SAP commerce cloud shop system navigate to Base Commerce -> Base Store -> < Store > -> Novalnet. Enter the following keys.

• Product activation key - a unique token for merchant authentication and payment processing.
• Payment access key - your secret key used to encrypt the data to avoid user manipulation and fraud.
• Tariff ID - a unique identifier which is dynamically created based on the tariff type at Novalnet.
• Client key - a unique key which is linked with your Novalnet merchant account to authenticate your client based requests. You need the client key to render the secure payment form and tokenize (temporarily) the sensitive information.

To get your Product activation key, Tariff ID, Payment access key and Client key, go to the Novalnet Admin Portal, navigate to PROJECT menu and click view icon on the right of your project to view the project details.

Notification/Webhook configuration in the SAP Commerce Cloud shop system

Novalnet Webhooks are used to communicate with your site. Webhook URL configuration is required to keep the merchant’s database/system up to date and synchronized with Novalnet (example: up-to-date transaction status delivery).

For Webhook synchronization, navigate to Environments -> -> Services -> Storefront -> choose Properties tab. Add the Novalnet webhook URL csrf.allowed.url.patterns=(/novalnet/callback)$ in the properties field.

Finally, click Save to update/save the properties.

Notification/Webhook configuration

Configure the Webhook Endpoint URL into your Novalnet Admin Portal account by following the below steps,

• Copy the Webhook Endpoint URL from the shop admin panel and in the Novalnet Admin Portal navigate to Projects menu and choose your project.
• Go to API credentials and click Edit.
• Then paste the copied Webhook Endpoint URL into the Vendor script URL/ Notification & Webhook URL and click Update.

Client key configuration in the Novalnet Admin Portal

Step 1: Go to the Novalnet Admin Portal.

Step 2: Navigate to the Projects menu, choose your desired project and click on the icon to view your project details.

Step 3: On the project details page click API credentials and click edit icon beside Allowed Domain(s).

Step 4: Paste your website URL in the Domain name field and click + Add button .

Step 5: After adding the Domain name, the web URLs are listed under Allowed Domain(s).

Payment Activation in the Novalnet Admin Portal

All the Novalnet supported payment methods can be viewed here: www.novalnet.com/payment if you have questions about the payment methods or additional payment method requests, please contact sales@novalnet.de

To activate the preferred payment methods for your website,

1. Navigate to Novalnet Admin Portal -> Projects.
2. Choose your project -> Payment Methods -> and click Edit Payment Methods in the top right corner.
3. Next, select the preferred payment methods.
4. You can also sort the payment methods in any order through "Drag and Drop" positioning.
5. Finally, click Update to save them on the checkout page.

Now select the preferred payment methods and click Update to activate them.

To use the PostFinance payment method, configure Ep2-Merchant ID details in the Novalnet Admin Portal as shown below.

Payment Configuration in the SAP Commerce Cloud shop system

To view the Novalnet payment methods in the shop system, go to Price Settings -> Payment Modes. Select each payment method, and click the PROPERTIES tab.

Set the status of Is Active as True to activate the preferred payment methods in the shop system. By default, the payment status will be set as False. Finally, click Save to save the changes.

Uninstallation

To uninstall the Novalnet Payment Module, please follow the below steps.

Step 1: Open the file path: < Root_Directory >/bin/platform in your terminal and run the below command to uninstall the Novalnet Payment Module.

ant addonuninstall -Daddonnames=novalnetcheckoutaddon -DaddonStorefront.yacceleratorstorefront=yacceleratorstorefront

Step 2: To remove novalnetcheckoutaddon file from the shop, open the file < Root_Directory >/config/localextensions.xml and remove the below code under < /extensions >.

<!--Search the below line-->
</extensions>
<!-- Remove the following code above the searched line -->
<extension name="novalnetcheckoutaddon"/>