Extension 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.
- Log in to your SAP Commerce shop system..
Installation
To install the Novalnet Payment Extension, please go to your SAP Commerce shop system and follow the steps below
Step 1: Upload the contents of the folder sap_commerce (which you have extracted from the payment extension package/zip file) into the file path: < Root_Directory >/bin/custom.
Step 2: To add Novalnet Payment extensions in the SAP Commerce, open < Root_Directory > /hybris/ config/localextensions.xml file and paste the following code as shown below,
//Search the below line
</extensions>
//Add the following code above the searched line
<extension name='novalnetcore' />
<extension name='novalnetocc' />
<extension name='novalnetfacades' />
<extension name='novalnetbackoffice' />Step 3: Rebuild and restart the hybris server.
Step 4: Go to hybris administration console -> Platform -> Update and do the following actions step by step.
- Update running system
- Clear the hMC configuration from the database
- Create essential data
- Localize types
- Set novalnetcheckoutaddon with sync content catalogs as yes.
Extension Installation for composable storefront (Spartacus)
Step 1: Upload the contents of the folder Spartacus (which you have extracted from the payment extension package/zip file) into Spartacus root directory < Root_Directory >/yourstore/src/app
Step 2: For setting up the Novalnet Payment Extension in Spartacus (Composable storefront), include the Extension in your main application, open < Root_Directory >/yourstore/src/app/app.module.ts file and paste the following code as shown below,
import { NovalnetModule } from "./novalnet/novalnet.module";
NovalnetModuleConfiguration in the SAP Commerce shop system
The main configuration occurs in your SAP Commerce shop system as well as in the Novalnet Admin Portal. In your SAP Commerce shop system navigate to Base Commerce -> Base Store -> < Store > -> Novalnet. Enter the following keys as shown below:
- 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 and Payment access key, go to the Novalnet Admin Portal, navigate to Projects menu and click view icon on the right of your project to view the project details.
Click API Credentials and copy the API Signature (Product activation key), Tariff ID and Payment access key.
Paste the Product activation key, Tariff ID and Payment access key and in the respective fields in your shop system and click Save to update/save the changes made.
Payment Activation in the SAP Commerce shop system
To display payment methods on the shop checkout page, select the option True under the Display payment method on the Novalnet API Configuration in Shop. Saving the configuration settings will enable the payment methods activated in the Novalnet Admin Portal.
Then go to Price Settings -> Payment Modes, select the checkbox novalnet as shown below.
Set the status of Is Active as True to activate the payment method in the shop system under Properties tab. By default, the payment status will be set as False. Finally, click Save to save the changes.
Uninstallation
To uninstall the Novalnet Payment Extension, please follow the step below, Open the file path: < Root_Directory >/config/localextensions.xml and remove the below code.
//Search the below line
</extensions>
//Remove the following code above the searched line
<extension name='novalnetcore' />
<extension name='novalnetocc' />
<extension name='novalnetfacades' />
<extension name='novalnetbackoffice' />