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

• Installation via app/code: Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.

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

• Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.

Installation Via Composer

Configuration Settings for Diamond Search

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

General Settings

• Enable Module – Select “Yes” or “No” to enable or disable the module.

• License Key – Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at [e-mail].
• Source:- Select the source from where the products are pulled. Rapnet/Demo pulls products via Rapnet API where Rapnet is live. "Local" pulls products from Magento.

• API Key (RapNet):- Enter the API key provided by RapNet here. • http://technet.rapaport.com/ProgrammaticAccess/Keys.aspx The following key works only “localhost” domain: 8EC95570ABE6411290197CB28845A6FF

  Please note - “localhost” means domain. Not IP- address like “127.0.0.1”, not other domain matched to local IP, “localhost” means domain. So this test API-key used only for local site running via “http://localhost”. Not for “http://127.0.0.1”, not for “http://my-domain-resolved-to-local-ip.tld”, only for “http://localhost”
• Theme Color:- Enter the color code for the entire diamond search theme

• Diamond Image Type:- Choose between two image types schematic or photo for diamonds that appear in the list

• Settings Attribute Set:- Attribute Set used to select products on Settings step(step 2) in Ring Builder (eg:- something like "Rings"). If you are creating a custom attribute set for rings 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 the front end as these values get used to select the correct Ring.

• Diamond Search Category:- Diamond Search Category used to show Settings on Step 2(choose a setting)

• Show Dropdown filters:- If set then filters will be dropdowned. If not set then filters will be always displayed

Widget Filter Settings

• Expand filters:- Select "Yes" to expand widget filters by default and select "No" to keep it hidden

• Show Natural / Lab filter:- Select "Yes" or "no" to show or hide the natural/lab filter for diamonds.

• Default Diamond Type:- Select default diamond type filter natural or lab.

• Show selected Shapes:- Select "Yes" to show different diamond varieties in filter menu and select "No" to keep them hidden

• Shapes:- Allowed Shapes(list of diamonds to appear in filter menu)

• Show selected Sizes:- Enable/Disable CARAT filter. Set "Yes" to show CARAT filter. If set to "No" CARAT filter will be disabled

• Size From:- CARAT filter range start

• Size To:- CARAT filter range end

• Show selected Colors:- Enable/Disable COLOR filter. Set "Yes" to show COLOR filter. If set to "No" COLOR filter will be disabled

• Color From:- COLOR filter range start

• Color To:- COLOR filter range end

• Show selected Clarities:- Enable/Disable CLARITY filter. Set "Yes" to show CLARITY filter. If set to "No" CLARITY filter will be disabled

• Clarity From:- CLARITY filter range start

• Clarity To:- CLARITY filter range end

• Show selected Cuts:- Enable/Disable CUT filter. Set "Yes" to show CUT filter. If set to "No" CUT filter will be disabled

• Cut From:- CUT filter range start

• Cut To:- CUT filter range end

• Show selected Polishes:- Enable/Disable POLISH filter. Set "Yes" to show POLISH filter. If set to "No" POLISH filter will be disabled

• Polish From:- POLISH filter range start

• Polish To:- POLISH filter range end

• Show selected Symmetry:- Enable/Disable SYMMETRY filter. Set "Yes" to show SYMMETRY filter. If set to "No" SYMMETRY filter will be disabled

• Symmetry From:- SYMMETRY filter range start

• Symmetry To:- SYMMETRY filter range end

• Show selected Labs:- Enable/Disable CERTIFICATE/LAB filter. Set "Yes" to show CERTIFICATE/LAB filter. If set to "No" CERTIFICATE/LAB filter will be disabled

• Labs:- Select list of labs to appear in CERTIFICATE/LAB filter

• Filter by Price Total In Currency:- Enable/Disable PRICE filter. Set "Yes" to show PRICE filter. If set to "No" PRICE filter will be disabled

• Filter by Price Total In Currency From:- PRICE filter range start

• Filter by Price Total In Currency To:- PRICE filter range end

• Show selected Fancy Colors:- ENABLE/DISABLE fancy colors in COLOR filter. NOTE:- Fancy Colors will only appear when "fancy" is selected in "Default Search Type" setting.

• Fancy Colors:- Allowed Fancy Colors(List of fancy colours to appear in the COLOR filter) NOTE:- Fancy Colors will only appear when "fancy" is selected in "Default Search Type" setting.

• Show Filter by Paired:- ENABLE/DISABLE PAIR filter. If "yes" Pair will be available in the Filter. It allows to filter diamonds by paired attribute.

• Diamond Title Format In Widget:- Placeholders like [size] means diamond property. Placeholders like {STRING} means lexicon string

• Default Search Type:- WHITE/Fancy selecting "white" will enable COLOR filter and color filter range wheras selecting "fancy" will enable the FANCY filter and fancy filter range.

• Page Size:- Enter the total number of products to appear in the Diamond list.

• Show Price:- If set to "Yes" then the PRICE column will be available in the Diamond list. If "No" then price column will disappear from the diamond list.

• Show Add To Cart Button:- Set "Yes" or "No" to show or hide Add To Cart Button On Frontend Diamond Page

• Show Add To Wishlist Button:- Set "Yes" or "No" to show or hide Add To Wishlist Button On Frontend Diamond Page

• Is Responsive:- Set "Yes" or "No" to choose whether the style is reponsive for diamond search or not.

Myo Widget

• Add custom size option to bundle product:- Set "Yes" or "No" to Add or Remove custom size option to bundle product

• Bundle Generated Size Label:- Bundle Generated Size Label for dropdown with custom options of generated bundle product

• Custom Sizes:- Select the custom Sizes added to bundle product on the fly

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:-

• ds_size_min

• ds_size_max

• ds_shape

• ds_is_paired

Rings

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

• mdiamond_id

• mshape

• msize

• mcolor

• mfancy_color_dominant_color

• mfancy_color_secondary_color

• mfancy_color_overtone

• mfancy_color_intensity

• mclarity

• mcut

• msymmetry

• mpolice

• mdepth_percent

• mtable_percent

• mmeas_length

• mmeas_width

• mmeas_depth

• mgirdle_min

• mgirdle_max

• mgirdle_condition

• mculet_size

• mculet_condition

• mfluor_color

• mfluor_intensity

• mhas_cert_file

• mcountry

• mcity

• mlab

• mtotal_purchase_price

• mtotal_sales_price

• mcurrency_code

• mcurrency_symbol

• mtotal_sales_price_in_currency

• mcert_num

• mstock_num

• mhas_sarineloupe

• msarineloupe_url

• mis_fancyColor

• ds_is_paired

• mis_lab_diamond

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.

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.

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.

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.

Multicurrency Setup

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

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

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

Currency Switcher Frontend

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

Certificate

360 view

Frontend

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

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 [e-mail].