System. Magento 2.1

PDF

ஆவணம்

விளம்பரம்

System

983

984

In this section of the guide, you’ll learn how to import and export data, manage security and permissions, install extensions and integrations, and use the many tools that are available to maintain your store at peak performance.

System Menu

Data Transfer

Working with CSV Files

Product Attribute Reference

Complex Data

Advanced Pricing

Customer Attribute Reference

Alternate Media Storage

Using a Database

Using a CDN

Security

Security Best Practices

Configuring Admin Security

CAPTCHA

Encryption Key

Session Validation

Browser Capabilities Detection

Cron (Scheduled Tasks)

Developer Tools

Frontend Development Workflow

Using Static File Signatures

File Optimization

Developer Client Restrictions

CHAPTER 74:

System Menu

The System Menu includes tools to import and export data, install extensions, manage system caches and indexes, manage permissions, backups, system notifications, and custom variables.

To display the System menu:

On the Admin sidebar, tap

System

System Menu

Magento Community Edition 2.1 User Guide 985

986

Menu Options

CHAPTER 74: System Menu

Data Transfer

The Import and Export tools give you the ability to manage multiple records in a single operation. You can import new items, and also update, replace, and delete existing products and tax rates.

Integrations

Manage integrations and extensions for your store.

Tools

Manage your system resources, including cache and index management, backups, and installation settings.

Permissions

Magento uses roles and permissions to create different levels of access for Admin users, which gives you the ability to grant permission on a “need to know” basis to people who work on your site.

Magento Community Edition 2.1 User Guide

CHAPTER 74: System Menu

Other Settings

Notifications

Your store has an inbox for the messages received from Magento. The messages are rated by importance, and might refer to system updates, patches, new releases, scheduled maintenance, upcoming events, and more.

Custom Variables

If you know a little basic HTML, you can create custom variables and use a

markup tag

to incorporate them into pages, blocks, banners, and email templates.

Manage Encryption Key

The encryption key is used to protect passwords and other sensitive data. Magento can autogenerate an encryption key, or you can use one from another source.

Magento Community Edition 2.1 User Guide 987

988 Magento Community Edition 2.1 User Guide

CHAPTER 75:

Data Transfer

The Import and Export tools give you the ability to manage multiple records in a single operation. You can not only import new items, but also update, replace, and delete existing sets of products. For example, you can add new products to your inventory, update product data and advanced price data, and replace a set of existing products with new products. If you have a large catalog of products, it’s much easier to export the data, edit the data in a spreadsheet, and import it back into your store.

Working with CSV Files

Import

Export

Product Attribute Reference

Customer Attribute Reference

Magento Community Edition 2.1 User Guide 989

Working with CSV Files CHAPTER 75: Data Transfer

Working with CSV Files

The comma-separated-value (CSV) file format is used as the basis of data transfer operations, and is supported by all spreadsheet and database applications. The following file types are supported for import and export:

Import

Export

CSV and ZIP (a compressed CSV file.)

CSV

Important! We recommend that you use a program that supports UTF-8 encoding, such as

Notepad++ or OpenOffice Calc , to edit CSV files. Microsoft Excel inserts additional characters into the column header of the CSV file, which can prevent the data from being imported back into

Magento. If you work on the Mac, you can save your data in the CSV (Windows) format.

CSV files have a specific structure that must match the database. Each column heading corresponds to the Attribute Code of the field that is represented by the column. To ensure that the column headings can be read by Magento, first export the data from your store as a CSV file. You can then edit the data and re-import it into Magento.

If you open an exported CSV file in a text editor, you will see that values are separated by commas, and multiple values are enclosed in double-quotes. During import, you can specify a custom separator character, although a comma is the default.

Product CSV Structure

A full export of the product database contains information about each product in the catalog, and the relationships between them. Each record has fixed selection of columns that corresponds to the attributes in the catalog, although the order of the attributes is ignored during the import process.

990

Exported Product CSV in OpenOffice Calc

Magento Community Edition 2.1 User Guide

CHAPTER 75: Data Transfer Working with CSV Files

The first row of the table contains the names of each attribute, which are used as column headers. The remaining rows describe the individual product records. Any row that begins with a value in the SKU column is the beginning of a new product record. A single product might include several rows that contain information about multiple images or product options. The next row that has a value in the SKU column begins a new product.

The category column contains a path for each category to which the product is assigned. The path includes the root category, followed by a forward slash (/) between each level. By default, the pipe “|” character is used to separate different category paths. For example:

Default Category/Gear|Default Category/Gear/Bags.

To import data, you need to include only the SKU and any columns with changes. Any blank columns are ignored during the import process. It is not possible to add attributes during the import process. You can include only existing attributes.

For a detailed description of each product attribute, see:

Product Attribute Reference .

Exported Product CSV in Notepad++

CSV Product Structure

COLUMN NAME

_<name>

DESCRIPTION

Column headers that begin with an underscore contain service entity properties or complex data. Service columns are not product attributes.

<attribute name> Column headers with an attribute code or field name identify the column of data. A column might represent a system attribute, or one that was created by the store administrator.

Magento Community Edition 2.1 User Guide 991

Working with CSV Files CHAPTER 75: Data Transfer

Customer CSV Structure

The customers CSV file contains customer information from the database, and has the following structure:

Exported Customer CSV in OpenOffice Calc

The first row of the table contains the names of the attribute columns (which are the same as attribute codes). There are two types of column names, as shown in the following table. Other rows contain attribute values, service data, and complex data. Each row with non-empty values in the “email” and “_website” columns starts the description of the subsequent customer. Each row can represent customer data with or without address data, or the address data only. In case a row contains only the address data, values in the columns, related to the customer profile, will be ignored and may be empty.

To add or replace more than one address for a customer, in the import file add a row for each new address with empty customer data and the new or updated address data below the customer data row.

For a detailed description of each customer attribute, see:

Customer Attribute Reference .

Exported Customer CSV in Notepad++

CSV Customer Structure

COLUMN NAME

_<name>

DESCRIPTION

Column headers that begin with an underscore contain service entity properties or complex data. Service columns are not customer attributes.

<attribute name> The names of the columns with values of both system-created attributes, and attributes created by the store administrator.

992 Magento Community Edition 2.1 User Guide

CHAPTER 75: Data Transfer Working with CSV Files

Data Validation

All data must pass validation before it can be imported into the store, to ensure that the values are consistent with the system database. Validation begins when you tap the Check Data button. During the process, all entities in the import file are verified for the following:

Attributes

Complex Data

Service Data

Required Values

Separators

Column header names are verified to ensure that they match the corresponding attributes in the system database. The value of each attribute is checked to ensure that it meets the requirements of the data type (decimal, integer, varchar, text, and datetime)

Values that originate from a defined set, such as a drop-down or multiple select input type, are verified to ensure that the values exist in the defined set.

The values in service data columns are verified to ensure that the properties or complex data values are consistent with what is already defined in the system database.

For new entities, the presence of required attribute values in the file is checked. For existing entities, there is no need to re-check the existence of required attribute values.

Although the separators aren’t visible when viewed in a spreadsheet, data values in a CSV file are separated by comma, and text values are enclosed in double-quotes. During the validation process, the separators are verified, and each set of quotes that enclose character strings is verified to be formatted correctly.

The results of the validation appear in the Validation Results section, and include the following information: l

The number of entities checked l

The number of invalid rows l

The number of errors found

If the data is valid, an “Import Success” message appears.

File is Valid!

Magento Community Edition 2.1 User Guide 993

Working with CSV Files CHAPTER 75: Data Transfer

If validation fails, read the description of each error, and correct the problem in the CSV file.

For example, if a row contains an invalid SKU, the import process stops, and that row, and all subsequent rows are not imported. After correctly the problem, import the data again. If many errors are encountered, it might take several attempts to pass validation.

Data Validation Messages

MESSAGES

DATA VALIDATION

Product with specified SKU not found in rows: 1 l

URL key for specified store already exists l

'7z' file extension is not supported l

'txt' file extension is not supported

ERRORS

Wrong field type. Type in the imported file %decimal%, expected type is %text%.

Value is not allowed. Attribute value does not exist in the system.

Field %column name% is required.

Wrong value separator is used.

Wrong encoding used. Supported character encoding is UTF-8 and Windows-1252.

Imported file does not contain SKU field.

SKU does not exist in the system.

Column name %column name% is invalid. Should start with a letter. Alphanumeric.

Imported file does not contain a header.

%website name% website does not exist in the system.

%storeview name% storeview does not exist in the system.

Imported attribute %attribute name% does not exist in the system.

Imported resource (image) could not be downloaded from external resource due to timeout or access permissions.

Imported resource (image) does not exist in the local media storage.

Product creation error displayed to the user equal to the one seen during manual product save.

Advanced Price creation error displayed to the user equal to the one seen during the manual product save.

Customer creation error displayed to the user equal to the one seen during the manual customer save.

994 Magento Community Edition 2.1 User Guide

CHAPTER 75: Data Transfer Import

Import

Data for all product types can be imported into the store. In addition, you can import customer data, customer address data, and product images. Import supports the following operations: l

Add/Update l

Replace Existing Complex Data l

Delete Entities

The size of the import file is determined by the settings in the php.ini file on the server. The system message on the Import page indicates the current size limit.

Process Overview:

Step 1: Prepare the Data

Step 2: Choose the Import Behavior

Step 3: Identify the Import File

Step 4: Check the Import Data

Import

Magento Community Edition 2.1 User Guide 995

Import CHAPTER 75: Data Transfer

Step 1:

Prepare the Data

On the Admin sidebar, tap System. Then under Data Transfer, choose Import.

Under Import Settings, set Entity Type to one of the following: l

Advanced Pricing l

Products l

Customers and Addresses l

Customers Main File l

Customer Addresses

Tap Download Sample File. Then on the download menu in the lower-left corner of your browser window, choose Open.

996

Download Sample File

The sample file includes column headings with placeholder data for example product types.

Downloaded Sample File

Magento Community Edition 2.1 User Guide

CHAPTER 75: Data Transfer Import

Examine the structure of the sample file. As you prepare your CSV import file, make sure that the column headings are spelled correctly.

Verify that the size of your import file does not exceed the limit shown in the message.

If the import data includes paths to product images, make sure that the image files have been uploaded to the appropriate location. The default location on the Magento server is: pub/media/import.

If the images reside on an external server, make sure that you have the full URL to the directory that contains the images.

Step 2:

Choose the Import Behavior

Set Import Behavior to one of the following: l

Add/Update l

Replace Existing Complex Data l

Delete Entities

Do the following:

Accept the default value of a comma (,) for the Field separator.

Accept the default value of a comma (,) for the Multiple value separator.

In a CSV file, a comma is the default separator. To use a different character, make sure that the data in the CSV file matches the character that you specify.

Import Behavior

Step 3:

Identify the Import File

Tap

Choose File

to select the file to import.

Find the CSV file that you prepared to import, and tap

Open

Magento Community Edition 2.1 User Guide 997

Import CHAPTER 75: Data Transfer

If the import data includes paths to product images, enter one of the following in the Images

File Directory

field: l

The path to the uploaded images on the Magento server. For example: var/import.

The full URL to the images on another server. For example: http://domain.com/images

To learn more about importing product images, see:

Importing Product Images

File to Import

Step 4:

Check the Import Data

In the upper-right corner, tap

Check Data

Then, wait a few moments for the validation process to complete. If the import data is valid, the following message appears:

998

File is Valid!

If the file is valid, tap

Import

. Otherwise, correct each problem with the data that is listed in the message, and try to import the file again.

The import process continues to the end of the data, unless an error is encountered.

If an error message appears in the Validation Results, correct the problem in the data, and import the file again. For a list of known errors, see: Import Troubleshooting .

URL Key Already Exists

A message appears when the import is complete.

Magento Community Edition 2.1 User Guide

CHAPTER 75: Data Transfer Import

Import Behavior

OPERATION

Add/Update

DESCRIPTION

New product data is added to the existing product data for the existing entries in the database. All fields except sku can be updated.

New tax classes that are specified in the import data are created automatically.

New product categories that are specified in the import file are created automatically.

New SKUs that are specified in the import file are created automatically

Replace Existing Complex

Data

The existing product data is replaced with new data.

Exercise caution when replacing data because the existing product data will be completely cleared and all references in the system will be lost.

Delete Entities

If a SKU in the import data matches the SKU of an existing entity, all fields, including the SKU are deleted, and a new record is created using the CSV data.

An error occurs if the CSV file references a SKU that does not exist in the database. You can Check Data to display error.

Any entities in the import data that already exist in the database are deleted from the database.

Delete ignores all columns in the import data, except for SKU. You can disregard all other attributes in the data.

An error occurs if the CSV file references a SKU that does not exist in the database. You can Check Data to display error.

Magento Community Edition 2.1 User Guide 999

Import CHAPTER 75: Data Transfer

Import History

Maintains a record of data that has been imported into your store, including the start date and time, user, execution time, and a link to the imported file.

To view the import history:

On the Admin sidebar, tap System.

Under Data Transfer, choose Import History.

Import History

1000 Magento Community Edition 2.1 User Guide

CHAPTER 75: Data Transfer Import

Importing Product Images

Multiple product images of each type can be imported into Magento, and associated with a specific product. The path and file name of each product image is entered in the CSV file, and the image files to be imported are uploaded to the corresponding path on the Magento server or external server.

Magento creates its own directory structure for product images that is organized alphabetically.

When you export product data with existing images to a CSV file, you can see the alphabetized path before the file name of each image. However, when you import new images, you don’t need to specify a path, because Magento manages the directory structure automatically. Just make sure to enter the relative path to the import directory before the file name of each image to be imported.

To upload images, you must have login credentials and correct permissions to access to the

Magento folder on the server. With the correct credentials, you can use any SFTP utility to upload the files from your desktop computer to the server.

Before you try to import a large amount of images, review the steps in the import method that you want to use, and run through the process with a few products. After you understand how it works, you’ll feel confident importing large quantities of images.

Important! We recommend that you use a program that supports UTF-8 encoding to edit CSV files, such as Notepad++ or OpenOffice Calc . Microsoft Excel inserts additional characters into the column header of the CSV file, which can prevent the data from being imported back into Magento.

Method 1:

Import Images from the Local Server

On the Magento server, upload the image files to the pub/media/import folder. This is the default folder for importing product images.

[magento installation folder]/pub/media/import

You can use a different folder on the Magento server, as long as the path to the folder is specified during the import process.

In the CSV data, enter the name of each image file to be imported on the correct row, by sku, and in the correct column according to image type (base_image, small_image, thumbnail_ image, or additional_images).

For images in the default import folder(/pub/media/import), do not include the path before the filename in the CSV data.

The CSV file must include only the sku column and the related image columns.

Magento Community Edition 2.1 User Guide 1001

Import CHAPTER 75: Data Transfer

CSV Import Image from Default Location

Follow the instructions to

import

the data.

After selecting the file to import, enter the relative path following Images File Directory:

/pub/media/import

Images File Directory

If importing multiple images for a single sku, insert a blank row below the sku, and enter the additional image file names in the appropriate columns. The additional rows are understood to belong to the parent sku.

Method 2:

Import Images from External Server

Upload the images to be imported to the designated folder on the external server.

In the CSV data, enter the full URL for each image file in the correct column by image type

(base_image, small_image, thumbnail_image, or additional_images).

http://example.com/images/image.jpg

Follow the instructions to

import

the data.

1002 Magento Community Edition 2.1 User Guide

CHAPTER 75: Data Transfer Import

Import Guidelines

New Entities

Entities are added with the attribute values specified in the CSV file.

If there is no value, or there is a non-valid value, for a required attribute with no default value set, then the entity (the corresponding row or rows) cannot be imported.

If there is no value, or there is a non-valid value, for a required attribute with the default value set, then the entity (the corresponding row or rows) is imported, and the default value is set for the attribute.

If the complex data is not valid, then the entity (the corresponding row or rows) cannot be imported.

Existing Entities

For attributes that are not complex data, the values from the import file, including the empty values for the non-required attributes, replace the existing values.

If there is no value, or there is a non-valid value, for a required attribute, then the existing value is not replaced.

If the complex data for the entity is invalid, the entity (the corresponding row or rows) cannot be imported, except the case, when Delete Entities was selected in the Import

Behavior drop-down menu.

Magento Community Edition 2.1 User Guide 1003

Import CHAPTER 75: Data Transfer

Complex Data

If an attribute that is specified in the import file already exists, and its value is derived from a defined set of values, the following applies:

If the value is not already included in the defined set of values, the row can be imported and a default value, if defined, is set for the attribute.

If the value is already included in the defined set, the corresponding row cannot be imported.

If an attribute name is specified in the import file but is not yet defined in the system, it is not created, and its values are not imported.

Invalid Files

A file cannot be imported if all rows are invalid.

A non-existing service data or complex data name is specified in the import file, such as a column with a _<non-existing name> heading.

1004 Magento Community Edition 2.1 User Guide

CHAPTER 75: Data Transfer Export

Export

The best way to become familiar with the structure of your database is to export the data and open it in a spreadsheet. Once you become familiar with the process, you’ll find that it is an efficient way to manage large amounts of information.

To export data:

On the Admin sidebar, tap System. Then under Data Transfer, choose Export.

In the Export Settings section, specify the following:

Set Entity Type to one of the following: l

Products l

Customers Main File l

Customer Addresses

Accept the default Export File Format of “CSV.”

Export Settings

The Entity Attributes section lists all the available attributes in alphabetical order. You can use the standard

list controls

to search for specific attributes, and to sort the list. The Search and

Reset Filter controls control the display of the list, but have no effect on the selection of attributes to be included in the export file.

Filtered Entity Attributes

Magento Community Edition 2.1 User Guide 1005

Export CHAPTER 75: Data Transfer

To filter the exported data based on attribute value, do the following: l

To export only records with specific attribute values, enter the required value in the Filter column. The followng example exports only a specific SKU.

Export Product Based on SKU

To omit an attribute from the export, mark the Exclude checkbox at the beginning of the row. For example, to export only the sku and image columns, select the checkbox of every other attribute. The column appears in the export file, but without any values.

Exclude Attributes

Scroll down and tap

Continue

in the lower-right corner of the page.

Look for the download prompt in the lower-right corner of your browser. The exported CSV file can be saved or opened in a spreadsheet. You can edit the data and import it back into your store.

1006 Magento Community Edition 2.1 User Guide

CHAPTER 75: Data Transfer Export

Export Criteria

Export filters are used to specify the data that you want to in the export file, based on attribute value. In addition, you can specify which attribute data you want to include or exclude from the export.

Export Criteria

Magento Community Edition 2.1 User Guide 1007

Export CHAPTER 75: Data Transfer

Export Filters

You can use filters to determine which SKUs are included in the export file. For example, if you enter a value in the Country of Manufacture filter, the exported CSV file will incude only products manufactured in that country.

The type of filter corresponds to the data type. For date fields, you can choose the date from the

Calendar . To learn more, see:

Attribute Input Types

. The format of the date is determined by the

locale

To inlcude only records with a specific value, such as a sku, type the value into the Filter field.

Some fields such as Price, Weight, and Set Product as New have a from/to range of values.

Exclude Attributes

The checkbox in the first column is used to exclude attributes from the export file. If an attribute is excluded, the associated column in the export data is included, but empty.

Export Criteria

EXCLUDE FILTER

RESULT

The exported file contains each attribute for all existing records.

Yes

The export file contains each attribute with only the records allowed by the filter.

The export file does not include the column for the excluded attribute, but does include all existing records.

The export file does not include the column for the excluded attribute, and contains only the records allowed by the filter.

1008 Magento Community Edition 2.1 User Guide

CHAPTER 75: Data Transfer Product Attribute Reference

Product Attribute Reference

The following table lists the attributes from a typical product export, in the default order in which they appear. Each attribute is represented in the CSV file as a column, and product records are represented by rows. Columns that begin with an underscore contain service data such as properties or option values for complex data.

The installation used to export this data has the sample data installed, and has two websites and several store views. Although this list includes all columns that are typically exported, the sku is the only required value. To import data, you can include only the columns with changes.

The sku should be the first column, but the order of the rest of the attributes doesn’t matter.

Simple Product CSV File Structure

ATTRIBUTE

sku

DESCRIPTION

(Required) The Stock-Keeping Unit is a unique, alphanumeric identifier that is used to track inventory. A

SKU can be up to 64 characters in length. For example: sku123

A SKU longer than 64 characters will cause import to fail.

store_view_code attribute_set_code product_type

Identifies the specific store view(s) where the product is available. If blank, the product is available at the default store view. For example: storeview1,english,spanish

Assigns the product to a specific attribute set or product template, according to product type. Once the product is created, the attribute set cannot be changed. For example: default

Indicates the type of product.Values: simple Tangible items that are generally sold as single units or in fixed quantities.

grouped A group of separate products that is sold as a set.

Magento Community Edition 2.1 User Guide 1009

Product Attribute Reference CHAPTER 75: Data Transfer

Simple Product CSV File Structure (cont.)

ATTRIBUTE DESCRIPTION

configurable categories product_websites name description virtual bundle

A product with multiple options that the customer must select before making a purchase.

Inventory can be managed for each set of variations because they represent a separate product with a distinct SKU. For example, a combination of color and size for a configurable product is associated with a specific SKU in the catalog.

A non-tangible product that does not require shipping and is not kept in inventory. Examples include services, memberships, and subscriptions.

A customizable product set of simple products that are sold together.

Indicates each category that is assigned to the product.

Separate categories and subcategories with a forward slash. To indicate multiple category paths, separate each path with a pipe “|” symbol. For example:

Default Category/Gear|Default Category/Gear/Bags

The

website code

of each website where the product is available. A single product can be assigned to multiple websites, or limited to one. If specifying multiple websites, separate each with a comma and without a space. For example: base base,website2

The product name appears in all product listings, and is the name that customers use to identify the product.

The product description provides detailed information about the product, and might include simple HTML tags.

1010 Magento Community Edition 2.1 User Guide

CHAPTER 75: Data Transfer Product Attribute Reference

Simple Product CSV File Structure (cont.)

ATTRIBUTE

short_description

DESCRIPTION

The use of the short product description depends on the theme. It might appear in product listings and is sometimes used in RSS feed listings sent to shopping sites.

weight product_online

The weight of the individual product. The actual product weight is determined by the carrier at the time of shipment.

Determines if the product is available for sale in the store. Values:

1 (Yes) The product is enabled, and available for sale.

2 (No) The product is disabled, and is not available for sale.

tax_class_name visibility

The name of the tax class that is associated with this product.

Determines if the product is visible in the catalog, and made available for search. Values:

Not Visible

Individually

The product is not included in product listings, although it might be available as a variation of another product.

Catalog The product appears in all catalog listings.

Catalog, Search

The product is available for search operations.

The product is included in catalog listings and is also available for search.

price special_price special_price_from_date

The price that the product is offered for sale in your store.

The discounted price of the product during the specified date range.

The beginning date of the time period when the special price is in effect.

Magento Community Edition 2.1 User Guide 1011

Product Attribute Reference CHAPTER 75: Data Transfer

Simple Product CSV File Structure (cont.)

ATTRIBUTE

special_price_to_date

DESCRIPTION

The last date of the time period when the special price is in effect.

url_key meta_title meta_keywords meta_description base_image base_image_label small_image small_image_label thumbnail_image

The part of the URL that identifies the product. The default value is based on the product name. For example: product-name

The meta title appears in the title bar and tab of the browser and search results lists. The meta title should be unique to the product, incorporate high-value keywords, and be less than 70 characters in length.

Meta keywords are visible only to search engines, and are ignored by some search engines. Choose high-value keywords, separated by a comma. For example: keyword1,keyword2,keyword3.

Meta descriptions provide a brief overview of the product for search results listings. Ideally, a meta description should be between 150-160 characters in length, although the field accepts up to 255 characters.

The relative path for the main image on the product page.

Magento stores files internally in an alphabetical folder structure.You can see the exact location of each image in the exported data. For example:

/sample_data/m/b/mb01-blue-0.jpg

To upload a new image or write over an existing image, enter the file name, preceded by a forward slash. For example: /image.jpg

The label that is associated with the base image.

The file name of the small image that is used on catalog pages, preceded by a forward slash. For example:

/image.jpg

The label associated with the small image. For example:

Small Image 1, Small Image 2

The file names of any thumbnail image to appear in the gallery on the product page, preceded by a forward slash.

For example:

/image.jpg

1012 Magento Community Edition 2.1 User Guide

CHAPTER 75: Data Transfer Product Attribute Reference

Simple Product CSV File Structure (cont.)

ATTRIBUTE

thumbnail_image_label

DESCRIPTION

The label associated with any thumbnail images. For example:

Thumbnail 1, Thumbnail 2 created_at updated_at new_from_date new_to_date display_product_options_in map_price msrp_price map_enabled

Indicates the date when the product was created. The date is automatically generated when the product is created, but can be edited later.

Indicates the date when the product was last updated.

Specifies the “from” date for new product listings, and determines if the product is featured as a new product.

Specifies the “to” date for new product listings, and determines if the product is featured as a new product.

If the product has multiple options, determines where they appear on the product page. Values:

Product Info Column

Block after Info Column

The minimum advertised price of the product. (Appears only if MAP is enabled.)

The manufacturer’s suggested retail price for the product.

(Appears only if MAP is enabled.)

Determines if Minimum Advertised Price is enabled in the configuration. Values:

1 (Yes) MAP is enabled.

0 (or blank) (No) MAP is not enabled.

gift_message_available custom_design

Determines if a gift message can be included with the product purchase. Values:

1 (Yes) The option to include a gift message is presented to the customer.

0 (or blank) (No) The option to include a gift message is not presented to the customer.

Lists the available themes that can be applied to the product page.

Magento Community Edition 2.1 User Guide 1013

Product Attribute Reference CHAPTER 75: Data Transfer

Simple Product CSV File Structure (cont.)

ATTRIBUTE

custom_design_from

DESCRIPTION

Specifies the beginning date when the selected theme is applied to the product page.

custom_design_to custom_layout_update page_layout

Specifies the end date when the selected theme is applied to the product page.

Additional XML code that is applied as a layout update to the product page.

Determines the page layout of the product page. Values:

No layout updates No change is made to the page layout.

1 column

2 columns with left bar

Applies a one- column layout to the product page.

Applies a two-column layout with a left sidebar to the product page.

2 columns with right bar

3 columns empty

Applies a two-column layout with a right sidebar to the product page.

Applies a three-column layout to the product page.

Applies a blank layout to the product page.

product_options_container msrp_display_actual_price_type

If the product has multiple options, determines where they appear on the product page. Values:

Product Info Column

Block after Info Column

Determines where the actual price of a product is visible to the customer.Values:

In Cart Displays the actual product price in the shopping cart.

Before Order

Confirmation

Displays the actual product price at the end of the checkout process, just before the order is confirmed.

1014 Magento Community Edition 2.1 User Guide

CHAPTER 75: Data Transfer Product Attribute Reference

Simple Product CSV File Structure (cont.)

ATTRIBUTE DESCRIPTION

On Gesture country_of_manufacture additional_attributes qty out_of_stock_qty use_config_min_qty

Displays the actual product price in a popup when the customer clicks the “Click for price” or

“What’s this?” link.

Identifies the country where the product was manufactured.

Additional attributes created for the product. For example: has_options=0,required_options=0 color=Black,has_options=0,required_options=0,size_ general=XS

The quantity of the product that is currently in stock.

The stock level that determines the product to be out of stock.

Determines if the default value from the configuration is used, and corresponds to the Use Config Settings checkbox. Values:

1 (Yes) The default configuration setting is used for the value of this attribute.

0 (or blank) (No) The default configuration can be overridden for the value of this attribute.

is_qty_decimal allow_backorders use_config_backorders

Determines if the qty attribute has a decimal value.

Values:

1 (Yes) The value of the qty attribute is a decimal value.

0 (or blank) (No) The value of the qty attribute is a whole number (integer).

Determines if your store allows backorders, and how they are managed.

Determines if the default configuration setting for backorders is used, and corresponds to the state of the

Use Config Settings checkbox. Values:

Magento Community Edition 2.1 User Guide 1015

Product Attribute Reference CHAPTER 75: Data Transfer

Simple Product CSV File Structure (cont.)

ATTRIBUTE DESCRIPTION

1 (Yes) The default configuration setting is used for the value of this attribute.

0 (or blank) (No) The default configuration can be overridden for the value of this attribute.

min_cart_qty use_config_min_sale_qty max_cart_qty use_config_max_sale_qty is_in_stock notify_on_stock_below use_config_notify_stock_qty

Specifies the minimum quantity of the item that can be purchased in a single order.

Determines if the default configuration setting for minimum quantity is used, and corresponds to the state of the Use Config Settings checkbox.. Values:

1 (Yes) The default configuration setting is used for the value of this attribute.

0 (or blank) (No) The default configuration can be overridden for the value of this attribute.

Specifies the maxinum quantity of the product that can be purchased in a single order.

Determines if the default configuration setting for maximum quantity is used, and corresponds to the state of the Use Config Settings checkbox.. Values:

1 (Yes) The default configuration setting is used for the value of this attribute.

0 (or blank) (No) The default configuration can be overridden for the value of this attribute.

Indicates if the product is in stock.

Specifies the stock level that triggers an “out of stock” notification.

Determines if the default configuration setting is used to trigger stock level notification, and corresponds to the state of the Use Config Settings checkbox. Values:

1 (Yes) The default configuration setting is used for the value of this attribute.

0 (or blank) (No) The default configuration can be overridden for the value of this attribute.

1016 Magento Community Edition 2.1 User Guide

CHAPTER 75: Data Transfer Product Attribute Reference

Simple Product CSV File Structure (cont.)

ATTRIBUTE

manage_stock

DESCRIPTION

Determines if inventory control is used to manage the product. Values:

1 (Yes) Activates full inventory control to manage stock levels of the product.

0 (or blank) (No) The system does not keep track of the number of items that are currently in stock.

use_config_manage_stock Determines if the default configuration setting for managing stock is used, and corresponds to the state of the Use Config Settings checkbox. Values:

1 (Yes) The default configuration setting is used for the value of this attribute.

0 (or blank) (No) The default configuration can be overridden for the value of this attribute.

use_config_qty_increments qty_increments use_config_enable_qty_inc enable_qty_increments

Determines if the default configuration setting for quantity increments is used, and corresponds to the state of the Use Config Settings checkbox.. Values:

1 (Yes) The default configuration setting is used for the value of this attribute.

0 (or blank) (No) The default configuration can be overridden for the value of this attribute.

Determines if the product is sold in quantity increments.

Options: Yes / No

Determines if the default configuration setting to enable quantity increments is used, and corresponds to the state of the Use Config Settings checkbox. Values:

1 (Yes) The default configuration setting is used for the value of this attribute.

0 (or blank) (No) The default configuration can be overridden for the value of this attribute.

Determines if quantity increments are enabled for the product.

Magento Community Edition 2.1 User Guide 1017

Product Attribute Reference CHAPTER 75: Data Transfer

Simple Product CSV File Structure (cont.)

ATTRIBUTE

is_decimal_divided

DESCRIPTION

Determines if parts of the product can be shipped separately. Options: Yes / No website_id related_skus crosssell_skus upsell_skus additional_images additional_image_labels custom_options

For installations with multiple websites, identifies a specific website where the product is available. If blank, the product is available in all websites.

Lists the sku of each product that has been identified as a

Simple Product CSV File Structure (cont.)

ATTRIBUTE DESCRIPTION

Configurable Products

_super_attribute_option

_super_attribute_price_corr

_associated_sku

_associated_default_qty

_associated_position

The value of a configurable product variation. For example: green

Applies to:

Configurable Products

A price adjustment that is associated with a configurable product variation.

Applies to:

Configurable Products

The SKU of a product that is associated with a grouped product.

Applies to:

Grouped Products

Bundle Products

Determines the quantity of the associated product that is included. Applies to:

Configurable Products

Grouped Products

Bundle Products

Determines the position of the associated product when listed with other associated products. Applies to:

Configurable Products

Grouped Products

Bundle Products

Magento Community Edition 2.1 User Guide 1019

Product Attribute Reference CHAPTER 75: Data Transfer

Complex Data

The term complex data

1 refers to the data that is associated with multiple product options.

The following product types use data that originates from separate products to create product variations and multiple options.

Configurable

Grouped

Bundle

If you were to export a configurable product, you would find the standard attributes that make up a simple product, plus the additional attributes that are needed to manage complex data.

1020

Exported Configurable Product Data

Complex Data Attributes

ATTRIBUT

E DESCRIPTION

CONFIGURABLE PRODUCTS

configurabl e_ variation_ labels

Labels that identify product variations. For example:

Choose Color:

Choose Size: configurabl e_ variations

Describes the values associated with a product variation. For example: sku=sku-red xs,color=red,size=xs,price=10.99,display=1,image=/pub/media/import/image1.pn

g|sku=sku-redm,color=red,size=m,price=20.88,display=1,image=/pub/media/import/image2.pn

1Data that is associated with multiple product options.

Magento Community Edition 2.1 User Guide

CHAPTER 75: Data Transfer Product Attribute Reference

Complex Data Attributes (cont.)

ATTRIBUT

E DESCRIPTION

GROUPED PRODUCTS

associated_ skus

Identifies the SKUs of the individual products that make up the group.

BUNDLE PRODUCTS

bundle_ price_type

Determines if the price of a bundle item is fixed or dynamic.

bundle_sku_ type

Determines if each item is assigned a variable, dynamic SKU, or if a fixed SKU is used for the bundle. Options include: Fixed / Dynamic.

bundle_ weight_type

Determines if the weight of a bundle item is variable or fixed.

bundle_ values

Describes teach value associated with a bundle option. For example: name=Bundle Option One,type=dropdown; required=1, sku=skuoption2,price=10, price_type=fixed

Magento Community Edition 2.1 User Guide 1021

Product Attribute Reference CHAPTER 75: Data Transfer

Advanced Pricing

Advanced Price Import/Export allows you to quickly update pricing information for product groups and tier prices. The process to

import

and

export

advanced price data is the same as any other entity type. The sample CSV file contains tier and group prices for each product type that supports advanced pricing. Making changes to advanced pricing does not affect the rest of the product record.

1022

Advanced Price Sample File

Advanced Pricing Attributes

ATTRIBUTE

sku

DESCRIPTION

(Required) The Stock-Keeping Unit is a unique, alphanumeric identifier that is used to track inventory. A SKU can be up to 64 characters in length. For example: sku123

A SKU longer than 64 characters will cause import to fail.

tier_price_website tier_price_customer_ group tier_price_qty tier_price group_price_website

The

website code

identifies each website where tier pricing is available. For example: website1

All Websites [USD]

Identifies the

customers groups

where tier pricing is available. For example:

ALL GROUPS

NOT LOGGED IN

General

Wholesale

Retailer

The quantity of the product that must be ordered to receive the tier price discount.

The discounted tier price of the product. For

bundle

products, tier price is calculated as a percentage.

The

website code

of each website where group pricing is available. If specifying multiple websites, separate each with a comma and without a space. For example: website1

Magento Community Edition 2.1 User Guide

CHAPTER 75: Data Transfer Product Attribute Reference

Advanced Pricing Attributes (cont.)

ATTRIBUTE DESCRIPTION

All Websites [USD] group_price_customer_ group

Identifies the

customers groups

where group pricing is available. For example:

NOT LOGGED IN

General

Wholesale

Retailer group_price The discounted group price of the product. For

bundle

products, group price is calculated as a percentage.

Magento Community Edition 2.1 User Guide 1023

Customer Attribute Reference CHAPTER 75: Data Transfer

Customer Attribute Reference

The following tables list the attributes from a typical export of the Customers Main File and

Customer Addresses. The installation that was used to export this data has two websites and several store views, with the sample data installed.

Each attribute, or field, is represented in the CSV file as a column, and customer records are represented by rows. Columns that begin with an underscore are service entities that contain properties or complex data.

Customers Main File

ATTRIBUTE

DESCRIPTION

_website

_store confirmation created_at created_in disable_auto_group_change dob firstname gender group_id lastname middlename password_hash prefix rp_token rp_token_created_at store_id suffix

1024 Magento Community Edition 2.1 User Guide

CHAPTER 75: Data Transfer

Customers Main File (cont.)

ATTRIBUTE

taxvat

DESCRIPTION

website_id password

Customer Addresses

ATTRIBUTE

_website

_email

_entity_id city company country_id fax firstname lastname middlename postcode prefix region region_id street suffix telephone vat_id vat_is_valid vat_request_date vat_request_id vat_request_success

DESCRIPTION

Magento Community Edition 2.1 User Guide

Customer Attribute Reference

1025

Customer Attribute Reference CHAPTER 75: Data Transfer

Customer Addresses (cont.)

ATTRIBUTE DESCRIPTION

_address_default_ billing_

Identifies the default billing address. A value of 1 indicates that the address is the default billing address of the customer. Values: 1 / 0

_address_default_ shipping_

Identifies the default shipping address. A value of 1 indicates that the address is the default shipping address of the customer. Values: 1 / 0

1026 Magento Community Edition 2.1 User Guide

CHAPTER 76:

Integrations

Establishes the location of OAuth credentials and redirect URL for third-party integrations, and identifies the available API resources that are needed for the integration.

Integrations

Magento Community Edition 2.1 User Guide 1027

Onboarding Workflow CHAPTER 76: Integrations

Onboarding Workflow

Authorize the integration. Go to the system/integration screen, find the relevant integration, and authorize.

Verify and establish login. When prompted, accept the access requested. If redirected to a third-party, log in to the system, or create a new account. After a successful login, you return to the integration page.

Receive confirmation of authorized integration. The system sends notification that the integration has been authorized successfully. After setting up an integration and receiving the credentials, it is no longer necessary to make calls to access or request tokens.

1028 Magento Community Edition 2.1 User Guide

CHAPTER 76: Integrations Onboarding Workflow

To add a new integration:

On the Admin sidebar, tap System. Then under Extensions, choose Integrations.

Enter the following Integration Info:

Enter the Name of the integration, and the contact Email address.

Enter the Callback URL where OAuth credentials can be sent when using OAuth for token exchange. We strongly recommend using https://.

Enter the Identity Link URL to redirect the users to a third-party account with these

Magento integration credentials.

New Integration

In the panel on the left, choose API. Then, do the following:

Set Resource Access to one of the following: l

All l

Custom

For custom access, mark the checkbox of each resource that is needed:

Magento Community Edition 2.1 User Guide 1029

Onboarding Workflow CHAPTER 76: Integrations

When complete, tap

Save

Resources Needed for Custom Access

1030 Magento Community Edition 2.1 User Guide

CHAPTER 76: Integrations Onboarding Workflow

To change the API guest access security setting:

By default, the system does not permit anonymous guest access to CMS, catalog, and other store resources. If you need to change the setting, do the following:

On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

In the panel on the left under Services, choose Magento Web API.

Expand the Web API Security Setting section.

Web API Security

Set Allow Anonymous Guest Access to “Yes,”

When complete, tap

Save Config

To learn more, see: “ Restricting access to anonymous web APIs ” in the Magento developer documentation.

Magento Community Edition 2.1 User Guide 1031

Magento Marketplace CHAPTER 76: Integrations

Magento Marketplace

Magento Marketplace is our next generation application store that offers merchants a curated selection of solutions, and provides qualified developers the tools, platform, and prime location to build a thriving business. To learn more, see the Magento Marketplace User Guide .For

extension installation instructions, see

Component Manager

in this guide, or the Marketplace

Quick Tour .

Magento Marketplace

1032 Magento Community Edition 2.1 User Guide

CHAPTER 76: Integrations Magento Connect

Magento Connect

Magento Connect is Magento’s original marketplace for Magento extensions. There are hundreds of extensions and themes available from all over the world. Magento out-of-the-box supports a few of the most popular ones. However, community members are developing and publishing new extensions in order to extend Magento with various new features.

Magento Connect

Magento Community Edition 2.1 User Guide 1033

1034 Magento Community Edition 2.1 User Guide

CHAPTER 77:

Permissions

Magento uses roles and permissions to create different levels of access to the Admin. When your store is first set up, you receive a set of login credentials for the Administrator role that has full permissions. However, you can restrict the level of permissions on a “need to know” basis for other people who work on your site. For example, a designer can be given access to only the Design tools, but not to areas with customer and order information.

In addition, you can further restrict Admin access to only a specific site, or set of sites and their associated data. If you have multiple brands or business units with separate stores on the same Magento installation, you can provide Admin access to each of your business units but hide and protect their data from other Admin users.

If an Admin user’s access is restricted to specific websites and/or stores, the websites and stores for which they are not authorized will either not be visible to them, or grayed-out as inactive. Only the sales and other data for permitted websites and stores is shown.

All Users

Magento Community Edition 2.1 User Guide 1035

Adding Users CHAPTER 77: Permissions

Adding Users

When your store is first installed, your login credentials give you full administrative access. As a best practice, one of the first things you should do is to create another user account with full

Administrator permissions. That way, you can use one account for your everyday

Administrative activities, and reserve the other as a “Super Admin” account in case you forget your regular credentials or they somehow become unusable.

If there are others on your team, or service providers who need access, you can create a separate user account for each, and assign restricted access. To limit the websites or stores that admin users can access when they log in, you must first create a role with limited scope and access to resources. Then, you can assign the role to a specific user account. Admin users who are assigned to a restricted role can see and change data only for websites or stores that are associated with the role. They cannot make changes to any global settings or data.

Step 1:

Create a New User

On the Admin sidebar tap System. Then under Permissions, choose All Users.

In the upper-right corner, tap

Add New User

In the Account Information section, do the following:

1036

New User Account Information

Magento Community Edition 2.1 User Guide

CHAPTER 77: Permissions Adding Users

Enter the User Name for account.

The User Name should be easy to remember. It is not case-sensitive. For example, if your user name is “John,” you can also log in as “john.”

Complete the following information: l

First Name l

Last Name l

Email address

This email address must be different from the one that is associated with your original

Admin account.

Assign a Password to the account.

An Admin password must be seven or more characters long, and include both letters and numbers.

In the Password Confirmation box, repeat the password to make sure it was entered correctly.

If your store has multiple languages, set Interface Locale to the language to be used for the Admin interface.

Set This Account is to “Active.”

Under Current User Identity Verification, enter Your Password.

Current User Identity Verification

Magento Community Edition 2.1 User Guide 1037

Adding Users CHAPTER 77: Permissions

Step 2:

Define the Role

In the panel on the left, choose User Role. The grid lists all the existing roles. For a new store,

Administrators is the only role available.

In the Assigned column, select the

Administrators

option.

Tap

Save User

You now have two accounts with Administrator access.

Add New User Role

Admin Password Requirements

FIELD

Password

DESCRIPTION

An Admin password must be seven or more characters long, and include both letters and numbers. For additional password options, see:

Configuring Admin Security

1038 Magento Community Edition 2.1 User Guide

CHAPTER 77: Permissions Locked Users

Locked Users

For the security of your business, user accounts are locked by default after six failed attempts to

to the Admin. Any user account that is currently locked appears in the Locked Users grid. An account can be unlocked by any other user with full Administrator permissions.

Additional password security measures can be implemented in the Advanced Admin configuration. To learn more, see:

Configuring Admin Security .

Admin Account Disabled

To unlock an admin account:

On the Admin sidebar, tap System. Then under Permissions, choose Locked Users.

In the grid, mark the checkbox of the locked account.

Locked Users

In the upper-left corner, set the Actions control to “Unlock.”

Tap

Submit

to unlock the account.

Magento Community Edition 2.1 User Guide 1039

User Roles CHAPTER 77: Permissions

User Roles

To give someone restricted access to the Admin, the first step is to create a role that has the appropriate level of permissions. After the role is saved, you can add new users and assign the restricted role to grant them limited access to the Admin.

Roles

1040 Magento Community Edition 2.1 User Guide

CHAPTER 77: Permissions User Roles

Step 1:

Define the Role

On the Admin sidebar, tap System. Then under Permissions, choose User Roles.

In the upper-right corner, tap

Add New Role

Under Role Information, enter a descriptive Role Name. Then under Current User Identity

Verification, enter Your Password.

Role Name

Step 2:

Assign Resources

Important! When assigning resources, be sure to disable access to the Permissions tool if you are limiting access for a given role. Otherwise, users will be able to modify their own permissions.

Under Roles Resources, set Resource Access to "Custom."

In the tree, mark the checkbox of each Admin Resource that the role can access.

When complete, tap

Save Role

Magento Community Edition 2.1 User Guide

Role Resources Assigned

1041

User Roles CHAPTER 77: Permissions

The role now appears in the grid, and can be assigned to new user accounts.

To edit a role:

In the Roles grid, and tap the row to open the record in edit mode.

Under Current User Identity Verification, enter Your Password.

1042

Editing a Role

In the panel on the left, choose Role Users.

The Role Users option appears only after a new role is saved.

To search for a specific user record, do the following:

Enter the value in the search filter at the top of a column. Then, press Enter.

When you are ready to return to the full list, click Reset Filter.

Mark the checkbox of any user(s) to be assigned to the role.

Tap

Save Role

Role Users

Magento Community Edition 2.1 User Guide

CHAPTER 77: Permissions Alternate Media Storage

Alternate Media Storage

Magento Community Edition 2.1 gives you the option to store media files in a database on a database server, or on a Content Delivery Network (CDN), as opposed to storing them on the file system of the web server. The advantage of using alternate storage is that it minimizes the effort required to synchronize media when multiple instances of the system that are deployed on different servers that need access to the same images, CSS files, and other media files.

Database

Content Delivery Network

(CDN)

Magento Community Edition 2.1 User Guide 1043

Alternate Media Storage CHAPTER 77: Permissions

Using a Database

By default, all images, compiled CSS files, and compiled JavaScript files of the Magento instance are stored in the file system on the web server. You can choose to store these files in a database on a database server. One advantage of this approach is the option of automatic synchronization and reverse synchronization between the web server file system and the database. You can use the default database to store media or create a new one. To be able to use a newly created database as media storage, you must add information about it and its access credentials to the local.xml file.

Database Workflow

Browser requests media. A page from the store opens in the customer’s browser, and the browser requests the media that is specified in the HTML.

System looks for media in file system. The system searches for the media in the file system and if found, passes it to the browser.

System locates media in database. If the media is not found in the file system, a request for the media is sent to the database that is specified in the configuration.

System locates media in database. A PHP script transfers the files from the database to the file system, and sent to the customer’s browser. The browser request for media triggers the script to run as follows: l

If web server

rewrites

are enabled for Magento and supported by the server, the PHP script runs only when the requested media is not found in the file system.

If web server rewrites are disabled for Magento, or not supported by the server, the

PHP script runs anyway, even if the required media is available in the file system.

1044 Magento Community Edition 2.1 User Guide

CHAPTER 77: Permissions Alternate Media Storage

To use a database for media storage:

On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

In the panel on the left, under Advanced, choose System.

In the upper-left corner set Store View to “Default Config,” to apply the configuration at the global level.

Expand the Storage Configuration for Media section. Then, do the following:

Storage Configuration for Media (Database)

Set Media Storage to “Database.”

Set Select Media Database to the database you want to use.

Tap

Synchronize

to transfer the existing media to the newly selected database.

Enter the Environment Update Time in seconds.

When complete, tap

Save Config

Magento Community Edition 2.1 User Guide 1045

Alternate Media Storage CHAPTER 77: Permissions

Using a Content Delivery Network

Storing media files in a CDN is another alternative supported in Magento. There is no full integration with a specific CDN, and you are responsible for choosing and configuring a CDN on your own.

After configuring the CDN, you must complete the configuration from the Admin. The changes can be made at either the global or website level. When a CDN is used for media storage, all paths to media on store pages are changed to the CDN paths that are specified in the configuration.

CDN Workflow

Browser requests media. A page from the store opens in the customer’s browser, and the browser requests the media that is specified in the HTML.

Request sent to CDN; images found and served. The request is sent first to the

CDN. If the CDN has the images in storage, it serves the media files to the customer's browser.

Media not found, request sent to Magento web server. If the CDN doesn’t have the media files, the request is sent to the Magento web server. If the media files are found in the file system, the web server sends them to the customer’s browser.

Important! For security, when a CDN is used as media storage, JavaScript may not function properly if the CDN is located outside of your subdomain.

1046 Magento Community Edition 2.1 User Guide

CHAPTER 77: Permissions Alternate Media Storage

To configure a content delivery network:

On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

In the panel on the left under General, choose Web.

In the upper-left corner, set Store View as needed.

Expand the Base URLs section. Then, do the following:

Base URLs

Update the Base URL for Static View Files with the URL of the location on the CDN where static view files are stored.

Update the Base URL for User Media Files with the URL of the JavaScript files on the

CDN.

Both these fields can be left blank, or can start with the placeholder: {{unsecure_base_ url}}

Expand the Base URLs (Secure) section.

Magento Community Edition 2.1 User Guide

Base URLs (Secure)

1047

Alternate Media Storage CHAPTER 77: Permissions

Update the Secure Base URL for Static View Files with the URL of the location on the

CDN where static view files are stored.

Update the Secure Base URL for User Media Files with the URL of the JavaScript files on the CDN.

Both these fields can be left blank, or can start with the placeholder: {{unsecure_base_ url}}

When complete,tap

Save Config

1048 Magento Community Edition 2.1 User Guide

CHAPTER 78:

Security

In this section of the guide, you will learn security best practices, how to manage Admin sessions and credentials, implement CAPTCHA, and manage website restrictions.

Security Best Practices

Configuring Admin Security

CAPTCHA

Encryption Key

Browser Capabilities Detection

Action Log

Stop by the Security Center and sign up for the Security Alert Registry to receive the latest information on potential vulnerabilities and best practices.

Security Center

Magento Community Edition 2.1 User Guide 1049

Security Best Practices CHAPTER 78: Security

Security Best Practices

All eCommerce sites are attractive targets to hackers because of the personal and payment information that is required to complete a sale. Even if the system does not directly process credit card transactions, a compromised site might reroute customers to a false page, or alter an order before it is transmitted to the payment processor.

A compromised site can have long-term consequences for both customers and merchants.

Customers might suffer financial loss and identify theft, while merchants can face damage to their reputations, loss of merchandise, higher processing fees, revoked privileges with financial institutions, and the threat of lawsuits.

This guide outlines a multifaceted approach to improve the security of your Magento installation. Although there is no single way to eliminate all security risks, there are many things that you can do to make your site a less attractive target. It is crucial for hosting providers, system integrators, and merchants to work together to establish and maintain a secure environment, implement methods for early detection, and determine a plan of action in the event of a breach.

Start Right

Work with reliable hosting providers and solution integrators. When evaluating their qualifications, ask about their approach to security. Verify that they have a secure software development life cycle in accord with industry standards such as The Open Web Application

Security Project ( OWASP ), and that they test their code for security issues.

If you are starting a new site, consider launching the entire site over HTTPs. Taking the lead on this issue, Google now uses HTTPs as a ranking factor.

For an existing installation, plan to upgrade the entire site to run over to a securely encrypted,

HTTPs channel. Although you will need to create redirects from HTTP to HTTPs, the effort will future-proof your site. We recommend that you plan to make this change sooner, rather than later.

1050 Magento Community Edition 2.1 User Guide

CHAPTER 78: Security Security Best Practices

Protect the Environment

Protecting the environment is the most critical aspect of ensuring the security of your store.

Keep all software on the server up to date, and apply security patches as recommended. This applies not only to Magento, but to any other software that is installed on the server, including database software and other websites that use the same server. Any system is only as secure as the weakest link.

Server Environment

Make sure that the server operating system is secure. Work with your hosting provider to ensure that there is no unnecessary software running on the server.

Use only secure communications protocol (SSH/SFTP/HTTPS) to manage files, and disable FTP.

Magento includes .htaccess files to protect system files when using the Apache web server. If you use a different web server such as Nginx, make sure that all system files and directories are protected. For an sample Nginx configuration, see: magentonginx.conf

on GitHub.

Use strong and unique passwords, and change them periodically.

Keep the system up to date, and immediately install patches when new security issues are discovered.

Closely monitor any issues that are reported for software components used by your

Magento installation, including the operating system, MySQL database, PHP, Redis (if used), Apache or Nginx, Memcached, Solr, and any other components in your specific configuration.

Limit access to cron.php file to only required users. For example, restrict access by IP address. If possible, block access completely and execute the command using the system cron scheduler.

Advanced Techniques

Automate the deployment process, if possible, and use private keys for data transfer.

Limit access to the Magento Admin by updating the whitelist with the IP address of each computer that is authorized to use the Admin and Magento Connect downloader. For examples of how to whitelist IP addresses, see: Secure Your Magento Admin .

Do not install extensions directly on a production server.

To disable the Magento Connect downloader on the production site, either remove or block access to the /downloader directory. You can also use the same whitelisting methods.

Magento Community Edition 2.1 User Guide 1051

Security Best Practices CHAPTER 78: Security

Advanced Techniques (cont.)

Use two-factor authorization for Admin logins. There are several extensions available that provide additional security by requiring an additional passcode that is generated on your phone, or a token from a special device.

Review your server for “development leftovers.” Make sure there are no accessible log files, publicly visible .git directories, tunnels to execute SQL, database dumps, phpinfo files,or any other unprotected files that are not required, and that might be used in an attack.

Limit outgoing connections to only those that are required, such as for a payment integration.

Use a Web Application Firewall to analyze traffic and discover suspicious patterns, such as credit card information being sent to an attacker.

Server Applications

Make sure that all applications running on the server are secure.

Avoid running other software on the same server as Magento, especially if it is accessible from the Internet. Vulnerabilities in blog applications such as Wordpress can expose private information from Magento. Install such software on a separate server or virtual machine.

Keep all software up to date, and apply patches as recommended.

Admin Desktop Environment

Make sure that the computer that is used to access the Magento Admin is secure.

Keep your antivirus software up to date, and use a malware scanner. Do not install any unknown programs, or click suspicious links.

Use a strong password to log in to the computer, and change it periodically. Use a password manager such as LasstPass , 1Password , or Dashlane to create and manage secure, unique passwords.

Do not save FTP passwords in FTP programs, because they are often harvested by malware and used to infect servers.

1052 Magento Community Edition 2.1 User Guide

CHAPTER 78: Security Security Best Practices

Protect Magento

Your effort to protect your Magento installation starts with the initial setup, and continues with the security-related configuration settings, password management, and ongoing maintenance.

Your Magento Installation

Use the latest version of Magento to ensure that your installation includes the most recent security enhancements.

If for any reason you cannot upgrade to the latest version, make sure to install all security patches as recommended by Magento. Although Magento issues security patches to fix major issues, new product releases include additional improvements to help secure the site.

Use a unique, custom Admin URL instead of the default “admin” or the often-used

“backend,” Although it will not directly protect your site from a determined attacker, it can reduce exposure to scripts that try to break into every Magento site. (Never leave your valuables in plain sight.)

Check with your hosting provider before implementing a custom Admin URL. Some hosting providers require a standard URL to meet firewall protection rules.

Block access to any development, staging, or testing systems. Use IP whitelisting and

.htaccess password protection. When compromised, such systems can produce a data leak or be used to attack the production system.

Use the correct file permissions. Core Magento and directory files should be set to ready only, including app/etc/local.xml files.

Use a strong password for the Magento Admin. To learn more, see: Creating a strong password .

Take advantage of Magento’s security-related configuration settings for Admin Security ,

Password Options , and CAPTCHA .

Don’t be Taken for a Ride

Install extensions only from trusted sources. Never use paid extensions that are published on torrent or other sites. If possible, review extensions for security issues before installing them.

Do not click suspicious links, or open suspicious email.

Do not disclose the password to your server or to the Magento Admin, unless you are required to do so.

Magento Community Edition 2.1 User Guide 1053

Security Best Practices CHAPTER 78: Security

Be Prepared!

Develop a disaster recovery/business continuity plan. Even a basic plan will help you get back on track in the event of a problem.

Ensure that your server and database are automatically backed up to external location. A typical setup requires daily incremental backups, with a full backup on a weekly basis.

Make sure to test the backup regularly to verify that it can be restored.

For a large site, simple text file dumps of the database take an unacceptable amount of time to restore. Work with your hosting provider to deploy a professional database backup solution.

Monitor for Signs of Attack

If your system is not immediately patched after a major security breach, there is a high probability that your site is already compromised. Complete a security review periodically to check for signs of attack, and also when contacted by customers with security-related concerns.

Security Review

Check periodically for unauthorized Admin users.

(Magento Enterprise only) Check the Admin Actions Log for suspicious activity.

Use automated log review tools such as Apache Scalp .

Work with your hosting provider to review server logs for suspicious activity, and to implement an Intrusion Detection System (IDS) on your network.

Use a file and data integrity checking tool such as TripWire to receive notification of any potential malware installation.

Monitor all system logins (FTP, SSH) for unexpected activity, uploads, or commands.

1054 Magento Community Edition 2.1 User Guide

CHAPTER 78: Security Security Best Practices

Follow Your Disaster Recovery Plan

In the event of a compromise, work with your internal IT security team if available, or hosting provider, and system integrator to determine the scope of the attack. Taking into consideration the type of compromise and the size of the store. Then, adjust the following recommendations to your business needs.

Block access to the site, so the attacker cannot remove evidence or steal more information.

Backup the current site, which will include evidence of the installed malware or compromised files.

Try to determine the scope of the attack. Was credit card information accessed? What information was stolen? How much time has elapsed since the compromise? Was the information encrypted? Typically you can expect the following types of attack:

Defacing of Site

Botnetting

Direct Attack on Server

Silent Card Capture

Site access is compromised, but often the payments information is not. User accounts might be compromised.

Your site becomes part of a botnet that sends spam email.

Although data is probably not compromised, your server is blacklisted by spam filters which prevents email that you send to customers from being delivered.

Data is compromised, backdoors and malware are installed, and the site no longer works. Payment information—provided that it is not stored on the server— is probably safe.

In this most disastrous attack, intruders install hidden malware or card capture software, or possibly modify the checkout process to collect and send out credit card data. Such attacks can go unnoticed for extended periods of time, and result in major compromise of customer accounts and financial information.

Try to find the attack vector to determine how the site was compromised, and when. Review server log files and file changes. Note that sometimes there are multiple different attacks on the same system.

If possible, wipe and reinstall everything. In case of virtual hosting, create a new instance.

Malware might be hidden in an unsuspected location, just waiting to restore itself. Remove all unnecessary files. Then, reinstall all required files from a known, clean source such as files from your own version control system, or the original distribution files from magento.com.

Apply all the latest security patches necessary.

Reset all credentials, including the database, file access, payment and shipping integrations, web services, and Admin login.

Magento Community Edition 2.1 User Guide 1055

Security Best Practices CHAPTER 78: Security

If payment information was compromised, it might be necessary to inform your payment processor.

Inform your customers about the attack and the type of information affected. If payment information was compromised, they should look for unauthorized transactions. If personal information, including email addresses was compromised, they might be targeted with phishing attacks or spam.

Acknowledgments

Parts of this article were inspired by real-world solutions that were shared by community members. The resulting article incorporates content from the community, with input from our team.

Bryan (BJ) Hoffpauir for sharing his insight on the Magento forum, and for contributing recommendations in the Attack Response Plan section of this article. See the original post by beejhuff for more information.

Anna Völkl (@rescueann), Magento developer at LimeSoda.

Robert Mangiafico (@robfico) CTO at LexiConn.

@dracony_gimp for his security presentation, Being Hacked is Not Fun .

Willem de Groot for providing a sample Nginx configuration .

1056 Magento Community Edition 2.1 User Guide

CHAPTER 78: Security Configuring Admin Security

Configuring Admin Security

Magento recommends that you take a multifaceted approach to protect the security of your store. You can begin by using a

custom Admin URL

that is not easy to ascertain, rather than the obvious “Admin” or “Backend.” .As a best practice , use only strong Admin passwords that include a combination of letters, numbers, and symbols. For increased security, consider implementing two-factor authentication that generates a token on a separate device. To learn more, see the selection of security-related extensions on Magento Marketplace .

The Admin security configuration gives you the ability to add a secret key to URLs, require passwords to be case sensitive, and to limit the length of Admin sessions, the lifetime of passwords, and the number of login attempts that can be made before the Admin user account is

locked . For increased security, you can configure the length of keyboard inactivity before the

current session expires, and require the user name and password to be case-sensitive. For additional security, the Admin login can be configured to require a

CAPTCHA .

Magento Community Edition 2.1 User Guide

Security

1057

Configuring Admin Security CHAPTER 78: Security

To configure Admin security:

On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

In the panel on the left under Advanced, choose Admin.

Expand the Security section. Then, do the following:

To prevent Admin users from logging in from the same account on different devices, set

Admin Account Sharing

to "No."

To determine the method that is used to manage password reset requests, set Password

Reset Protection Type

to one of the following:

By IP and Email

By IP

By Email

The password can be reset online after a response is received from the notification is sent to the email address associated with the Admin account.

The password can be reset online without additional confirmation.

The password can be reset only by responding by email to the notification that is sent to the email address associated with the Admin account.

The password can be reset only by the store administrator.

None

In the Recovery Link Expiration Period (hours) field, enter the number of hours a password recovery link remains valid.

To determine the maximum number of password requests that can be submitted per hour, enter the Max Number of Password Reset Requests.

In the Min Time Between Password Reset Requests field, enter the minimum number of minutes that must pass between password reset requests.

To append a secret key to the Admin URL as a precaution against exploits, set Add Secret

Key to URLs

to “Yes.” This setting is enabled by default.

To require that the use of upper- and lowercase characters in any login credentials entered match what is stored in the system, set Login is Case Sensitive to “Yes.”

To determine the length of an Admin session before it times out, enter the duration of the session in seconds, in the Admin Session Lifetime (seconds) field. The value must be 60 seconds or greater.

In the Maximum Login Failures to Lockout Account field, enter the number of times a user can try to log in to the Admin before the account is locked. By default, six attempts are allowed . Leave the field empty for unlimited login attempts.

In the Lockout Time (minutes) field, enter the number of minutes that an Admin account is locked when the maximum number of attempts is met.

1058 Magento Community Edition 2.1 User Guide

CHAPTER 78: Security Configuring Admin Security

To limit the lifetime of Admin passwords, enter the number of days a password is valid in the Password Lifetime (days) field. /For an unlimited lifetime, leave the field blank.

Set Password Change to one of the following:

Forced

Recommended

Requires that Admin users change their passwords after the account is set up.

Recommends that Admin users change their passwords after account is set up.

When complete, tap

Save Config

Magento Community Edition 2.1 User Guide 1059

CAPTCHA CHAPTER 78: Security

CAPTCHA

A CAPTCHA is a visual device that ensures that a human being, rather than a computer, is interacting with the site. CAPTCHA is an acronym for “Completely Automated Public Turing test to tell Computers and Humans Apart,” and can be used for both Admin and customer account logins.

You can reload the CAPTCHA as many times as is necessary by clicking the Reload icon in the upper-right corner of the image. The CAPTCHA is fully configurable and can be set appear every time, or only after a number of failed login attempts.

Customer Login with CAPTCHA

1060 Magento Community Edition 2.1 User Guide

CHAPTER 78: Security CAPTCHA

Admin CAPTCHA

For an extra level of security, you can add a CAPTCHA to the Admin Sign In and Forgot

Password page. Administrator users can reload the displayed CAPTCHA by clicking the Reload icon in the upper-right corner of the image. The number of reloads is unlimited.

Admin Sign In with CAPTCHA

To configure an Admin CAPTCHA:

On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

In the panel on the left, under Advanced, choose Admin.

In the upper-right corner, set Store View to “Default.”

Expand the CAPTCHA section, and do the following:

Magento Community Edition 2.1 User Guide 1061

CAPTCHA CHAPTER 78: Security

1062

Admin CAPTCHA Configuration

Set Enable CAPTCHA in Admin to “Yes.”

Enter the name of the Font to be used for the CAPTCHA symbols. Default font:

LinLibertine

To add your own font, the font file must reside in the same directory as your Magento instance, and be declared in the config.xml file of the Captcha module at: app/code/Magento/Captcha/etc

Select the Forms where the CAPTCHA is to be used: l

Admin Login l

Admin Forgot Password

Magento Community Edition 2.1 User Guide

CHAPTER 78: Security CAPTCHA

Set Displaying Mode to one of the following:

Always

After number of attempts to login

CAPTCHA is always required to log in the Admin.

When selected displays the Number of Unsuccessful

Attempts to Login field. Enter the number of login attempts allowed. A value of 0 (zero) is similar to setting Displaying

Mode to Always. This option does not cover the Forgot

Password form. If CAPTCHA is enabled and set to be appear on this form, then it is always included on the form.

Enter the Number of Unsuccessful Attempts to Login before the CAPTCHA appears. If set to zero, the CAPTCHA is always used.

In the CAPTCHA Timeout (minutes) field, enter the number of minutes before the

CAPTCHA expires. When the CAPTCHA expires, the user must reload the page.

Enter the Number of Symbols used in the CAPTCHA, up to eight. For a variable number of symbols that changes with each CAPTCHA, enter a range, such as 5-8.

In the Symbols Used in CAPTCHA field, specify the symbols that can be used in the

CAPTCHA. Only letters (a-z and A-Z) and numbers (0-9) are allowed. The default set of characters does not include similar symbols such as I or 1. For best results, use symbols that users can readily identify.

To require that users enter the characters exactly as shown set Case Sensitive to “Yes.”

When complete, tap

Save Config…

Magento Community Edition 2.1 User Guide 1063

CAPTCHA CHAPTER 78: Security

Customer CAPTCHA

Customers can be required to enter a CAPTCHA each time they log in to their accounts, or after several unsuccessful attempts to log in. CAPTCHA can be used for the following forms in the storefront: l

Create User l

Forgot Password l

Checkout as Guest l

1064

Customer CAPTCHA Configuration

Magento Community Edition 2.1 User Guide

CHAPTER 78: Security CAPTCHA

To configure a Storefront CAPTCHA:

On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

In the panel on the left, under Customers, choose Customer Configuration.

Expand the CAPTCHA section, and do the following:

Set Enable CAPTCHA on Frontend to “Yes.”

Enter the name of the Font to be used for the CAPTCHA symbols.

To add your own font, the font file must reside in the same directory as your Magento instance, and be declared in the config.xml file of the CAPTCHA module.

Choose one of the following Forms where CAPTCHA is to be used.

Create User l

Forgot Password l

Checkout as Guest l

Set Displaying Mode to one of the following:

Always CAPTCHA is always required to access the selected form(s).

After number of attempts to login

Enter the number of login attempts before the CAPTCHA appears. A value of 0 (zero) is similar to “Always.” When selected, the number of unsuccessful login attempts appears.

This option does not apply to the Forgot Password form, which always display the CAPTCHA, if enabled,

Enter the Number of Unsuccessful Attempts to Login before the CAPTCHA appears. If set to zero, the CAPTCHA is always used.

In the CAPTCHA Timeout (minutes) field, enter the number of minutes before the

CAPTCHA expires. When the CAPTCHA expires, the user must reload the page to generate a new CAPTCHA.

Enter the Number of Symbols in the CAPTCHA, up to eight. For a variable number of symbols that change with each CAPTCHA, enter a range such as 5-8.

In the Symbols Used in CAPTCHA field, specify the symbols that can be used in the

To require that the user enter the upper-and lowercase characters exactly as shown set

Case Sensitive

to “Yes.”

When complete, tap

Save Config

Magento Community Edition 2.1 User Guide 1065

Encryption Key CHAPTER 78: Security

Encryption Key

The encryption key is used to protect passwords and other sensitive data. During the

Magento setup , you have the option to generate an encryption key, or use an another.

Encryption Key

To change the encryption key:

On the Admin sidebar, tap System. Then under Other Settings, choose Manage Encryption

Key

Set Auto-generate Key to “Yes.”

Tap

Change Encryption Key

1066 Magento Community Edition 2.1 User Guide

CHAPTER 78: Security Session Validation

Session Validation

Magento Community 2.1 allows you to validate session variables as a protective measure against possible session fixation attacks, or attempts to poison or hijack user sessions. The

Session Validation Settings determine how session variables are validated during each store visit, and if the session ID is included in the URL of the store.

Session Validation Settings

The validation checks to see that visitors are who they say they are by comparing the value in the validation variables against the session data that is already stored in $_SESSION data for the user. Validation fails if the information is not transmitted as expected, and the corresponding variable is empty. Depending on the session validation settings, if a session variable fails the validation process, the client session immediately terminates.

Enabling all of the validation variables can help prevent attacks, but might also impact the performance of the server. By default, all session variable validation is disabled. We recommend that you experiment with the settings to find the best combination for your Magento installation. Activating all of the validation variables might prove to be unduly restrictive, and prevent access to customers who have Internet connections that pass through a proxy server, or that originate from behind a firewall. To learn more about session variables and their use, see the system administration documentation for your Linux system.

Magento Community Edition 2.1 User Guide 1067

Session Validation CHAPTER 78: Security

To configure the Session Validation Settings:

On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

In the panel on the left under General, choose Web.

Expand the Session Validation Settings section. Then, do the following:

To verify that the IP address of a request matches what is stored in the $_SESSION variable, set Validate REMOTE_ADDR to “Yes.”

To verify that the proxy address of an incoming request matches what is stored in the $_

SESSION variable, set Validate HTTP_VIA to “Yes.”

To verify that the forwarded-for address of a request matches what is stored in the $_

SESSION variable, set Validate HTTP_X_FORWARDED_FOR to “Yes.”

To verify that the browser or device that is used to access the store during a session matches what is stored in the $_SESSION variable, set Validate HTTP_USER_AGENT to

“Yes.”

If you want a user to stay logged in while switching between stores, set Use SID on

Frontend

to “Yes.”

If including SID with analytics, you must configure your analytics software to filter the SID from URLs, so the page visit counts are correct.

When complete, tap

Save Config

1068 Magento Community Edition 2.1 User Guide

CHAPTER 78: Security Browser Capabilities Detection

Browser Capabilities Detection

As is true of most websites and applications on the Internet, Magento requires that the visitor’s browser allow both cookies and JavaScript for full operations. However, occasionally a user’s browser is set to the highest privacy setting that prevents both cookies and JavaScript. Your store can be configured to test the capabilities of each visitor’s browser, and to display a notice if the settings need to be changed.

If the browser’s privacy settings disallow cookies, you can configure the system to automatically redirect them to the

Enable Cookies

page, which explains how to make the recommended settings with most browsers.

If the browser’s privacy settings disallow JavaScript, you can configure the system to display the following message above the header of every page:

To configure browser capabilities detection:

On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

In the panel on the left under General, choose Web.

Expand the Browser Capabilities Detection section, and do the following:

To display instructions that explain how to configure the browser to allow cookies, set

Redirect to CMS-page if Cookies are Disabled

to “Yes.”

To display a banner above the header when JavaScript is disabled in the user’s browser, set

Show Notice if JavaScript is Disabled

to “Yes.”

Browser Capabilities Detection

When complete, tap

Save Config

Magento Community Edition 2.1 User Guide 1069

Action Log CHAPTER 78: Security

Action Log

The Action Log tracks the activities of administrators who work in your store. For most events, the available information includes the action, the name of the user who performed it, whether it was a success or failure, and the ID of the object on which the action was performed.

Additionally the IP and date are always logged.

1070

Admin Actions Logging

To configure the Action Log:

On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

In the panel on the left under Advanced, choose Admin.

Expand the Admin Actions Logging section, and do the following: l

To enable admin logging, mark the checkbox.

To disable admin logging, clear the checkbox.

When complete, tap

Save Config

Magento Community Edition 2.1 User Guide

CHAPTER 79:

Tools

In this section of the guide, you will learn how to perform routine index and cache management operations, back up the system, and use tools that help our Support team troubleshoot and resolve issues.

Cache Management

Alternate Media Storage

Magento Community Edition 2.1 User Guide 1071

Cache Management CHAPTER 79: Tools

Cache Management

Magento’s cache management system is an easy way to improve the performance of your site.

Whenever a cache needs to be refreshed, a notice appears at the top of the workspace to guide you through the process. Follow the link to Cache Management, and refresh the invalid caches.

Update Cache Message

The Cache Management page shows the status of each primary cache and its associated tag.

The large buttons in the upper-right corner can be used to flush the Magento Cache, or the allinclusive Cache Storage. At the bottom of the page there are additional buttons to flush the catalog product images cache and JavaScript/CSS cache. After clearing a cache, always refresh your browser to make sure that you can see the most recent files.

1072

Cache Management

Magento Community Edition 2.1 User Guide

CHAPTER 79: Tools Cache Management

To refresh specific caches:

Do one of the following: l

Click the Cache Management link in the message above the workspace.

On the Admin sidebar, tap System. Then under Tools, choose Cache Management.

For each cache to be refreshed, mark the checkbox at the beginning of the row.

Set Actions to “Refresh,” and tap

Submit

To perform mass actions:

To select a group of caches, set Mass Actions to one of the following: l

Select All l

Select Visible

Mark the checkbox of each cache to be targeted by the action.

Set Actions to “Refresh,” and tap

Submit

To flush the product image cache:

From the Cache Storage Management page, under Additional Cache Management, click Flush

Catalog Images Cache

to clear pre-generated product image files.

The message, “Image cache was cleaned” appears at the top of the workspace.

Make sure to also clear the cache of your browser.

To flush the JavaScript/CSS cache:

From the Cache Storage Management page, under Additional Cache Management, click Flush

JavaScript/CSS Cache

to clear any JavaScript and CSS files that have been merged into a single file.

The message, “The JavaScript/CSS cache has been cleaned” appears at the top of the workspace.

Make sure to also clear the cache of your browser.

Magento Community Edition 2.1 User Guide 1073

Cache Management CHAPTER 79: Tools

Control Descriptions

CONTROL

Mass Actions

DESCRIPTION

Marks the checkbox of multiple caches. Options include:

Select All

Unselect All

Marks the checkbox of all caches.

Clears the checkbox of all caches.

Select Visible

Unselect Visible

Marks the checkbox of all visible caches.

Clears the checkbox of all visible caches.

Actions

Submit

Determines the action to be applied to all selected caches. Options include:

Enable

Disable

Enables all selected caches.

Disables all selected caches.

Refresh Refreshes all selected caches.

Applies the action to all selected caches.

Button Descriptions

BUTTON

Flush Magento Cache

Flush Cache Storage

Flush Catalog Images

Cache

Flush JavaScript/CSS

Cache

Flush Static Files Cache

DESCRIPTION

Removes all items in the default Magento cache (var/cache), according to their associated Magento tags.

Removes all items from the cache, regardless of Magento tag. If your system uses an alternate cache location, any cached files used by other applications are removed in the process.

Removes all automatically resized and watermarked catalog images that are stored at: media/catalog/product/cache.

If recently uploaded images aren't reflected in the catalog, try flushing the catalog and refreshing your browser.

Removes the merged copy of JavaScript and CSS files from the cache. If recent changes to the style sheet or JavaScript aren't reflected in the store, try flushing the JavaScript/CSS cache and refreshing your browser.

Removes preprocessed view files and static files.

1074 Magento Community Edition 2.1 User Guide

CHAPTER 79: Tools Cache Management

Cache Descriptions

CACHE

Configuration

DESCRIPTION

Various XML configurations that were collected across modules and merged. Associated Tag: CONFIG

System: config.xml

local.xml

Module: config.xml

Layouts

Blocks HTML output

EAV types and attributes

Page Cache

Layout building instructions.

Associated Tag: LAYOUT_GENERAL_CACHE_TAG

Page blocks HTML. Associated Tag: BLOCK_HTML

Collections Data Collection data files. Associated Tag: COLLECTION_DATA

Database DDL operations Results of DDL queries, such as describing tables or indexes.

Associated Tag: DB_DDL

Entity types declaration cache. Associated Tag: EAV

Full page caching. Associated Tag: FPC

Integrations Configuration Integration configuration file. Associated Tag: INTEGRATION

Integrations API

Configuration

Integrations API configuration file.

Associated Tag: INTEGRATION_API_CONFIG

Target Rule

Translations

Web Services

Configuration

The target rule index.

Associated Tag: IARGET_RULE

Translation files. Associated Tag: TRANSLATE

REST and SOAP configurations, generated WSDL file.

Associated Tag: WEBSERVICE

Magento Community Edition 2.1 User Guide 1075

Cache Management CHAPTER 79: Tools

Full-Page Cache

Magento Community Edition 2.1 uses full-page caching on the server to quickly display category, product, and CMS pages. Full-page caching improves response time and reduces the load on the server. Without caching, each page might need to run blocks of code and retrieve information from the database. However, with full-page caching enabled, a fully-generated page can be read directly from the cache. For more technical information, see: Configure and Use

Varnish

We recommend Varnish to be used only in a production environment.

Cached content can be used to process the requests from similar types of visits. As a result, pages shown to a casual visitor might differ from those shown to a customer. For the purposes of caching, each visit is one of three types:

Non-sessioned

Sessioned

Customer

During a non-sessioned visit, a shopper views pages, but does not interact with the store. The system caches the content of each page viewed, and serves them to other non-sessioned shoppers.

During a sessioned visit, shoppers who interact with the store—through activities such as comparing products or adding products to the shopping cart—are assigned a session ID. Cached pages that are generated during the session are used only by that shopper during the session.

Customer sessions are created for those who have registered for an account with your store and shop while logged in to their accounts.

During the session, customers can be presented with special offers, promotions, and prices that are based on the customer group to which they are assigned.

To configure the full-page cache:

On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

In the panel on the left under Advanced, choose System.

Expand the Full Page Cache section.

1076

Full Page Cache

Magento Community Edition 2.1 User Guide

CHAPTER 79: Tools Cache Management

Set Caching Application to one of the following: l

Built-in Application l

Varnish Caching

To set the time-out for the page cache, enter the TTL for public content. (The default value is

86400)

If using Varnish, complete the Varnish Configuration section as follows:

In the Access list field, enter the IP addresses that can purge the Varnish configuration to generate a config file. Separate multiple entries with a comma. The default value is

“localhost.”

In the Backend host field, enter the IP address of the backend host that generates config files. The default value is “localhost.”

In the Backend port field, identify the backend port that is used to generate config files.

The default value is: “8080.”

To export the configuration as a varnish.vcl file, tap the button for the version of Varnish that you use.

Export VCL for Varnish 3 l

Export VCL for Varnish 4

When complete, tap

Save Config

Varnish Configuration

Magento Community Edition 2.1 User Guide 1077

Index Management CHAPTER 79: Tools

Index Management

Magento reindexes automatically whenever one or more items change. Actions that trigger reindexing include price changes, creating catalog or shopping cart price rules, adding new categories, and so on. To optimize performance, Magento accumulates data into special tables using indexers. As the data changes, the indexed tables must be updated—or reindexed.

Reindexing is performed as a background process, and your store remains accessible during the processes.

Reindexing data speeds up processing, and reduces the time the customer has to wait. For example, if you change the price of an item from $4.99 to $3.99, Magento reindexes the data to show the price change in the store. Without indexing, Magento would have to calculate the price of every product on the fly—taking into account shopping cart price rules, bundle pricing, discounts, tier pricing, and so on. Loading the price for a product might take longer than the customer is willing to wait.

The indexers can be set to either update on save, or on schedule. Reindexing is performed as a background process that is scheduled as a cron job, and your store remains accessible during the processes. A system message appears if a

cron job

is not available to update any indexers that become invalid.

1078

Index Management

Index Management has a slightly different presentation for flat product catalogs.

To avoid problems when multiple Admin users update objects that trigger automatic reindexing, we recommend that you set all indexers to run on schedule as

cron jobs .

Otherwise, every time an object is saved, any objects with interdependencies might cause a deadlock. Symptoms of a deadlock include high CPU usage and MySQL errors.

As a best practice, we recommend that you use scheduled indexing .

Magento Community Edition 2.1 User Guide

CHAPTER 79: Tools Index Management

To change the index mode:

On the Admin sidebar, tap System. Then under Tools, choose Index Management.

Mark the checkbox of each indexer that you want to change.

Set Actions to one of the following: l

Update on Save l

Update by Schedule

Tap

Submit

to apply the change to each selected indexer.

Column Descriptions

COLUMN

Indexer

DESCRIPTION

The name of the indexer.

Description

Mode

A description of the indexer.

Indicates the current update mode for each indexer. Options:

Update on Save The index is set to update whenever a change is saved.

Update on

Schedule

The index is set to update on schedule according to a cron job.

Status

Updated

Displays one of the following:

Ready The index is up-to-date.

Scheduled Reindexing is scheduled to take place.

Running Reindexing is currently running.

Reindex Required A change has been made that requires reindexing, but the indexers cannot be updated automatically. Check to see if

cron

is available and configured correctly.

Indicates the date and time an index was last updated.

Magento Community Edition 2.1 User Guide 1079

Index Management CHAPTER 79: Tools

Index Trigger Events

Reindexing Triggers

INDEX TYPE

Product Prices

REINDEXING EVENT

Add customer group

Change configuration settings

Flat catalog

1 product data Add store

Add store group

Add, edit, or delete attribute (for searching and filtering)

Flat catalog category data Add store

Add store group

Add, edit, or delete attribute (for searching and filtering)

Catalog category/product index

Add, edit, or delete products (single, mass, and import)

Change product-to-category relations

Add, edit, or delete categories

Add or delete stores

Delete store groups

Delete websites

Catalog search index

Stock status index

Category permissions index

Add, edit, or delete products (single, mass, and import)

Add or delete stores

Delete store groups

Delete websites

Change inventory configuration settings.

Add store, add store group, add or delete or update attribute (for searching and filtering)

1080

1 The flat product and category indexers also influence how catalog and shopping cart price rules are indexed. If you have a large number of SKUs (about 500,000 or more), you will notice a dramatic improvement in indexing time for price rules. To take advantage of this improvement, you must enable

Use Flat Catalog Product

Magento Community Edition 2.1 User Guide

CHAPTER 79: Tools

Index Actions and Controls

Index Actions

ACTION

Creating a new store, new customer group, or any action listed in “Actions that Cause a Full

Reindex.”

RESULT

Full reindex

Index Management

TO CONTROL

Full reindexing is performed on the schedule determined by your Magento cron job.

Bulk loading of items in the following ways:

Partial reindex (only changed items are reindexed) l

Magento import/export l

Direct SQL query l

Any other method that directly adds, changes, or deletes data.

Changing scope (for example, from global to website)

Partial reindex (only changed items are reindexed)

At the frequency determined by your

Magento cron job.

At the frequency determined by your

Magento cron job.

Events that Trigger Full Reindexing

Full Reindex Triggers

INDEXER

Catalog Category Flat

Indexer

Catalog Product Flat

Indexer

EVENT

Create a new web store

Create a new web store view

Create, or delete an attribute that is any of the following: l

Searchable or visible in advanced search l

Filterable l

Filterable in search l

Used for sorting

Change an existing attribute to be any of the preceding.

Enable flat category storefront options

Create a new web store

Create a new web store view

Create, or delete an attribute that is any of the following:

Magento Community Edition 2.1 User Guide 1081

Index Management CHAPTER 79: Tools

Full Reindex Triggers (cont.)

INDEXER

Stock status indexer

EVENT

Searchable or visible in advanced search l

Filterable l

Filterable in search l

Used for sorting

Change an existing attribute to be any of the preceding.

Enable flat category storefront options

When the following Catalog Inventory options change in the system configuration:

Stock Options Display Out of Stock Products

Product Stock

Options

Manage Stock

Price Indexer

Category or Product

Indexer

Adding a new customer group.

When any of the following Catalog Inventory options change in the system configuration:

Stock Options Display Out of Stock Products

Manage Stock Product Stock

Options

Price Catalog Price Scope

Create or delete a store view

Delete a store

Delete a website

1082 Magento Community Edition 2.1 User Guide

CHAPTER 79: Tools Backups

Backups

Magento Community Edition 2.1 gives you the ability to back up different parts of the system— such as the file system, database, and media files—and to rollback automatically. A record for each backup appears in the grid on the Backups page. Deleting a record from the list deletes the archived file as well. Database backup files are compressed using the .GZ format. For the system backups and database and media backups, the .TGZ format is used. As a best practice, you should restrict access to backup tools, and back up before installing extensions and updates.

Restrict access to backup tools. Access to the Backups and Rollback management tool can be restricted by configuring user permissions for backup and rollback resources. To restrict access, leave the corresponding checkbox unselected. If you need to grant access to rollback resources, you must grant access to backup resources as well.

Back up before installing extensions and updates. Always perform a backup before you install an extension or update.

Component Manager

includes a backup option that you can use before installing an extension or upgrading to a new release.

Backups

Magento Community Edition 2.1 User Guide 1083

Backups CHAPTER 79: Tools

To create a backup:

On the Admin sidebar, tap System. Then under Tools, choose Backups.

In the upper-right corner, tap the button for the type of backup you want to create:

System Backup Creates a complete backup of the database and the file system. During the process, you can choose to include the media folder in the backup.

Creates a backup of the database and the media folder.

Database and

Media Backup

Database Backup Creates a backup of the database.

To put the store into maintenance mode during the backup, mark the checkbox. When the backup is complete, maintenance mode is turned off automatically.

For a system backup, mark the Include Media folder to System Backup checkbox if you want to include the media folder. Then when prompted, confirm the action.

To schedule backups

On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

In the panel on the left under Advanced, choose System.

Expand the Scheduled Backup Settings section, and do the following:

When complete, tap

Save Config

1084 Magento Community Edition 2.1 User Guide

CHAPTER 79: Tools Cron (Scheduled Tasks)

Cron (Scheduled Tasks)

Magento performs some operations on schedule by periodically running a script. You can control the execution and scheduling of Magento cron jobs from the Admin. Store operations that run according to a cron schedule include: l

Catalog Price Rules

Newsletters

XML Sitemap Generation

Currency Rate Updates

In addition, you can configure the following to run according to a cron schedule: l

Order System Grid Updates and Reindexing l

Pending Payment Lifetime

Make sure that the

base URLs

for the store are set correctly, so the URLs that are generated during cron operations are correct. To learn more, see: Setting Up Cron Jobs .

To configure cron:

On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

In the panel on the left under Advanced, choose System.

Expand the Cron section.

Cron (Scheduled Tasks)

Magento Community Edition 2.1 User Guide 1085

Cron (Scheduled Tasks) CHAPTER 79: Tools

Then, complete the following settings for the Index and Default groups. The settings are the same in each section.

Generate Schedules Every l

Schedule Ahead for l

Missed if not Run Within l

History Cleanup Every l

Success History Lifetime l

Failure History Lifetime l

Use Separate Process

Cron Configuration for Group: Index

When complete, tap

Save Config

1086 Magento Community Edition 2.1 User Guide

CHAPTER 79: Tools Advanced Developer Tools

Advanced Developer Tools

Use the Advanced Developer tools to determine the compilation mode during frontend development, create a whitelist of IP addresses, display template path hints, and make spot changes to text in the interface of the storefront and Admin.

Frontend Development Workflow

Using Static File Signatures

File Optimization

Developer Client Restrictions

Template Path Hints

Translate Inline

Magento Community Edition 2.1 User Guide 1087

Advanced Developer Tools CHAPTER 79: Tools

Frontend Development Workflow

The Frontend Development Workflow type determines if Less compilation takes place on the clientor server side during development. Less is an extension of CSS that has additional features and conventions, and that produces streamlined code. Client-side Less compilation is recommended for theme development. Server-side compilation is the default mode. The development workflow options are not available for stores in production mode. To learn more, see Client-side LESS compilation vs.

server-side in the developer documentation.

Front-end Development Workflow

On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

In the panel on the left under Advanced, choose Developer.

Expand the Front-end Development Workflow section.

Set Workflow Type to one of the following:

Client side less compilation

Server side less compilation

Compilation takes place in the browser using the native less.js library.

Compilation takes place on the server using the Less PHP library. This is the default mode for production.

When complete, tap

Save Config

1088 Magento Community Edition 2.1 User Guide

CHAPTER 79: Tools Advanced Developer Tools

Using Static File Signatures

Adding a digital signature to the URL of static files makes it possible for browsers to detect when a newer version of the file is available. Static files that can be tracked with digital signatures include JavaScript, CSS, images, and fonts. The signature is appended to the path directly after the base URL. If a file’s signature differs from what is currently stored in the browser’s cache, then the newer version of the file is used. To learn more, see Static File

Processing in the developer documentation.

Static File Settings

To enable signed static files:

On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

In the panel on the left under Advanced, choose Developer.

Expand the Static Files Settings section.

Set Sign Static Files to “Yes.”

When complete, tap

Save Config

Magento Community Edition 2.1 User Guide 1089

Advanced Developer Tools CHAPTER 79: Tools

Optimizing Resource Files

The time it takes to load resource files can be reduced by merging and bundling files, and by minimizing code.

Merging combines separate files of the same type into a single file.

Bundling is a technique that groups separate files in order to reduce the number of HTTP requests that are required to load a page.

Minification removes spaces, line breaks, and comments, but does not affect the functionality of the code. Because minimized files cannot be edited, the process should be applied only when you are ready to go into production.

By default, Magento does not merge, bundle, or minimize files, and the project developer should determine which file optimization methods should be used. The following operations are supported for each file type:

FILE TYPE

CSS Files

SUPPORTED OPERATIONS

Merge l

Minify

JavaScript Files

Template Files l

Merge l

Bundle l

Minify l

Minify

To optimize resource files:

On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

In the panel on the left under Advanced, choose Developer.

To optimize CSS files, do the following:

Expand the CSS Settings section. Then, do the following:

Set Merge CSS Files to “Yes.”

Set Minify CSS Files to “Yes.”

1090

CSS Settings

Magento Community Edition 2.1 User Guide

CHAPTER 79: Tools Advanced Developer Tools

To optimizeJavaScript files, do the following:

Expand the JavaScript Settings section. Then, do the following:

Set Merge JavaScript Files to “Yes.”

Set Minify JavaScript Files to “Yes.”

JavaScript Settings

To minify PHTML template files, do the following:

Expand the Template Settings section.

Set Minify Html to “Yes.”

When complete, tap

Save Config

Template Settings

Magento Community Edition 2.1 User Guide 1091

Advanced Developer Tools CHAPTER 79: Tools

Developer Client Restrictions

Before using a tool such as

Template Path Hints

, make sure to add your IP address to the

Developer Client Restrictions whitelist to avoid disrupting the shopping experience of customers in the store, .If you don’t know your IP address, you can search for it online.

Add Your IP Address to the Whitelist

On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

In the panel on the left under Advanced,choose Developer.

Expand the Developer Client Restrictions section.

Developer Client Restrictions

In the Allow IPs field, enter your IP address. If access is needed from multiple IP addresses, separate each with a comma.

When complete, tap

Save Config

When prompted, refresh any invalid caches.

1092 Magento Community Edition 2.1 User Guide

CHAPTER 79: Tools Advanced Developer Tools

Template Path Hints

Template Path Hints are a diagnostic tool that adds notation with the path to each template that is used on the page. Template path hints can be enabled for either the storefront or the

Admin.

Template Path Hints in Storefront

Step 1:

Whitelist Your IP Address

Before using template path hints, add your IP address to the

whitelist

, so you won’t interfere with customers who are shopping in the store. When you are finished, make sure to clear the

Magento cache to remove all hints from the store.

Developer Client Restrictions

Magento Community Edition 2.1 User Guide 1093

Advanced Developer Tools CHAPTER 79: Tools

Step 2:

Enable Template Path Hints

On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

In the panel on the left under Advanced, choose Developer.

Expand the Debug section. Then, do the following:

Debug

To activate template path hints for the store, set Enabled Template Path Hints for

Storefront

to “Yes.”

To activate template path hints for the Admin, set Enabled Template Path Hints for

Admin

to “Yes.”

To include the names of blocks, set Add Block Names to Hints to “Yes.”

When complete, tap

Save Config

When you are finished, return to the Admin to disable the hints and clear the cache.

Step 3:

Clear the Cache

On the Admin sidebar, tap System. Then under Tools, choose Cache Management.

In the upper-right corner, tap

Flush Magento Cache

1094 Magento Community Edition 2.1 User Guide

CHAPTER 79: Tools Advanced Developer Tools

Translate Inline

You can use the Translate Inline tool to touch up the interface text to reflect your voice and brand. When the Translate Inline mode is activated, any text on the page that can be edited is outlined in red. It’s easy to edit field labels, messages, and other text that appears throughout the storefront and Admin. For example, many themes use terminology such as “My Account,”

“My Wishlist,” and “My Dashboard,” to help customers find their way around. However, you might prefer to simply use the words “Account,” “Wishlist,” and “Dashboard.”

Translatable Text

If your store is available in multiple languages, you can make fine adjustments to the translated text for the locale. On the server, interface text is maintained in a separate CSV file for each output block, and is organized by locale. As an alternate approach, rather than use the

Translate Inline tool, you can also edit the CSV files directly on the server.

To use the Translate Inline tool, your browser must allow pop-ups.

Step 1

: Disable Output Caches

On the Admin sidebar, tap System. Then under Tools, choose Cache Management.

Mark the following checkboxes: l

Blocks HTML output l

Page Cache l

Translations

Set the Actions control to “Disable.” Then, tap

Submit

Magento Community Edition 2.1 User Guide 1095

Advanced Developer Tools CHAPTER 79: Tools

1096

Disable Output Caches

Step 2:

Enable the Translate Inline Tool

On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

To work with a specific store view, set the Store View that is to be updated.

In the panel on the left under Advanced, choose Developer.

Expand the Translate Inline section. Then if necessary, clear the Use Website checkbox.

The Enabled for Admin option is not available when editing a specific store view.

Translate Inline

Set Enabled for Storefront to “Yes.”

When complete, tap

Save Config

When prompted, refresh the invalid caches, but leave the disabled caches as they are for now.

Magento Community Edition 2.1 User Guide

CHAPTER 79: Tools Advanced Developer Tools

Step 3:

Update the Text

Open your storefront in a browser, and go to the page that you want to edit. If necessary, use the language chooser to change the store view.

Each string of text that can be translated is outlined in red. When you hover over any text box, a book icon appears.

Tap the book icon to open the Translate window. Then, do the following:

If the change is for the specific store view, mark the Store View Specific checkbox.

Enter the new Custom text.

When complete, tap

Submit

Enter Custom Text

To see your changes in the store, press the F5 key to refresh the browser.

Repeat this process for any elements in the store to be changed.

Step 4:

Restore Original Settings

Return to the Admin of your store. On the Admin sidebar, tap Store. Then under Settings, choose Configuration.

Set Store View to the specific view that was edited.

In the panel on the left under Advanced, choose Developer.

Expand the Translate Inline section.

Magento Community Edition 2.1 User Guide 1097

Advanced Developer Tools CHAPTER 79: Tools

Translate Inline

Set Enabled for Frontend to “No.”

When complete, tap

Save Config

On the Admin sidebar, tap System. Then under Tools, choose Cache Management.

Mark the checkbox of the following output caches that were previously disabled: l

Blocks HTML output l

Page Cache l

Translations

Set the Actions control to “Enable.” Then, tap

Submit

When prompted, refresh any invalid caches.

Step 5:

Verify the Changes in Your Store

Go to your storefront and examine each page that was updated to make sure the changes are correct. In this example, “Customer Login” was changed to “Customer Sign In.” If changes were made to a specific view, use the Language Chooser to switch to the correct view.

1098

Customer Sign In

Magento Community Edition 2.1 User Guide

CHAPTER 79: Tools Web Setup Wizard

Web Setup Wizard

The Web Setup Wizard can be used to install components, modules,and extensions, upgrade your installation, and change the system configuration.

Magento Community Edition 2.1 User Guide

Web Setup Wizard

Component Manager

Component Manager lists each component that is currently installed, and can be used to synchronize any extensions you have purchased from Magento

Marketplace with your system.

System Upgrade

The System Upgrade tool can be used to upgrade your installation of Magento. During the process, it checks your system for readiness, creates a backup, and then upgrades your system.

System Config

The System Config tool can be synchronized with your

Marketplace account, based on your public and private access keys.

1099

Web Setup Wizard CHAPTER 79: Tools

Component Manager

Installing an extension is a three-step process that should take place during off-peak hours.

Before the extension is installed, your store is put into maintenance mode, checked for readiness, and backed up. After the extension is installed, it must be configured for your store according to the developer’s instructions. To learn more, see: Marketplace User Guide .

Before you begin, make sure that your system meets Component Manager prerequisties. To learn more, see:

Component Manager and System Upgrade Guide in the developer documentation.

To install an extension:

On the Admin sidebar, tap System. Then under Tools, choose Web Setup Wizard.

Web Setup Wizard

Tap Component Manager. Then, click the Sign In link in the upper-right corner.

1100

Component Manager

When prompted, paste the Public Access Key and Private Access Key from your Marketplace account. Then, tap

Sign In

. To learn more, see Magento 2 Access Keys in the Marketplace User

Guide.

Magento Community Edition 2.1 User Guide

CHAPTER 79: Tools Web Setup Wizard

Paste Access Keys

To synchronize Component Manager with your Marketplace purchases, tap

Sync

. It might take a few minutes. When the process is complete, the number of new purchases appears with the date and time the store was last synchronized.

Component Manager

In the Marketplace Purchases section under New Purchases, click Install.

In the Extensions Grid, mark the checkbox of the extension you want to install. Then in the

Action

column, click the Install link for the item.

Extensions Grid

We’re almost done! Follow these steps to complete the installation:

Magento Community Edition 2.1 User Guide 1101

Web Setup Wizard CHAPTER 79: Tools

Step 1:

Readiness Check

Before the installation begins, your store environment must be checked for compatibility. When ready to begin, tap

Start Readiness Check

. The progress indicator shows where you are in the process.

Readiness Check

When the Readiness Check completes successfully, tap

Next

Readiness Check Complete

1102 Magento Community Edition 2.1 User Guide

CHAPTER 79: Tools Web Setup Wizard

Step 2:

Create Backup

Your store will be put in maintenance mode while the backup is created. When you are ready to begin, tap

Create Backup

. Then, wait a few minutes for the backup to complete.

Backup Complete

You can see the path to the backup file at the bottom of the report. When the backup is complete, tap

Next

Step 3:

Component Install

When you are ready to begin, tap

Install

. Then, wait a few moments for the installation to complete.

Installation Complete

When complete, tap

Back to Setup Tool

. Then, tap the System Configuration tile.

Setup Wizard

In the upper-right corner of Component Manager, click the Reset link to log out.

Magento Community Edition 2.1 User Guide 1103

Web Setup Wizard CHAPTER 79: Tools

Logged Out

Step 4:

Configure the Extension for Your Store

On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

In the panel on the left, find the new tab for the extension you installed. Then, follow the instructions from the extension developer to complete the configuration.

1104 Magento Community Edition 2.1 User Guide

CHAPTER 79: Tools Web Setup Wizard

Web Setup

The Web Setup is the second part of the Magento installation that checks system readiness, establishes the database connection, and creates the initial Admin account. The following steps give an overview of the process that takes place at the end of the installation.

Step 1:

Readiness Check

To verify that your system meets the system requirements, tap

Start Readiness Check

When the results appear, tap Details for more information. Then, do one of the following; l

If your system fails the readiness check, correct the issue and tap

Try Again

If your system meets the requirements, tap

Next

Readiness Check

Step 2:

Add a Database

To change the MySQL database or update the credentials, do the following:

Enter the Database Server Host. If the database resides on the same server as the

Magento code, enter “localhost.”

Enter the Database Server Username.

Enter the Database Server Password.

Enter the Database Name.

If applicable, enter the Table prefix.

When complete, tap

Next

. Your credentials must be correct to continue to the next step.

Magento Community Edition 2.1 User Guide 1105

Web Setup Wizard CHAPTER 79: Tools

Add a Database

Step 3:

Web Configuration

Under Web Configuration, do the following:

In the Your Store Address field, enter the full URL of your Magento store.

In the Magento Admin Address field, enter the full URL of the Magento Admin.

Expand the Advanced Options, and do the following:

Mark the checkbox of the HTTPS Options that apply to your system: l

Use HTTPS for Magento Storefront l

Use HTTPS for Magento Admin

To enable your server to use Apache Rewrites, mark the checkbox.

Mark the checkbox of the Encryption Key setting that applies to your system: l

I want to use a Magento generated key.

I want to use my own encryption key.

1106 Magento Community Edition 2.1 User Guide

CHAPTER 79: Tools Web Setup Wizard

Web Configuration

Step 4:

Customize Your Store

To install or reinstall the Sample Data, do the following:

To create a sample store with sample products, mark the Use Sample Data checkbox.

If you are reinstalling the sample data, also mark the Clean up automatically checkbox.

Set Store Default Time Zone to the correct time zone for your locale.

Set Store Default Currency to the default currency that you accept as payment.

Set Store Default Language to the primary language of your store.

Magento Community Edition 2.1 User Guide

Customize Your Store

1107

Web Setup Wizard CHAPTER 79: Tools

(Optional) Expand the Advanced Modules Configuration, and do the following:

To install only specific modules, clear the Select All checkbox.

In the list, select the checkbox of each module you want to install.

1108

Advanced Modules Configuration

When complete, tap

Next

Step 5:

Create Admin Account

Enter a New Username for the Admin account.

Enter a New E-Mail for the Admin account.

Enter a New Password for the Admin account. Then in the Confirm Password field, enter your new password again.

When complete, tap

Next

Magento Community Edition 2.1 User Guide

CHAPTER 79: Tools Web Setup Wizard

Create Admin Account

Step 6:

Install

When you are ready to complete the setup, tap

Install Now

Install

When the installation completes, a page appears with your Magento Admin and database credentials, but without the passwords. You can print the page and keep it for your records.

Then, do of the following: l

Launch Magento Storefront l

Launch Magento Admin

If the installation fails to complete, view the Console Log to learn more. Then, correct the problem and try again.

Magento Community Edition 2.1 User Guide 1109

Web Setup Wizard CHAPTER 79: Tools

A little Housekeeping

After Setup is complete, do the following to set the recommended permissions for all files and folders in your Magento2 installation:

Change to the Web user who has full permissions to the Magento2 folder. (For example, apache or root.) su – apache

Change directories to the Magento2 folder, and set the following permissions. You can copy the code, and paste it as a single command.

find . -type d -exec chmod 700 {} \; && find . -type f -exec chmod 600 {} \;

&& chmod +x bin/magento

1110 Magento Community Edition 2.1 User Guide

Appendices

1111

1112

Release Notes

Change Log

Glossary

Configuration Reference

விளம்பரம்

System

Contents

System Menu

To display the System menu:

Menu Options

Data Transfer

Integrations

Tools

Permissions

Other Settings

Notifications

Custom Variables

Manage Encryption Key

Data Transfer

Working with CSV Files

Product CSV Structure

CSV Product Structure

Customer CSV Structure

CSV Customer Structure

Data Validation

Data Validation Messages

Import

Prepare the Data

Choose the Import Behavior

Identify the Import File

Check the Import Data

Import Behavior

Import History

To view the import history:

Importing Product Images

Import Images from the Local Server

Import Images from External Server

Import Guidelines

New Entities

Existing Entities

Complex Data

Invalid Files

Export

To export data:

Export Criteria

Export Filters

Exclude Attributes

Export Criteria

Product Attribute Reference

Simple Product CSV File Structure

Simple Product CSV File Structure (cont.)

Simple Product CSV File Structure (cont.)

Simple Product CSV File Structure (cont.)

Simple Product CSV File Structure (cont.)

Simple Product CSV File Structure (cont.)

Simple Product CSV File Structure (cont.)

Simple Product CSV File Structure (cont.)

Simple Product CSV File Structure (cont.)

Simple Product CSV File Structure (cont.)

Simple Product CSV File Structure (cont.)

Complex Data

Complex Data Attributes

Complex Data Attributes (cont.)

Advanced Pricing

Advanced Pricing Attributes

Advanced Pricing Attributes (cont.)

Customer Attribute Reference

Customers Main File

Customers Main File (cont.)

Customer Addresses

Customer Addresses (cont.)

Integrations

Onboarding Workflow

To add a new integration:

To change the API guest access security setting:

Magento Marketplace

Magento Connect

Permissions

Adding Users

Create a New User

Define the Role

Admin Password Requirements

Locked Users

To unlock an admin account:

User Roles