User guide

Terminology

Sources
Represent physical sites where the available products are stocked and shipped from. It can be warehouses, stores, wholesalers...
See your sources from:
StoresInventorySources
Source Item
It is a source for a given product.
Assign sources to your products from the Sources tab of any product page in:
Catalog Products
Stocks
One stock can be linked to several websites and sources.
See your stocks from:
StoresInventorySTocks
Sales Channels
Refers to a website. It can only be linked to one stock.
See your websites from:
StoresSettingsALL Stores
Salable Quantity
It is the total virtual inventory that can be sold from a website.
Check the salable quantity from:
CatalogProducts
Reservations
It is the number of products reserved and deducted from the salable quantity when customers add products to cart and pass their order.
Check the quantities reserved from:
CatalogProducts
When an order is shipped, the quantity of reservations is reset and deducted from the quantities of the inventories of the appropriate sources.

Adopt the best way to manage your inventory with the MSI Suite

Name: MSI Custom Attributes
Brand: Wyomind
SKU: MSICA
Price: 195 EUR
Availability: InStock

The MSI Suite includes several extensions. Each one responds to a problem and to a desire to improve Magento 2 default inventory management.

Thanks to these extensions that are completely plug and play, the MSI Suite easily adapts to your business model, whether you manage several warehouses, multi-stocks, dropshipping…

Perfect your inventory management and your selling process with the MSI Suite and enjoy:

optimal order management: optimize and automate the orders assignation to the appropriate sources. Save time and avoid human errors in your Magento 2 back office with MSI Order Management (available soon).
smoother and fine-tuned inventory management: gain considerable time while managing your inventory directly from the stocks grid and get a clear and accurate view of your products' availability thanks to the tree view with MSI Stock Management and MSI Backorders.
team management under control: limit the access to your orders, products, and stock management for each source by assigning specific permissions to each user registered in your Magento 2 admin with MSI Permissions.
more transparent information on product availability: provide your customers with more information on your products' availability, carriers, or delivery times via completely customizable stock status messages with MSI Stock Status and MSI Custom Attributes.

How to use MSI Custom Attributes for Magento 2

Since the release of Magento 2.3, many enhancements were added to the default Magento features and particularly to the inventory management.

The MSI Custom Attributes extension allows you to expand your inventory system with any additional information.

You'll be able to create any kind of fields:

Text field
Number field
Date field
Yes/No field
Dropdown field

Create your custom attributes

You can create custom attributes for your inventory in:
StoresInventoryStock Attributes

Click on Add a new Attribute.

Configure the settings of the attribute

In the Settings section, you'll have to fill in:

Code
Define an internal code for the attribute.
Label
The label for the attribute will appear in the sources grid from the product page.
Location
Sort order
Define the order of display in the sources grid.

You can create different types of attributes and you'll have to fill in more information depending on these types.

Text attribute

You can create text attributes. You'll have to fill in a default value and define if the attribute is required or not.

Number attribute

You can create number attributes. You must fill in a default value and define if the attribute is required or not.

Date attribute

You can also add date attributes. You'll have to define if the attribute is required or not.

Yes/No attribute

You have the possibility to add a Yes/No attribute.

The attribute will appear in the sources grid as a switch button.

If you want to create dropdown attributes, you have to add the different options available in the dropdown list.

You must tick the default value and add the Value for Admin.

Note that you can drag and drop each option to modify the order.

Use MSI Custom Attributes with the extensions of the MSI Suite

The MSI Suite is a package including all necessary extensions to completely improve and enhance the Magento 2 inventory and multi-stock inventory.

With MSI Custom Attributes, the Suite includes 5 other extensions:

MSI Stock Status
Display customized and elaborate stock status messages to better inform your customers about the availability of your products.
MSI Backorders
Easily switch from a global backorders management to management at the level of your sources and arrange backorders dates and quantities.
MSI Permissions
Control the access to the orders, the products, and the stock management for each source and for each user registered in your Magento admin.
MSI Stock Management
Manage all your stocks inventory directly from the stock grid and get a clear and accurate view of your products' availability thanks to the tree view.
MSI Orders Management (coming soon)

The MSI Custom Attributes extension can be used in combination with the below extension of the MSI Suite.

MSI Custom Attributes with MSI Permissions

Using MSI Permissions with MSI Custom Attributes would allow you to manage your custom attributes for the sources for which store managers are responsible only.

See more about the MSI Permissions extension.

MSI Custom Attributes with MSI Stock Management

Using MSI Stock Management with MSI Custom Attributes allows you to update all your custom attributes in bulk directly from the stocks grid.

See more about the MSI Stock Management extension.

MSI Custom Attributes with MSI Stock Status

Using MSI Stock Status with MSI Custom Attributes gives you the possibility to provide your customers with more information about your inventory via customized stock status messages.

For example, you could inform your customers about the cutoff time for each source in your stock status messages.

You will be able to display these stock status messages:

on the product page
in the cart
in the checkout
in the order confirmation email

See more about the MSI Stock Status extension.

Completely enhance your inventory system with additional information!

Use the MSI Custom Attributes extension for Magento^® 2 to brighten up your inventory system and add any kind of information with custom fields.

Lifetime license
12 months support & upgrade
60 days money-back guarantee
Extensible source code
Unlimited test domains
Free composer access
Marketplace approved

Want to know more?

Easily extend your inventory with more information

Add as much complementary information as you want to your inventory: location of the products in the warehouse, name of the provider, contact info, dates, notes...

Brighten up your inventory with any kind of custom fields

Create any type of fields: Text field, Number field, Date field, Yes/No field, Dropdown field

Do you want to know more?

Play with our demo

Get in touch with us

Explore our user guide

This extension is part of the MSI Suite and can be used in combination with: MSI Stock Management MSI Stock Status Mass Stock Update

MSI Stock Management
Improve your stock management!

Manage all your custom attributes in bulk from the stocks grid available with MSI Stock Management.

Are you interested in MSI Stock Management?

See More details

Check the demo

MSI Stock Status
Enhance your stock status messages!

Create custom stock status messages and provide any additional information to your customers using the MSI Stock Status extension.

Are you interested in MSI Stock Status?

See More detailS

Check the demo

Mass Stock Update
Keep your stocks synch with your ERP!

Start with the sample profile included with the module

Update your stocks from CSV or XML files

Automate update tasks thanks to the cron tasks or the CLI

Are you interested in Mass Stock Update?

See More details

Check the demo

Freqently Asked Questions

Pre-sales informations

Magento^® versions supported by MSI Custom Attributes

This extension works with Magento Community Edition and also Magento Enterprise Edition. To know if MSI Custom Attributes is compatible with your Magento version, please check the Compatibility tab.

Advanced Inventory vs MSI Suite

Find in the below comparison table, the differences between the Advanced Inventory extension and the MSI Suite.

	Advanced Inventory	MSI Suite
Magento versions	<v2.3, >= v2.3 (MSI disabled)	>= v2.3
Stock management by storeview
Manage product availability at the storeview level		(default is by website)
Backorders management
Backorders at warehouse/store/source level
Additional fields (back-ordered qty and backorder date)
Stocks display
Stock grid display on the product page
Stock status message on the product page
Stock status message in the cart
Stock status message in the checkout
Stock status message in the order confirmation email
Fully customizable messages
Widget integration
Additional custom fields in the product/source management
Text field
Date field
Number field
Dropdown field
Yes/No field
Stock management improvements
Grid view management	(qty only)	(all inventory fields, can be limited to a selection of fields)
Tree view summary in the product grid
Order management improvements
Automatic assignation
Shipping address-based assignation rule
Warehouse fallback assignation rule
Sources minimizer algorithm
Permissions management for admin users
Order level
Inventory level
Source level
Product level

Magento^® Open Source vs Magento^® Commerce vs Magento^® Commerce Cloud

Magento offers three variations of its product.

As their names have changed over the past few years, here is a recap:

Magento Open Source: previously Magento Community Edition (CE), is a free and non-hosted e-commerce platform.
Magento Commerce: previously Magento Enterprise (EE), is the paid version of Magento and offers support services.
Magento Commerce Cloud: is the paid version of Magento and offers support and hosting services.

License and domains

License validity

A license is valid for an unlimited period of time on one single installation

If you're using more than one installation, you will have to buy a separate license for each instance.
if you're running several domains on a same installation, you will need only one license for all of them.

Although your license doesn’t have a limited period of validity, your Support & Upgrade period does. By purchasing a module, you’ll be granted a 12-month support period for free. Passed this period, you will have to pay for a new one (see FAQ: Extend your Support period)

Domains pre-registration

You can pre-register your live domain to your license in advance.

Thanks to this option, you'll be able to get the module ready to use on your domain before it goes live.

To pre-register your production domain:

Go to:
mY accountLicenses & DOwnloads
Click on the Settings icon next to the module you want your domain to pre-register on.
Click on the link at the bottom of the page saying:
Do you want to pre-register your domain in order to be ready to go live?
Finally, enter your domain name and click on pre-register now .

Attention, this doesn't mean your license is activated. You'll still have to activate it on your new domain when the module is installed.

Testing environments

One license is valid for an unlimited period of time on one installation only. However, it is possible to extend or transfer your license in 2 cases:

If you would like to add your testing environments to your license.
In that case, it is possible to extend your license to an unlimited number of domains for free.
For mywebsite-staging.com or mywebsite-dev.com
If you want to transfer your license to another live domain.
In that case, the Support & Upgrade period for your license must still be active.

To be able to use MSI Custom Attributes on both your production and testing environments, follow the instructions below:

Download MSI Custom Attributes.
(see FAQ: Extensions download)
Install MSI Custom Attributes on your environment.
(see FAQ: Modules installation in Magento or in WooCommerce)
Activate the license.
(see FAQ: Licenses activation in Magento or in WooCommerce)

Also, if you are managing a large amount of domains, please contact us so that we can automatically whitelist these domains.

Modules versioning and download

Extensions download

In order to download MSI Custom Attributes, log into your Wyomind account:

Go to:
my accountLicenses & downloads
Click on the settings icon next to MSI Custom Attributes.

A new window opens.
Click on the download icon.

Only the latest extension version released within your Support & Upgrade period is available. In order to get the very latest extension version make sure your Support & Upgrade plan is up to date.

Modules upgrade

When purchasing a module from wyomind.com, you benefit from 12 months of upgrade. Within this period you can at any time download the latest version of the module directly from your account.

To upgrade MSI Custom Attributes, follow the steps below:

Go to:
my accountLicenses & Downloads
Click on the settings icon next to MSI Custom Attributes.
Click on the download icon.
Install the new version of MSI Custom Attributes in your Magento admin or your WooCommerce back-office.

Modules Installation/Uninstallation

Extensions manual installation

You can install MSI Custom Attributes manually.

Download MSI Custom Attributes (zip file) on:
mY ACCOUNTLicenses & Downloads

Refer to the FAQ: Extensions download
Once MSI Custom Attributes is downloaded, open the folder and unzip it.
Copy the content of the unzipped folder and paste all files and directories in your Magento 2 root directory.

In your Command Line Interface, execute:

bin/magento setup:upgrade

If you are using a production mode, execute also:

bin/magento setup:static-content:deploy

bin/magento setup:di:compile

Extensions installation via Composer

You can install MSI Custom Attributes using Composer software in two cases:

if you purchased MSI Custom Attributes on Magento Marketplace.
if you purchased MSI Custom Attributes on Wyomind.com AND requested access to our repository:
repo.wyomind.com

Add to your composer configuration our repository:

composer config repositories.wyomind composer https://repo.wyomind.com

Execute Composer command:

composer require wyomind/msicustomattributes

Then go in your Command Line Interface and execute:
```
bin/magento setup:upgrade 
```

If you are using a production mode, also execute:

bin/magento setup:static-content:deploy

bin/magento setup:di:compile

Extensions uninstallation

To uninstall MSI Custom Attributes, start with disabling the extension running the following command:

bin/magento module:disable Wyomind_MsiCustomAttributes

Then, you have 2 ways to uninstall the extension depending on how the extension has been previously installed:

Manual installation

Run the msicustomattributes-uninstall.sh file (you can find it in the extension zip folder) from your Magento root directory:
```
sh msicustomattributes-uninstall.sh
```
Installation via Composer

Run the below command line:
```
composer remove wyomind/msicustomattributes
```

Once the uninstallation is over, refresh your cache and enable the compiler back again (if you use it).

Extensions installation via Web Setup Wizard

You can install MSI Custom Attributes via Web Setup Wizard if you purchased it from Magento Marketplace only.

To know how to proceed, all steps are described in the link below:
http://docs.magento.com/m2/ce/user_guide/system/component-manager.html

Next step is to activate your license:
Extension activation

Modules activation

Extensions activation from the back-office of Magento^®

Once MSI Custom Attributes is installed, you have to activate the license. For previous versions, you can activate the license from your back-office:

Go to your Magento admin panel. A message pops up at the top of the page.
If the message doesn't appear then you must check that:

1. The Adminhtml_Notifications and Wyomind_Core modules are well enabled.
2. The HTML output of the Adminhtml_Notifications and Wyomind_Core modules are not disabled in:
storesconfigurationadvanced advanced
3. The encryption key well exists in app/etc/env.php:
```
<?php
 return array(
 'backend' => array(
 'frontName' => 'admin'
 ),
 'crypt' => array(
 'key' => '1e8f3c6772b7a6a6689c3c8cefa4ccf0'
 ),
 /* ... */
 )
?>
```
Copy your activation key in:
StoresConfigurationWyomind Your extension

You can find your activation key in 2 different places:
- In the confirmation email that you received after purchasing MSI Custom Attributes.
- In your Wyomind account:My account Licenses & downloads
Select MSI Custom Attributes and click on .

A new page opens where you'll find your activation key (see below).
In your Magento admin go to:
StoresConfigurationWyomind Your extension

Paste the activation key in the Activation Key field and choose between the automatic (yes) or the manual (no) activation method:
- By choosing Yes, the connection to Wyomind license server will be automatic.
- By choosing No, you will have to log on to Wyomind license server yourself.
Click on Save config .
A message appears at the top of your admin panel. Click on that link:
Activate it now!
Copy and paste the license code in the License code field from your admin or simply click on Activate now!
Finally, refresh your cache, log out and log in back straight after, to complete the installation.

When the extension includes other modules, repeat the steps described above for each one, using the corresponding activation keys (each module has its own activation key).

Add another domain to your license

To activate the license on another domain (test, staging...):

Once the extension is installed on the new domain, copy your activation key in:
StoresConfigurationWyomind Your extension
After having saved the configuration, a notification appears. Click on Add this domain to my license.
A transfer request will then be sent to our team within an hour.
Once the request is taken care of, you will receive a confirmation email.
If your transfer request is accepted, you can use MSI Custom Attributes on both environments at the same time.

Note that the order in which you activate your license on your domains does not matter. You can start with your staging/dev/local environment or with your live domain, the process will be the same.

Also, if you have loads of staging domains, or if you are an agency managing load of domains for your customers, please contact us so that we can automatically whitelist these domains.

Extensions activation from the CLI

Once MSI Custom Attributes is installed, you have to activate the license.

For this, you can use the below command line (change the Activation key with the corresponding value):

bin/magento wyomind:license:activate Wyomind_MsiCustomAttributes <YOUR_ACTIVATION_KEY>

To retrieve the list of all the available modules as well as the licenses status, please use:

bin/magento wyomind:license:status

Among the different status, you can find:

registered = your license is registered
pending = you need to run the activation command line
invalidated = the license has been invalidated due to a wrong activation key or a license infringement

To activate several licenses at the same time, use:

bin/magento wyomind:license:activate \
Wyomind_Extension1,Wyomind_Extension2 \
ACTIVATION_KEY_1,ACTIVATION_KEY_2

or:

bin/magento wyomind:license:activate \
Extension1,Extension2 \
ACTIVATION_KEY_1,ACTIVATION_KEY_2

Check how to add another domain to your license.

Magento 2 Compatibility

Magento 2^® Open Source

2.0.3
2.0.3
2.0.4
2.0.4
2.0.5
2.0.5
2.0.6
2.0.6
2.0.7
2.0.7
2.0.8
2.0.8
2.0.9
2.0.9
2.0.10
2.0.10
2.0.11
2.0.11
2.0.12
2.0.12
2.0.13
2.0.13
2.0.14
2.0.14
2.0.15
2.0.15
2.0.16
2.0.16
2.0.17
2.0.17
2.0.18
2.0.18
2.1.1
2.1.1
2.1.2
2.1.2
2.1.3
2.1.3
2.1.4
2.1.4
2.1.5
2.1.5
2.1.6
2.1.6
2.1.7
2.1.7
2.1.8
2.1.8
2.1.9
2.1.9
2.1.10
2.1.10
2.1.11
2.1.11
2.1.12
2.1.12
2.1.13
2.1.13
2.1.14
2.1.14
2.1.15
2.1.15
2.1.16
2.1.16
2.1.17
2.1.17
2.1.18
2.1.18
2.2.1
2.2.1
2.2.2
2.2.2
2.2.3
2.2.3
2.2.4
2.2.4
2.2.5
2.2.5
2.2.6
2.2.6
2.2.7
2.2.7
2.2.8
2.2.8
2.2.9
2.2.9
2.2.10
2.2.10
2.2.11
2.2.11
2.3
2.3
2.3.1
2.3.1
2.3.2
2.3.2
2.3.3
2.3.3
2.3.4
2.3.4
2.3.5
2.3.5
2.3.6
2.3.6
2.3.7
2.3.7
2.4
2.4
2.4.1
2.4.1
2.4.2
2.4.2
2.4.3
2.4.3
2.4.4
2.4.4
2.4.5
2.4.6
2.4.7

Magento 2^® Adobe Commerce

2.0.3
2.0.3
2.0.4
2.0.4
2.0.5
2.0.5
2.0.6
2.0.6
2.0.7
2.0.7
2.0.8
2.0.8
2.0.9
2.0.9
2.0.10
2.0.10
2.0.11
2.0.11
2.0.12
2.0.12
2.0.13
2.0.13
2.0.14
2.0.14
2.0.15
2.0.15
2.0.16
2.0.16
2.0.17
2.0.17
2.0.18
2.0.18
2.1.1
2.1.1
2.1.2
2.1.2
2.1.3
2.1.3
2.1.4
2.1.4
2.1.5
2.1.5
2.1.6
2.1.6
2.1.7
2.1.7
2.1.8
2.1.8
2.1.9
2.1.9
2.1.10
2.1.10
2.1.11
2.1.11
2.1.12
2.1.12
2.1.13
2.1.13
2.1.14
2.1.14
2.1.15
2.1.15
2.1.16
2.1.16
2.1.17
2.1.17
2.1.18
2.1.18
2.2.1
2.2.1
2.2.2
2.2.2
2.2.3
2.2.3
2.2.4
2.2.4
2.2.5
2.2.5
2.2.6
2.2.6
2.2.7
2.2.7
2.2.8
2.2.8
2.2.9
2.2.9
2.2.10
2.2.10
2.2.11
2.2.11
2.3
2.3
2.3.1
2.3.1
2.3.2
2.3.2
2.3.3
2.3.3
2.3.4
2.3.4
2.3.5
2.3.5
2.3.6
2.3.6
2.3.7
2.3.7
2.4
2.4
2.4.1
2.4.1
2.4.2
2.4.2
2.4.3
2.4.3
2.4.4
2.4.4
2.4.5
2.4.6
2.4.7

User's reviews

Log into your account to leave your review and get up to 3 months of free Support & Upgrade.

Changelog

master v4.0.2 released on 16/08/2024

master v4.0.1 released on 08/02/2024

Compatibility

Compatibility with Php v8.2

master v4.0.0 released on 07/07/2023

Initial release for the master version

legacy v3.0.0 released on 07/07/2023

Initial release for the legacy version

master v2.0.0 released on 22/03/2023

Compatibility

Compatibility with Magento v2.4.6 + PHP v8.2

master v1.3.0 released on 27/10/2022

Improvements

Apply database upgrade and database install from patches instead of the setup scripts
Remove drop table instruction in setup patches

master v1.2.4 released on 20/06/2022

Fix when saving data from the stocks grid when using MSI Stock Management

master v1.2.3 released on 17/12/2020

Enhancements

Table name prefixes are taken into account
Improved conversion of dates from local to UTC format

master v1.2.2 released on 10/11/2020

Minor fix on code

master v1.2.1 released on 10/09/2020

Enhancement

General code improvements

master v1.2.0 released on 03/08/2020

First Public Release

master v1.1.1 released on 17/07/2020

Update for the phpdoc

master v1.1.0 released on 09/07/2020

Enhancement

Database improvement with EAV data structure

master v1.0.0 released on 16/06/2020

First Release

Demo store

Front-end

Url

https://msi.wyomind.com

Back-end

Url

https://msi.wyomind.com/admin

MSICustomAttributes

Password

MSICustomAttributes123

MSI Custom Attributes

Brighten up your inventory system with any kind of information thanks to custom fields available with the MSI Custom Attributes extension for Magento 2.

Terminology

Adopt the best way to manage your inventory with the MSI Suite

How to use MSI Custom Attributes for Magento 2

Create your custom attributes

Configure the settings of the attribute

Text attribute

Number attribute

Date attribute

Yes/No attribute

Dropdown attribute

Use MSI Custom Attributes with the extensions of the MSI Suite

MSI Custom Attributes with MSI Permissions

MSI Custom Attributes with MSI Stock Management

MSI Custom Attributes with MSI Stock Status

Completely enhance your inventory system with additional information!

Easily extend your inventory with more information

Brighten up your inventory with any kind of custom fields

Do you want to know more?

MSI Stock ManagementImprove your stock management!

MSI Stock StatusEnhance your stock status messages!

Mass Stock UpdateKeep your stocks synch with your ERP!

Magento 2® Open Source

Magento 2® Adobe Commerce

MSI Stock Management
Improve your stock management!

MSI Stock Status
Enhance your stock status messages!

Mass Stock Update
Keep your stocks synch with your ERP!

Magento 2^® Open Source

Magento 2^® Adobe Commerce