Matrix (Table) Attribute
Use this attribute type to store a table of data to an Account or Contact.
Matrix (Table) Attribute Overview
The matrix attribute allows you to create your own data table!
You can set the column internal key (code identifier) and give it a label. Then fill the rows with data on individual customers through the admin UI, CSV import, or API calls.
Creating a Matrix (Table) Attribute
Setting up a new matrix attribute is simple. You must give it a Name, and choose the Attribute Type of Matrix.
Matrix attributes can be created for just Accounts or Contacts, not addresses.
After creating the matrix attribute you must open its configuration again to add Columns.
Adding Columns to a Matrix (Table) Attribute
Each column in your matrix attribute table is made up of the Key and Label.
- The Key must start with a lowercase letter. It is the ID that is used to update values within the table through API or CSV import.
- The Label is simply displayed at the top of the column.
You are creating your own custom table which can be filled with data and displayed like any other attribute!
Other Attribute Settings
Use the Visibility and Form sections to determine who the table will be visible to and where!
Account Create / Edit / View Form (Admin) must be checked off for the table to appear in the account's overview.
Edit Account Form (Store Frontend) being checked will cause the table to be editable in the customer's Account Manager page.
Viewing and Editing the Matrix Table attribute.
Matrix (Table) in the Admin
In the admin, your Account's matrix attribute table will appear underneath Notes. Click Edit to begin entering data by adding rows.
Editing the Table Data
You can add or change data saved to the matrix attribute's table through the Admin just like any other attribute. Click on the attribute in the Account Overview to edit it.
You can also import tables of data or set the values through our API.
A slide out menu will appear for you to set data into each column and Add Rows to store more records.
Your matrix attribute can also be added to the grids!
Matrix (Table) on your Storefront
Your customers can be allowed to see and edit their table attributes through the Account Manager. There they would see any account attributes that are visible to them.
Managers can click Edit to add rows or change data in the table.
Matrix Attributes in CSV or API
The matrix attribute's table can be edited or added to through CSV import or API calls.
To do that, you will need to understand how the table is represented in data. Export Account Data to Edit for example:
[{"name":"Edward","org":"UNSP","role":"Manager","phone":"9143236591","email":"[email protected]"}], [{"name":"John","org":"UNSP","role":"Sales Rep","phone":"9142359153","email":"[email protected]"}]
The data above represents the matrix table and its values. The pairs go {key:data}
across the row. Each row is contained by square brackets []
and is delimited by a comma.
You can import changes or new data to your matrix attribute in that format through CSV or API.
Updated 6 days ago