Installation
You will require to install MageDelight Base Extension first. If it is not installed then please download it from https://www.magedelight.com/pub/extensions/magedelight-base.zip and unzip the package file into the root folder of your Magento 2 installation.
Before installing the extension, please make sure to Backup your web directory and store database
You will require to install MageDelight Base Extension first. If it is not installed then please download it from https://www.magedelight.com/pub/extensions/magedelight-base.zip and unzip the package file into the root folder of your Magento 2 installation.
Root Directory is - "app/code/magedelight/#YourExtensionName#"
- Unzip the extension package file into the root folder of your Magento 2 installation.
- Connect to SSH console of your server:
- Navigate to the root folder of your Magento 2 setup
Run command as per below sequence,
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento cache:clean
- log out from the backend and log in again
If you are using Magento 2.3 or later then you do not need to activate license. Extension will be activated with silent activation mechanism and does not require activation keys to be entered manually.
Backend Functionality (Admin side)
- Enabled: Select "Yes" to enable Order Attribute module for your store.
- Display Attribute Values in the Order Summary : set the option to "Yes" if you want to display custom order attributes in the Order Summary
- Include Order Attributes into Emails : Enable this options to have the ability to include order attribute values into email.
- Order View Title : Here you can define the label for Order Attribute that will display in Payment information of order, invoice, credit memo and shipment section.
- Display on the Invoice Grid : Enable this option to display order attributes on the invoices grid.
- Include Order Attributes into Invoice PDF : Enable this option to include the completed order attributes into the invoice PDF.
- Display on the Shipments Grid : Enable this option to display order attributes on the shipments grid.
- Include Order Attributes into Shipment PDF (packing slip) : Enable this option to include the completed attributes into the shipping documentation.
Backend Functionality
- Grid to list all order attributes and filter it.
- Attribute Code: Provide order attribute code.
- Default label: Provide default label.
Input Type: Select input type for the order attribute values. i.e. text box, drop down list, check box, radio buttons, etc.
After the attribute code and the catalog input type are specified and saved they can’t be changed.
- Input Validation: Select input validation if you would like to apply. i.e. alphanumeric, numeric, URLs, emails, only alphabets, etc.
Show On StoreFront : Enable / Disable custom order attribute in frontend
When you disable the order attribute in storefront. It would not display an custom order attribute on the checkout page. But it will still be available on the order details page in the customer's account and, in addition to this, the info will be included in emails for any previous generated order.
- Show On Admin : Enable / Disable Order Attribute in admin panel
- Values Required: Select "Yes" to make attribute value required /mandatory.
- Default value: Provide default attribute values if any.
- Store View: Select store views to allow Order attributes.
- Customer group: Select customer groups you would like to enable Order attributes. By this way you can create customer group specific attributes.
- Save Value For Future Checkout: If set to "Yes", previously entered value will be used during checkout. Works for registered customers only. if you set the option to Yes, the registered customers will need to fill in the field only once, after that the field will be automatically filled in (with the possibility to edit).
- Visible on Admin Order Grids : Enable this option to display the attribute on the backend grids.
- Include Into HTML Print-out : Enable this option to include the attribute into the HTML print-outs. Order attributes will be included in the document that a customer prints in his account.
- Include Into PDF Documents : Enable this option to include the attribute into the PDF documentation.
- Include Into Transactional Emails : Enable this option to include the attribute into the transactional emails.
- Sorting Order: Provide sort options if you would like to arrange attribute in particular sequence.
- Manage Titles: Provide labels as per store views. You can manage store view specific attribute labels from here.
- Manage Option Values: Provide values from attribute options if any. For drop down, checkbox or radio button type of attribute this will be used.
Sales >> Order
- Custom Order Attribute into order section of admin panel
Frontend Functionality
- Custom Order Attributes into Order Summery.
- Order Attributes at checkout page.
Thank you for choosing MageDelight!