Stock Availability and Price Reduction Notifiers Configuration Manual

Overview

This manual guides you through the deployment and configuration process of the Stock Availability and Price Reduction Notifiers for the ONe B2B platform. Follow these steps meticulously to ensure successful integration and functionality of these modules.

Deployment Process

Step 1: HAD-IT Configuration

• Integration Key & Tenant Name: HAD-IT must first add the integration key and tenant name into the database of the plugin framework. This crucial step ensures secure and accurate communication between the ONe platform and the plugin framework.
• URL Configuration: HAD-IT enter the Front Office and Back Office URLs into the database. This action defines the endpoints for user interactions and administrative configurations.
• Module Activation: HAD-IT will then proceed to enable the modules in the database.

This step does not require access to ONe's Back Office.

Step 2: ONe Support Team Deployment

• Plugin Deployment: The ONe support team is responsible for deploying the plugin via the integration API of the plugins microservice. This step activates the plugin within the ONe platform environment.

Plugin ID: oneframework

{
	"author": "HAD IT Services Kft",
	"name": {
		"en": "ONe Framework",
		"hu": "ONe Framework",
		"pl": "ONe Framework"
	},
	"authorizeWithOne": true,
	"components": [
		{
			"type": "iframe_bo",
			"id": "one-framework-plugin",
			"buttonLabel": {
				"en": "ONe eXtensions",
				"hu": "ONe eXtensions",
				"pl": "ONe eXtensions"
			},
			"buttonIcon": "cil-puzzle-piece",
			"requiresLogin": true,
			"page": {
				"slug": "one-framework-plugin",
				"iframeUrl": "https://ase-oneframework-prod-westeu-01.azurewebsites.net/?culture=PL-pl",
				"title": {
					"en": "ONe eXtensions",
					"hu": "ONe eXtensions",
					"pl": "ONe eXtensions"
				}
			}
		},
		{
			"type": "iframe_front",
			"id": "productnotif",
			"page": {
				"slug": "productnotif",
				"title": {
					"en": "Product Notification",
					"hu": "Termék értesítő",
					"pl": "Product Notification"
				},
				"iframeUrl": "https://ase-oneframework-prod-westeu-01.azurewebsites.net/productnotif/trbg_fo_product_notif?culture=PL-pl",
				"requiresLogin": true
			}
		}
	],
	"security": {
		"authorizeWithOne": true,
		"permissions": {
			"view": {
				"components": [
					"one-framework-plugin"
				],
				"name": {
					"en": "ONe Framework plugin",
					"hu": "ONe Framework plugin",
					"pl": "ONe Framework plugin"
				}
			}
		}
	}
}

• Configuration Access: Post-deployment, the ONe support team can access the product page dynamic HTML sample in the plugin's Back Office configuration. This sample serves as the foundation for further customization by the front-end development team.

Step 3: Front-End Development

• Dynamic HTML Integration: The front-end developer should integrate the new dynamic HTML capable of handling VUE scripts onto the product page. This integration decides where the "subscribe to stock availability notifier" and "subscribe to price reduction notifier" buttons are displayed.

• Customization: Developers have the freedom to edit, redesign the dynamic HTML, and apply custom CSS to align with the brand's aesthetic preferences.

Step 4: Testing

• Subscription Testing: It is crucial to test the subscription functionality of both modules. Ensure that the subscription process is smooth and user-friendly.
• Trigger Testing: To verify the email notification system, change the test product's price and adjust stock levels. This action should trigger the email notifications, confirming the operational status of the notifiers.

Step 5: Completion

Once all steps have been successfully executed and tested, the deployment and configuration process is considered complete.

Additional Recommendations

• Design Consistency: Ensure that the custom CSS applied to the dynamic HTML maintains consistency with the overall design language of the ONe platform to provide a cohesive user experience.
• Continuous Testing: Regularly test the functionality of the notifiers to ensure they operate as expected, especially after updates to the ONe platform or the plugin framework.

Conclusion

By following this configuration manual, the Stock Availability and Price Reduction Notifiers will be seamlessly integrated into your ONe B2B platform, enhancing your e-commerce capabilities and improving user engagement.