Magento 2 Diamond Search

Installation and User Guide for Magento 2 Diamond Search Extension

Table of Contents

  1. Prerequisites( module installed previously )
    • Module Installed via composer
    • Module Installed by Placing Files in app/code
  2. Installation
    • Installation via app/code
    • Installation via Composer
  3. Configuration Settings for Diamond Search
    • General Settings
    • Filter Widget Settings
    • Myo Widget
  4. Integration Modes
    • Local
    • RapNet
  5. Custom Attribute Set
    • Settings
    • Diamonds
  6. Ring Builder
    • Choosing a Diamond
    • Choosing a Setting
    • Review Complete Ring
  7. Setup 360 view and Certificate
    • Certificate
    • 360 view
  8. Frontend

Prerequisites( module installed previously )

If you have previously installed this module on your store using MageInn Extension then you need to follow the steps below in order to install it again on your site. You will need to remove the module first then proceed with the installation steps in the next section.

Module Installed via Composer

If the module was installed previously via composer then run the commands below to remove it completely:- 

// disable the module php bin/magento module:disable Mageinn_DiamondSearch

//remove the module composer remove mageinn/module-diamondsearch

//run upgrade commands 
php bin/magento setup:upgrade 
php bin/magento setup:di:compile 
php bin/magento setup:static-content:deploy

Module Installed by placing files in app/code

If the module was previously installed by placing extension files in app/code then simply go the following directory app/code/MageInn/ and remove the DiamondSearch folder completely then run the upgrade commands as shown below:- 

php bin/magento setup:upgrade 
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy

Installation

https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer

Configuration Settings for Diamond Search

Go to Admin> Stores> Configuration> Scommerce > Diamond Search

General Settings

image (57).jpg

Widget Filter Settings

image (78).png

image (58).jpg

image (59).jpg

image (59).jpg

image (79).png

image (60).jpg

image (80).png

Myo Widget

image (81).png

Integration Modes

The extension comes with two integration modes:- Local and RapNet.

Local

When mode is set to local you can create your diamond products directly from Magento admin. All you need to do is to assign "Diamonds" attribute set to your diamond products

RapNet

RapNet brings millions of dollars in diamond product to your Magento store, without the cost of owning the physical diamonds. All diamonds and attributes should be configured directly from RapNet admin panel. RapNet provides data and pricing in real time. Once the customer places the order using the ring builder the product gets automatically created in Magento catalog. https://www.rapnet.com/

Custom Attribute Set

By default, the module adds two attribute sets i.e. Settings and Diamonds. These contain essential attributes for the module to work. If you want to create a custom attribute set, you need to include the attributes from these existing sets in order for your custom attribute set to work properly and the functional flow to be correct. We will go through each of these attribute sets and the attributes contained within them.

Settings

If you want to use a custom attribute set for "Rings" aside from settings then include critical Settings attributes which are Shape, Size from and Size To and these attributes must have values against them for everything to work correctly on frontend as these values get used to select correct Ring. All the attributes included in this attribute set are as follows:-

Rings

All the attributes included in this attribute set are as follows:-

Ring Builder

Ring Builder is a great tool to allow your customers to pair any diamond with setting of their choice. Ring builder is fully responsive. You can also define a filter for each setting, so that only compatible diamonds are shown when setting is selected.

The entire process is divided into three steps namely, choosing a diamond, choosing a ring and in the final step a bundled product is created using previous selections and customers can place an order with that product.

Note:- Customers can start by either choosing a diamond first or choosing a setting(ring) first they will automatically be redirected to the next step.

Choosing a Diamond

If customers chooses to start by selecting a diamond then they will be able to see the diamond search page as shown in the image below. It contains several filters which can be utilized to pinpoint the exact diamond as per requirements.

image (82).png

Once the customer decides on a diamond they click on it which takes them to a detailed page for that diamond. It contains all the necessary details related to that specific diamond. Once satisfied they click on SELECT DIAMOND and they are redirected to the next step i.e choosing a ring.

image (61).jpg

Choosing a Setting(Ring)

In the next step, customers are directed towards the ring selection. Rings automatically get filtered and only the compatible rings for the diamond selected are displayed on this page. Simply click on choose this setting and you will redirected to the final step.

image (62).jpg

Review Complete Ring

In the final step a bundled product is created using the first two selections which customers can add to basket and place an order with it.

image (63).jpg

Multicurrency Setup

Multiple currencies can be added/selected from Admin > Stores Configuration > General > Currency Setup - Allowed Currencies - Select currencies

image (83).png

Currency rates can be configured against base currency from Admin > Stores > Currency > Currency Rates

image (84).png

Base currency can be defined from Admin > Stores Configuration > General > Currency Setup > Base Currency - Select currency

Currency Switcher Frontend

image (85).png

Setup 360 view and Certificate

Please follow the steps provided below in order to setup 360 view and certificate:-

  1. Use local inventory in the configuration
  2. Update diamond and add below values from Admin > Catalog > Products > Select Diamiond > Edit > "Diamond Details"
    1. Put any value with url of the document (ex. https://certimage.s3-accelerate.amazonaws.com/images/full_size/certificates/LG480159253.pdf) in the "Has cert file" attribute for the certificate
    2. Put any value for 360 url value for " Sarineloupe Url" attribute (ex. V360 Viewer ) and 1 to " Has Sarineloupe" attribute.

Test URL - Choose a diamond

image (86).png

Certificate

image (87).png

360 view

image (88).png

Frontend

The below screengrab contains order with custom ring size selected:-

image (89).png

If you have a question related to this extension please check out our FAQ Section first. If you can't find the answer you are looking for then please contact support@scommerce-mage.com.

Revision #4
Created 30 May 2025 12:26:24 by scommerce
Updated 24 October 2025 09:51:43 by scommerce