Magento Commerce 2.2 User Guide

User Manual:

Open the PDF directly: View PDF .
Page Count: 1760

Download
Open PDF In Browser	View PDF

Ma
g
ent
oCommer
c
e

Contents
GETTING STARTED

CHAPTER 1: Welcome

Resources

Join the Conversation!

CHAPTER 2: About This Release
System Requirements

Installation

Prelaunch Checklist

Your Login Credentials

For Your Records

CHAPTER 3: Your Magento Account

Creating an Account

Sharing Your Account

CHAPTER 4: Quick Tour

Path to Purchase

Home Page

Catalog Page

Search Results

Product Page

Shopping Cart

Customer Journey

Attract New Customers

Engage Your Customers

Increase Average Order Value

Contents

Moment of Purchase

Retain Customers

Build Loyalty & Advocacy

Success!

Basic Configuration

CHAPTER 5: Store Admin

Admin Sign In

Your Admin Account

Admin Sidebar

Admin Workspace

Dashboard

Message Inbox

Global Search

Grid Controls

Grid Layout

Actions Control

Admin Session Lifetime

CHAPTER 6: Store Details

Store Information

Locale Options

State Options

Country Options

Merchant Location

Currency

Store Email Addresses

CHAPTER 7: Storefront Branding

103

Uploading Your Logo

104

Adding a Favicon

107

Welcome Message

110

Magento Commerce User Guide

iii

Contents

111

Store Demo Notice

113

CHAPTER 8: Websites, Stores & Views
Scope

116

Changing Scope

117

Catalog Scope

120

Product Scope

121

Price Scope

123

Customer Account Scope

125

Scope Quick Reference

126

Single Store Mode
CHAPTER 9: Industry Compliance

128
131

PCI Compliance Guidelines

132

GDPR Compliance

133

Google Analytics Settings for GDPR

133

138

Cookie Law Compliance

140

Cookie Restriction Mode

141

Cookie Reference

143

Magento 2.x Default Cookies

143

Google Analytics Cookies

147

CATALOG
CHAPTER 10: Catalog Menu

149
151

Menu Options

152

Catalog URLs

153

CHAPTER 11: Products Grid

157

CHAPTER 12: Creating Products

161

Product Workspace

115

162

Magento Commerce User Guide

Contents

Default Field Values

165

Scheduled Changes

167

Product Types

168

Simple Product

170

Configurable Product

175

Part 1: Creating a Configurable Product

176

Part 2: Adding Configurations

180

Grouped Product

188

Virtual Product

195

Bundle Product

200

Customizing the Bundle
Downloadable Product
Configuring Download Options
Gift Cards

201
211
220
222

Gift Card Workflow

223

Creating a Gift Card

225

Gift Card Accounts

231

Configuring Gift Card Accounts

235

CHAPTER 13: Product Settings

239

Advanced Product Settings

240

Other Product Settings

241

Content

243

Configurations

244

Product Reviews

244

Images and Videos

245

Search Engine Optimization

246

Related Products, Up-Sells, and Cross-Sells

248

Related Products

248

Up-sells

250

Cross-sells

252

Customizable Options

Magento Commerce User Guide

254

Contents

Product in Websites

258

Design

260

Autosettings
Gift Options

261

Downloadable Information

262

Grouped Products

262

Bundle Items

263

Gift Card Information

263

CHAPTER 14: Managing Price

265

Advanced Pricing

266

Group Price

269

Special Price

271

Tier Price

276

Minimum Advertised Price

278

MAP Logic

278

Configuring MAP

280

CHAPTER 15: Managing Inventory

285

Stock Management Methods

286

Stock Options

291

Product Stock Options

293

Stock Message Scenarios

295

Product Page Stock Messages

295

Catalog Page Stock Messages

297

Product Alerts
Product Alert Run Settings
CHAPTER 16: Catalog Images and Video

261

299
301
303

Uploading Product Images

304

Adding Product Video

308

Media Gallery

311

Image Zoom

312

Light Boxes and Sliders

312
Magento Commerce User Guide

Contents

Placeholders

313

Watermarks

314

Swatches

317

Text-Based Swatches

317

Swatches in Layered Navigation

318

Creating Swatches

319

CHAPTER 17: Categories

325

Best Practices for Product Categories

326

Creating Categories

327

Root Categories

333

Hidden Categories

336

Modifying a Category

337

Scheduled Changes

338

Content Settings

339

Display Settings

340

Search Engine Optimization

341

Products in Category

343

Sorting Category Products

347

Design Settings

351

Category Permissions

353

CHAPTER 18: Product Attributes

359

Best Practices for Product Attributes

360

Creating Product Attributes

361

Adding an Attribute to a Product

366

Attribute Sets

372

Attribute Input Types

374

Date & Time Options
CHAPTER 19: Using a Flat Catalog
Flat Catalog Setup

Magento Commerce User Guide

376
379
380

vii

Contents

MARKETING
CHAPTER 20: Marketing Menu
Main Sections
CHAPTER 21: Shopping Tools

387
388
391

Opportunities to Engage

392

Email a Friend

393

Wish Lists

396

Configuring Wish Lists

397

Updating Wish Lists

398

Sharing a Wish List

401

Wish List Search

403

Product Relationships

405

Compare Products

406

Other PayPal Solutions

1156

PayPal Payments Advanced
Requirements

Magento Commerce User Guide

1158
1158

xix

Contents

Checkout Workflow
Checkout Workflow
Order Processing Workflow
Order Processing Workflow
Setting Up PayPal Payments Advanced

1159
1159
1159
1160

PayPal Payments Pro

1161

Requirements

1161

Checkout Workflow

1162

Checkout Workflow
Order Processing Workflow
Order Processing Workflow
Setting Up PayPal Payments Pro

1162
1163
1163
1164

PayPal Payments Standard

1165

Merchant Requirements

1165

Checkout Workflow

1165

Checkout Workflow
Setting Up PayPal Payments Standard

1165
1166

PayPal Payflow Pro

1167

Requirements

1167

Customer Workflow

1168

Customer Workflow
Online Order Processing Workflow

1168
1168

Online Order Processing Workflow

1168

Setting Up PayPal Payflow Pro

1169

PayPal Payflow Link

1170

Requirements

1170

Customer Workflow

1170

Customer Workflow
Order Workflow
Order Workflow
Setting Up PayPal Payflow Link
PayPal Reference

1159

1170
1171
1171
1172
1173

Magento Commerce User Guide

Contents

PayPal Business Account

1174

PayPal Credit®

1175

PayPal Fraud Management Filter

1179

PayPal by Country

1180

CHAPTER 72: Other Payment Methods
Klarna

1183
1184

Klarna Customer Experience

1185

Setting Up Klarna

1186

Managing Your Account

1191

Amazon Pay

1194

Amazon Pay Customer Experience

1195

Setting Up Amazon Pay

1198

Using Amazon Seller Central

1204

Managing Amazon Pay Transactions

1206

Amazon Pay Resources

1208

Authorize.Net Direct Post

1210

CyberSource

1211

eWAY

1214

Worldpay

1217

CHAPTER 73: Basic Payment Methods

1221

Check / Money Order

1222

Cash On Delivery

1224

Bank Transfer

1226

Purchase Order

1228

Zero Subtotal Checkout

1230

CHAPTER 74: Fraud Protection
Signifyd Guaranteed Fraud Protection

Shipping
CHAPTER 75: Shipping Settings

Magento Commerce User Guide

1233
1234

1237
1239

xxi

Contents

Point of Origin

1240

Multiple Addresses

1241

Shipping Policy

1242

CHAPTER 76: Basic Shipping Methods
Free Shipping

1246

Flat Rate

1248

Table Rates

1250

Dimensional Weight

1257

CHAPTER 77: Magento Shipping
Quick Look

1259
1260

Customer Experience

1261

Shipping Methods

1261

Click & Collect

1262

Returns

1262

Setting Up Magento Shipping

1263

Locations

1269

Shipping Partners

1273

Packaging

1276

Shipping Experience Rules

1280

Troubleshooting

1284

CHAPTER 78: Carriers

1285

CHAPTER 79: Shipping Labels

1287

Shipping Label Workflow

1288

Configuring Shipping Labels

1289

Creating Shipping Labels

1293

Label Packages

REPORTS
CHAPTER 80: Reports Menu

xxii

1245

1300

1305
1307

Magento Commerce User Guide

Contents

Menu Options

1308

Refresh Statistics

1309

CHAPTER 81: Marketing Reports
Reports
CHAPTER 82: Review Reports
Reports
CHAPTER 83: Sales Reports
Reports
CHAPTER 84: Customer Reports
Reports
CHAPTER 85: Product Reports
Reports
CHAPTER 86: Private Sales Reports
Reports
CHAPTER 87: Marketing Automation

BUSINESS INTELLIGENCE

1311
1312
1313
1314
1315
1316
1319
1320
1321
1322
1325
1326
1327

1329

CHAPTER 88: Advanced Reporting

1331

CHAPTER 89: BI Essentials

1339

Dashboards

1343

Report Builder

1346

Visual Report Builder

1347

Filters

1352

Formulas

1356

Manage Data

1362

Metrics

1363

Filter Sets

1369

Magento Commerce User Guide

xxiii

Contents

Export Data
CHAPTER 90: New Relic Reporting
New Relic Queries

1377
1379

OPERATIONS

1387

Stores

1388

CHAPTER 91: Stores Menu
Menu Options

1389
1390

CHAPTER 92: All Stores

1393

Adding Store Views

1394

Editing a Store View

1396

Adding a Language

1398

Translating Products

1400

Translating Content

1402

Adding Stores

1403

Adding Websites

1407

Store URLs

1409

Use Secure Protocol

1409

Using a Custom Admin URL

1414

CHAPTER 93: Configuration

1417

Configuration Tabs

1417

CHAPTER 94: Taxes

1419

Vertex Cloud
Your Vertex Account
General Tax Settings
Cross-Border Price Consistency
Tax Rules
Tax Classes

xxiv

1373

1421
1422
1424
1430
1432
1436

Magento Commerce User Guide

Contents

Configuring Tax Classes

1437

Adding New Tax Classes

1438

Default Tax Destination

1440

EU Place of Supply for Digital Goods

1441

Fixed Product Tax
Configuring FPT

1442
1443

Price Display Settings

1448

Tax Zones and Rates

1451

Import/Export Tax Rates

1453

Value Added Tax (VAT)

1456

Configuring VAT

1457

VAT ID Validation

1460

Configuring VAT ID Validation

1462

Tax Quick Reference

1467

International Tax Guidelines

1469

U.S. Tax Guidelines

1471

Canadian Tax Guidelines

1473

EU Tax Guidelines

1478

Warning Messages

1484

Calculation Settings

1484

Discount Settings

1485

CHAPTER 95: Currency

1487

Currency Configuration

1488

Currency Symbols

1492

Updating Currency Rates

1493

CHAPTER 96: Attributes

1495

Customer Attributes

1496

Customer Address Attributes

1501

Customer Address Templates

1502

Product Attributes

Magento Commerce User Guide

1504

xxv

Contents

System
CHAPTER 97: System Menu
Menu Options

1511
1512

CHAPTER 98: Data Transfer

1515

Working with CSV Files

1516

Data Validation

1519
1521

Import
Import History

1526

Importing Product Images

1527

Import Guidelines

1529

Export

1531

Export Criteria

1533

Export Filters

1534

Exclude Attributes

1534

Data Transfer Examples

1534

Importing Configurable Products

1534

Importing Tier Prices

1540

Scheduled Import/Export

1543

Scheduling an Import

1544

Scheduling an Export

1550

Product Attribute Reference

1555

Complex Data

1566

Advanced Pricing Data

1568

Customer Attribute Reference

1570

CHAPTER 99: Integrations

1573

Onboarding Workflow

1574

Magento Marketplace

1578

CHAPTER 100: Permissions

xxvi

1509

1579

Adding Users

1580

Locked Users

1584

Magento Commerce User Guide

Contents

User Roles

1585

Role Resources

1588

Alternate Media Storage

1591

Using a Database

1592

Database Workflow

1592

Using a Content Delivery Network

1594

CDN Workflow

1594

CHAPTER 101: Security

1597

Security Scan

1598

Security Best Practices

1602

Start Right

1602

Protect the Environment

1603

Protect Magento

1605

Don’t be Taken for a Ride

1605

Be Prepared!

1606

Monitor for Signs of Attack

1606

Follow Your Disaster Recovery Plan

1607

Security Action Plan

1608

Configuring Admin Security

1609

CAPTCHA

1612

Admin CAPTCHA

1613

Customer CAPTCHA

1616

Encryption Key

1618

Session Validation

1620

Browser Capabilities Detection

1622

CHAPTER 102: Tools

1623

Cache Management

1624

Full-Page Cache

1630

Index Management
Index Trigger Events
Backups

Magento Commerce User Guide

1632
1634
1637

xxvii

Contents

Cron (Scheduled Tasks)

1639

Developer Tools

1641

Action Log

1642

Action Log Report

1642

Related Products

Magento Commerce User Guide

CHAPTER 4: Quick Tour

Path to Purchase

Product Page

Magento Commerce User Guide

Path to Purchase

CHAPTER 4: Quick Tour

Shopping Cart
The cart is where order total can be determined, along with discount coupons and estimated
shipping and tax, and is a great place to display your trust badges and seals. It’s also an ideal
opportunity to offer one last item. As a cross-sell, you can select certain items to be offered as
an impulse purchase whenever a specific item appears in the cart.
Callouts

One Item in Cart

Change the Quantity

Estimate Shipping & Tax

Go to Checkout

Edit Line Item

Update the Cart

Checkout with Multiple Addresses

Use a Coupon

Cross-sells

Special Price

Magento Commerce User Guide

CHAPTER 4: Quick Tour

Path to Purchase

Shopping Cart Page

Magento Commerce User Guide

Customer Journey

CHAPTER 4: Quick Tour

Customer Journey
Attract New Customers
Magento Commerce includes SEO functionality out of
the box. Improve your search ranking and attract the
most visitors to your site.

Engage Your Customers
Design your site with prepared templates, or create a
custom design with features that invite people to interact
with your store.

Increase AOV
Increase average order value with promotions and
content that encourage your customers to shop more.

Moment of Purchase
Give your customers a faster and easier way to check
out. Calculate shipping and taxes automatically, and
integrate multiple payment methods on a single page.

Magento Commerce User Guide

CHAPTER 4: Quick Tour

Customer Journey

Customer Retention
Create and manage newsletters and promotions to keep
your customers coming back for more.

Loyalty & Advocacy
Encourage customers to write product reviews, create
wish lists, and send email about products to their friends.
Strengthen your relationship with your customers, who in
return, speak positively of your business to friends
and family.

Magento Commerce User Guide

Customer Journey

CHAPTER 4: Quick Tour

Attract New Customers
Magento Commerce is packed with features that make it
easy to create a “search engine friendly” websites and
increase the likelihood of bringing the right customers to
your site.

Search Engine Optimization
Magento offers powerful, native capabilities to streamline Search Engine Optimization (SEO)
practices for content and site exposure that are integrated with the Admin, and tied directly into the
user experience.

Custom URLs
Custom URLs are short, clean, and easy to remember. You can also autogenerate search-friendly
URLs to streamline your purchase path.

Meta Data
Improve your search engine rankings by choosing specific criteria that helps search engines to find
and index your products more easily. Meta data can be entered for product, category, and content
pages.

Sitemap
Link to a sitemap from the footer of your store to give customers an overview of the catalog structure,
with links to all categories and products in the store. Easy integration with Google Sitemap.

Analytics
In addition to monitoring your site from the Admin dashboard, you can integrate third-party analytics
tools such as Google Analytics and New Relic Reporting for detailed statistics on traffic and sales.

Magento Commerce User Guide

CHAPTER 4: Quick Tour

Customer Journey

Engage Your Customers
Magento Commerce makes it easy to create a
customized, engaging site experience. Encourage your
customers to spend more time exploring your site, and
give them the tools to make it easy to find what they want
faster.

Content Management
Magento’s CMS makes it easy to store pages, or parts of pages, that you can use in your store. Even
those without a technology background can create and manage site content.

Design & Theme
Control the visual elements of your store with a collection of templates and skin files. You can apply
these visual elements to all pages in your store, giving your store a cohesive look and feel.

Multiple Stores, Sites & Views
Control the look and feel of multiple sites, introduce new market and languages, and track analytics
from a single Admin.

Multiple Devices
Magento’s powerful features make it easy to create storefronts optimized for iPhone, Android, and
Mobile Opera browsers to help you engage consumers with mobile commerce now, and into the
future.

Shopping Tools
Your store includes a set of shopping tools that create opportunities for your customers to interact
with your store, connect on social media, and share with friends.

Sophisticated Search
Filter product by price, manufacturer, or any other criteria to reduce the time to purchase.

Magento Commerce User Guide

Customer Journey

CHAPTER 4: Quick Tour

Increase Average Order Value
Magento Commerce provides a range of tools to help you
tailor the shopping experience, and encourage your
customers to put more items in their shopping carts and
spend more money.

Targeted Promotions
Use catalog and shopping cart price rules to create promotions that kick into gear when a set of
conditions is met. Segment customers dynamically and build segments based on specific
characteristics such as customer address, order history, shopping cart content, and much more.

Coupons
Create limited-time offers and coupons that customers can scan with their phone and apply to a
purchase.

Product Suggestions
Another way to increase AOV is to offer suggestions for related products and opportunities to up-sell
and cross-sell at strategic points along the path to conversion.

Email Reminders
Send automated reminder emails to customers who have added items to their carts or wish lists, but
haven’t made a purchase. A variety of triggers can launch automated emails, including total cart
value, quantity, items in the cart, and more.

User Permissions & Roles
Restrict access to data in the Admin on a “need to know” basis. Create multiple admin roles for readonly or and editing privileges. Track and review all activity at a granular level to specific stores and
websites.

Magento Commerce User Guide

CHAPTER 4: Quick Tour

Customer Journey

Full-Page Caching
Enhance performance by caching primary pages. Caching pages improves server response times,
reduces load, and increases sustainable traffic.
You can use tags to define which components to cache, so only relevant pages are cached as
updates take place. It also has the ability to identify and differentiate visitors from shoppers.

Sales Order Archive
Archiving orders frees resources and improves performance when sales reps are assisting customers
with orders.

Index Management
Automatic reindexing takes place whenever prices change, shopping carts are updated, or new
categories created. Reindexing is a background process that does not interfere with store operations.

Magento Commerce User Guide

Customer Journey

CHAPTER 4: Quick Tour

Moment of Purchase
Now that you’ve given your customer an engaging
shopping experience, make it easy for them to complete
their purchases. Magento is designed to help you
streamline your checkout process experience while
boosting conversion rates.

Instant Purchase
Simplify ordering and boost conversion rates by allowing your customers to speed through checkout
by using stored payment and shipping information.

Shopping Assistance
Assisted shopping makes it easy for customer service reps to create orders for customers. Customer
service reps have access to shopping cart contents, and can move items from a wish list to a
shopping cart, apply coupon codes, and more.

Security
Whether an order is fulfilled online or over the phone, Magento provides sophisticated security,
including CAPTCHA and SSL encryption, with best-in-breed encryption and hashing algorithms to
protect the security of the system.

Order Processing
Magento supports a complete order processing workflow. It's easy to customize order statuses and
track communications between sales reps and customers.

Multiple Payment Options
Magento Commerce supports the payment methods and currencies needed for global commerce.
You can choose the ones you want to offer, and at checkout, your customers can choose the ones
they prefer.

PayPal Merchant Solutions
It's easy to integrate a PayPal Payments account to provide your customers faster, more secure
checkout options.

Magento Shipping
Offer seamless access to global carrier networks, and use customer experience rules to streamline
operations and automate processes.

Magento Commerce User Guide

CHAPTER 4: Quick Tour

Customer Journey

Multiple Shipping Options
Magento supports a variety of shipping methods so you can give your customers a choice at
checkout. Customers can see a real-time estimate of shipping charges right from the shopping cart.

Shipping Labels
Merchants have complete control over package characteristics such as weight and size. Shipping
labels, rate, and bar code information originates directly from the carrier. Labels can be generated for
single or multiple orders.

Magento Commerce User Guide

Customer Journey

CHAPTER 4: Quick Tour

Retain Customers
Magento makes it easy for you to get repeat business
and build brand loyalty. Magento gives you total control
and flexibility over creating and revising goodies like
rewards programs, custom coupons and automated
emails to keep your customers coming back again and
again.

Email Marketing Automation
Send professionally designed, dynamic email campaigns with with live data from your Magento store,
powered by dotmailer.

RMA
Customers can submit requests for Return Merchandise Authorization from your store. You can
create shipment orders in a carrier system, and print shipping labels with RMA numbers.

Store Credit
Keep customers loyal and happy by issuing refunds as store credit or virtual gift cards to ensure that
the money they spend stays in your store.

Reward Points
Drive customer engagement with reward programs with award points based on a range of
transactions and customer behaviors. Base redemption on a variety of factors, such as balance,
customer history, and conversion rates.

Target Shopping History
Encourage customers to make return purchases with targeted promotions based on their shopping
history. With the Magento platform, you can easily build segments based on your customer base.

Custom Coupons
Create coupons codes for social media, email, or print campaigns. You can incorporate coupon codes
into any design you like.

Newsletters
Stay in touch with current customers who’ve opted to receive newsletters. You can create as many
newsletter templates as you want.

Magento Commerce User Guide

CHAPTER 4: Quick Tour

Customer Journey

RSS Feed
When RSS feeds are enabled, any additions to products, specials, categories, and coupons are
automatically sent to the subscribers of each feed. A link to all RSS feeds that you publish is in the
footer of your store.

Magento Commerce User Guide

Customer Journey

CHAPTER 4: Quick Tour

Build Loyalty & Advocacy
Give customers a direct connection to your brand by
allowing them to create customer accounts where they
can see their purchase history, wish lists, and newsletter
subscriptions. Use product ratings and reviews to give
new customers objective product opinions and promote a
sense of community. These features turn customer
satisfaction into one of the most powerful and costefficient marketing tools at your disposal.

Advanced Reporting
Gain valuable insights at a glance with dynamic product, order, and customer reports, powered
by Magento Business Intelligence.

Dashboard Snapshots
Knowing what’s of interest on your site is crucial to maximize your marketing budget. Use this
information to determine what you should cross- and up-sell to loyal customers, or which products to
put on sale.

Customer Accounts
Opening an account provides customers with a personalized shopping experience that they can share
with their friends. Customers can save their shopping preferences, and manage their own store billing
and shipping information.

Advocacy Tools
Customers who share wish lists and send gift cards make a powerful endorsement of your brand.
Wish lists become powerful advocacy tools when shared by email or RSS feed, and gift cards bring
motivated new shoppers to your store.

Reviews & Ratings
Product reviews give your customers a way to engage with your brand while fostering a sense of
community. You can curate your reviews with tools to help you edit and approve comments for
inappropriate content before they go live.

Magento Commerce User Guide

CHAPTER 4: Quick Tour

Customer Journey

Success!
Opening your Magento store for business requires the
following areas of consideration. While there are virtually
any number of customizations you can make to the
storefront and Admin, you can use each link in this is list
as a place to start.

Implementation
If you need help setting up your store, you can choose from our vast network of Magento Solutions
Partners.

Design
You can use a prepared theme and design your own home page, or work with an experienced
Magento designer or Magento Associate to customize your site.

Product Catalog
Configure products, create categories, import existing product catalogs, and leverage APIs or thirdparty data management solutions.

Payment Methods
Magento supports a wide variety of payment methods, services, and gateways that you can offer for
your customers’ convenience.

Shipping Methods
Magento shipping methods are easy to set up and give you the ability to connect with carriers who
can ship your products all over the world.

Taxes
Manage your taxes with our native tools, or add third-party extensions from Magento Marketplace.

Thanks for your order!
Magento can help you to build relationships with your customers, and bring them back to your store,
again and again.

Magento Commerce User Guide

Basic Configuration

Contents
This section of the guide introduces your store's
Admin, and walks you through the basic
configuration settings. You’ll learn the concepts
of store hierarchy and configuration scope, and
establish best practices for industry standards
and requirements.

Store Admin
Your Admin Account
Admin Sidebar
Admin Workspace
Dashboard
Message InBox
Global Search
Grid Controls
Actions Control
Store Details
Store Information
Locale Options
State Options
Country Options
Merchant Location
Currency
Store Email Addresses
Contact Us
Storefront Branding
Uploading Your Logo
Uploading a Favicon
Welcome Message
Store Demo Notice
Copyright Notice
Websites, Stores & Views
Configuration Scope
Single Store Mode
Industry Compliance
PCI Compliance
Privacy Policy
Cookie Law Compliance
Cookie Restriction Mode
Cookie Reference

CHAPTER 5:

Store Admin
Your store Admin is the password-protected back office where you, as the merchant, can set up
products, promotions, manage orders, and perform other administrative tasks. All basic
configuration tasks and store management operations are performed from the Admin.

Admin Sidebar and Dashboard
Your initial sign-in credentials were set up during the Magento installation. If you forget your
password, a temporary password can be sent to the email address that is associated with the
account. For increased security, you can configure your store to require a case-sensitive user
name and password. For additional security, the Admin login can be configured to require a
CAPTCHA. To learn more, see: Configuring Admin Security.
In addition to the default Admin account, you can create as many additional accounts that are
needed to manage the store and to support customer accounts. Each account can be associated
with a specific role and level of access, based on the person’s business need to know. The email
address that is associated with each Admin account must be unique.

Magento Commerce User Guide

Admin Sign In

CHAPTER 5: Store Admin

Admin Sign In
The first thing you will learn is how to sign in and out of the Admin, and to reset your
password. All of the instructions in the rest of this guide are written for a user with full
administrative privileges, and begin with the assumption that you are logged in to the Admin.
To learn more about Admin users and roles, see: Permissions
The Advanced Admin configuration determines how many times an admin user can try to log
in before the account is locked. By default, six attempts are allowed. To unlock a user account,
see: Locked Users.

Admin Sign In

To sign in to the Admin:
1.

In the address bar of your browser, enter the URL that was specified during the installation,
followed by the base URL of your store’s Admin. The default Admin URLs look something like
this:
http://www.yourdomain.com/admin

You can bookmark the page, or save a shortcut on your desktop for easy access.

Enter your Admin User Name and Password.

Tap Login .

Magento Commerce User Guide

CHAPTER 5: Store Admin

Admin Sign In

To reset your password:
1.

If you forget your password, click the Forgot Your Password? link. Then, enter the Email
Address that is associated with the Admin account.

Forgot Password
2.

Tap Retrieve Password .
If an account is associated with the email address, an email will be sent to reset your
password.
Your Admin password must be seven or more characters long, and include both letters and
numbers.

To sign out of the Admin:
In the upper-right corner, tap the Account (

) icon. Then on the menu, choose Sign Out.

Sign Out
The Sign-In page returns, with a message that you are logged out. It’s always a good idea to
sign out of the Admin whenever you leave your computer unattended.

Admin Password Requirements
FIELD
Password

Magento Commerce User Guide

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.

Your Admin Account

CHAPTER 5: Store Admin

Your Admin Account
Your Admin account was initially set up during the installation, and might contain initial
placeholder information, or information from the sample data. You can personalize your user
name and password, and update your first and last name, and email address at any time. To
learn more about Admin accounts and roles, see: Permissions.

To edit your account information:
1.

In the upper-right corner, tap the Account (

) icon. Then, choose Account Setting.

Make any changes necessary changes to your account information. If you change your login
credentials, make sure to write them down.

When complete, tap Save Account .

Account Information

Magento Commerce User Guide

CHAPTER 5: Store Admin

Admin Sidebar

Admin Sidebar
The sidebar on the left is the main menu for your store’s Admin, and is designed for both
desktop and mobile devices. The flyout menu provides access to all the tools you need to
manage your store on a daily basis.

Admin Startup Page
Displays the Admin startup page, which by default is the Dashboard.

Dashboard
The Dashboard provides a quick overview of the sales and customer activity in
your store, and is usually the first page that appears when you log in to the
Admin.

Sales
The Sales menu is where you can find everything related to the operations of
processing orders, invoices, shipments, credit memos, and transactions.

Catalog
The Catalog menu is used to create products and define categories.goo

Customers
The Customers menu is where you can manage customer accounts, and see
which customers are online at the moment.

Magento Commerce User Guide

Admin Sidebar

CHAPTER 5: Store Admin

Marketing
The Marketing menu is where you set up catalog and shopping cart price rules
and coupons. Price rules trigger actions when a set of specific conditions is met.

Content
The Content menu is where you manage the content elements and design of your
store. You will learn how to create pages, blocks, and frontend apps, and manage
the presentation of your store.

Reports
The Reports menu provides a broad selection of reports that give you insight into
every aspect of your store, including sales, shopping cart, products, customers,
tags, reviews, and search terms.

Stores
The Stores menu includes tools to configure and maintain every aspect of your
store, including multisite installation settings, taxes, currency, product attributes,
and customer groups.

System
The System menu includes tools to manage system operations, install
extensions, and manage Web Services for integration with other applications.

Find Partners & Extensions
This is where you can find a marketplace Magento Partners and solutions for
your store.

Magento Commerce User Guide

CHAPTER 5: Store Admin

Admin Workspace

Admin Workspace
The Admin workspace provides access to all the tools, data, and content that you need to run
your store. The default start up page can be set in the configuration. Many Admin pages have a
grid that lists the data for the section, with a set of tools to search, sort, filter, select, and apply
actions. By default, the Dashboard is the startup page for the Admin. However, you can choose
any other page to appear as the startup page when you log in. You can tap the Magento logo in
the Admin sidebar to return to the Admin startup page.

Admin Workspace

To change the Admin startup page:
1.

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

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

Expand

Set Startup Page to the page that you want to appear first after you log in to the Admin.

the Startup Page section.

Startup Page
5.

When complete, tap Save Config.

Magento Commerce User Guide

Admin Workspace

CHAPTER 5: Store Admin

Workspace Controls
CONTROL

DESCRIPTION

The Global Search box can be used to find any value in the database,
including product, customer, and order records.

Sort

The header of each column can be used to sort the list in ascending or
descending order.

Filters

Defines a set of search parameters that determines the records that appear in
the grid.
In addition, the filters in the header of some columns can be used to limit the
list to specific values. Some filters have additional options that can be
selected from a list box, and for others, you can simply type the value you
want to find.

Default View

Determines the default column layout of the grid.

Columns

Determines the selection of columns and their order in the grid. The column
layout can be changed. and saved as a “view.” By default, only some of the
columns are included in the grid.

Paginate

The pagination controls are used to view the additional pages of results.

Actions

The Actions control applies an operation to all selected records. To select
individual records, mark the checkbox in the first column of each row, or use
the Select control.

Select

The Select control is used to select multiple records that are to be the target
of action. Options: Select All / Deselect All

Potential Startup Pages
SIDEBAR

PAGES

Dashboard
Sales

Operations

Orders
Invoices
Shipments
Credit Memos
Returns
Billing Agreements
Transactions

Related Products

248

Magento Commerce User Guide

CHAPTER 13: Product Settings

Other Product Settings

To set up related products:
1.

Open the product in edit mode.

Scroll down and expand

the Related Products, Up-Sells, and Cross-Sells section. Then,

tap Add Related Products.

Related Products

Up-sells

Cross-sells

Creating a Related Product Rule

If the rule is to be active for a specific range of time, enter the From and To dates.

In the Result Limit field, enter the number of records to appear in the results list. The
maximum number is 20.

If the rule applies to a specific customer segment, set Customer Segments to “Specified.”
Then, choose the customer segment from the list.

In the panel on the left, choose Products to Match. Then, build the condition as you would for
a catalog price rule.

Products to Match
5.

In the panel on the left, choose Products to Display. Then, build the results condition as you
would for a catalog price rule.

Products to Display
6.

Complete the condition to describe the products that you want to include in the results.

When complete, tap Save.

Magento Commerce User Guide

461

Creating a Related Product Rule

CHAPTER 24: Related Product Rules

Field Descriptions
FIELD

DESCRIPTION

Rule Name

A name that identifies the rule for internal use.

Priority

Determines the sequence in which the results of the rule appear
when displayed with other sets of results that target the same place
on the page. The value can be set to any whole number, with the
highest priority of 1.
For example, if there are multiple up-sell rules that apply, the one with
the highest priority appears before the others. The sort order of the
products within each set of results is random.
Any up-sell, cross-sell, and related products that were manually
configured always appear on the page before any rule-based product
promotions.

Status

Controls the active status of the rule. Options: Active / Inactive

Apply To

Identifies the type of product relationship that is associated with the
rule. Options include:
Related Products
Up-sells
Cross-sells

462

From Date

If the rule is active for a range of time, determines the first date the
rule is active.

To Date

If the rule is active for a range of time, determines the last date the
rule is active.

Result Limit

Determines the number of products that appear in the results at one
time. The maximum number is 20. If more matching results are
found, the products rotate through the block each time the page is
refreshed.

Customer Segments

Identifies the customer segments to which the rule applies. Options:
All / Specified

Magento Commerce User Guide

CHAPTER 24: Related Product Rules

Category

Global

When creating a new event, this field links back to
the category tree. When editing an event, it links to
the category page related to the event.

Start Date

Global

The starting date and time of the event in
MMDDYYYY HH;MM format. Click the calendar
button to select the date.

End Date

Global

The ending date and time of the event in
MMDDYYYY HH;MM format. Click the calendar
button to select the date.

Image

Store View

Uploads an image that appears in the Catalog Events
Carousel widget.

Sort Order

Global

Determines the sequence in which this event appears
when listed with other events.

Display Countdown Ticker
On

Global

Displays the countdown ticker in the header of each
page specified. Options include:
Category Page / Product Page

Status

Magento Commerce User Guide

Global

Indicates the status of the event based on the Start
Date and End Date range. Status is a read-only
value. Values include: Open / Closed / Upcoming

513

Catalog Events Carousel

CHAPTER 28: Private Sales & Events

Updating Events
Events can be edited from either the Events page or from the category that is associated with
the event. When a category has an associated event, an Edit Event button appears in the
upper-right corner.

Edit Event

Method 1: Edit Event from the Events Page
1.

On the Admin sidebar, tap Marketing. Then under Private Sales, choose Events.

Find the event in the list, and open it in edit mode.

Make the necessary changes to the event.

When complete, tap Save.

Method 2: Edit Event from Category
1.

On the Admin sidebar, tap Products. Then under Inventory, choose Categories.

In the category tree on the left, select the category that is associated with the event. Then in
the upper-right corner, tap Edit Event.

Make the necessary changes to the event.

When complete, tap Save.

Catalog Events Carousel
The Catalog Events Carousel widget displays a slider of upcoming events with a countdown
ticker for each event. You can choose the page(s) and area of the page layout where the carousel

514

Magento Commerce User Guide

CHAPTER 28: Private Sales & Events

Catalog Events Carousel

is to appear, and control the width and number of events that appear at a time. The result you
get depends on your theme, where it’s positioned to appear on the page, and the options that
you choose.

Event Carousel in Left Sidebar

Step 1: Enable the Catalog Carousel Widget
1.

Before you begin, follow the instructions to configure the Catalog Event widget is enabled for
the storefront.

Catalog Events

Step 2: Create the Widget
1.

On the Admin sidebar, tap Content. Then under Elements, choose Widgets.

In the upper-right corner, tap Add Widget.

In the Settings section, do the following:
a.

Set Type to “Catalog Events Carousel.”

Choose the Design Theme that is used by the store.

Magento Commerce User Guide

515

Catalog Events Carousel

CHAPTER 28: Private Sales & Events

Tap Continue.

Widget Type
5.

In the Storefront Properties section, complete the following fields:
Widget Title

Enter a descriptive title for your widget. This title is visible only
from the Admin.

Assign to Store Views

Select the store views where the widget will be visible. You can
select a specific store view, or "All Store Views."

Sort Order

(Optional) Enter a number to determine the order this items
appears with others in the same part of the page. (0 = first, 1 =
second, 3= third, and so on.)

Storefront Properties

516

Magento Commerce User Guide

CHAPTER 28: Private Sales & Events

Catalog Events Carousel

Step 3: Choose the Location
1.

In the Layout Updates section, tap Add Layout Update. Then, do the following:
a.

Set Display On to “Specified Page.”

Set Page to “CMS Home Page.”

Set Container one fo the following:
l

Main Content Area

Sidebar Additional

Sidebar Main
The results vary according to theme and page layout. The “Catalog Events Carousel Default
Template.” must also be specified in the category configuration.

If you want the Events Carousel to appear in an additional location in the storefront, tap
Add Layout Update. Then, repeat these steps.

Layout Updates
2.

Tap Save and Continue Edit.
For now, you can ignore the message to refresh the cache.

Step 4: Configure the Options
1.

In the panel on the left, choose Widget Options. Then, do the following:
a.

In the Frame Size field, enter the number of events that you want to list in the slider at
the same time. To view only one event at a time, enter “1.”

In the Scroll field, enter the number of event listings that you want to scroll per click. To
scroll to the next event, enter “1.”

For a custom width, enter the number of pixels in the Block Custom Width field. The custom
width for the example on this page is set to 250 pixels.

Magento Commerce User Guide

517

Catalog Events Carousel

CHAPTER 28: Private Sales & Events

Widget Options
3.

When complete, tap Save.

When prompted to refresh the cache, click the link in the message at the top of the workspace,
and follow the instructions.

518

Magento Commerce User Guide

CHAPTER 28: Private Sales & Events

Invitations

Invitations
When invitations are enabled, customers can send and view invitations from the dashboard of
their customer accounts. The invitation email includes a link to your store’s Customer Login
page.

Invitation Workflow
Customer prepares invitations. From the account dashboard, the customer prepares
the list of recipients, and completes the invitation. A custom message can be included,
depending on the configuration.
Customer sends invitations. When ready, the customer taps the Send Invitations
button.

System manages transmission.The system sends invitations in batches, according to
the number set in the configuration.

Customer monitors response. The customer monitors the status of each invitation
from the account dashboard, as having been Sent, Accepted, or Canceled.

Magento Commerce User Guide

519

Invitations

CHAPTER 28: Private Sales & Events

Configuring Invitations
The invitation configuration enables invitations for the store, and determines how they are
sent.

To configure invitations:
1.

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

In the panel on the left, under Customers, choose Invitations.

Expand

the General section. Then, do the following:

General

520

Magento Commerce User Guide

CHAPTER 28: Private Sales & Events

Set Enable Invitations Functionality to “Yes.”

To allow customers to manage invitations from the storefront, set Enable Invitations on
Storefront to “Yes.”

Set Referred Customer Group to one of the following:

Invitations

Same as Inviter

Default Customer Group from Configuration

Set New Accounts Registration to one of the following:
l

By Invitation Only

Available to All

To Allow Customers to Add Custom Message to Invitation Email, select “Yes.”

To limit the number of invitations that can be sent at one time, enter the number in the
Max Invitations Allowed to be Sent at One Time field.

Expand

the Email section, and do the following:

Select the store identity to be used as the Customer Invitation Email Sender.

Select the Customer Invitation Email Template used for invitations sent.

When complete, tap Save Config.

Magento Commerce User Guide

521

522

Magento Commerce User Guide

Communications

523

Contents
In this section of the guide, you will learn how to
customize email and newsletter templates, as
well as PDF invoices and packing slips. You will
also learn how to personalize the content with
variables and markup tags.

Email
Supported Email Clients
Preparing Your Email Logo
Configuring Email Templates
Sales Email
Payment Failed Email
Admin Email
Customizing Email Templates
Header Template
Footer Template
Message Templates
Configuring Email Communications
Sales Documents
Configuring Sales Emails
PDF Logo Requirements
Adding Reference IDs to Header
Email Reminder Rules
Configuring Email Reminders
Creating Email Reminders
Email Reminder Templates
Newsletters
Configuring Newsletters
Newsletter Templates
Sending Newsletters
Managing Subscribers
RSS Feeds
Using Variables
Adding Predefined Variables
Creating Custom Variables
Markup Tags
Variable Reference

524

CHAPTER 29:

Email
Email templates define the layout, content, and formatting of automated messages sent from
your store. They are called transactional emails1 because each one is associated with a specific
type of transaction, or event.
Magento includes a set of responsive email templates that are triggered by a variety of events
that take place during the operation of your store. Each template is optimized for any screen
size, and can be viewed from the desktop, as well as on tablets and mobile devices. You will
find a variety of prepared email templates related to customer activities, sales, product alerts,
admin actions, and system messages that you can customize to reflect your brand.

1An automated email message that is sent in response to a specific event or transaction.

Magento Commerce User Guide

525

Supported Email Clients

CHAPTER 29: Email

Supported Email Clients
A wide range of technologies is supported by the various email clients and services available
today. Although there is some variation in the way email messages are rendered, we have found
the following services to be compatible with Magento Commerce.

Desktop Clients
OPERATING SYSTEM

CLIENTS SUPPORTED

OS X 10.8

Apple Mail 6

OS X 10.7

Outlook 2011
Outlook 2013

Windows 8

Outlook 2010

Windows 7

Outlook 2007
Outlook 2003

Mobile Clients
OPERATING SYSTEM

CLIENTS SUPPORTED

Android 4.2, “Jelly Bean”

Native email app

Android 2.3, “Gingerbread”

Native email app

Gmail App (Android 4.2)

Native email app

Blackberry 5 OS

Native email app

IOS 8

iPhone 6
iPhone 6 Plus

IOS 7

iPad (Retina)
iPad Mini
iPhone 5s
Mail on these devices:

IOS 6

526

iPhone 5
iPhone 4s

Magento Commerce User Guide

CHAPTER 29: Email

Supported Email Clients

Web Clients
EMAIL APPLICATION

BROWSERS SUPPORTED*

AOL Mail

Chrome
Internet Explorer
Firefox

Gmail

Chrome
Internet Explorer
Firefox

Yahoo! Mail

Chrome
Internet Explorer
Firefox

Outlook.com

Chrome
Internet Explorer
* The latest version of each browser was used for testing.

Magento Commerce User Guide

527

Preparing Your Email Logo

CHAPTER 29: Email

Preparing Your Email Logo
Logos can be saved as any of the following file types. Logos with transparent backgrounds can
be saved as either .GIF or .PNG files.
l

JPG/JPEG

GIF

PNG

To ensure that your logo renders well on high-resolution devices, the uploaded image should be
three times the size of the dimensions that are specified in the header template. Typically,
original logo artwork is created as a vector image, so it can be scaled up without losing
resolution. The image can then be saved in one of the supported bitmap image formats.

Logo Three Times Display Size
To take advantage of the limited vertical space in the header, make sure to crop the image to
eliminate any wasted space at the top or bottom. When editing the image, be careful to
preserve the aspect ratio1 of the logo, so the height and width resize proportionally.
As a general rule, you can make an image smaller than the original, but not larger without
losing resolution. Taking a small image and scaling it up in a photo editor lowers the
resolution of the image. For example, if the display dimensions of the logo are 168 pixels wide
by 48 pixels high in the header template, the uploaded image should be 504 pixels wide by 144
pixels high.

LOGO DIMENSIONS

1 X (DISPLAY SIZE)

3 X (IMAGE SIZE)

Width:

168 px

504 px

Height:

48 px

144 px

1The proportional relationship between the width and height of an image.

528

Magento Commerce User Guide

CHAPTER 29: Email

Configuring Email Templates

Configuring Email Templates
The configuration determines the logo, as well as the header and footer templates that are used
for all transactional email messages that are sent from your store.

Transactional Emails

Process Overview:
Step 1: Upload Your Logo
Step 2: Select the Header and Footer Templates

Step 1: Upload Your Logo
1.

On the Admin sidebar, tap Content. Then under Design, choose Configuration.

Find the store view that you want to configure. Then in the Action column, click Edit.

Under Other Settings, expand
a.

the Transactional Emails section. Then, do the following:

To upload your prepared Logo Image, tap Upload. Find the file on your computer, and
select the file.

In the Logo Image Alt field, enter alternate text to identify the image.

Enter the Logo Width and Logo Height in pixels. Enter each value as a number, without
the “px” abbreviation. These values refer to the display dimensions of the logo in the
header, and not to the actual size of the image.

Magento Commerce User Guide

529

Configuring Email Templates

CHAPTER 29: Email

Step 2: Choose the Header and Footer Templates
If you have custom header and footer templates for your store, or for different stores, you can
specify which templates are used for each, according to the scope of the configuration.

530

Choose the Header Template to be used for all transactional email messages.

Choose the Footer Template to be used for all transactional email messages.

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 29: Email

Configuring Email Templates

Sales Email
A number of email messages are triggered by the events related to an order, and the
configuration is similar. You must identify the store contact that appears as the sender of the
message, the email template to be used, and anyone else who is to receive a copy of the
message. Sales emails can be sent when triggered by an event, or by predetermined interval.

Sales Emails

Step 1: Update the Email Templates
Make sure that you have updated each email template to reflect your brand. For a complete
list of templates, see: Email Template List.

Step 2: Choose the Type of Transmission
1.

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

In the panel on the left under Sales, choose Sales Emails.

Expand

the General Settings section. Then, set Asynchronous Sending to one of the

following:
Disable

Sends sales email when triggered by an event.

Enable

Sends sales email at predetermined, regular intervals.

General Settings

Magento Commerce User Guide

531

Configuring Email Templates

CHAPTER 29: Email

Step 3: Complete the Details for Each Sales Email Message
4.

Expand

the Order section. Then, do the following:

Order
a.

Verify that Enabled is set to “Yes.”

Set New Order Confirmation Email to the store contact that appears as the sender of the
message.

Set New Order Confirmation Template to the template that is used for the email that is
sent to registered customers.

Set New Order Confirmation Template for Guest to the template that is used for the
email that is sent to guests who do not have an account with your store.

In the Send Order Email Copy To field, enter the email address of anyone who is to
receive a copy of the new order email. If sending a copy to multiple recipients, separate
each address with a comma.

Set Send Order Email Copy Method to one of the following:
Bcc

Sends a “blind courtesy copy” by including the recipient in the
header of the same email that is sent to the customer. The BCC
recipient is not visible to the customer.

Separate Email
5.

532

Expand

Sends the copy as a separate email.

the Order Comments section, and repeat these steps.

Magento Commerce User Guide

CHAPTER 29: Email

Configuring Email Templates

Order Comments
6.

Complete the configuration for the remaining sales emails:
l

Invoice

Shipment

Credit Memo

When complete, tap Save Config.

Magento Commerce User Guide

533

Configuring Email Templates

CHAPTER 29: Email

Payment Failed Email
A notification is sent to the customer if the payment method that is chosen during checkout
fails to complete the transaction.

Payment Failed Emails

Step 1: Update the Email Templates
Make sure that you have updated each email template to reflect your brand. For a complete
list of templates, see: Email Template List.

Step 2: Configure the Payment Failed Emails
1.

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

In the panel on the left under Sales, choose Checkout.

Expand
a.

the Payment Failed Emails section. Then, do the following:

Set Payment Failed Email Sender to the store contact that appears as the sender of the
message.

534

Set Payment Failed Email Receiver to the store contact that is to receive notification of
failed email transmissions.

Set Payment Failed Template to the template that is used for the email that is sent when
the payment method fails during checkout.

In the Send Payment Failed Email Copy To field, enter the email address of anyone who
is to receive a copy of the payment failed notification. If sending a copy to multiple
recipients, separate each address with a comma.

Magento Commerce User Guide

CHAPTER 29: Email

Configuring Email Templates

Send Payment Failed Copy Method to one of the following:
Bcc

Sends a “blind courtesy copy” by including the recipient in the
header of the same email that is sent to the customer. The BCC
recipient is not visible to the customer.

Separate Email
4.

Sends the copy as a separate email.

When complete, tap Save Config.

Admin User Email
The Admin email template configuration determines the email templates that are sent when
users forget and reset their passwords, the store contact that appears as the sender of the
message, and how long the password recovery link remains valid.

Admin User Emails

To configure the Admin email templates:
1.

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

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

Expand

the Admin User Emails section. Then, do the following:

Set Forgot Password Email Template to the template that is sent when Admin users
forget their passwords.

Set Forgot and Reset Email Sender to the store contact that appears as the sender of the
message.

Set User Notification Template to the email template that is used as the default for admin
notifications.

When complete, tap Save Config.

Magento Commerce User Guide

535

Customizing Email Templates

CHAPTER 29: Email

Customizing Email Templates
Magento includes a default email template for the body section of each message that is sent by
the system. The template for the body content is combined with the header and footer
templates to create the complete message. The content is formatted with HTML and CSS, and
can be easily edited, and customized by adding variables and frontend apps. Email templates
can be customized for each website, store, or store view. Make sure to update the system
configuration after creating a customized template, so the custom template is used instead of
the default.
The default templates include your logo and store information, and can be used without further
customization. However as a best practice, you should view each template, and make any
necessary changes before they are sent to customers.

Preview of Welcome Template

536

Magento Commerce User Guide

CHAPTER 29: Email

Customizing Email Templates

Header Template
The email header template includes your logo that is linked to your store. In addition, you can
easily insert variables to add store contact information to the header.

Email Templates

Process Overview:
Step 1: Load the Template
Step 2: Customize and Preview the Template
Step 3: Update the Configuration

Step 1: Load the Default Template
1.

On the Admin sidebar, tap Marketing. Then under Communications, choose Email Templates.

Tap Add New Template. Then, do the following:
a.

Under Load default template, in the Template list under Magento_Email, choose
“Header.”

Default Header Template

Magento Commerce User Guide

537

Customizing Email Templates

CHAPTER 29: Email

Tap Load Template.
The HTML code and variables from the template appear in the form.

Step 2: Customize the Template
1.

Under Template Information, do the following:
a.

Enter the Template Name for your custom header.

Enter a Template Subject to help organize the templates. In the grid, the list of templates
can be sorted and filtered by the Subject column.

Header Template Information
c.

In the Template Content box, modify the HTML as needed.
When working in the template code, be careful not to overwrite anything that is enclosed in
double braces.

To insert a variable, position the cursor in the code where you want the variable to appear,
and tap Insert Variable. Then, choose the variable that you want to insert.
When a variable is selected, a markup tag for the variable is inserted in the code.

Insert Variable

538

Magento Commerce User Guide

CHAPTER 29: Email

Customizing Email Templates

Although the Store Contact variables are the ones most often included in the header, you
can enter the code for any system or custom variable directly into the template.
e.
2.

If you need to make any CSS declarations, enter the styles in the Template Styles box.

When you are ready to review your work, tap Preview Template. Then, make adjustments to the
template as needed.

When complete, tap Save Template.
Your custom header now appears in the list of available Email templates.

Step 3: Update the Configuration
1.

On the Admin sidebar, tap Content. Then under Design, choose Configuration.

In the grid, find the store view that you want to configure. Then in the Action column, click
Edit.

Scroll down and expand

the Transactional Emails section.

Choose the Header Template that is used as the default for email notifications.

When complete, tap Save Config.

Transactional Emails

Field Descriptions
FIELD

DESCRIPTION

LOAD DEFAULT TEMPLATE
Template

Lists the selection of available templates, and identifies the template
to be customized.

TEMPLATE INFORMATION

Magento Commerce User Guide

539

Customizing Email Templates

CHAPTER 29: Email

Field Descriptions (cont.)
FIELD
Template Name
Insert Variable

540

DESCRIPTION
The name of your custom template.
Inserts a Store Contact Information variable into the template at the
cursor location.

Template Subject

The Template Subject appears in the Subject column, and can be
used to sort and filter the templates in the list.

Template Content

The content of the template in HTML.

Template Styles

Any CSS style declarations that are needed to format the template
header can be entered in the Template Styles box.

Magento Commerce User Guide

CHAPTER 29: Email

Customizing Email Templates

Footer Template
The email template footer contains the closing and signature line of the email message. You can
change the closing to fit your style, and add additional information, such as the company
name and address below your name.

Email Templates

Process Overview:
Step 1: Load the Default Template
Step 2: Customize and Preview the Template
Step 3: Update the Configuration

Step 1: Load the Default Template
1.

On the Admin sidebar, tap Marketing. Then under Communications, choose Email Templates.

Tap Add New Template. Then, do the following:
a.

Under Load default template, in the Template list under Magento_Email, choose “Footer.”

Tap Load Template.

Default Footer Template

Step 2: Customize and Preview the Template
1.

Enter the Template Name for your custom footer.

Enter a Template Subject to help organize the templates. In the grid, the templates can be
sorted and filtered by the Subject column.

Magento Commerce User Guide

541

Customizing Email Templates

CHAPTER 29: Email

Footer Template Information
3.

In the Template Content box, modify the HTML as needed.
When working in the template code, be careful not to overwrite anything that is enclosed in double
braces.

To insert a variable, position the cursor in the code where you want the variable to appear, and
tap Insert Variable. Then, choose the variable that you want to insert.
When a variable is selected, a markup tag for the variable is inserted in the code.

Insert Variable
Although the Store Contact variables are the ones most often included in the footer, you can
enter the code for any system or custom variable directly into the template.
5.

542

If you need to make any CSS declarations, enter the styles in the Template Styles box.

Magento Commerce User Guide

CHAPTER 29: Email

Customizing Email Templates

Step 3: Update the Configuration
1.

On the Admin sidebar, tap Content. Then under Design, choose Configuration.

In the grid, find the store view that you want to configure. Then in the Action column, click
Edit.

Scroll down and expand

the Transactional Emails section.

Choose the Footer Template that is used as the default for email notifications.

When complete, tap Save Config.

Transactional Emails

Field Descriptions
FIELD

DESCRIPTION

LOAD DEFAULT TEMPLATE
Template

Lists the selection of available templates, and identifies the template
to be customized.

TEMPLATE INFORMATION
Template Name
Insert Variable

The name of your custom template.
Inserts a Store Contact Information variable into the template at the
cursor location.

Template Subject

The Template Subject appears in the Subject column, and can be
used to sort and filter the templates in the list.

Template Content

The content of the template in HTML.

Template Styles

Any CSS style declarations that are needed to format the template
footer can be entered in the Template Styles box.

Magento Commerce User Guide

543

Customizing Email Templates

CHAPTER 29: Email

Message Templates
The process of customizing the body of each message is the same as the customizing the header
or footer. The only difference is that there is a different message template for each activity or
event that triggers a notification. You can use the templates as they are, or customize them to
match your voice and brand. In addition to the template text, there's a wide selection of
variables that can be incorporated into the template.

Process Overview:
Step 1: Load the Default Template
Step 2: Customize the Template
Step 4: Update the Configuration
Step 5: Preview and Save

Step 1: Load the Default Template
1.

On the Admin sidebar, tap Marketing. Then under Communications, choose Email Templates.

Tap Add New Template. Then, do the following:
a.

Under Load default template, in the Template list, choose the template that you want to
customize.

Tap Load Template.

Default Message Template

Step 2: Customize the Template
1.

In the Template Name field, enter a name for your custom template.

By default, the Template Subject contains the first line of the message, which is the
salutation. You can leave it as is, or enter something more descriptive.

Take note of the Currently Used For path to the template configuration. You will later follow
this path to update the configuration.

544

Magento Commerce User Guide

CHAPTER 29: Email

Customizing Email Templates

Message Template Information
4.

In the Template Content box, modify the HTML as needed. The content consists of a
combination of HTML tags, CSS directives, variables, and text.
When working in the template code, be careful not to accidentally type over the code that is
enclosed in double braces.

Template Message Content
5.

To insert a variable, position the cursor in the code where you want the variable to appear, and
tap Insert Variable. Then, choose the variable that you want to insert.
When a variable is selected, a markup tag for the variable is inserted in the code.

Insert Variable
In addition to the Store Contact variables, the list includes the Customer Account URL,
Customer Email, and Customer Name. However, you are not limited to the variables in this
list. You can enter the code for any system or custom variable directly into the template.
6.

If you need to make any CSS declarations, enter the styles in the Template Styles box.

Magento Commerce User Guide

545

Customizing Email Templates

CHAPTER 29: Email

Step 3: Update the Configuration
1.

In the breadcrumb trail at the top of the Template Information section, find the following
information, as it relates to your template. In this example the template configuration is
located on the Customer Configuration page, in the Create New Account Options section, and
in the Default Welcome Email field.
Page

Customer Configuration

Section

Create New Account Options

Field

Default Welcome Email

Tap the link to open the template configuration page.

Expand

the section. Then, find the field for the email template that you customized, and

specify the new template as the default.

Welcome Email Configuration

Step 4: Preview and Save the Template
1.

When you are ready to review your work, tap Preview Template. Then, make adjustments to the
template as needed.

When complete, tap Save Template.
Your custom template is now available in the list of Email templates.

546

Magento Commerce User Guide

CHAPTER 29: Email

Customizing Email Templates

Field Descriptions
FIELD

DESCRIPTION

LOAD DEFAULT TEMPLATE
Template

Lists the selection of available templates, and identifies the template
to be customized.

TEMPLATE INFORMATION
Template Name
Insert Variable

The name of your custom template.
Inserts a variable into the template at the cursor location.

Template Subject

The Template Subject appears in the Subject column, and can be
used to sort and filter the templates in the list.

Template Content

The content of the template in HTML.

Template Styles

Any CSS style declarations that are needed to format the template
can be entered in the Template Styles box.

Magento Commerce User Guide

547

548

Magento Commerce User Guide

CHAPTER 30:

Email Reminders
The purpose of an email reminder is encourage people who have visited your store to take
advantage of a promotion and make a purchase. Email reminders can be automatically sent to
customers when a specific set of conditions is met. For example, you might send a reminder to
customers who have added something to their cart or wishlist, but have not yet made a
purchase. You can use email reminders to encourage customers to return to your store, and
include a coupon code as an incentive. Coupon codes can be automatically generated for each
batch of email reminders, to give you control over the offers that are associated with each
batch.
Email reminders can be triggered after a certain number of days have passed since a cart was
abandoned, or for any other condition you want to define, such as total cart value, quantity,
items in cart, and so on.

Email Reminders

Magento Commerce User Guide

549

Creating Email Reminders

CHAPTER 30: Email Reminders

Creating Email Reminders
Before setting up an email reminder rule, you must first set up a cart price rule to define the
promotion that is being offered. Rule conditions that trigger an email reminder can be based on
cart properties, wishlist properties, or both.
Email reminders might promote a cart price rule with, or without, a coupon. A cart price rule that
defines an auto-generated coupon generates a random coupon code for each customer.

To create an email reminder:
1.

On the Admin sidebar, tap Marketing. Then under Communications, choose Email Reminder
Rules.

In the upper-right corner, tap Add New Rule.

Complete the Rule Information, as follows:

Rule Information

550

Enter a Rule Name to identify the rule internally.

Enter a brief Description of the rule.

To choose the Cart Price Rule promotion that this reminder is to advertise, tap Select
Rule…. Then, select the rule.

Magento Commerce User Guide

CHAPTER 30: Email Reminders

Creating Email Reminders

Select Cart Rule
d.

If you want the rule to go into effect immediately, set Status to “Active.”

To set up a date range for the rule to be active, enter the From and To dates. You can also
).
choose the date from the Calendar (

To send the reminder more than once, enter the number of days before the next email blast
in the Repeat Schedule field.
To repeat the reminder multiple times, separate the number of days with a comma. For
example, enter “7” to trigger the rule again in seven days; enter “7,14” to trigger the rule in
seven days, and again fourteen days later.

In the panel on the left, choose Conditions. At least one condition must be defined for the rule.
The process is similar to building a catalog price rule.

Conditions
a.

Tap Add (

) to display the list of options. Then, choose one of the following conditions:

Wish List

Shopping Cart

Complete the condition to describe the scenario that triggers the email reminder.

Magento Commerce User Guide

551

Creating Email Reminders

CHAPTER 30: Email Reminders

Completed Condition
5.

In the panel on the left, choose Emails and Labels

Email and Labels
6.

In the Email Templates section, choose the email template to be used for each website and
store view in your store hierarchy.
If you don’t want to send the reminder email to customers of a store view, leave the value “Not
Selected.”

In the Default Titles and Description section, do the following:
a.

Enter the Rule Title for All Store Views.
This value can be incorporated into email templates by using the promotion_name variable.

552

Magento Commerce User Guide

CHAPTER 30: Email Reminders

Creating Email Reminders

Enter the Rule Description for All Store Views.

Default Titles and Description
c.

In the Titles and Descriptions Per Store View section, enter the Rule Title and Description
for the Default Store View. For multiple store views, enter the appropriate title and
description for each.
The description can be incorporated into email templates by using the promotion_description
variable.

Titles and Description per Store View
8.

When complete, tap Save.

Magento Commerce User Guide

553

Creating Email Reminders

CHAPTER 30: Email Reminders

Trigger Conditions
SOURCE
Wish List

TRIGGER
Number of days abandoned
Sharing
Number of items
Specific items

Shopping Cart

Number of days abandoned
Specific coupon code applied
Line items quantity
Items quantity
Total
Virtual items
Specific Items

Field Descriptions
FIELD

DESCRIPTION

RULE INFORMATION
Rule Name

The name of the automated reminder rule identifies the rule internally.

Description

A description of the rule for internal reference.

Shopping Cart Price Rule

The shopping cart rule that is associated with this email reminder.
Reminder emails can promote a shopping cart price rule with or
without coupon. If a shopping cart price rule includes an autogenerated coupon, the reminder rule will generate a random, unique
coupon code for each customer.

Assigned to Website

The websites to receive automated reminder emails based on this
rule.

Status

Activates the rule. If status is inactive, then all other settings are
ignored, and the rule is not triggered.
Options: Active / Inactive

554

From Date

The starting date for this automated reminder rule. If no date is
specified, the rule becomes active immediately.

To Date

The ending date for this automated reminder rule. If no date is
specified, the rule becomes active indefinitely.

Magento Commerce User Guide

CHAPTER 30: Email Reminders

Creating Email Reminders

Field Descriptions (cont.)
FIELD
Repeat Schedule

DESCRIPTION
The number of days before the rule is triggered, and the reminder
email sent again, provided the conditions are met.
To trigger the rule more than once, enter the number of days before
the next email blast, separated by a comma. For example, enter “7” to
have the rule triggered again seven days later; enter “7,14” to have
the rule triggered in seven days, and again fourteen days later.

EMAIL AND LABELS
Email Templates

Determines the email template to be used for each store view.

Rule Title for All Store
Views

Determines the title of the rule for each store view.

Rule Description for All
Store Views

Determines the description of the rule for each store view.

Magento Commerce User Guide

555

Configuring Email Reminders

CHAPTER 30: Email Reminders

Configuring Email Reminders
Email reminder rules can be sent at regular intervals by the minute, hour, or day. The
configuration determines how many emails are sent in a batch, and the store identity that
appears as the sender of the message.

To configure email reminders:
1.

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

In the panel on the left, under Customers, choose Promotions.

Expand

the Automated Email Reminder Rules section. Then, do the following:

Automated Email Reminder Rules

556

Magento Commerce User Guide

CHAPTER 30: Email Reminders

Configuring Email Reminders

Set Enable Reminder Emails to “Yes.”

To set how often Magento checks for new customers who qualify automated email
reminders, set Frequency to one of the following:
l

Minute Intervals

Hourly

Daily

Set the appropriate Interval, based on the Frequency setting. Then, set Start Time to the
hour, minute, and second the email is sent, based on a 24-hour clock.

To limit the number of emails that can be sent in a batch, enter the number in the
Maximum Emails per One Run field.

To avoid repeated attempts to send failed email, enter the maximum number of attempts
in the Email Send Failure Threshold field.

Set Reminder Email Sender to the store contact that appears as the sender of the
reminder email.

When complete, tap Save Config.

Magento Commerce User Guide

557

Email Reminder Templates

CHAPTER 30: Email Reminders

Email Reminder Templates
The default email reminder template can be customized, and additional templates created for
different promotions. Email reminders have a selection of specific variables that can be
incorporated into the message. The information in these variables is determined by the email
reminder rule that you set up, and by the cart price rule that is associated with the coupon.
The Insert Variable button can be used to insert the markup tag with the variable into the
template. To learn more, see: Email Templates.

Preview of Promotion Reminder

To customize an email reminder template:
1.

On the Admin sidebar, tap Marketing. Then under Communications, choose Email Templates.

Tap Add New Template. Then, do the following:
a.

In the Template list under Magento_Reminder, choose the Promotion
Notification/Reminder template.

b.
3.

558

Tap Load Template.

Follow the standard instructions to customize the template.

Magento Commerce User Guide

CHAPTER 30: Email Reminders

Email Reminder Templates

Email Reminder Variables
VARIABLE

MARKUP TAG

Coupon Code

Coupon Usage Limit

Coupon Usage Per
Customer

Customer Account URL

Customer Name

Email Footer Template

Email Header Template

Email Logo Image Alt

Email Logo Image URL

Promotion Description

Promotion Name

Store Name

Store URL

Magento Commerce User Guide

559

Configuring Email Communications

CHAPTER 30: Email Reminders

Configuring Email Communications
The Mail Sending Settings give you the ability to route returned email or replies to email to a
specific address. Also, if your store is running on a Windows server, you can verify the host and
port settings.
Security Notice! We recommend that all merchants immediately set their mail sending
configuration to protect against a recently identified potential remote code execution exploit. Until
this issue is resolved, we highly recommend that you avoid using Sendmail for email
communications. In the Mail Sending Settings, make sure that Set Return Path is set to "No." To
learn more, see the Magento Security Center posting.

Mail Sending Settings

560

Magento Commerce User Guide

CHAPTER 30: Email Reminders

Configuring Email Communications

To configure email communications:
1.

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

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

Expand
a.

If necessary, set Disable Email Communications to “No.”

If running on a Windows server, verify the following settings:

the Mail Sending Settings section. Then, do the following:

Host

localhost

Port (25)

Until the current security issue is resolved, we highly recommend that you set Set Return
Path to "No."
No

(Recommended Security Measure) Routes returned email to the
default store email address.

Yes

Routes returned email to the default store email address.

Specified

Routes returned email to the email address specified in the Return
Path Email field.

In the panel on the left under Sales, choose Sales Emails. Then, do the following:
a.

Expand the General Settings section.

Set Asynchronous sending to “Enable.”

General Settings
5.

When complete, tap Save Config.

Magento Commerce User Guide

561

562

Magento Commerce User Guide

CHAPTER 31:

Marketing Automation
Marketing Automation is a cloud-based tool powered by dotmailer that produces professional,
personalized email communications and reports using data from your Magento store.
Dotmailer gives you the ability to:
l

Create customized email communications

Import contacts

Schedule campaigns

Create rules to add logic and automate your campaigns

Changes in the Latest Release
Release 2.2.4
New Features
l

Support for custom transactional email templates

Transactional email can now be set at store level

Validation for CSV files deleted during cron jobs

Abandoned Cart report

Magento Commerce User Guide

563

564

Magento Commerce User Guide

Creating a Campaign

Creating a Campaign
Dotmailer includes a large selection of professionally-designed email and newsletter templates
for a variety of promotions and events. You can use one of their prepared templates, or design
your own.
In this example, we will rework a prepared template for the Magento Luma demo store. The
purpose of the example is to introduce you to different types of content building blocks and
editing techniques.

Step 1: Create a Campaign
1.

On the Welcome page, click create a quick tester campaign. Notice that the Campaigns option
is now active in the main menu, and the email icon is highlighted in the sidebar.

Hover over the thumbnail image, to show the Select and Preview buttons. Then, do the
following:
) to see a mockup of the template.

Tap Preview (

Tap Select to choose the template for your campaign.

Template Preview
3.

Enter a Campaign name, and accept the default Campaign location as the folder where the
campaign will be saved. Then, tap Continue.

Magento Commerce User Guide

565

Creating a Campaign

Campaign Name
4.

To complete the setup of your simple test campaign, do the following:
a.

Enter a Subject line for the email. Subject lines can be personalized for each recipient by
using a placeholder. To learn how to add data fields, see Step 5.

Enter your Friendly from name that will appear in the header instead of your email
address.

In the From address field, choose the email address that is to appear as the sender of the
message. The list includes all email addresses that are associated with your account.

(Optional) All replies to your campaign are automatically stored in your dotmailer
account. If you would like to send each reply to specific individuals, enter each
Forwarding address, separated by comma.

(Optional) In the Campaign tags field, enter as many tags as needed to filter your
campaigns for reporting purposes. Press the Tab key to separate multiple tags.

Campaign Details
As you type, the Preview section shows how your message will appear in the inbox of each
recipient. Notice how your “Friendly from name” is used to distinguish it from other email.

566

Magento Commerce User Guide

Creating a Campaign

Campaign Preview
5.

Above the Campaign details section, click the Campaign settings tab. For this test campaign,
we will use the default settings. Tap Save.

Campaign Settings

Step 2: Edit the Campaign Content
1.

Before you get started, it’s important to know that you can save your work at any time. If you
log out and continue your work later, you can find the most recently saved version of your
campaign in the menu under Campaigns > My Campaigns. To continue editing, find your
campaign in the list, and click its name.

The content editor uses building blocks to represent each type of content that can be added to
the template. The Build tab of the sidebar on the left displays the selection of building blocks
that you can drag and drop into position. For this example, we will replace the sample content
in the template with content of our own.

The following instructions walk you through each section of the template, and introduce
editing and formatting tools, and techniques.

Complete the Preheader (Optional)
The space above the header can be used to enter a brief message. Click the text box, and enter
the text that you want to appear above the header.

Magento Commerce User Guide

567

Creating a Campaign

Preheader Text

Upload Your Logo
1.

On the Build tab, choose Images. To upload your logo, click Manage. Then, click here to
upload the image. Choose the image that you want to upload. Image manager is similar
to Media Storage, and is used to organize the images that are available in your dotmailer
account.
It is recommended to limit the combined size of all images in a campaign to less than 100kb.

Image Manager
2.

To organize your images, click New folder. Then, enter a name for the untitled folder. The
new folder is nested below the original parent folder.
You can create as many folders as needed, and organize them any way you want. Over
time, you will upload many images to your account, and it’s important to organize them
in a way that makes them easy to find.

In the sidebar, click the parent folder that contains the logo that you uploaded. Then,
drag the image to the new folder. Then, click Close (X) in the upper-right corner to return
to the content editor.

New Folder
4.

The logo that you uploaded appears in the sidebar, where it can be dragged into position.
Drag and drop your logo to replace the placeholder image.

Edit and Format Text
The next section of the template represents your store’s menu. However, it’s actually a building
block with a multi-column layout, similar to a table. The text in each cell can be edited and

568

Magento Commerce User Guide

Creating a Campaign

formatted separately. The Columns building block can be used in many ways to control the
text layout.
1.

Click the menu area, so you can see the multi-column layout. The Columns building
block is located in the sidebar under Layout.

Click each cell and enter the menu options for your store. Then, use the toolbar to change
the font, size, and style of the text, as needed.

Add Links
To link each menu option in the template to your store, do the following:
1.

Open your store In another window, and click the first menu option. Then, copy the full
URL.

In the template, select the text for the first menu option. Then in the toolbar, click the
Hyperlink ( ) tool.

In the Link (URL) field, paste the link that you copied from your store.

If you want to later be able to track how many people click the link, enter a code for that
menu option. Then, tap Insert.

Repeat these steps to link each menu option to your store.

Magento Commerce User Guide

569

Creating a Campaign

Add a Link

Change the Background Color
1.

In the sidebar, choose the Styles tab. Notice that Background layers is set to “Table row
(tr).” In the underlying HTML of the template, the menu background is actually a row in
a table.

In the template, hover over the menu background to highlight the entire row.

In the sidebar under the color picker, enter the hexadecimal code for the background color
of your store’s menu. In the Magento Luma store, the background color of the menu is
#f0f0f0.

Tap Save colour to save the color in the My colors section of the sidebar.

Background Color

570

Magento Commerce User Guide

Creating a Campaign

Replace the Banner
1.

On the Build tab of the sidebar, under Images, click Add Image ( + ).

Choose the banner image that you want to upload. After a moment, the image appears in
the sidebar.

From the sidebar, drag the new banner to replace the placeholder.

Banner

Add Featured Products
Dotmailer gives you the ability to dynamically incorporate data from your store into a
template. However, for this simple example, product data is added as static images with links
to your store. Although this template includes two rows of products, only one row is included
to reduce the number of images. The “Shop Now” blocks was also removed from the template,
because it didn’t introduce any new editing techniques.
1.

Upload the image for each featured product.

Edit the text, as needed, for each featured product.
The price can be updated as any other text field. To change the currency, simply type a
dollar sign, or any other currency symbol that is needed.

To update the product buttons, do the following:
a.

Click the button to display its settings appear in the sidebar.

Paste the Button URL for the corresponding product detail page. Then, update the
color and formatting as needed.

Repeat these steps for each product button.

Magento Commerce User Guide

571

Creating a Campaign

Button Settings

Add Social Media Links
1.

In the template, scroll down to the social media placeholder.

In the building blocks sidebar under Tools, drag the Social Links building block into
position in the template. The empty building block appears either above or below the
placeholder.

Social Media Building Block
3.

572

Click the empty building block to open the Social links settings. Then, do the following:
a.

Mark the checkbox of each social link that you want to include in the template.

For each social link, paste the URL of your company profile page.

When complete, tap Apply.

Magento Commerce User Guide

Creating a Campaign

Social Links
4.

To adjust the format and spacing of the buttons, click anywhere in the social links
building block. You can experiment with these settings to adjust the size and format of
the buttons. To make your buttons look like the template, do the following:
a.

In the sidebar under Label position, set Horizontal alignment to “Center.”

Under Spacing, set Horizontal to “15px” and Vertical to “None.”

To delete the placeholder social media links, click Close ( X ) in the upper-right
corner.

Formatting the Social Media Links

Magento Commerce User Guide

573

Creating a Campaign

Complete the Footer
The information at the bottom of the template is important, and in many countries is required
by law. You must provide a mechanism for recipients to unsubscribe, and clearly identify the
sender of the email.

Footer Information
1.

Do not change the “Unsubscribe” and “Forward this email “links, because they contain
code that manages each operation. However, you can format the text if you like.

Click the Footer info text block, and enter your company information, including your
registration number, if applicable, so recipients know who has sent the email.

Click the Company registered address text block, and complete the information. In this
example, we added a link to the Contact Us page on our site.

The template is now fully customized for your store. Tap Save.

Step 3: Send a Test
1.

To test your campaign, tap Test send in the template header.

To send the test email to yourself, mark the checkbox of the email address that is associated
with your dotmailer account.

574

To add more recipients, click Add another email address. Then, do the following:
a.

Enter the Email address, First name and Last name of the recipient. Then, tap Add.

Repeat these steps to add as many recipients as you want.

Mark the checkbox of each additional recipient that is to receive the test email.

When you are ready to send the test campaign, tap Test Send. If prompted, tap Save and send.

Magento Commerce User Guide

Creating a Campaign

Send a Test of Your Email Campaign
5.

Check your email to see how it looks!

Step 4: Review the Summary Report
The Summary Report validates the campaign, lists any errors that are found, and suggests
areas for improvement.
In addition to the Summary Report, the Reports menu has a selection of Marketing
Automation reports.
1.

On the Campaigns menu, choose My Campaigns.

My Campaigns
2.

In the record for your test campaign, click Summary (

) to view the summary report.

This report says that the quality of the text content needs to be improved.

Magento Commerce User Guide

575

Creating a Campaign

Summary Report

Step 5: Add a Personal Note
In this step, we’ll add a personal note with a link, and then do another test run.
1.

576

Drag a text building block from the sidebar to the template. Then, do the following:
a.

Enter the word “Hi” to begin the greeting.

In the toolbar at the top of the template, tap Data Fields.

In the list of data fields, choose First name.

Complete the note, and add a link. Then, Save your work.

Magento Commerce User Guide

Creating a Campaign

Personalized Greeting

Step 6: Preview the Campaign
1.

In the button bar at the top of the workspace, tap Preview.

Desktop Preview
2.

In the upper-right corner, click Phone (

), and choose Portrait.to see how the message looks

on a mobile device.

Magento Commerce User Guide

577

Creating a Campaign

Phone Preview
3.

578

Close the preview.

Magento Commerce User Guide

Creating a Campaign

Import Your Contacts
Your dotmailer account is synced with your store, and maintains up-to-date address books of
your customers, guests, and subscribers.

To view your contacts:
1.

On the dotmailer menu, choose Campaigns > My Campaigns.
The contact list includes customer, guest and subscription data that is automatically imported
from your store.

Address Books
2.

To view the import report, click the Notifications bell ( ) near the bottom of the sidebar.
Whenever the data is updated, the number of updated imports appears in red.
There are two recent imports. available. Although this list doesn’t tell you what they are, one is
your list of customers, and the other is your list of subscribers.

In the first message, click import report.

Notifications Report
4.

In the Notifications list, click import report.

Magento Commerce User Guide

579

Creating a Campaign

The Contacts import report includes a summary of all subscribers as well as duplicates,
failures, soft and hard bounces, invalid email addresses, and those who have unsubscribed, or
have been blocked, globally suppressed, or otherwise blacklisted. You can use this report to help
keep your data clean.

Import Report
5.

After reading the report, tap Go to address book. This import contains your subscribers, and
the other one contains your customers.

Subscriber Address Book
6.

In the main menu, return to Contacts > My Contacts. This time, click the Magento_
Customers address book.

580

Magento Commerce User Guide

Creating a Campaign

Customer Address Book Actions
7.

To see all the things you can do with your customer data from dotmailer, click More actions.
Using what we’ve covered so far, you should be able to create a newsletter campaign and send
it to your list of subscribers.

Magento Commerce User Guide

581

Creating a Campaign

Schedule Your Campaign
You now have a campaign and a list of customers. The next step is to schedule the campaign,
and send it on its way.

To schedule a campaign:
1.

On the dotmailer menu, choose Campaigns > My Campaigns.

Send Your Campaign
2.

Find your test campaign in the list, and in the last column, click Send (

). Then, do the

following:
a.

With Select address books or queries marked under step 1, choose the address book that
is the target of the campaign. For this test campaign, mark the Magento_Customers
checkbox.

Choose the Address Book
b.

582

Complete the options to select when you want to send the campaign.

Magento Commerce User Guide

Creating a Campaign

Schedule the Campaign
c.

If you want to remail the campaign, select “Yes.” By default, campaigns are not sent a
second time.

Remail Options
d.

Tap Save & continue.

Take one last look at the report before you send the campaign. Then, scroll down to the
bottom and tap Send campaign immediately. When prompted to confirm, tap Send.

Send Immediately
3.

Congratulations! Your campaign is on its way!

Your Campaign Is On Its Way
4.

To see the results, tap Check out the campaign report.

Magento Commerce User Guide

583

Creating a Campaign

Campaign Report
5.

On the menu, choose Dashboard to see your progress. You have completed the first four tasks,
and a notification is waiting for you at the bottom of the sidebar.

Dashboard

584

Magento Commerce User Guide

Creating a Campaign

Automate Your Campaign
dotmailer includes three prepared automation templates, plus a blank template that you can
use to create custom programs. When setting up an automated campaign, you can use existing
campaigns, or create placeholders for new ones. This example uses a prepared template to
create a simple Welcome campaign with a follow-up message that is sent a week later.

Choose a Template

Step 1: Create a New Program
1.

On the dotmailer menu, choose Automation. Then, tap New program.

My Programs
2.

To choose the Welcome program template, hover over the tile and tap Select. Then, do the
following:

When prompted, enter the Program name. For now, you can accept the Programs folder
location. Then, tap Continue.
The Edit program workspace includes a flowchart of the program logic. Each box in the
diagram is a node. The panel on the left has a selection of nodes that can be added to the
program. You can create sophisticated automations using these simple building blocks.

Magento Commerce User Guide

585

Creating a Campaign

Edit Program

Step 2: Complete the Start Options
1.

In the flowchart, click the Start node.
The panel on the left provides an overview of the process, and walks you through each step.

Start
2.

586

Under 1. Enrolment scheduling, tap Set enrolment schedule.
a.

By default, the Welcome program is scheduled to run Daily at 11:00 AM. ‘

For this example, accept the default scheduling. Then, tap Apply.

Magento Commerce User Guide

Creating a Campaign

Enrollment Scheduling
3.

Under 2. Enrolment rule, tap Trigger from contact date field.
The options describe the event that triggers the rule. For this program, the welcome email
campaign will be triggered whenever a new account is created.
Complete the trigger description as follows:

Trigger from Date

Accept the option to Trigger from contact date field.

To determine when contacts are added to the program, accept the default entry, default
entry 0 days after.

Set the Date field to ACCOUNT_CREATED_DATE.

When complete, tap Apply.

Under 3. Enrolment limits, tap Set enrolment limits. Then, do the following:

Magento Commerce User Guide

587

Creating a Campaign

For this program, accept the default option to re-enrol contacts every day they meet the
start criteria.
This option ensures that every person who signs up for a new account will be included in
the next scheduled mailing.

b.
5.

Tap Apply.

Review the options in the Start panel. Then, tap Apply.

Enrolment Limits

Step 3: Choose the Campaign
1.

In the flowchart, click the Campaign node. Then, do the following:
a.

To choose an existing campaign, tap Select campaign.

Send Campaign

588

Magento Commerce User Guide

Creating a Campaign

Tap Create campaign.

Enter the Campaign name, and accept the Campaigns folder as the default Campaigns
location.

Tap Create.

Create Campaign
2.

Tap Apply.
The name of the new campaign appears in the Campaign box.

Step 4: Set the Delay
You can add a delay to the program to wait a number of days, or until a specific time of day,
before sending a follow-up campaign.
1.

In the flowchart, click the Delay node.

Accept the default Wait period of 7 days. Then, tap Apply.

Magento Commerce User Guide

589

Creating a Campaign

Delay

Step 5: Create a Follow-Up Campaign
1.

In the flowchart, click the next Campaign node.

Enter the Campaign name, and accept the Campaigns folder as the default Campaigns
location.

Tap Create. Then, tap Apply.
Your follow-up campaign is added to the workflow.

Step 6: Define the End of the Program
All programs have defined starting and end points.

590

Click the End node.

For this example, you can accept the default name of the end point.

Tap Apply.

Magento Commerce User Guide

Creating a Campaign

Step 7: Edit Your Campaign
If you added placeholders for new campaigns, you still need to complete the definition of each
campaign. However, if you used existing campaigns, your Welcome program is good to go!
1.

On the Automation menu, choose Trigger campaign content.

Find the campaign in the list, and click Edit (

My Campaigns

Magento Commerce User Guide

591

Exclusion Rules

Exclusion Rules
An exclusion rule can be created to exclude abandoned cart and review emails from being sent
under certain conditions. A rule describes the conditions that must be met to trigger the action.
For example, a rule might exclude all abandoned carts with a subtotal that is equal or less than
10. To learn more, see Exclusion Rules in the dotmailer help centre.

Dotmailer Exclusion Rules

To add a new rule:
1.

On the Admin sidebar, choose Marketing. Under Marketing Automation, choose Exclusion
Rules. Then, tap Add New Rule.

592

On the Rule Information tab, do the following:
a.

Enter a descriptive Rule Name.

Set Rule Type to one of the following:
l

Abandoned Cart Exclusion Rule

Review Email Exclusion Rule

Leave Status set to “Inactive” for now. You can later change it to “Active.”

Choose the Websites where the rule applies.

Magento Commerce User Guide

Exclusion Rules

Rule Information
3.

On the Conditions tab, set Conditions Combination Match to one of the following:
l

ANY

ALL

Exclusion Rule Conditions

Magento Commerce User Guide

593

Exclusion Rules

Tap Add New Condition. Then, do the following:
a.

Choose the Attribute that is the subject of the conditional statement.

Under Condition, choose the operator.

Enter the Value that is needed to complete the condition.

Conditions
d.
5.

594

For multiple conditions, tap Add New Condition. Then, repeat these steps.

When complete, tap Save.

Magento Commerce User Guide

Automation Studio

Automation Studio
The Automation Studio option in the Marketing menu is a shortcut to the Dotmailer Developer
configuration settings.

Dotmailer Developer Configuration

To access Automation Studio:
On the Admin sidebar, choose Marketing. Then under Marketing Automation, choose
Automation Studio.

Magento Commerce User Guide

595

596

Magento Commerce User Guide

CHAPTER 32:

Sales Documents
In addition to the email messages related to a sale, your store generates invoices, packing slips,
and credit memos in both HTML and PDF formats. Before your store goes live, make sure to
update these documents with your logo and store address. You can customize the address
format, and also include additional information for reference.
l

Invoices

Packing Slips

Credit Memos

Magento Commerce User Guide

597

Preparing Your Invoice Logo

CHAPTER 32: Sales Documents

Preparing Your Invoice Logo
Unlike the logo images used in HTML, the logo for PDF invoices and other sales documents can
be a high-resolution, 300 dot per inch (DPI) image. However, the image must be rendered to fit
a space that is 200 pixels wide by 50 pixels high. Be careful to preserve the aspect ratio when
you resize the logo. Resize the logo to fit the height, and don’t worry about any unused space to
the right.

200 x 50 pixels
One way to resize your logo to fit the required size is to create a new, blank image with the
correct dimensions. Then, paste your logo image and resize it to fit the height. With most
image editing programs, you can either scale it by a percentage to preserve the aspect ratio, or
hold down the Shift key and manually resize the image.

To configure invoices and packing slips:
1.

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

In the panel on the left, under Sales, choose Sales.

Expand

the Invoice and Packing Slip Design section. Then, do the following:

Invoice and Packing Slip Design
a.

To upload the Logo for PDF Print-outs, tap Choose File. Find the logo that you have
prepared, and tap Open.

598

To upload the Logo for HTML Print View,tap Choose File. Find the logo that you have
prepared, and tap Open.

Magento Commerce User Guide

CHAPTER 32: Sales Documents

Preparing Your Invoice Logo

Enter your address as you want it to appear on invoices and packing slips.

When complete, tap Save Config.
For reference, a thumbnail of the uploaded image appears before each field. Don’t worry if the
thumbnail appears distorted. The proportion of the logo will be correct on the invoice.

To replace an image:
1.

Tap Choose File and choose a different logo file.

Mark the Delete Image checkbox for the image you want to replace.

Tap Save Config.

Image Formats
FORMAT

REQUIREMENTS

PDF
File Format

JPG (JPEG), PNG, TIF (TIFF)

Image Size

200 pixels wide x 50 pixels high

Resolution

300 DPI recommended

HTML
File Format

JPG (JPEG), PNG, GIF

Image Size

Determined by theme.

Resolution

72 or 96 DPI

Magento Commerce User Guide

599

Adding Reference IDs to Header

CHAPTER 32: Sales Documents

Adding Reference IDs to Header
The Order ID and customer IP address can be included in the header of sales documents that
accompany an order. By default, both the Order ID and customer IP address appear in the
header of invoices, shipment packing slips, and credit memos.

PDF Print-outs

To change the Order ID settting:
1.

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

In the panel on the left under Sales, choose PDF Print-outs.

Expand

the Invoice section.

Invoice

600

Set Display Order ID in Header according to your preference.

Repeat for the Shipment and Credit Memo sections.

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 32: Sales Documents

Adding Reference IDs to Header

To change the customer IP address setting:
1.

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

In the panel on the left under Sales, choose Sales.

Expand

the General section.

General
4.

Set Hide Customer IP to your preference.

When complete, tap Save Config.

Magento Commerce User Guide

601

Customer Address Templates

CHAPTER 32: Sales Documents

Customer Address Templates
You can modify the template that determines the format of customer billing and shipping
addresses that appear on printed invoices, shipments, and refunds, as well as in the address
book of the customer account.

Example 1: Text Templates
For Text, Text One Line, HTML and PDF Address Templates
{{depend address attribute code}} a space, a character, or UI label
{{/depend}};
{{if address attribute code}}{{var address attribute code}} a space, a
character, or UI label
{{/if}}

Example 2: JavaScript Template
For JavaScript Address Template
#{address attribute code} or User Interface label #{address attribute code}

Address Templates

602

Magento Commerce User Guide

CHAPTER 32: Sales Documents

Customer Address Templates

To change the order of address fields:
1.

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

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

Expand

the Address Templates section. The section includes a separate set of formatting

instructions for each of the following:
l

Text

Text One Line

HTML

PDF

Edit each template as needed, using the examples for reference.

When complete, tap Save Config.

Magento Commerce User Guide

603

604

Magento Commerce User Guide

CHAPTER 33:

Newsletters
Publishing a regular newsletter is considered to be one of the most powerful and affordable
marketing tools available. Magento Commerce gives you the ability to publish and distribute
newsletters to customers who have subscribed, plus tools to produce your newsletter, build and
manage your list of subscribers, develop content, and drive traffic to your store. You can also
use Page Hierarchy to create an archive of past issues.
You can add capabilities by integrating your Magento installation with a third-party newsletter
service provider and by adding extensions. To learn more, see Magento Connect.

Magento Commerce User Guide

605

Configuring Newsletters

CHAPTER 33: Newsletters

Configuring Newsletters
The first step in creating newsletters is to configure the newsletter settings for your site. You
can require customers to click a confirmation link that is sent by email to confirm the
subscription. This double opt-in1, method requires customers to confirm twice that they want
to receive your newsletter, and reduces the possibility that it might be considered to be spam.

To configure subscription options:
1.

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

In the panel on the left under Customers, choose Newsletter.

If necessary, expand

the Subscription Options section. Then, do the following:

Subscription Options

1The process for subscribing email recipients by requiring them to take a secondary step to confirm that they want

to receive emails.

606

Magento Commerce User Guide

CHAPTER 33: Newsletters

Configuring Newsletters

Confirm the email template and sender of the each of the following email messages that
are sent to subscribers:

Success email

Confirmation email

Unsubscribe email

To use the double opt-in process to confirm subscriptions, set Need to Confirm to “Yes.”

To allow people who do not have an account with your store to subscribe to the newsletter,
set Allow Guest Subscription to “Yes.”

When complete, tap Save Config.

Magento Commerce User Guide

607

Newsletter Templates

CHAPTER 33: Newsletters

Newsletter Templates
You can create as many newsletter templates as you need for different purposes. You might
send a weekly product update, a monthly newsletter, or annual holiday newsletter. Newsletter
templates can be prepared with HTML markup, or as plain text. Unlike HTML, plain text
newsletters contain no images, rich text, or formatted links. In the grid, the Template Type
column indicates whether a template is HTML or text.

Newsletter Templates

To create a newsletter template:
1.

On the Admin sidebar, tap Marketing. Then under Communications, choose Newsletter
Template.

To add a new template, click the Add New Template button. Then, do the following:
a.

In the Template Name enter name for internal reference.

In the Template Subject field, describe the purpose of the newsletter.

In the Sender Name field , enter the name of the person who is to appear as the sender of
the newsletter.

In the Sender Email field, enter the email address of the newsletter sender.

Template Information

608

Magento Commerce User Guide

CHAPTER 33: Newsletters

Newsletter Templates

At the Template Content field, tap Show / HIde Editor to display the WYSIWYG editor.
Then, update the content as needed. To learn more, see: Using the Editor.
Do not remove the unsubscribe link at the bottom of the template content. In some
jurisdictions, the link is required by law.

In the Template Styles field, enter the CSS declarations needed to format the content.

Template Information
3.

Tap Preview Template to see how it looks. Then, make any changes that are needed.

When complete, tap Save Template.
After you save a template, a Save As button appears the next time you edit the template. It
can be used to save variations of the template without overwriting the original.

To convert the template to plain text:
1.

At the top of the page, tap Convert to Plain Text. When prompted to confirm, tap OK.

To preview the plain text version of the template, tap Preview Template. The preview opens in a
new browser tab.

To save the plain text version, tap Save Template.

To restore the HTML:
1.

At the top of the page, tap Return HTML Version.

To preview the HTML version of the template, tap Preview Template. The preview opens in a
new browser tab.

To save the HTML version, tap Save Template.

Magento Commerce User Guide

609

Sending Newsletters

CHAPTER 33: Newsletters

Sending Newsletters
To manage the load on the server, newsletters with many subscribers are sent in a queue of
multiple batches. You can check the newsletter queue periodically to check the status, and see
how many have been processed. Any problems that occur during transmission appear on the
Newsletter Problem Report.

Add to Newsletter Queue

To send a newsletter:
1.

On the Admin menu, tap Marketing. Then under Newsletters, choose Newsletter Templates.

In the grid, find the template for the newsletter that is to be sent. Then, set the Action column
to “Queue Newsletter.”

In the Queue Date Start field, select the date that the transmission is to begin from the
calendar (

In the Subscribers From list select each store view that is to be included in the email blast.

Complete the email header information as follows:
a.

Enter a brief description of the newsletter for the Subject line of the email header.

Enter the Sender Name.

In the Sender Email field, enter the email address of the sender.
The default name and email address of the sender is specified in the configuration.

610

Magento Commerce User Guide

CHAPTER 33: Newsletters

Sending Newsletters

Queue Information
6.

If applicable, enter a note in the Message box above the instructions to unsubscribe. Do not
remove the instructions, which are required by law in many jurisdictions.

When complete, tap Save and Resume.
The newsletter appears in the queue waiting to be processed.

Newsletter Queue

To check for problems:
1.

On the Admin menu, tap Reports.

Under Marketing, choose Newsletter Problem Reports.

Magento Commerce User Guide

611

Managing Subscribers

CHAPTER 33: Newsletters

Managing Subscribers
As a best practice you should manage your subscription list on a regular basis, and make sure
to process any requests to unsubscribe. In some jurisdictions, it is required by law that requests
to unsubscribe are processed within a specific period of time.
If you want to use a third-party service to send newsletters, you can export your subscription
list as a CSV or XML file.

To cancel a subscription:
1.

On the Admin sidebar, tap Marketing. Then under Communications, choose Newsletter
Subscribers.

Find the subscriber in the grid. Then, mark the checkbox in the first column.

Set the Action control to “Unsubscribe.” Then, tap Submit.
The status of the record changes to “Unsubscribed.”

Unsubscribe

612

Magento Commerce User Guide

CHAPTER 33: Newsletters

Managing Subscribers

To export the list of subscribers:
1.

From the Newsletter Subscribers list, use the filter controls to include only records with a
Status of “Subscribed,” and for the appropriate website, store, or store view.

Set the Export to control to one of the following:
l

CSV

XML

Tap Export. Then, look for the prompt at the bottom of the screen, and save the file.

Export Newsletter Subscribers

Magento Commerce User Guide

613

614

Magento Commerce User Guide

CHAPTER 34:

RSS Feeds
RSS (Really Simple Syndication) is an XML-based data format that is used to distribute
information online. Your customers can subscribe to your RSS feeds to learn of new products
and promotions. RSS Feeds can also be used to publish your product information to shopping
aggregation sites, and can be included in newsletters.
When RSS feeds are enabled, any additions to products, specials, categories, and coupons are
automatically sent to the subscribers of each feed. A link to all RSS feeds that you publish is in
the footer of your store.
The orange RSS symbol is typically used to identify an RSS feed.

The software that is required to read an RSS feed is called a feed reader1, and allows people to
subscribe to headlines, blogs, podcasts, and much more. Google Reader is one of the many feed
readers that are available online for free.

RSS Feeds

1Software that is used to read syndicated content from RSS feeds.

Magento Commerce User Guide

615

CHAPTER 34: RSS Feeds

To set up RSS feeds for your store:
1.

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

In the upper-right corner, set Store View to the view(s) where the feeds are to be available. If
prompted to confirm, tap OK.

In the panel on the left, under Catalog, choose RSS Feeds.

Expand

the Rss Config section. Then, set Enable RSS to “Enable.”

If necessary, clear the Use Website checkbox to change the default value.

RSS Feeds
5.

Expand

the Wish List section. Then, set Enable RSS to “Enable.”

Expand

the Catalog section and set other feeds to “Enable” as needed.

New Products

Special Products

Coupons/Discounts

Top Level Category

Catalog

616

Expand

the Order section. Then, set Customer Order Status Notification to “Enable.”

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 34: RSS Feeds

Types of RSS Feeds
RSS FEED

DESCRIPTION

Wish List

When enabled, an RSS feed link appears at the top of customer wish
list pages. Additionally, the wish list sharing page includes a
checkbox that lets you include a link to the feed from shared wish
lists.

New Products

Publishes notification of new products added to the catalog.

Special Products

Publishes notification of any products with special pricing.

Coupons / Discounts

Publishes notification of any special coupons or discounts that are
available in the store.

Top Level Category

Publishes notification of any change to the top-level category
structure of your catalog, which is reflected in the main menu.

Customer Order Status

Gives customers the ability to track their order status by RSS feed.
When enabled, an RSS feed link appears on the order.

Magento Commerce User Guide

617

618

Magento Commerce User Guide

CHAPTER 35:

Using Variables
Variables are pieces of information that can be created once and used in multiple places, such
as email templates, blocks, and content pages. Your store includes a large number of predefined
variables that can be used to personalize communications. In addition, you can create your
own custom variables.
l

Predefined Variables

Custom Variables

Magento Commerce User Guide

619

Adding Predefined Variables

CHAPTER 35: Using Variables

Adding Predefined Variables
Predefined variables are easy to add to content email templates and content pages to
personalize communications. The selection of available variables depends on the template.

Variables for Contact Form Template

To add a variable to an email template:
1.

On the Admin sidebar, tap Marketing. Then under Communications, choose Email Templates.

Do one of the following:

Load an existing template.

Add a new template.

In the Template Content box, position the insertion point where you want the variable to
appear. Then, tap Insert Variable.

In the list of available variables, choose the one you want to insert into the template.

To preview the template in a new browser window, tap Preview. Then, return to the main
window.

620

When complete, tap Save Template.

Magento Commerce User Guide

CHAPTER 35: Using Variables

Adding Custom Variables

Adding 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.
{{CustomVar code= "my_custom_variable"}}

Custom Variables

To create a custom variable:
1.

On the Admin sidebar, tap System. Then under Other Settings, choose Custom Variables.

Tap Add New Variable.

Enter an identifier in the Variable Code field. Use all lowercase characters, without spaces.

Enter a Variable Name, which is used for internal reference. Then, do one of the following:
l

In the Variable HTML Value text field, enter any content you want to include, using basic
HTML tags. This option allows you to format the value.

In the Variable Plain Value field, enter the variable value as plain text.
You can drag the lower-right corner to make the boxes bigger.

Magento Commerce User Guide

621

Adding Custom Variables

CHAPTER 35: Using Variables

New Custom Variable
5.

622

When complete, tap Save.

Magento Commerce User Guide

CHAPTER 35: Using Variables

Markup Tags

Markup Tags
A markup tag is a directive that contains snippet of code with a relative reference to an object
in your store, such as a variable, URL, image, or block. Markup tags can be used anywhere the
editor is available and incorporated into the HTML of content pages, blocks, email templates,
newsletters, and so on.
Markup tags are enclosed in double, curly braces, and can either be generated by the Widget
tool, or typed directly into HTML content. For example, rather than hard-coding the full path
to a page, you can use a markup tag to represent the store URL. The markup tags featured in
the following examples include:

Custom Variable
The Variable markup tag can be used to insert a custom variable into an email templates,
blocks, newsletters, and content pages,
{{CustomVar code= "my_custom_variable"}}

Store URL
The Store URL markup tag represents the base URL of your website, and is used as a substitute
for the first part of a full URL, including the domain name. There are two versions of this
markup tag: One that goes directly to your store, and the other with a forward slash at the end
that is used when a path is added.
{{store url='apparel/shoes/womens'}}

Media URL
The dynamic media URL markup tag represents the location and file name of an image that is
stored on a content delivery network (CDN). The tag can be used to place an image on a page,
block, banner, or email template.
{{media url='shoe-sale.jpg'}}

Magento Commerce User Guide

623

Markup Tags

CHAPTER 35: Using Variables

Block ID
The Block ID markup tag is one of the easiest to use, and can be used to place a block directly
on a CMS page, or even nested inside another block. You can use this technique to modify a
block for different promotions or languages. The Block ID markup tag references a block by its
identifier.
{{block id='block-id'}}

Template Tag
A template tag references a PHTML template file, and can be used to display the block on a
CMS page or static block. The code in the following example can be added to a page or block to
display the Contact Us form.
“Contact Us” Template Tag

{{block class="Magento\Contact\Block\ContactForm"
name="contactForm" template="Magento_Contact::form.phtml"}}

The code in the next example can be added to a page or block to display the a list of products
in a specific category, by category ID.
“Category Product List” Template Tag

{{block type="catalog/product_list" category_id="22"
template="catalog/product/list.phtml"}}

624

Magento Commerce User Guide

CHAPTER 35: Using Variables

Markup Tags

Widget Code
The Widget tool can be used to display lists of products, or to insert complex links, such as one
that goes to a specific product page, based on product ID. The code that is generated includes
the block reference, location of the code module, and corresponding PHTML template. After the
code is generated, you can copy and paste it from one place to another.
The code in the following example can be added to a page or block to display the list of new
products.
“New Products Grid” Code

{{widget type="catalog/product_widget_new"
display_type="new_products" products_count="10"
template="catalog/product/widget/new/content/new_grid.phtml"}}

The code in the next example can be added to a page or block to display a link to a specific
product, by product ID.
“Link to Product” Code

{{widget type="catalog/product_widget_link" anchor_text="My Product Link"
title="My Product Link" template="catalog/product/widget/link/link_
block.phtml"
id_path="product/31"}}

Magento Commerce User Guide

625

Markup Tags

CHAPTER 35: Using Variables

Using Markup Tags in Links
You can use markup tags with HTML anchor tags, and link directly to any page in your store.
The link can be incorporated into content pages, blocks, banners, or email and newsletter
templates. You can also use this technique to link an image to a specific page.
Process Overview:
Step 1: Identify the Destination URL
Step 2: Add the Markup to the URL
Step 3: Complete the Anchor Tag

Step 1: Identify the Destination URL
If possible, navigate to the page that you want to link to, and copy the full URL from the
address bar of your browser. The part of the URL that you need comes after the “dot com
forward slash.” Otherwise, copy the URL Key from the CMS page that you want to use as the
link destination.
Full URL to Category Page

http://mystore.com/apparel/shoes/womens
http://mystore.com/apparel/shoes/womens.html
Full URL to Product Page

http://mystore.com/apparel/shoes/womens/nine-west-pump
http://mystore.com/apparel/shoes/womens/nine-west-pump.html
Full URL to CMS Page

http://mystore.com/about-us

626

Magento Commerce User Guide

CHAPTER 35: Using Variables

Markup Tags

Step 2: Add the Markup to the URL
The Store URL tag represents the base URL of your website, and is used as a substitute for the
“http address” part of the store URL, including the domain name and “dot com.” There are two
versions of the tag, which you can use, depending on the results you want to achieve.
store direct_url

Links directly to a page.

store url

Places a forward slash at the end, so additional references can be
appended as a path.

In the following examples, the URL Key is enclosed in single quotes, and the entire markup tag
is enclosed in double curly braces. When used with an anchor tag, the markup tag is placed
inside the double quotes of the anchor. To avoid confusion, you can alternate using single-and
double quotes for each nested set of quotes.
1.

If you are starting with a full URL, delete the “http address” part of the URL, up through and
including the “dot.com forward slash.” In its place, type the Store URL markup tag, up
through the opening single quote.
Store URL Markup Tag

http://mystore.com/apparel/shoes/womens
{{store url='apparel/shoes/womens'}}

Otherwise, type the first part of the Store URL markup tag, and paste the URL key or path that
you copied earlier.
Store URL Markup Tag with URL Key

{{store url='
{{store url='apparel/shoes/womens'}}

To complete the markup tag, type the closing double quotes and double braces.

Magento Commerce User Guide

627

Markup Tags

CHAPTER 35: Using Variables

Step 3: Complete the Anchor Tag
1.

Wrap the completed markup tag inside an anchor tag, using the markup tag instead of the
target URL. Then, add the link text, and closing anchor tag.
Markup in Anchor Tag

Link Text

Paste the completed anchor tag into the code of any CMS page, block, banner, or email
template, where you want the link to appear.
Complete Link with Markup

Shoe Sale

628

Magento Commerce User Guide

CHAPTER 35: Using Variables

Markup Tags

Dynamic Media URLs
A dynamic media URL is a relative reference to an image or other media asset. When enabled,
dynamic media URLs can be used to link directly to assets on your server, or to files stored on a
content delivery network. The use of dynamic media URLs can impact catalog performance,
and the editor can be configured to use either static or dynamic media URLs for catalog
product and category descriptions.
As with all markup tags, the code is enclosed in double curly braces. The format of a dynamic
media URL looks like this:
{{media url="path/to/image.jpg"}}

To configure dynamic media URLs:
1.

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

In the panel on the left under Catalog, choose Catalog. Then, expand

the Storefront

section, and do the following:

Storefront

Magento Commerce User Guide

629

Markup Tags

CHAPTER 35: Using Variables

Scroll down to Allow Dynamic Media URLs in Products and Categories. Then, clear the
Use system value checkbox.

b.
3.

Set Allow Dynamic Media URLs in Products and Categories to your preference.

When complete, tap Save Config.

To use static URLs by default for media files:
By default, images inserted into the catalog from media storage have relative, dynamic URLs.
If you prefer to use a static URL, you can change the configuration setting.
1.

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

In the panel on the left under General, choose Content Management.

Expand

the WYSIWYG Options section.

WYSIWYG Options

630

Set Use Static URLs for Media Content in WYSIWYG for Catalog to “Yes.”

When complete,tap Save Config.

Magento Commerce User Guide

CHAPTER 35: Using Variables

Variable Reference

Variable Reference
Most email templates have a section of additional variables that are specific to the template.
The following are examples of some frequently used templates.

Email Template Variables
VARIABLE

MARKUP TAG

Email Footer Template

Email Header Template

Email Logo Image Alt

Email Logo Image URL

Email Logo Image Height

Email Logo Image Width

Template CSS

Store Contact Information Variables
VARIABLE

MARKUP TAG

Base Unsecure URL

Base Secure URL

General Contact Name

General Contact Email

Sales Representative
Contact Name

Sales Representative
Contact Email

Custom1 Contact Name

Custom1 Contact Email

Magento Commerce User Guide

631

Variable Reference

CHAPTER 35: Using Variables

Store Contact Information Variables (cont.)
VARIABLE

632

MARKUP TAG

Custom2 Contact Name

Custom2 Contact Email

Store Name

Store Phone Telephone

Store Hours

Country

Region/State

Zip/Postal Code

City

Street Address 1

Street Address 2

Store Contact Address

Magento Commerce User Guide

CHAPTER 35: Using Variables

Variable Reference

New Account Template Variables
VARIABLE

MARKUP TAG

Customer Account URL

Customer Email

Customer Name

New Order Template Variables
VARIABLE

MARKUP TAG

Billing Address

Email Order Note

Order ID

Order Items Grid

{{layout handle="sales_email_order_items"
order=$order area="frontend"}}

Payment Details

Shipping Address

Shipping Description

Magento Commerce User Guide

633

634

Magento Commerce User Guide

CHAPTER 36:

Social
Your Magento store can be connected to social networks either by using the Magento Social
Facebook connector, or by installing a Marketplace extension. In addition, you can easily add
social plugins such as the “Like” button to CMS blocks that can be incorporated into pages
throughout your store.
l

Connect to Facebook

Marketplace Extensions

Adding Social Plugins

Magento Commerce User Guide

635

Connect to Facebook

CHAPTER 36: Social

Connect to Facebook
Magento Social is an integration that establishes a connection between your store and your
Facebook account, and creates a shopping page with products from your catalog. When
shoppers click a product on your Facebook page, they are redirected to the corresponding
product page in your Magento store. All transactions take place from your Magento store.

Magento Social
The capacity and features that are available for your Facebook shopping page are determined by
your Magento Social account. For a free account, only nine products are initially added to the
page. To support an unlimited number of products, you must upgrade your Magento Social
account.

Before You Begin
If your browser is set to disable popups, it must be updated to permit the popups that are used
during the configuration of the Facebook connector. The following procedure shows how to add
the URL that generates the necessary popups to the whitelist in Chrome. The process is similar
for other browsers.
1.

In the upper-right corner of the browser window, click the three dots to display the menu.
Then, choose Settings.

Scroll down to the bottom of the page, and click Advanced.

In the Privacy and security section, expand Content Settings. Then, expand the Popups
section, and do the following:
a.

Under Allow, tap ADD.

Enter the URL for your store, and click ADD.

Enter the following URL, and click ADD.
https://fbapp.ezsocialshop.com

Step 1: Activate Magento Social

636

On the Admin sidebar, tap Marketing. Then under Social, choose Connect to Facebook.

Under Step 1, tap Integrations page to establish your Magento Social connection.

Magento Commerce User Guide

CHAPTER 36: Social

Connect to Facebook

Step 1: Activate Magento Social
3.

Find Magento Social in the Integrations grid, and click Activate.

Activate Magento Social
4.

When prompted to approve access to the following API resources, tap Allow.

Magento Commerce User Guide

637

Connect to Facebook

CHAPTER 36: Social

API Resources
5.

When the “Success” message appears, tap Close.

Activation Successful
6.

When you return to the Integrations grid, the status of Magento Social is “Active.” If necessary
in the future, you can repeat these steps to Reauthorize the integration.

638

Magento Commerce User Guide

CHAPTER 36: Social

Connect to Facebook

Sent for Activation

Step 2: Launch Your Store
1.

Keeping your Magento window open, open a new browser tab, and sign in to your Facebook
account. Then, return to the Magento tab.

On the Admin sidebar, tap Marketing. Then again under Social, choose Connect to Facebook.

On the “Connect your store to Facebook” page under Step 2, tap Launch Store.

Step 2: Launch Your Store
4.

When prompted to “Turn your Magento store into a Facebook store,” tap Connect Magento to
Facebook.

Magento Commerce User Guide

639

Connect to Facebook

CHAPTER 36: Social

Connect Your Store to Facebook
5.

At the Log In with Facebook window, tap Continue as [username].

Tap OK to let Shopial manage your pages.

Let Shopial Manage Pages
7.

640

At the “Head to Facebook” page,” tap Create a Facebook page. Then, do the following:

Magento Commerce User Guide

CHAPTER 36: Social

Connect to Facebook

Create a Facebook Page
a.

Under Create a Page, tap Brand or Product.

Refresh
b.

Under Choose a Category, select “App page”.
The categories listed are not integrated with your Magento Social page. At this time, Magento
Social does not support choosing specific products from your catalog.

Enter a Name for your Magento Social page.

Tap Get Started.

Get Started
e.

Return to the tab with the “Head to Facebook” page, and tap Refresh.

When the Congratulations message appears, tap Close to see your new Facebook shop.

Magento Commerce User Guide

641

Connect to Facebook

CHAPTER 36: Social

Congratulations!
g.

Your initial store has nine products from your Magento catalog. To finish the page, you
can add a profile photo, cover image, and description.

Magento Store on Facebook
8.

Whenever you want to return to your Magento store page from other pages in your Facebook
account, do the following:

642

In the panel on the left, click See more to display the full list of options.

Choose the last option, Store.

Magento Commerce User Guide

CHAPTER 36: Social

Connect to Facebook

Step 3: Upgrade Your Magento Social Store
Your Magento Social account determines the number of products that can be added to a single
Magento Social page. To create multiple pages, you must open a separate Magento Social
account for each page.
1.

If necessary, Sign in to your Facebook account. In the panel on the left, click See more. Then,
choose Store.

In the green message, click See plans and pricing here.

See Plans and Pricing
3.

On the Upgrade tab of the Magento Social section, choose one of the following account types.
Then, tap Upgrade.
l

Lite

Pro

Unlimited

Upgrade Levels
4.

In the Order Information section, do the following:

Magento Commerce User Guide

643

Connect to Facebook

CHAPTER 36: Social

If you have a coupon, enter the Coupon Code.

Tap Recalculate.

Order Information
5.

Complete the Customer Information.

Customer Information
6.

Complete the Credit Card Information. Then, review the information and tap Submit.

Credit Card Information

644

Magento Commerce User Guide

CHAPTER 36: Social

Connect to Facebook

Reauthorizing Magento Social
If you need to repeat the process after setting up your store for the first time, do the following:
1.

On the Admin sidebar, tap Marketing. Then under Social, choose Connect to Facebook.

Under Step 1, tap Integrations page to establish your Magento Social connection.

Step 1: Activate Magento Social
3.

Find Magento Social in the Integrations grid, and tap Reauthorize.

Reauthorize
4.

When prompted to approve access to the following API resources, tap Reauthorize.

Troubleshooting
1.

If the “Unable to Connect” page appears, complete the following instructions to refresh your
request and activate your token.
a.

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

Find Magento Social in the list, and click either Activate. or Reauthorize.

Magento Commerce User Guide

645

Connect to Facebook

CHAPTER 36: Social

Return to the “Unable to connect” page, and tap Refresh.

Unable to Connect
2.

If your store is still not connected, complete the following instructions to manually insert your
consumer key.
a.

Find Magento Social in the Integrations grid, and click the Information (

) icon to

display the Integration Info.
b.

Under Current User Identity Verification, enter Your Password that is used to log in to
the Admin.

Under Integration Details, select the entire value of the Consumer Key field, and copy it
to the clipboard.
To copy the selected key, either right-click and choose Copy from the context menu, or
press Ctrl+C.

Copy Consumer Key
d.

646

Return to the “Unable to connect” page, and paste the Consumer Key value into the text
box. Then, tap Send.

Magento Commerce User Guide

CHAPTER 36: Social

Connect to Facebook

Send Consumer Key
3.

You should now be able to continue with Step 2: Launch Your Store.

Magento Commerce User Guide

647

648

Magento Commerce User Guide

SEO & Search

649

Contents
In this section of the guide, we'll take a look at
the search capabilities of your store, what you
can learn from customer search terms, and how
to make your products easy to find. Finally,
you’ll learn best practices and techniques that
you can use to bring more traffic to your store.

Catalog Navigation
Top Navigation
Breadcrumb Trail
Product Listings
Pagination Controls
Layered Navigation
Catalog Search
Quick Search
Advanced Search
Search Results
Weighted Search
Configuring Catalog Search
MySQL
Elasticsearch
Solr
Using a Flat Catalog
Meta Data
Canonical Meta Tag
Catalog URLs
SEO URL Rewrites
Configuring URL Rewrites
Automatic Product Redirects
Creating URL Rewrites
Search Terms
Popular Search Terms
Adding Search Terms
Search Terms Report
Using a Sitemap
Google Tools
Google Analytics
Google Tag Manager
Google Adwords

650

CHAPTER 37:

Catalog Navigation
The term navigation1 refers to the methods shoppers use to move from page to page
throughout your store. The main menu, or top navigation of your store is actually a list of
category links, and provides easy access to the products in your catalog. You will also find
categories in the breadcrumb trail that runs across the top of most pages, and in the layered
navigation that appears on the left side of some two- or three-column pages. To learn more
about category display options, see: Display Settings.
For a product to be visible in your store, it must be assigned to at least one category. Each
category can have a dedicated landing page with an image, static block, a description, and a
list of products in the category. You can also create special designs for category pages that are
active only for a specific period of time such as for a holiday or promotion.

Catalog Navigation

1The primary group of web page links that a customer uses to navigate around the website; the navigation links to

the most important categories or pages on an online store.

Magento Commerce User Guide

651

Top Navigation

CHAPTER 37: Catalog Navigation

Top Navigation
The main menu of your store is like a directory to the different departments in your store. Each
option represents a different category of products. The position and presentation of the top
navigation might vary by theme, but the way it works is essentially the same.

Top Navigation
The category structure of your catalog can influence how well your site is indexed by search
engines. The more deeply nested a category, the less likely it is to be thoroughly indexed. As a
general rule, anywhere between one and three visible levels is considered to be the most
effective. The root category counts as the first level, although it doesn't appear in the menu.
The maximum number of levels that are available in the top navigation is determined by the
configuration. In addition, there might be a limit to the number of menu levels that are
supported by your store theme. For example, the sample Luma theme supports up to five
levels, including the root.

Counting Menu Levels

652

Level 1

The first level is the root category, which in the sample data is named
“Default Category.” The root is a container for the menu, and its name
does not appear as an option in the menu.

Level 2

On a desktop display, the top navigation is the main menu that
appears across the top of the page. On a mobile device, the main
menu typically appears as a fly-out menu of options. The secondlevel options in the Luma store are “What's New,” “Women,” “Men,”
“Gear,” “Training,” and “Sale.”

Level 3

The third-level appears below each main menu option. For example,
under “Women,” the third-level options are “Tops” and “Bottoms.”

Level 4

The fourth-level options are subcategories that fly out from a thirdlevel option. For example, under “Tops,” the fourth level menu options
are “Jackets,” “Hoodies & Sweatshirts,” “Tees,” and “Bras & Tanks.”

Magento Commerce User Guide

CHAPTER 37: Catalog Navigation

Top Navigation

To set the top navigation:
See “Creating Categories” to define the category structure of the main menu. For a multistore
installation, a different main menu can be assigned as the root category for each store.

To set the depth of the top navigation:
1.

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

In the panel on the left, expand Catalog. Then, choose Catalog.

Expand the Category Top Navigation section.
Because the depth of the top navigation has a global configuration scope, the setting applies to
all websites, stores, and store views in the Magento installation. The Category Top Navigation
configuration section is available only when Store View in the upper-left corner is set to
“Default Config.”

Default Config
4.

To limit the number of subcategories that appear in the top navigation, enter the number in the
Maximal Depth field.
The default Maximal Depth value is zero, which does not place a limit on the number of
subcategory levels.

When complete, tap Save Config .

Category Top Navigation

Magento Commerce User Guide

653

Breadcrumb Trail

CHAPTER 37: Catalog Navigation

Breadcrumb Trail
A breadcrumb trail is a set of links that shows where you are in relation to other pages in the
store. You can click any link in the breadcrumb trail to return to the previous page.
The breadcrumb trail can be configured to appear on content pages, as well as catalog pages.
The format and position of the breadcrumb trail varies by theme, but it is usually located just
below the header. By default, the breadcrumb trail appears on CMS pages.

Breadcrumb Trail

654

Magento Commerce User Guide

CHAPTER 37: Catalog Navigation

Breadcrumb Trail

To remove the breadcrumbs from CMS pages:
1.

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

In the panel on the left under General, choose Web. Then, do the following:

Expand the Default Pages section.

Clear the Use system value checkbox.

Set Show Breadcrumbs for CMS Pages to "No."

When complete, tap Save Config .

Show Breadcrumbs for CMS Pages

Magento Commerce User Guide

655

Product Listings

CHAPTER 37: Catalog Navigation

Product Listings
Product listings can be set to appear by default as either a list or grid. You can also determine
how many products appear per page, and which attribute is used to sort the list. Each catalog
page with a product list has a set of controls that can be used to sort the products, change the
format of the list, sort by attribute, and advance from one page to the next.

Products Displayed as a Grid

656

Magento Commerce User Guide

CHAPTER 37: Catalog Navigation

Product Listings

To configure product listings:
1.

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

Scroll down and in the panel on the left, tap Catalog. Then choose Catalog.

Expand

the Storefront section, and do the following:

Storefront
a.

Set the default List Mode to one of the following:
l

Grid Only

List Only

Grid (default) / List

List (default / Grid

In the Products per Page on Grid Allowed Values field, enter the number of products
that you want to appear per page when shown in grid format. To enter a selection of
values, separate each number by a comma.

In the Products per Page on Grid Default Value field, enter the default number of
products to appear in the grid per page.

Magento Commerce User Guide

657

Product Listings

CHAPTER 37: Catalog Navigation

In the Products per Page on List Allowed Values field, enter the number of products that
you want to appear per page when shown in list format. To enter a selection of values,
separate each number by a comma.

In the Products per page on List Default Value field, enter the default number of products
that appear in the list, per page.

To give customers the option to list all products, set Allow All Products on Page to “Yes.”

Set Product Listing Sorted by to the default attribute that is initially used to sort the list.

If using a flat catalog, do the following:
a.

To display a flat category listing of products, set Use Flat Catalog Category to “Yes.”

To display a flat product listing, set Use Flat Catalog Product to “Yes.”

If you want to allow dynamic references for media assets in category and product URLs, set
Allow Dynamic Media URLs in Products and Categories to “Yes.”

When complete, tap Save Config .

Page Controls
CONTROL

658

DESCRIPTION

View As

Displays the products in either a grid or list format.

Sort By

Changes the sort order of the list.

Show Per Page

Determines how many products appear per page.

Pagination Links

Navigation links to other pages.

Magento Commerce User Guide

CHAPTER 37: Catalog Navigation

Pagination Controls

Pagination Controls
The Pagination settings appear at the top and bottom of the list, and control the format of the
pagination links for product listings. You can set the number of links that appear in the
control, and configure the Next and Previous links. For the pagination links to appear, there
must be more products in the list than are allowed per page in the product list configuration.

Pagination Controls

Pagination Controls
View As
Displays the list in either a Grid or List format.
Sort By
Changes the sort order of the list. The “Used for Sorting in Product
Listing” storefront property determines which product attributes can
be used to sort the list.
Show Per Page
Determines how many products appear per page.
Pagination Links
Navigation links to other pages.

Magento Commerce User Guide

659

Pagination Controls

CHAPTER 37: Catalog Navigation

To configure the pagination controls:
1.

On the Admin sidebar, tap Content. Then under Design, choose Configuration.

Find the store view that you want to configure. Then in the Action column, click Edit.

Under Other Settings, expand

the Pagination section.

Pagination
a.

In the Pagination Frame field, enter the number of links that you want to appear in the
pagination control.

In the Pagination Frame Skip field, enter the number of links that you want to skip ahead
before displaying the next set of links in the pagination control.
For example, if the pagination frame has five links, and you want to jump to the next five
links, how many links do you want to skip ahead? If you set this to four, then the last link
from the previous set will be the first link in the next set.

660

In the Anchor Text for Previous field, enter the text that you want to appear for the
Previous link. Leave blank to use the default arrow.

In the Anchor Text for Next field, enter the text that you want to appear for the Next link.
Leave blank to use the default arrow.

When complete, tap Save Config .

Magento Commerce User Guide

CHAPTER 37: Catalog Navigation

Layered Navigation

Layered Navigation
Layered navigation makes it easy to find products based on category, price range, or any other
available attribute. Layered navigation usually appears in the left column of search results and
category pages and sometimes on the home page. The standard navigation includes a “Shop
By” list of categories and price range. You can configure the display of layered navigation,
including product count and price range.

Layered Navigation by Category and Price

Magento Commerce User Guide

661

Layered Navigation

CHAPTER 37: Catalog Navigation

Filterable Attributes
Layered navigation can be used to search for products by category or by attribute. For example,
when a shopper chooses the Mens/Shorts category from the top navigation, the initial results
include all products in the category. The list can be filtered further by choosing a specific style,
climate, color, material, pattern, or price—or a combination of values. Filterable attributes
appear in an expanding section that lists each attribute value. As an option, the list of
products with matching results can be configured to include products with, or without, a
match.
The attribute properties, combined with the product input type determines which attributes
can be used for layered navigation. Layered navigation is available only for “anchor” categories,
but can also be added to search results pages. The Catalog Input Type for Store Owner property
of each attribute must be set to “Dropdown,” “Multiple Select,” or “Price.” To make the
attributes filterable, the Use in Layered Navigation property of each must be set to either
“Filterable (with results)” or “Filterable (no results).”

Filterable Attributes In Layered Navigation

662

Magento Commerce User Guide

CHAPTER 37: Catalog Navigation

Layered Navigation

The following instructions show how to set up basic layered navigation with filterable
attributes. For advanced layered navigation with price steps, see: Price Navigation.
Process Overview:
Step 1: Set Up the Attribute Properties
Step 2: Make the Category an Anchor
Step 3: Test the Results

Step 1: Set Up the Attribute Properties
1.

On the Admin sidebar, tap Stores. Then under Attributes, choose Product.

Find the attribute in the list, and open in edit mode. Then, do the following:

Filtered Search on Attribute Code
a.

In the panel on the left, choose Storefront Properties. Then, set Use In Layered
Navigation to one of the following:
Filterable (with
results)

Filterable (no
results)

Magento Commerce User Guide

663

Layered Navigation

CHAPTER 37: Catalog Navigation

Filterable Swatch Value with No Results
b.

Set Use In Search Results Layered Navigation to “Yes.”

Storefront Properties
3.

664

Repeat these steps for each attribute that you want to include in layered navigation.

Magento Commerce User Guide

CHAPTER 37: Catalog Navigation

Layered Navigation

Step 2: Make the Category an Anchor
1.

On the Admin sidebar, tap Products. Then under Inventory choose Categories.

In the categories tree on the left, select the category where you want to use layered navigation.

Expand

Tap Save .

the Display Settings section. Then, set Anchorto “Yes.”

Category Display Settings

Step 3: Test the Results
To test the setting, go to your store and navigate to the category from the main menu. The
selection of filterable attributes appears in the layered navigation of the category page.

Magento Commerce User Guide

665

Layered Navigation

CHAPTER 37: Catalog Navigation

Price Navigation
Price navigation can be used to distribute products by price range in layered navigation. You
can also split each range in intervals. There are ways to calculate price navigation:
l

Automatic (Equalize Price Ranges)

Automatic (Equalize Product Counts)

Manual

With the first two methods, the navigation steps are calculated automatically. The manual
method lets you specify a division limit for price intervals. The following example shows the
difference between price navigation steps of 10 and 100.
Iterative splitting provides the best distribution of products among price ranges. With iterative
splitting, after choosing the $0.00-$99 range, the customer can drill-down through several
sub-ranges of prices. Price-range splitting stops when the number of products reaches the
threshold set by the Interval Division Limit.

Example: Price Navigation Steps
PRICE STEP BY 10

PRICE STEP BY 100

$20.00 - $29.99 (1)

$0.00 - $99.99 (4)

$30.00 - $39.99 (2)

$100 - $199.99 (5)

$70.00 - $79.99 (1)

$400.00 - $499.99 (2)

$100.00 - $109.99 (1)

$700.00 and above (1)

$120.00 - $129.99 (2)
$150.00 - $159.99 (1)
$180.00 - $189.99 (1)
$420.00 - $429.99 (1)
$440.00 - $449.99 (1)
$710.00 and above (1)

666

Magento Commerce User Guide

CHAPTER 37: Catalog Navigation

Layered Navigation

To configure price navigation:
1.

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

In the panel on the left under Catalog, choose Catalog.

Expand
a.

the Layered Navigation section. Then, do the following:

By default, Display Product Count is set to “Yes.” The change the setting, first clear the
Use system value checkbox.

Set Price Navigation Steps Calculation to one of the following methods:

Layered Navigation

Method 1: Automatic (equalize price ranges)
Leave Price Navigation Steps Calculation set to the default, “Automatic (Equalize Price
Ranges.)” This setting uses the standard algorithm for price navigation.

Method 2: Automatic (equalize product counts)
To change the value of any of the following fields, first clear the Use system value checkbox.
1.

Set Price Navigation Steps Calculation to “Automatic (equalize product counts).”

To display a single price when multiple products with the same price, set Display Price
Interval as One Price to “Yes.”

In the Interval Division Limit field, enter the threshold for a number of products within a
price range. The range cannot be further split beyond this limit., The default value is 9.

Automatic (equalize product counts)

Magento Commerce User Guide

667

Layered Navigation

CHAPTER 37: Catalog Navigation

Method 3: Manual
To change the value of any of the following fields, first clear the Use system value checkbox.
1.

Set Price Navigation Steps Calculation to “Manual.”

Enter a value to determine the Default Price Navigation Step.

Enter the Maximum Number of Price Intervals allowed, up to 100.

Manual
4.

668

When complete, tap Save Config .

Magento Commerce User Guide

CHAPTER 37: Catalog Navigation

Layered Navigation

Configuring Layered Navigation
The layered navigation configuration determines if a product count appears in parentheses after
each atribute, and the size of the step calculation that is used in price navigation.

To configure layered navigation:
1.

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

In the panel on the left, expand the Catalog section. Then choose Catalog.

Expand the Layered Navigation section, and do the following:

Layered Navigation
a.

To display the number of products found for each attribute, set Display Product Count to
“Yes.” If necessary, first clear the Use system value checkbox.

Set Price Navigation Step Calculation to “Automatic (equalize price ranges).” If necessary,
first clear the Use system value checkbox.

When complete, tap Save Config .

Magento Commerce User Guide

669

670

Magento Commerce User Guide

CHAPTER 38:

Catalog Search
Research shows that people who use search are more likely to make a purchase than those who
rely on navigation alone. In fact, according to some studies, people who use search are nearly
twice as likely to make a purchase. In this section of the guide, we will explore how customers
search for products in your catalog, and how you can configure catalog search.
l

Quick Search

Advanced Search

Search Results

Configuring Catalog Search

Flat Catalog

Magento Commerce User Guide

671

Quick Search

CHAPTER 38: Catalog Search

Quick Search
The Search box in the header of the store helps visitors find products in your catalog. The
search text can be the full or partial product name, or any other word or phrase that describes
the product. The search terms that people use to find products can be managed from the
Admin.

To do a quick search:
1.

In the Search box, enter the first few letters of what you want to find.
Any matches in the catalog appear below, with the number of results found.

Either press the Enter key or tap a result in the list of matching products.

672

Magento Commerce User Guide

CHAPTER 38: Catalog Search

Advanced Search

Advanced Search
Advanced Search lets shoppers search the catalog based on values entered into a form. Because
the form contains multiple fields, a single search can include several parameters. The result is a
list of all products in the catalog that match the criteria. A link to Advanced Search is in the
footer of your store.

Advanced Search
Each field in the form corresponds to an attribute from your product catalog. To add a field, set
the frontend properties of the attribute to “Include in Advanced Search.” As a best practice,
include only the fields that customers are most likely to use to find a product, because having
too many will slow down the search.

Magento Commerce User Guide

673

Advanced Search

CHAPTER 38: Catalog Search

To use advanced search:
1.

In the footer of the store, click Advanced Search.

In the Advanced Search form, full or partial values in as many fields as necessary.

Tap Search to display the results.

Search Results
4.

If you don’t see what you are looking for in the search results, tap Modify your search and try
another combination of criteria.

674

Magento Commerce User Guide

CHAPTER 38: Catalog Search

Search Results

Search Results
The Search Results list includes all products that match the search criteria entered in the Quick
Search box or the Advanced Search form. Every product list in the catalog has essentially the
same controls. The only difference is that one is the result of a search query, and the other is
the result of navigation.
The results can be formatted as either a grid or list, and sorted by a selection of attributes.
Pagination controls appear if there are more products than fit on the page, and are used to
move from one page to the next. The number of records per page is determined by the Catalog
Frontend configuration. To learn more, see Product Listings.

Search Results with Pagination Controls

Magento Commerce User Guide

675

Weighted Search

CHAPTER 38: Catalog Search

Weighted Search
Product attributes that are enabled for catalog search can be assigned a weight to give them a
higher value in search results. Attributes with a greater weight are returned before those with a
lower weight. For example, if there are two attributes in the system, “color” with a search
weight of 3 and “description” with a search weight of 1. A search for the word “red,” returns a
list of products with a color attribute value of “red,” but does not return products with
descriptions that contain the word “red.” In this example, the color attribute has a greater
weight than the description attribute.

Search Weight

To set the search weight properties of an attribute:
1.

On the Admin sidebar, tap Stores. Then under Attributes, choose Product.

Find the attribute in the list, and open in edit mode.

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

676

To include the attribute in search queries, set Use in Search to “Yes.”

To establish the search value of the attribute, set Search Weight to a number from 1 to 10,
where 10 has the highest priority. If no value is entered, all attributes have a search weight
of 1.

When complete, tap Save Attribute button.

Magento Commerce User Guide

CHAPTER 38: Catalog Search

Configuring Catalog Search

Configuring Catalog Search
By default, Magento uses the MySQL search engine. The available options depend on the search
engine that is configured for your Magento installation.

MySQL
MySQL is the default search engine used by Magento Commerce.

Elasticsearch
Elasticsearch is a powerful and highly scalable distributed search engine that is used by many
industry leaders with high-volume sites.

Magento Commerce User Guide

677

Configuring Catalog Search

CHAPTER 38: Catalog Search

MySQL
MySQL is the default search engine used by Magento Commerce. By adjusting the Catalog
Search configuration, you can control the behavior of the search operations and determine the
size of valid query text and the display of search recommendations.

MySQL Configuration

To configure MySQL search:
1.

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

In the panel on the left under Catalog, choose Catalog.

Expand

To limit the length and word count of search query text, do the following:
a.

the Catalog Search section.

Set Minimal Query Length to the minimum number of characters that can be submitted in
a query.

Set Maximum Query Length to the maximum number of characters that can be submitted
in a query.

Accept the default, Search Engine, “MySQL.”

To display search suggestions, set Enable Search Suggestions to “Yes.” Then, do the
following:
a.

In the Search Suggestion Count field, enter the number of suggestions to offer for each
search term that returns no results. The default is 2.

678

To display the number of search results for each suggested term, set Show Results Count
for Each Suggestion to “Yes.”

Magento Commerce User Guide

CHAPTER 38: Catalog Search

Configuring Catalog Search

To offer search recommendations, set Enable Search Recommendations to “Yes.” Then, do the
following:
a.

In the Search Recommendations Count field, enter the number of recommendations that
you want to offer. The default is 5.

To display the number of results for each recommendation, set Show Results Count for
Each Recommendation to “ Yes.”

When complete, tap Save Config .

Magento Commerce User Guide

679

Configuring Catalog Search

CHAPTER 38: Catalog Search

Elasticsearch
Elasticsearch is a powerful and highly scalable distributed search engine that is used by such
high-volume sites as eBay, Wikipedia, and GitHub. The implementation of Elasticsearch
includes both search suggestions and recommendations. For installation instructions, see Set
up Elasticsearch service in the developer documentation.

Step 1: Set the Query Length
1.

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

In the panel on the left under Catalog, choose Catalog.

Expand

the Catalog Search section. Then, do the following:

Elasticsearch Query Length
a.

In the Minimal Query Length field, enter the minimum number of characters that can be
submitted in a query.

In the Maximum Query Length field, enter the maximum number of characters that can
be submitted in a query.

Step 2: Configure the Elasticsearch Connection
1.

After the Search Engine field, clear the Use system value checkbox. Then, set Search Engine
to “Elasticsearch,” and do the following:

Elasticsearch Connection Settings

680

Enter the Elasticsearch Server Hostname. The default is: localhost.

Enter the Elasticsearch Server Port.

In the Elasticsearch Index Prefix field, enter a prefix.to identify the Elasticsearch index.
For example: Magento2.

Magento Commerce User Guide

CHAPTER 38: Catalog Search

Configuring Catalog Search

Set Enable Elasticsearch HTTP Auth to “Yes” to use HTTP authentication to prompt for a
username and password to access Elasticsearch Server.

In the Elasticsearch Server Timeout field, enter the number of seconds before the system
times out. The default is: 15.

To verify the configuration, tap Test Connection.

Step 3: Configure Suggestions and Recommendations
Search suggestions and recommendations can impact server performance.

Set Enable Search Suggestions to “Yes.” Then, do the following:

Elasticsearch Suggestion and Recommendation Settings

In the Search Suggestions Count field, enter the number of search suggestions to offer.

To show the number of results found for each suggestion, set Show Results for Each
Suggestion to “Yes.”

To offer recommendations, set Enable Search Recommendations to “Yes.” Then, do the
following:
a.

In the Search Recommendation Count field, enter the number of recommendations to
offer.

To show the number of results found for each recommendation, set Show Results Count
for Each Recommendation to “Yes.”

When complete, tap Save Config.

Magento Commerce User Guide

681

682

Magento Commerce User Guide

CHAPTER 39:

Search Terms
You can learn what your customers are looking for by examining the search terms they use to
find products in your store. If enough people look for a product that you don’t carry, perhaps
it’s time to add it to your catalog. Meanwhile, rather than have them leave them empty
handed, why not redirect them to another product in your catalog? Here are a few ways you
can leverage customer search terms:

Landing Page
The landing page for a search term can be a content page, a category page, a product detail page, or
even a page on a different site.

Synonyms
One way to improve the effectiveness of catalog search is to include different terms that people may
use to describe the same item. You don’t want to lose a sale just because someone is looking for a
“sofa,” and your product is listed as a “couch.” You can capture a broader range of search terms by
entering the words, “sofa” “davenport,” and “loveseat” as synonyms for “couch,” and direct them to the
same landing page.

Misspelled Words
Use search terms to capture common misspellings and redirect them to the appropriate page. For
example, if you sell wrought iron patio furniture, you know that many people misspell the term as “rod
iron,” or even “rot iron.” You can enter each misspelled word as a search term, and make them
synonyms for “wrought iron.” Even though the word is misspelled, the search will be directed to the
page for “wrought iron.”

Magento Commerce User Guide

683

Popular Search Terms

CHAPTER 39: Search Terms

Popular Search Terms
The Search Terms link in the footer of your store displays the search terms used by visitors to
your store, ranked by popularity. Search terms appear in a “tag cloud” format, where the size of
the text indicates the popularity of the term.
By default, Popular Search Terms is enabled as a search engine optimization tool, but has no
direct connection to the catalog search process. Because the Search Terms page is indexed by
search engines, any terms on the page can help improve your search engine ranking and the
visibility of your store. The URL of the Popular Search Terms page is:
mystore.com/search/term/popular/

Popular Search Terms

684

Magento Commerce User Guide

CHAPTER 39: Search Terms

Popular Search Terms

To configure Popular Search Terms:
1.

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

In the panel on the left under Catalog, choose Catalog.

Expand

Clear the Use system value checkbox. Then, set Popular Search Terms as needed.

When complete, tap Save Config.

the Search Engine Optimization section.

Search Engine Optimization

Magento Commerce User Guide

685

Adding Search Terms

CHAPTER 39: Search Terms

Adding Search Terms
As you learn new words that people use to search for products in your catalog, you can add
them to your search terms list to direct people to the most closely matching products in your
catalog.

Search Terms

To add a new search term:
1.

On the Admin sidebar, tap Marketing. Then under SEO & Search, choose Search Terms.

Tap Add New Search Term. Then, do the following:

General Information

686

Magento Commerce User Guide

CHAPTER 39: Search Terms

Adding Search Terms

Under General Information in the Search Query box, type the word or phrase that you
want to add as a new search term.

If your store is available in multiple languages, choose the applicable Store view.

To redirect the search results to another page in your store, or to another website, enter the
full URL of the target page in the Redirect URL field.

If you want this term to be available for use as a suggestion whenever a search returns no
results, set Display in Suggested Terms to “Yes.”

When complete, tap Save Search.

To edit a search term:
1.

In the Search Terms grid, click the row of any record to open the search term in edit mode.

Make the necessary changes.

When complete, tap Save Search.

To delete a search term:
1.

In the list, mark the checkbox of the term to be deleted.

In the upper-left corner of the list, set Actions to “Delete.”

When complete, tap Submit.

Magento Commerce User Guide

687

Search Terms Report

CHAPTER 39: Search Terms

Search Terms Report
The Search Terms report shows the number of results for each term, and the number of times
(hits) the term was used. The report data can be filtered by term, store, results, and hits, and
exported for further analysis.

To view the search terms report:
1.

On the Admin sidebar, tap Reports. Then under Marketing, choose Search Terms.

Use the controls to filter the report as needed.

Search Terms Report

688

Magento Commerce User Guide

CHAPTER 39: Search Terms

Search Synonyms

Search Synonyms
One way to improve the effectiveness of catalog search is to include different terms that people
may use to describe the same item. You don’t want to lose a sale just because someone is
looking for a “sofa,” while your product is listed as a “couch.” Or perhaps they spelled it wrong,
or just differently. Is it a sweatshirt, or a sweat shirt? Maybe it’s a fleece or a hoodie. You can
capture a broad range of search terms by entering all the possible words a customer might use
to find your products.

Search Results

To create a new synonym group:
1.

On the Admin sidebar, tap Marketing. Then under SEO & Search, choose Search Synonyms.
The Search Synonyms grid appears. If this is the first time you have used search synonyms, the
grid will be empty.

Search Synonyms Grid

Magento Commerce User Guide

689

Search Synonyms

CHAPTER 39: Search Terms

Tap New Synonym Group. Then, do the following:

New Synonym Group
a.

Set Scope to the store views whee the synonyms apply.

Enter each synonym in the group, separated by comma. Choose words that people might
use as search criteria. For example:

sweatshirt, sweat shirt, hoodie, fleece

cell phone, mobile phone, smart phone

couch, sofa, davenport

wrought iron, rot iron, rod iron

To merge these synonyms into a group with others that have the same scope, mark the
Merge existing synonyms checkbox.

When complete, tap Save Synonym Group.

Search Synonym Group Saved

690

Magento Commerce User Guide

CHAPTER 40:

SEO Best Practices
Search engine optimization is the practice of fine-tuning the content and presentation of a site
to improve the way the pages are indexed by search engines. Magento Commerce includes a
number of features to support your ongoing SEO effort.

Commerce Resources
See the latest Magento eBooks to gain access to expert
insight and online business resources to help develop
and improve your store.

Magento Commerce User Guide

691

Meta Data

CHAPTER 40: SEO Best Practices

Meta Data
Your store is loaded with places where you can enter keyword-rich meta data to improve the
way search engines index your site. While setting up your store, you might enter preliminary
meta data, with the intention of finishing it later. Over time, you can fine-tune the meta data
to target the buying patterns and preferences of your customers.

Meta Title
The meta title appears in the title bar and tab of your
browser, and search results listings. The meta title
should be unique to the page, and less than seventy
characters in length.

Meta Keywords
Although some search engines ignore meta keywords,
others continue to use them. The current best practice is
to incorporate high-value keywords in the meta title and
meta description.

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

692

Magento Commerce User Guide

CHAPTER 40: SEO Best Practices

Meta Data

Canonical Meta Tag
The canonical meta tag tells search engines which page
to index when multiple URLs have identical or very
similar content.

Rich Snippets
Rich snippets provide detailed information for search
results listings and other applications. By default,
structured data markup that is based on the schema.org
standard is added to your store’s product template. As a
result, more information is available for search engines to
include as “rich snippets” in product listings.

Magento Commerce User Guide

693

Meta Data

CHAPTER 40: SEO Best Practices

Canonical Meta Tag
Some search engines penalize websites that have multiple URLs that point to the same content.
The canonical meta tag tells search engines which page to index when multiple URLs have
identical or very similar content. Using the canonical meta tag can improve your site ranking
and aggregate pageviews. The canonical meta tag is placed in the block of a product or
category page. It provides a link to your preferred URL, so search engines will give it greater
weight.

Example 1: Category Path Creates Duplicate URLs
For example, if your catalog is configured to include the category path in product URLs, your
store will generate multiple URLs that point to the same product page.
http://mystore.com/gear/bags/driven-backpack.html
http://mystore.com/driven-backpack.html

Example 2: Category Page Full URL
When canonical meta tags for categories are enabled, the category page of your store includes a
canonical URL to the full category URL:
http://mystore.com/gear/bags/driven-backpack.html

Example 3: Product Page Full URL
When canonical meta tags for products are enabled, the product page includes a canonical
URL to the domain-name/product-url-key because product URL keys are globally unique.
http://mystore.com/driven-backpack.html

If you also include the category path in product URLs, the canonical URL remains domainname/product-url-key. However, the product can also be accessed using its full URL, which
includes the category. For example, if the product URL key is driven-backpack, and is
assigned to the Gear > Bags category, the product can be accessed using either URL.
You can avoid being penalized by search engines by omitting the category from the URL, or by
using the canonical meta tag to direct search engines to index either by product or category. As
a best practice, it is recommended that you enable canonical meta tags for both categories and
products.

To enable the canonical meta tag:

694

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

In the panel on the left under Catalog, choose Catalog.

Magento Commerce User Guide

CHAPTER 40: SEO Best Practices

Expand

Meta Data

the Search Engine Optimization section.

To change any field values, you must first clear the Use system value checkbox after each field.

Search Engine Optimization
4.

If want search engines to index only category pages using the full category path, do the
following:

Set Use Canonical Link Meta Tag for Categories to “Yes.”

Set Use Canonical Link Meta Tag for Products to “No.”

If you want search engines to index product pages only using the domain-name/product-urlkey format, do the following:

Set Use Canonical Link Meta Tag for Products to “Yes.”

Set Use Canonical Link Meta Tag for Categories to “No.”

When complete, tap Save Config .

Magento Commerce User Guide

695

Using a Site Map

CHAPTER 40: SEO Best Practices

Using a Site Map
A site map improves the way your store is indexed by search engines, and is specifically
designed to find pages that might be overlooked by web crawlers. A site map can be configured
to index all pages and images.
When enabled, Magento creates a file called sitemap.xml that is saved to your installation in
the location that you specify. The configuration gives you the ability to set the frequency of the
updates, and the priority for each type of content. Your site map should be updated as
frequently as the content on your site changes, which might be daily, weekly, or monthly.
While your site is in development, you might include instructions in the robots.txt file for
webcrawlers to avoid indexing the site. Then before the launch, you can change the instructions
to allow the site to be indexed.
For technical information, see: Add sitemap and robots.txt in the developer documentation.

Site Map in Grid

Process Overview:
Step 1: Configure the Site Map
Step 2: Generate the Site Map
Step 3: Configure and Enable robots.txt (Optional)
Step 4: Submit Your Site Map to Search Engines
Step 5: Restore the Previous Robot Instructions (Optional)

Step 1: Configure the Site Map
Complete the XML Sitemap configuration to determine what is included, and how frequently
the site map is updated.

696

Magento Commerce User Guide

CHAPTER 40: SEO Best Practices

Using a Site Map

Step 2: Generate the Site Map
1.

On the Admin menu, choose Marketing. Then under SEO & Search, choose Site Map.

Tap Add Site Map. Then, do the following:

Site Map
a.

Enter the site map Filename. For example: sitemap.xml

Enter the Path to determine where the site map file is to reside on the server. Make sure
that the path is writeable.
/sitemap/

Places the site map file in a directory called “sitemap.”

Places the site map file at the base path, or root of your Magento
installation.

New Site Map
3.

When complete, tap Save & Generate.
It might take a few minutes for the site map to appear in the grid.

Magento Commerce User Guide

697

Using a Site Map

CHAPTER 40: SEO Best Practices

Step 3: Configure and Enable robots.txt (Optional)
Complete the Search Engine Robots configuration with instructions that direct search engines
to crawl the parts of your site that you want to be indexed.

Step 4: Submit Your Site Map to Search Engines
You can submit your site map to different search engines by providing them the link to the
sitemap.xml file in your Magento installation. To copy the link, do the following:
1.

In the Site Map grid, right-click the URL in the Link for Google column.

On the menu, choose Copy Link Address.
For more information, see the instructions for the specific search engine. Here are links to
instructions for two top search engines:
l

Google

Microsoft Bing

Step 5: Restore Previous Robot Instructions (Optional)
You can now restore either the original, or default restrictions.

Column Descriptions
COLUMN

698

DESCRIPTION

The sequential record number of the current site map.

Filename

The file name of the site map.

Path

The location where the site map resides on the server. For example:
/sitemap/

Places the site map file in a directory called
“sitemap,” one level below the root of the
Magento installation.

Places the site map file at the base path, or
root of the Magento installation.

Link for Google

The URL of the site map that is to be submitted to Google and other
search engines.

Last Generated

Indicates the date and time the site map was last generated.

Store View

The store view where the site map applies.

Action

Generate

Regenerates the site map.

Magento Commerce User Guide

CHAPTER 40: SEO Best Practices

Site Map Configuration

Site Map Configuration
Your site map should be updated as frequently as the content on your site changes, which
could be on a daily, weekly, or monthly basis. The configuration lets you set the frequency and
priority for each type of content.

Step 1: Set the Frequency and Priority of Content Updates
1.

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

In the panel on the left under Catalog, choose XML Sitemap.

Expand
a.

the Categories Options section. Then, do the following:

Set Frequency to one of the following:
l

Always

Hourly

Daily

Weekly

Monthly

Yearly

Never

In the Priority field, enter a value between 0.0 and 1.0. Zero has the lowest priority.

Categories Options
4.

Click to expand the Products Options section. Then, complete the Frequency and Priority
settings as needed.

To determine the extent that images are included in the sitemap, set Add Images into Sitemap
to one of the following:
l

None

Base Only

All

Magento Commerce User Guide

699

Site Map Configuration

CHAPTER 40: SEO Best Practices

Products Options
6.

Click to expand the CMS Pages Options section. Then, complete the Frequency and Priority
settings as needed.

CMS Pages Options
7.

When complete, tap Save Config.

Step 2: Complete the Generation Settings
1.

Expand

the Generation Settings section.

Generation Settings
2.

700

To generate a sitemap, set Enabled to “Yes.” Then, do the following:
a.

Set Start Time to the hour, minute and second that you want the sitemap to be updated.

Set Frequency to one of the following:
l

Daily

Weekly

Monthly

Magento Commerce User Guide

CHAPTER 40: SEO Best Practices

Site Map Configuration

In the Error Email Recipient field, enter the email address of the person who is to receive
notification if an error occurs during a sitemap update.

Set Error Email Sender to the store contact who appears as the sender of the error
notification.

Set Error Email Template to the template used for the error notification.

Step 3: Set the Site Map File Limits
1.

Expand
a.

the Sitemap File Limits section. Then, do the following:

In the Maximum No of URLs per File field, enter the maximum number of URLs that can
be included in the sitemap. By default, the limit is 50,000.

In the Maximum File Size field, enter the largest size in bytes that is allocated for the
sitemap. The default size is 10,485,760 bytes.

Sitemap File Limits

Step 4: Set the Search Engine Submission Settings
1.

Expand

the Search Engine Submission Settings section.

If using a robots.txt file to provide instructions to search engines that crawl your site, set
Enable Submission to Robots.txt to “Yes.”

Search Engine Submission Settings
3.

When complete, tap Save Config.

Magento Commerce User Guide

701

Search Engine Robots

CHAPTER 40: SEO Best Practices

Search Engine Robots
The Magento configuration includes settings to generate and manage instructions for web
crawlers and bots that index your site. The instructions are saved in a file called “robots.txt”
that resides in the root of your Magento installation. The instructions are directives that are
recognized and followed by most search engines.
By default, the robots.txt file that is generated by Magento contains instructions for web
crawler to avoid indexing certain parts of the site that contain files that are used internally by
the system. You can use the default settings, or define your own custom instructions for all, or
for specific search engines. There are many articles online that explore the subject in detail.

Example: Custom Instructions
Allows Full Access

User-agent:*
Disallow:
Disallows Access to All Folders

User-agent:*
Disallow: /
Default Instructions

Disallow: /lib/
Disallow: /*.php$
Disallow: /pkginfo/
Disallow: /report/
Disallow: /var/
Disallow: /catalog/
Disallow: /customer/
Disallow: /sendfriend/
Disallow: /review/
Disallow: /*SID=

To configure robots.txt:

702

On the Admin sidebar, tap Content. Then under Design, choose Configuration.

Find the Global configuration in the first row of the grid, and click Edit.

Magento Commerce User Guide

CHAPTER 40: SEO Best Practices

Search Engine Robots

Global Design Configuration
3.

Scroll down and expand

the Search Engine Robots section. Then, do the following:

Search Engine Robots
a.

Set Default Robots to one of the following:
INDEX, FOLLOW

Instructs web crawlers to index the site and to check back
later for changes.

NOINDEX, FOLLOW

Instructs web crawlers to avoid indexing the site, but to
check back later or changes.

INDEX, NOFOLLOW

Instructs web crawlers to index the site once, but to not
check back later for changes.

NOINDEX, NOFOLLOW

Instructs web crawlers to avoid indexing the site, and to not
check back later for changes.

If needed, enter custom instructions into the Edit Custom instruction of robots.txt file
box: For example, while a site is in development, you might want to disallow access to all
folders.

To restore the default instructions, tap Reset to Default.

When complete, tap Save Configuration.

Magento Commerce User Guide

703

704

Magento Commerce User Guide

CHAPTER 41:

URL Rewrites
The URL Rewrite tool lets you change any URL that is associated with a product, category, or
CMS page. When the rewrite goes into effect, any links that point to the previous URL are
redirected to the new address.
The terms rewrite and redirect are often used interchangeably, but refer to slightly different
processes. A URL rewrite changes the way a URL appears in the browser. A URL redirect, on
the other hand, updates the URL that is stored on the server. A URL redirect can be either
temporary or permanent. Your store uses URL rewrites and redirects to make it easy for you to
change the URL key of a product, category, or page and preserve existing links.
By default, automatic URL redirects are enabled for your store. The "Create Permanent Redirect
for old URL" checkbox is marked under the URL key field of each product.

Create Permanent Redirect for Old URL

Magento Commerce User Guide

705

Configuring URL Rewrites

CHAPTER 41: URL Rewrites

Configuring URL Rewrites
URL rewrites make it possible to make existing URLs more “search engine friendly” and also
easier for humans to read. Enabling Web Server Apache Rewrites is part of the initial Magento
setup. Magento routinely uses URL rewrites to remove the file name “index.php” that normally
appears in the URL just after the root folder. When Web Server Rewrites are enabled, the
system rewrites each URL to omit “index.php.” The rewrite removes words that convey nothing
of value to search engines or customers, and has no impact on performance or site rank.
URL without Web Server Rewrite

http://www.yourdomain.com/magento/index.php/storeview/url-identifier
URL with Web Server Rewrite

http://www.yourdomain.com/magento/storeview/url-identifier

To configure URL rewrites:
1.

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

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

Expand

the Search Engine Optimization section.

Search Engine Optimization

706

Set Use Web Server Rewrites to your preference.

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 41: URL Rewrites

Automatic Product Redirects

Automatic Product Redirects
Your store can be configured to automatically generate a permanent redirect whenever the URL
key of a product or category changes. In the Search Engine Optimization section, the checkbox
below the URL key indicates if permanent redirects are enabled. If your store is already
configured to automatically redirect catalog URLs, making a redirect is as easy as updating the
URL key. The process to create an automatic redirect is the same for both products and
categories.

Create Permanent Redirect for Old URL

To set up automatic redirects:
1.

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

In the panel on the left under Catalog, select Catalog.

Expand the Search Engine Optimization section.

Set Create Permanent Redirect for URLs if URL Key Changed to “Yes.”

When complete, tap Save Config.

Search Engine Optimization

Magento Commerce User Guide

707

Automatic Product Redirects

CHAPTER 41: URL Rewrites

To automatically redirect product URLs:
1.

On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.

Find the product in the list, and click to open the record.

Expand

the Search Engine Optimization section. Then in the URL Key field, do the

following:
a.

Make sure that the Create Permanent Redirect for old URL checkbox is selected. If not,
follow the instructions to enable automatic redirects.

Update the URL Key as needed, using all lowercase characters and hyphens instead of
spaces.

When complete, tap Save.

When prompted to refresh the cache, follow the links in the message at the top of the
workspace. The permanent redirect is now in effect for the product and any associated category
URLs.

To automatically redirect category URLs:
1.

On the Admin sidebar, tap Products. Then under Inventory, choose Categories.

Find the category in the tree, and click to open the record.

Expand

the Search Engine Optimization section. Then in the URL Key field, do the

following:
a.

Make sure that the Create Permanent Redirect for old URL checkbox is selected. If not,
follow the instructions to enable automatic redirects.

Update the URL Key as needed, using all lowercase characters and hyphens instead of
spaces.

When complete, tap Save.

When prompted to refresh the cache, follow the links in the message at the top of the
workspace. The permanent redirect is now in effect for the category and any associated product
URLs.

708

Magento Commerce User Guide

CHAPTER 41: URL Rewrites

Creating URL Rewrites

Creating URL Rewrites
The URL Rewrite tool can be used to create product and category rewrites, and custom rewrites
for any page in your store. When the rewrite goes into effect, any existing links that point to the
previous URL are seamlessly redirected to the new address.
URL rewrites can be used to add high-value keywords to improve the way the product is
indexed by search engines. You can also use rewrites to create additional URLs for a temporary
seasonal change, or permanent change. Rewrites can be created for any valid path, including
CMS content pages. Internally, the system always references products and categories by their
ID. No matter how often the URL changes, the ID remains the same. Here are some ways you
can use URL rewrites:
System URL

http://www.example.com/catalog/category/id/6
Original URL

http://www.example.com/peripherals/keyboard.html
Redirected Product URL

http://www.example.com/ergonomic-keyboard.html
Additional Category URLs

http://www.example.com/all-on-sale.html
http://www.example.com/save-now/spring-sale

URL Rewrites

Magento Commerce User Guide

709

Creating URL Rewrites

CHAPTER 41: URL Rewrites

Product Rewrites
Before you begin, make sure that you understand exactly what the redirect is to accomplish.
Think in terms of "target" and "original request," or "redirect to" and "redirect from." Although
people might still navigate to the former page from search engines or outdated links, the
redirect causes your store to switch to the new target.
If automatic redirects are enabled for your store, there is no need to create a rewrite when a
product URL Key is changed.

Add URL Rewrite for Product

Process Overview:
Step 1. Plan the Rewrite
Step 2: Create the Rewrite
Step 3. Test the Result

Step 1: Plan the Rewrite
1.

To avoid mistakes, write down the "redirect to" path and "redirect from" path. The path
includes the URL Key and suffix, if applicable.
If you're not sure, open each product page in your store, and copy the path from the address
bar of your browser. When creating a product redirect, you can either include or exclude the
category path. For this example, we create a product redirect without a category path.

Product with Category Path

710

Redirect to:

gear/bags/impulse-duffle.html

Redirect from:

gear/bags/overnight-duffle.html

Magento Commerce User Guide

CHAPTER 41: URL Rewrites

Creating URL Rewrites

Product without Category Path
Redirect to:

impulse-duffle.html

Redirect from:

overnight-duffle.html

Step 2: Create the Rewrite
1.

On the Admin sidebar, tap Marketing. Then under Search & SEO, choose URL Rewrites.

Before you proceed, do the following to verify that the "request path" is available.
a.

In the search filter at the top of the Request Path column, enter the URL key of the page
that is to be redirected. Then, tap Search.

If there are multiple redirect records for the page, find the one that matches the applicable
store view. Then, open the redirect record in edit mode.

In the upper-right corner, tap Delete. When prompted, tap OK to confirm.

In the upper-right corner of the URL Rewrites page, tap Add URL Rewrite.

When you return to the URL Rewrites page, tap Add URL Rewrite.

Set Create URL Rewrite to “For product.”

In the grid, find the product that is the target—or destination—of the redirect. Then, click the
row.

Add URL Rewrite for a Product
7.

Below the category tree, tap Skip Category Selection. For this example, the redirect does not
include a category.

Magento Commerce User Guide

711

Creating URL Rewrites

CHAPTER 41: URL Rewrites

Skip Category Selection
The Add URL Rewrite for a Product page displays a link to the target in the upper-left corner,
and the Target Path field displays the system version of the path, which cannot be changed.
Initially, the Redirect Path field also displays the target path.
a.

If you have multiple store views, set Store to the view where the rewrite applies Otherwise,
a rewrite will be created for each view.

In the Request Path field, type over the default entry, and enter the URL key and suffix—if
applicable—of the original product request. This is the "Redirect from" product that you
identified in the planning step.
The Request Path must be unique for the specified store. If there is already a redirect that uses
the same Request Path, you will receive an error when you try to save the redirect. The
previous redirect must be deleted before you can create a new one.

712

Set Redirect Type to one of the following:
l

Temporary (302)

Permanent (301)

For your own reference, enter a brief Description of the rewrite.

Magento Commerce User Guide

CHAPTER 41: URL Rewrites

Creating URL Rewrites

URL Rewrite Information
8.

Before saving the redirect, review the following:
l

The link in the upper-left corner displays the name of the target product.

The Request Path contains the path for the original "redirect from" product.

When complete, tap Save.
The new product rewrite now appears at the top of the URL Rewrites grid.

URL Rewrite Saved

Step 3: Test the Result
1.

Go to the home page of your store.

Do one of the following:
l

Navigate to the original "redirect from" product request page.

In the address bar of the browser, enter the path to the original "redirect from" product
immediately after the store URL. Then, press Enter.

The new target product appears instead of the original product request.

Magento Commerce User Guide

713

Creating URL Rewrites

CHAPTER 41: URL Rewrites

Field Descriptions
FIELD
Create URL Rewrite

DESCRIPTION
Indicates the type of rewrite. The type cannot be changed after the
rewrite is created. Options:
Custom
For category
For product
For CMS page

Request Path

The product that is to be redirected. Depending on your configuration,
the Request Path might include the .html or .htm suffix, and
category.
The Request Path must be unique, and cannot be in use by another
redirect. If you receive an error that the Request Path already exists,
delete the existing redirect, and try again.

Target Path

The internal path that is used by the system to point to the destination
of the redirect. The target path is grayed out and cannot be edited.

Redirect

Determines the type of redirect. Options :
No

No redirect is specified.
Many operations create redirect
requests of this type. For example,
every time you add products to a
category, a redirect of the "No" type
is created each store view.

Description

714

Temporary (302)

Indicates to search engines that the
rewrite is for a limited time. Search
engines generally do not retain page
rank information for temporary
rewrites.

Permanent (301)

Indicates to search engines that the
rewrite is permanent. Search engines
generally retain page rank
information for permanent rewrites.

Describes the purpose of the rewrite for internal reference.

Magento Commerce User Guide

CHAPTER 41: URL Rewrites

Creating URL Rewrites

Category Rewrites
If a category is removed from your catalog, you can use a category rewrite to redirect links to
the URL of another category in your store. Think in terms of "target" and "original request," or
"redirect to" and "redirect from." Although people might still navigate to the former page from
search engines or outdated links, the redirect causes your store to switch to the new target.
If automatic redirects are enabled for your store, there is no need to create a rewrite when a
category URL Key is changed.

URL Rewrite for Category

Process Overview:
Step 1: Plan the Rewrite
Step 2: Create the Rewrite
Step 3: Test the Result

Step 1: Plan the Rewrite
1.

To avoid mistakes, write down the "redirect to" path and "redirect from" path. The paths
should include the URL Key and suffix, if applicable.
If you're not sure, open each category page in your store, and copy the path from the address
bar of your browser.
Category Path

Redirect to:

gear/backpacks-and-bags.html

Redirect from:

gear/bags.html

Magento Commerce User Guide

715

Creating URL Rewrites

CHAPTER 41: URL Rewrites

Step 2: Create the Rewrite
1.

On the Admin sidebar, tap Marketing. Then under SEO & Search, choose URL Rewrites.

Before you proceed, do the following to verify that the "request path" is available,
a.

In the search filter at the top of the Request Path column, enter the URL key of the
category that is to be redirected. Then, tap Search.

If there are multiple redirect records for the page, find the one that matches the applicable
store view. Then, open the redirect record in edit mode.

In the upper-right corner, tap Delete. When prompted, tap OK to confirm.

When you return to the URL Rewrites page, tap Add URL Rewrite.

Set Create URL Rewrite to “For category.” Then in the category tree, choose the target category
that is the destination of the redirect.

Category Tree
5.

In the URL Rewrite section, do the following:
a.

If you have multiple stores, select the Store where the rewrite applies.

In the Request Path field, enter the URL key of the category that the customer requests.
This is the "redirect from" category.
The Request Path must be unique for the specified store. If there is already a redirect that uses
the same Request Path, you will receive an error when you try to save the redirect. The
previous redirect must be deleted before you can create a new one.

716

Set Redirectto one of the following:

Magento Commerce User Guide

CHAPTER 41: URL Rewrites

Temporary (302)

Permanent (301)

Creating URL Rewrites

For your reference, enter a brief description of the rewrite.

Category Rewrite Information
6.

Before saving the redirect, review the following:
l

The link in the upper-left corner displays the name of the target category.

The Request Path contains the path for the original "redirect from" category.

When complete, tap Save button.
The new category rewrite appears at the top of the URL Rewrites grid.

New Category Rewrite

Step 3: Test the Result
1.

Go to the home page of your store.

Do one of the following:

Magento Commerce User Guide

717

Creating URL Rewrites

CHAPTER 41: URL Rewrites

Navigate to the original "redirect from" category.

In the address bar of the browser, enter the path to the original "redirect from" category
immediately after the store URL. Then, press Enter.

The new target category appears instead of the original category request.

Field Descriptions
FIELD
Create URL Rewrite

DESCRIPTION
Indicates the type of rewrite. The type cannot be changed after the
rewrite is created. Options:
Custom
For category
For product
For CMS page

Request Path

The category that is to be redirected. Depending on your
configuration, the Request Path might include the .html or .htm
suffix, and parent category.
The Request Path must be unique, and cannot be in use by another
redirect. If you receive an error that the Request Path already exists,
delete the existing redirect, and try again.

Target Path

The internal path that is used by the system to point to the destination
of the redirect. The target path is grayed out and cannot be edited.

Redirect

Determines the type of redirect. Options :
No

No redirect is specified.
Many operations create redirect
requests of this type. For example,
every time you add products to a
category, a redirect of the "No" type
is created each store view.

Description

718

Temporary (302)

Indicates to search engines that the
rewrite is for a limited time. Search
engines generally do not retain page
rank information for temporary
rewrites.

Permanent (301)

Indicates to search engines that the
rewrite is permanent. Search engines
generally retain page rank
information for permanent rewrites.

Describes the purpose of the rewrite for internal reference.

Magento Commerce User Guide

CHAPTER 41: URL Rewrites

Creating URL Rewrites

CMS Page Rewrites
Before you begin, make sure that you understand exactly what the redirect is to accomplish.
Think in terms of "target" and "source," or "redirect to" and "redirect from." Although people
might still navigate to the former page from search engines or outdated links, the redirect
causes your store to switch to the new target.

Add URL Rewrite

Process Overview:
Step 1: Plan the Rewrite
Step 2: Create the Rewrite
Step 3: Test the Result

Step 1: Plan the Rewrite
1.

To avoid mistakes, write down the URL key of the "redirect to" page and "redirect from" page.
If you're not sure, open each page in your store, and copy the path from the address bar of your
browser.

CMS Page Path
Redirect to:

new-page

Redirect from:

old-page

Magento Commerce User Guide

719

Creating URL Rewrites

CHAPTER 41: URL Rewrites

Step 2: Create the Rewrite
1.

On the Admin sidebar, tap Marketing. Then under SEO & Search, choose URL Rewrites.

Before you proceed, do the following to verify that the "request path" is available.
a.

In the search filter at the top of the Request Path column, enter the URL key of the page
that is to be redirected. Then, tap Search.

If there are multiple redirect records for the page, find the one that matches the applicable
store view. Then, open the redirect record in edit mode.

In the upper-right corner, tap Delete. When prompted, tap OK to confirm.

When you return to the URL Rewrites page, tap Add URL Rewrite.

Set Create URL Rewrite to “for CMS page.”

Find your new target page in the grid, and open in edit mode.

Custom URL Rewrite
6.

Under URL Rewrite Information, do the following:
a.

If you have multiple store views, select the Store where the rewrite applies.

In the Request Path field, enter the URL key of the original page that the customer
requests. This is the "redirect from" page.
The Request Path must be unique for the specified store. If there is already a redirect that uses
the same Request Path, you will receive an error when you try to save the redirect. The
previous redirect must be deleted before you can create a new one.

720

Set Redirect to one of the following:

Magento Commerce User Guide

CHAPTER 41: URL Rewrites

Temporary (302)

Permanent (301)

Creating URL Rewrites

For your reference, enter a brief description of the rewrite.

Custom URL Rewrite
7.

Before saving the redirect, review the following:
l

The link in the upper-left corner displays the name of the target page.

The Request Path contains the path for the original "redirect from" page.

When complete, tap Save.
The new rewrite appears in the grid at the top of the list.

Saved URL Rewrite

Magento Commerce User Guide

721

Creating URL Rewrites

CHAPTER 41: URL Rewrites

Step 3: Test the Result
1.

Go to the home page of your store.

Do one of the following:
l

Navigate to the original "redirect from" page.

In the address bar of the browser, enter the name of the original "redirect from" page
immediately after the store URL. Then, press Enter.

The new target page appears instead of the original page request.

Field Descriptions
FIELD
Create URL Rewrite

DESCRIPTION
Indicates the type of rewrite. The type cannot be changed after the
rewrite is created. Options:
Custom
For category
For product
For CMS page

Request Path

The CMS page that is to be redirected.
The Request Path must be unique, and cannot be in use by another
redirect. If you receive an error message that the Request Path
already exists, delete the existing redirect, and try again.

Target Path

The internal path that is used by the system to point to the
destination. The target path is grayed out and cannot be edited.

Redirect

Determines the type of redirect. Options :

Description

722

No redirect is specified.

Temporary (302)

Indicates to search engines that the
rewrite is for a limited time. Search
engines generally do not retain page
rank information for temporary
rewrites.

Permanent (301)

Indicates to search engines that the
rewrite is permanent. Search engines
generally retain page rank
information for permanent rewrites.

Describes the purpose of the rewrite for internal reference.

Magento Commerce User Guide

CHAPTER 41: URL Rewrites

Creating URL Rewrites

Custom Rewrites
A custom rewrite can be used to manage miscellaneous redirects, such as redirecting a page
from your store to an external website. For example, you might have two Magento websites,
each with their own domain. You can use a custom redirect to reroute requests for a product,
category, or page to the other website. Unlike other redirect types, the target of a custom
redirect is not chosen from a list of existing pages in your store.
Before you begin, make sure that you understand exactly what the redirect is to accomplish.
Think in terms of "target" and "original request," or "redirect to" and "redirect from." Although
people might still navigate to the former page from search engines or outdated links, the
redirect causes your store to switch to the new target.

Add URL Rewrite

Process Overview:
Step 1: Plan the Rewrite
Step 2: Create the Rewrite
Step 3: Test the Result

Step 1: Plan the Rewrite
1.

To avoid mistakes, write down the URL of the "redirect to" page, and the URL key of the
"redirect from" page.
If you're not sure, open each page, and copy the URL from the address bar of your browser.
Custom Path

Redirect to:

http://www.different-website.com/page.html

Redirect from:

cms-page

Magento Commerce User Guide

723

Creating URL Rewrites

CHAPTER 41: URL Rewrites

category.html
category/subcategory.html
product.html
category/product.html

Step 2: Create the Rewrite
1.

On the Admin sidebar, tap Marketing. Then under SEO & Search, choose URL Rewrites.

Before you proceed, do the following to verify that the "request path" is available:
a.

In the search filter at the top of the Request Path column, enter the URL key of the page
that is to be redirected. Then, tap Search.

If there are multiple redirect records for the page, find the one that matches the applicable
store view. Then, open the redirect record in edit mode.

In the upper-right corner, tap Delete. When prompted, tap OK to confirm.

When you return to the URL Rewrites page, tap Add URL Rewrite.

Set Create URL Rewrite to “Custom.”

Under URL Rewrite Information, do the following:
a.

If you have multiple store views, select the Store where the rewrite applies.

In the Request Path field, enter the URL key and path—if applicable—of the product,
category, or CMS page that is to be redirected.
The Request Path must be unique for the specified store. If there is already a redirect that uses
the same Request Path, you will receive an error when you try to save the redirect. The
previous redirect must be deleted before you can create a new one.

In the Target Path field, enter the URL of the destination. If the target is located on
another website, enter the fully qualified URL.

Set Redirectto one of the following:

724

Temporary (302)

Permanent (301)

For your reference, enter a brief description of the rewrite.

Magento Commerce User Guide

CHAPTER 41: URL Rewrites

Creating URL Rewrites

Custom URL Rewrite
6.

Before saving the redirect, review the following:
l

The Request Path contains the URL key or path of the original "redirect from" page.

The Target Path contains the URL of the "redirect to" page.

When complete, tap Save.
The new rewrite appears in the grid at the top of the list.

Saved URL Rewrite

Step 3: Test the Result
1.

Go to the home page of your store.

Do one of the following:
l

Navigate to the original "redirect from" page.

In the address bar of the browser, enter the name of the original "redirect from" page
immediately after the store URL. Then, press Enter.

Magento Commerce User Guide

725

Creating URL Rewrites

CHAPTER 41: URL Rewrites

The new target page appears instead of the original page request.

Field Descriptions
FIELD
Create URL Rewrite

DESCRIPTION
Indicates the type of rewrite. The type cannot be changed after the
rewrite is created. Options:
Custom
For category
For product
For CMS page

Request Path

The path to the product, category, or CMS page that is to be
redirected. Depending on your configuration, the Request Path might
include the .html or .htm suffix.
The Request Path must be unique, and cannot be in use by another
redirect. If you receive an error that the Request Path already exists,
delete the existing redirect, and try again.

Target Path

The path or URL that is the destination of the redirect.

Redirect

Determines the type of redirect. Options :
No

No redirect is specified.
Many operations create redirect
requests of this type. For example,
every time you add products to a
category, a redirect of the "No" type
is created each store view.

Description

726

Temporary (302)

Indicates to search engines that the
rewrite is for a limited time. Search
engines generally do not retain page
rank information for temporary
rewrites.

Permanent (301)

Indicates to search engines that the
rewrite is permanent. Search engines
generally retain page rank
information for permanent rewrites.

Describes the purpose of the rewrite for internal reference.

Magento Commerce User Guide

CHAPTER 42:

Google Tools
Your store configuration is integrated with the following Google tools to help optimize your
content, analyze your traffic, and connect your catalog to shopping aggregators and
marketplaces.
l

Google Analytics

Google Content Experiments

Google Tag Manager

Google AdWords

Magento Commerce User Guide

727

Google Analytics

CHAPTER 42: Google Tools

Google Analytics
Google Universal Analytics gives you the ability to define additional custom dimensions and
metrics for tracking, with support for offline and mobile app interactions, and access to
ongoing updates.

Google Analytics

Process Overview:
Step 1: Sign Up for Google Universal Analytics
Step 2: Complete the Magento Configuration

Step 1: Sign Up for Google Universal Analytics
Visit the Google website, and sign up for a Google Universal Analytics account.

Step 2: Complete the Magento Configuration
1.

Return to your store, and log in to the Admin. On the Admin sidebar, tap Stores. Then under
Settings, choose Configuration.

In the panel on the left, under Sales, choose Google API.

Expand

the Google Analytics section. Then, do the following:

Set Enable to “Yes.”

Enter your Google Analytics Account Number.

If you want to conduct A/B testing and other performance tests on your content, set
Content Experiments to “Yes.”

When complete, tap Save Config.

Google Content Experiments

728

Magento Commerce User Guide

CHAPTER 42: Google Tools

Google Analytics

The following example shows how to set up an A/B test of products, categories, or content
pages using Google Analytics Content Experiments. We recommend that you keep two browser
tabs open while working through the instructions, because you will need to bounce back and
forth between the Magento Admin and your Google Analytics account.
Google Content Experiments has been deprecated, and will eventually be replaced by Google
Optimize.

Step 1: Enable Content Experiments (Magento)
1.

Follow the instructions to enable Google Analytics with Content Experiments in the Magento
configuration.

Enable Content Experiments

Step 2: Set Up the Variations (Magento)
Create multiple variations of the same product, cateogory, or page.
l

Each variation must have a unique URL key.

Each variation must have the same store view selected.

You can create up to ten variations of each entity that you want to test. For products, use Save
& Duplicate to save time.

Step 3: Set Up the Experiment (Google)
You must have the appropriate permissions to the Google account to create an experiment.

Open another browser tab, and log into your Google Analytics account. If necessary, navigate
to the Account and Property.

In the sidebar on the left, choose Admin. Then, do one of the following:

Choose an Existing View
In the header of the View column, click the down arrow, and choose the view that is to

Magento Commerce User Guide

729

Google Analytics

CHAPTER 42: Google Tools

provide the data for the experiment.

Create a New Reporting View
1.

In the header of the View column, tap Create View. Then, do the following:
a.

Identify the experiment location as one of the following:
l

Website

Mobile app

Enter a descriptive Reporting View Name.

Specify the Reporting Time Zone.

When complete, tap Create View. Then, click the back arrow to return to the previous
page.

New Reporting View
3.

In the panel on the left under Reports, choose Behavior > Experiments.

Tap Create experiment. Then, do the following:

730

Specify the percentage of traffic to redirect.

Specify the Original Page URL and the URLs of each page variation that you want to test.

Complete the other options. If you need help see: .Configure & Modify Experiments.

When the experiment is set up, tap Manually Insert the Code. Then, copy the code snippet.

Magento Commerce User Guide

CHAPTER 42: Google Tools

Google Analytics

Step 4: Paste Code Snippet (Magento)
1.

Return to the Admin of your Magento installation. Then, open the original version of the
product, category, or page in edit mode.

Expand the View Optimization section for the product, category, or page. Then, paste the code
snippet that you copied from Google Analytics into the Experiment Code text box.
Do not paste the code snippet into any of the variations.

Product View Optimization
3.

When complete, tap Save.

Step 5: Review and Start the Experiment (Google)
1.

Return to your Google Analytics account.

Review the experiment settings.

If ready to begin, tap Start Experiment. Otherwise, tap Save for Later.

Magento Commerce User Guide

731

Google Tag Manager

CHAPTER 42: Google Tools

Google Tag Manager
Google Tag Manager helps you manage the many tags, or snippets of code, that are related to
your marketing campaign events. Google Tag Manager gives you the ability to add tracking
tags to your site to measure the audience, or to personalize, retarget, or conduct search engine
marketing initiatives.
Google Tag Manager directly transfers data and events to Google Analytics, Enhanced
Ecommerce and other third-party analytics solutions, to produce a clear picture of how well
your site, products, and promotions are performing.
The following instructions walk you through the process of setting up a Google Tag Manager
account, configuring your Magento store, and creating a tag.
Process Overview:
Step 1: Configure Your Google Analytics Account
Step 2: Configure Your Google Tag Manager Account
Step 3:Configure Your Store

Step 1: Configure Your Google Analytics Account
1.

To enable Internal Site Search Tracking, do the following:

732

Navigate to Select View > View Settings.

Turn Site Search Tracking On.

Set Query parameter to “q”.

When complete, Save the settings.

To enable display features, do the following:
a.

Choose Property Settings.

Under Advertising Features, set Enable Demographics and Interest Reports to “On”.

Save the settings.

To enable Ecommerce Tracking, do the following:
a.

Navigate to Select View > Ecommerce Settings.

Set Enable Ecommerce to “On”.

Set Enable Enhanced Ecommerce Reporting to “On”.

Save the settings.

Reload the page to verify that all the settings remain “On”.

Magento Commerce User Guide

CHAPTER 42: Google Tools

Google Tag Manager

If not all settings are “On,” repeat the previous steps, save, and reload the page. Repeat this
process until all settings are set to “On”.

Step 2: Configure Your Google Tag Manager Account
The following instructions show how to configure a new container with the basic settings. A
sample Composer configuration (.json) file is used to simplify the process.
1.

Right-click this link: GMT_M2_Config_json.txt. Choose Save link as to download the sample
text file. Then, do the following:
a.

Open the file in an editor, and save as GMT_M2_Config.json.

Zip the file to produce an archive called GMT_M2_Config.zip.
The zipped file will be uploaded directly to Google Tag Manager, and does not need to be
copied to your server.

Create a new container. For this example, we recommend that you create a new container,
rather than modify an existing container.

Navigate to Admin > Container > Import Container. Then, verify the following settings:
l

The Overwrite option should be selected for the new container.

The Merge option should be selected is you are using an existing container.

To edit the Google Analytics ID that is referenced in variables, do the following:
a.

Navigate to Variables > User-Defined Variables.

Choose Google Analytics. Then, update the placeholder (UA-xxxxxx-x) with your own GA
ID.

Follow Google’s instructions to add tags, triggers, and variables to the new container.
If you have settings in another container that you want to use, they can be moved to the new
container.

Follow Google’s instructions to publish the new container.

Step 3: Configure Your Store
1.

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

In the panel on the left under Sales, choose Google API.

Expand

the Google Analytics section, and do the following:

Magento Commerce User Guide

733

Google Tag Manager

CHAPTER 42: Google Tools

Google API - Google Tag Manager

734

Set Enable to “Yes.”

Set Account type to “Google Tag Manager.”

In the Container ID field, enter your GTM ID. (GTM-xxxxxx)

If you are also using Google Analytics to content experiments, set Enable Content
Experiments to “Yes.”

Leave the remaining fields as they are.

When complete, tap Save Config .

Test your Google Tag Manager settings to verify that everything works correctly.

Magento Commerce User Guide

CHAPTER 42: Google Tools

Google Tag Manager

Field Descriptions
FIELD

SCOPE

Enable

Store View

DESCRIPTION
Determines if Google Analytics Enhanced
Ecommerce can be used to analyze activity in your
store.
Options include: Yes / No

Account type

Store View

Determines the Google tracking code that is used to
monitor store activity and traffic. Options include:
Google Analytics
Google Tag Manager

Container Id

Store View

If Google Tag manager is already installed and
configured for your store, the Container ID appears
automatically in this field.

List property for the
catalog page

Store View

Identifies the Tag Manager property associated with
the catalog page. Default value: Catalog Page

List property for the crosssell block

Store View

Identifies the Tag Manager property associated with
the cross-sell block. Default value:Cross-sell

List property for the up-sell
block

Store View

Identifies the Tag Manager property associated with
the up-sell block. Default value: Up-sell

List property for the related
products block

Store View

Identifies the Tag Manager property associated with
the related products block. Default value: Related
Products

List property for the search
results page

Store View

Identifies the Tag Manager property associated with
the search results page. Default value: Search
Results

“Internal Promotions” for
promotions field “Label”

Store View

Identifies the Tag Manager property associated with
the labels for internal promotions. Default value: Label

Magento Commerce User Guide

735

Google Tag Manager

CHAPTER 42: Google Tools

Creating a Tag to Track Conversions
If you have a Google AdWords account, you can create a tag that tracks conversions. The
following example shows how to use both Google Tag Manager and Google Analytics to create a
tag that fires on your store’s conversion “Success” page.
Process Overview:
Step 1: Create a Tag
Step 2: Create a Rule
Step 3: Preview and Publish

Step 1: Create a Tag
1.

In the New Tag box, tap Add a new tag.

Google Tag Manager
3.

You will need the following information from your AdWords account:
l

Conversion ID

Conversion Label

If you need help, visit Google’s support site.
4.

736

From the Google Tag Manager dashboard, tap Google AdWords. Then, do the following:
a.

Tap the title placeholder, and enter a name for the new tag.

Under Choose Product, select Google Adwords.

Magento Commerce User Guide

CHAPTER 42: Google Tools

Google Tag Manager

Choose Product
c.

Under Choose a Tag Type, select AdWords Conversion Tracking. Then, tap Continue.

Enter the Conversion ID and Conversion Label from your AdWords account. Then, tap
Continue.

Configure Tag

Magento Commerce User Guide

737

Google Tag Manager

CHAPTER 42: Google Tools

Step 2: Create a Rule
Continuing from the Google Tag Manager dashboard, the next step is to create a rule that fires
the tag on the conversion page.
1.

Under Fire On, tap Some Pages.

In the Choose Pages section, complete the following settings:
Name:

Enter a name for the page description.

Variable:

url

Operation:

matches RegEx

To learn more, see: What is “matches regex” for? in Tag Manager
Help
Value:

checkout/success.*

Conversion Page Location
3.

Mark the green checkbox, and tap Save. The trigger that you set up appears as a blue button
in the Fire On section.

738

When complete, tap Save Tag.

Magento Commerce User Guide

CHAPTER 42: Google Tools

Google Tag Manager

Step 3: Preview and Publish
The next step in the process is to preview the tag. Each time the tag is previewed, a snapshot of the
version is saved. When you are satisfied with the results, go to the version that you want to use, and
tap Publish.

Magento Commerce User Guide

739

Google Tag Manager

CHAPTER 42: Google Tools

Enhanced Ecommerce
Enhanced Ecommerce is a plugin for Google Universal Analytics that gives you insight into the
shopping and purchasing behavior of your customers. You can use Enhanced Ecommerce to
produce reports about key customer activities, such as when customers add items the cart,
begin the checkout process, or complete a purchase. You can also identify and analyze patterns
of shoppers who abandon their carts without making a purchase.
The following instructions show how to configure Google Tag Manager with Universal Analytics
to produce Enhanced Ecommerce data and reports.

Tags Fired in Shopping Cart Shown in Debug Mode

Step 1: Sign Up for Google Accounts
1.

Step 2: Configure Enhanced Ecommerce

740

Create a new property for Enhanced Ecommerce analytics with the following settings:

Magento Commerce User Guide

CHAPTER 42: Google Tools

Google Tag Manager

Enhanced Ecommerce Property
SETTING

VALUE

ENABLE ECOMMERCE SETTINGS
Status

Related Products

ENHANCED ECOMMERCE SETTINGS
Enable Enhanced Ecommerce Reporting ON
Checkout Labeling
3.

(not required)

When complete, tap Submit.

Magento Commerce User Guide

741

Google Tag Manager

CHAPTER 42: Google Tools

Step 3: Create Tags and Triggers
1.

Google Tag Manager Triggers
NAME

EVENT TYPE

AddToCart

Custom Event

Checkout

Custom Event

Checkout only

Page View

CheckoutOption

Custom Event

gtm.dom

Custom Event

ProductClick

Custom Event

PromotionClick

Custom Event

RemoveFromCart

Custom Event

FILTER

Page URL matches RegEx /checkout/.*

Create the following Universal Analytics tags with the same basic configuration.

Universal Analytics Tags
NAME

742

TYPE

FIRING TRIGGERS

Add to cart tracking

Universal Analytics

AddToCart

Checkout option tracking

Universal Analytics

CheckoutOption

Checkout tracking

Universal Analytics

Checkout

Pageview tracking

Universal Analytics

gtm.dom

Product client tracking

Universal Analytics

ProductClick

Promo click tracking

Universal Analytics

PromotionClick

Remove from cart tracking

Universal Analytics

RemoveFromCart

Magento Commerce User Guide

CHAPTER 42: Google Tools

Google Tag Manager

Basic Tag Configuration
SETTING

VALUE

Product

Google Analytics

Tag Type

Universal Analytics

Tracking ID

UA-XXX (The tracking ID from your Universal Analytics account.)

Enable Enhanced
Ecommerce Features

True

Use data layer

True

Use Debug version

True

Complete the individual tracking configurations as follows:
a.

Enter the following Add to Cart tracking settings:

Add to Cart Configuration
SETTING

VALUE

Track Type

Event

Category

Ecommerce

Action

Add to Cart

Trigger

AddToCart

Enter the following Checkout option tracking settings:

Checkout Option Configuration
SETTING

VALUE

Track Type

Event

Category

Ecommerce

Action

Checkout Option

Trigger

CheckoutOption

Enter the following PageView tracking settings:

Page View Configuration
SETTING

VALUE

Track Type

PageView

Trigger

gtm.dom

Magento Commerce User Guide

743

Google Tag Manager

CHAPTER 42: Google Tools

Complete the following Product Click tracking configuration:

Product Click Configuration
SETTING

VALUE

Track Type

Event

Category

Ecommerce

Action

Product Click

Trigger

ProductClick

Complete the following Promotion Click tracking configuration:

Promotion Click Configuration
SETTING

VALUE

Track Type

Event

Category

Ecommerce

Action

Promotion Click

Trigger

PromotionClick

Complete the following Remove from Cart tracking configuration:

Remove from Cart Configuration
SETTING

744

VALUE

Track Type

Event

Category

Ecommerce

Action

Remove from Cart

Trigger

RemoveFromCart

When complete, tap Preview and verify that the tags work correctly.

When complete, tap Publish.

Magento Commerce User Guide

CHAPTER 42: Google Tools

Google Tag Manager

Troubleshooting Tools
Both Google Tag Manager and Universal Analytics have debug modes with a variety of tools
that you can use to troubleshoot your integration.

Preview and Debug
Tag Manager’s debug preview mode shows tags as they are fired and their associated data
layers.

Tags Fired During Checkout
Google Analytics Enhanced Ecommerce makes it possible to send sales data, and information
about product impressions and promotions to the data layer, along with any Google Analytics
pageview or event. You can use the values in the data layer to measure impressions and
analyze customer actions.

Magento Commerce User Guide

745

Google Tag Manager

CHAPTER 42: Google Tools

Values in Data Layer
You also can use the JavaScript console in Chrome to see the output of events as it is sent to
Google.

Chrome JavaScript Console

746

Magento Commerce User Guide

CHAPTER 42: Google Tools

Google AdWords

Google AdWords
Google AdWords is a service that you can use to place ads in Google Search results and on the
pages of companies in the Google Display Network. The AdWords dashboard includes tools to
manage your campaigns, track response, and measure results.
Conversion tracking shows how many ad clicks lead to a sale or other valuable action. The
"Success" page that appears to your customer after an order has been submitted is used to track
conversions because it appears only after a sale. After completing the Google AdWords
configuration for your store, there is no need to copy the conversion tracking script to the
"Success" page, because Magento already has the necessary information. To learn more, see
Google AdWorlds Help.

Magento Ad in Google Search Results

Step 1: Create a Google AdWords Campaign
1.

Visit Google AdWords, and sign up for an account.

Follow the instructions to create a campaign.

To set up conversion tracking for your campaign, do the following:
a.

On the Tools tab of your AdWords dashboard, choose Conversions. Then, tap
Conversion.

When prompted for the conversion source, choose Website

Enter a name for the conversion action that you want to track. Then, tap Done.

Click Value. Then if applicable, assign a value to the conversion. For example,
l

If you make $5 on each sale, choose "Each time it happens," and assign a value of $5.

If the value of each sale varies, leave the value blank.

Then, tap Done.
e.

Tap Conversion windows, and complete the settings to determine how long the conversions
are to be tracked, the reporting category, and attribution model.

When complete, tap Save and Continue.

Magento Commerce User Guide

747

Google AdWords

CHAPTER 42: Google Tools

Step 2: Get Your Conversion Tag
1.

Under Install your tag, choose to count conversions on Page load.

As an option, you can add the Google Site Stats notification to the conversion page. The
notification appears in the lower corner with a link to Google's security standards and cookie
usage.

To choose how you want to manage the your AdWords tag, do one of the following:
l

If you plan to add the script to your store yourself, choose Save instructions and tag.

If you plan to have someone else add the script to your store , choose Email instructions
and tag.

When complete, tap Done.

Step 3: Configure Your Store
1.

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

If configuring Google AdWords tor a specific store view, do the following:

In the upper-left corner, choose the Store View that is to be configured.

When prompted to confirm scope switching, tap OK.

In the panel on the left, under Sales, choose Google API. Then, expand

the Google

AdWords section and do the following:
a.

If necessary, clear the Use Website checkbox for each setting to be changed.

Set Enable to “Yes.”:

Enter the Conversion ID from your Google AdWords script.

Google AdWords
4.

748

To format the Google Sites Stat notification, do the following:

Magento Commerce User Guide

CHAPTER 42: Google Tools

Google AdWords

Set Conversion Language to the language that is identified in your Google AdWords
script.

Enter the Conversion Format to be used for the Google Sites Stat notification on the
conversion page.
1

Displays a one-line notification with a link to more information about Google
tracking.

Displays a two-line notification with a link to more information about Google
tracking.

Displays no customer notification.

Enter the hexadecimal code for the Conversion Color that you want to use for the Google
Site Stats notification label.

Enter the encrypted text for the Conversion Label that appears on the Google Sites Stat
notification.
For example: MlEYCOKBnGoQz6CZoAM

Sample Google AdWords Tag Code

Set Conversion Value Type to one of the following:
Dynamic

Determines that a conversion has occurred based on the dynamic Order
Amount value.

Constant

Determines that a conversion has occurred based on a specific value
entered.

For a Constant conversion value type, enter a specific Value for the Order Amount to qualify as
a conversion.
6.

When complete, tap Save Config.

Step 4: Verify the Configuration
Within a few hours, the tracking status in your Google AdWords dashboard changes from
"Unverified" to "No recent conversions" or "Recording conversions." When someone clicks your
ad and makes a purchase, the conversion appears on the Conversion Actions page of your
dashboard and campaign report.

750

Magento Commerce User Guide

CONTENT

751

Contents
In this section of the guide, you’ll learn how to
create content and manage the presentation of
your store.

752

Content Elements
Design & Theme

CHAPTER 43:

Content Menu
The term content marketing1 refers to the art of promoting your products or services by
providing valuable information to your customers at no charge. The quality of your content
helps distinguish your store from others, increases your visibility to search engines, and
provides support to your customers. This soft-sell approach is often more effective than
advertising, builds credibility and trust, and can turn your store into a destination. Content is
still king.
Your content should reflect the branding of your store, and be delivered with your distinctive
visual presentation and voice to convey your message. Use pictures to tell a story. Educate,
inspire, and entertain. Keep in mind that with quality content, sometimes less is more.

Content Menu

To display the Content menu:
On the Admin sidebar, tap Content .

1The art of promoting products or services by providing valuable information at no charge.

Magento Commerce User Guide

753

Menu Options

CHAPTER 43: Content Menu

Menu Options
Pages
Create pages with text, images, blocks, variables, and
widgets, that can be incorporated into the navigation of
your store, and linked to other pages. Then, organize your
pages into a hierarchy with navigation.

Blocks
Create blocks of content without writing any code.
Blocks can contain text, images, and even video, and
can be assigned to any part of the page layout.

Banners
Create banners that are triggered by promotions and that
appear only to customers in specific, targeted segments.

Widgets
Display dynamic data and add blocks, links, and
interactive elements most anywhere in your store.

Design
Learn to manage the visual presentation of your store,
apply themes, and schedule design changes.

754

Magento Commerce User Guide

CHAPTER 43: Content Menu

Menu Options

Staging
Content Staging gives your business team the ability to
easily create, preview, and schedule a wide range of
content updates directly from the Admin of your store.

Magento Commerce User Guide

755

756

Magento Commerce User Guide

Content Elements

757

Content Elements
In this section of the guide, you’ll learn how to
create and manage content pages and blocks,
and use variables and widgets to add dynamic
content.

Content Menu
Pages
Core Content Pages
Workspace Controls
Adding a New Page
Using the Editor
Inserting a Link
Inserting an Image
Inserting a Widget
Inserting a Variable
Configuring the Editor
Adding a Lightbox or Slider
Using Media Storage
Page Hierarchy
Configuring Page Hierarchy
Adding a Node
Blocks
Adding a New Block
Adding Social Plugins
Positioning Blocks on a Page
Banners
Creating a Banner
Rotating Banners
Using Banners in Price Rules
Widgets
Widget Types
Creating a Widget
New Products List
Design & Theme

758

CHAPTER 44:

Pages
All content can be viewed in terms of its shelf life, just as any product in a store. Did you know
that the shelf life of social media content is less than twenty-four hours? The potential shelf life
of the content you create can help you decide where to invest your resources.
Content with a long shelf life is sometimes referred to as evergreen content 1. Examples of
evergreen content include customer success stories, "how to" instructions, and Frequently
Asked Questions (FAQ.) In contrast, content is perishable by nature includes events, industry
news, and press releases.

About Us

1Content that has a long shelf life.

Magento Commerce User Guide

759

Core Content

CHAPTER 44: Pages

Core Content
The Magento demo store has examples of core content pages to help you get started. All of the
pages can be modified to meet your needs. Take a look at the following pages in your store, to
make sure that the content conveys your message, voice, and brand.

Home
The demo “Home” page includes a banner, an image
carousel, several static blocks with links, and a list of
new products.

About Us
The “About Us” page is linked from the footer of your
store. You can include images, video, links to press
releases and announcements. The sample page has an
image on the right, and one of a decorative sort to
indicate the end of the page.

Customer Service
The “Customer Service” page is another node in the
page hierarchy. The two headers on the page have
content that only becomes visible when the header is
clicked.

Privacy Policy
Your store’s “Privacy Policy” page should be updated
with your own information. As a best practice, your
privacy policy should explain to your customers the
type of information that your company collects and
how it is used.

760

Magento Commerce User Guide

CHAPTER 44: Pages

Core Content

404 Not Found
The “404 Page Not Found” page is named for the
response code that is returned when a page cannot be
found. URL redirects reduce the number of times that
this page appears. However, for those times when it is
necessary, you might as well take advantage of the
opportunity to offer some links to products that the
customer might find interesting.

Enable Cookies
The “Enable Cookies” page appears when visitors to
your site do not have cookies enabled in their
browsers. The page provides step-by-step, illustrated
instructions to enable cookies for the most popular
browsers.

Service Unavailable
The “503 Service Unavailable" page is named for the
response code that is returned when the server is
unavailable.

Magento Commerce User Guide

761

Core Content

CHAPTER 44: Pages

Default Pages
The Default Pages configuration determines the landing page that is associated with the base
URL, and the corresponding home page. It also determines which page appears when a “Page
Not Found” error occurs, and if a breadcrumb trail appears at the top of each page.

To configure the default pages:
1.

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

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

Expand

the Default Pages section. Then, do the following:

Default Pages
a.

In the Default Web URL field, enter the relative path to the folder in the Magento
installation that contains the landing page. The default value is “cms.”
For a specific store view, clear the Use Default checkbox next to the Default Web URL field,
and any other default fields to be changed.

762

Set CMS Home Page to the CMS page to be used as the home page.

In the Default No-route URL field, enter the relative path to the folder in the Magento
installation where the page is redirected when a “404 Page Not Found” error occurs. The
default value is “cms/index/noRoute.”

Set CMS No Route Page to the CMS page that appears when a “404 Page Not Found”
error occurs.

Set CMS No Cookies Page to the CMS page that appears when cookies are disabled in the
browser.

If you want a breadcrumb trail to appear at the top of all CMS pages, set Show
Breadcrumbs for CMS Pages to “Yes.”

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 44: Pages

Workspace Controls

Workspace Controls
The page workspace includes tools to help you quickly find the pages you need, and commands
to perform routine maintenance on individual or multiple pages. You can also quickly update
page properties from the grid.

Pages Grid

To quickly update page properties:
1.

Click any row in the grid. To select multiple records, mark the checkbox of each row that you
want to update.

Update Page Properties
2.

Update any of the following properties:
l

Title

URL Key

Status

Layout

When complete, tap Save.

Magento Commerce User Guide

763

Workspace Controls

CHAPTER 44: Pages

Workspace Controls
CONTROL
Add New Page

DESCRIPTION
Adds a new page.

Initiates a catalog search based on the current filters.

Actions

Lists all actions that can be applied to selected items in the list. To
apply an action to a page, or to multiple pages, mark the checkbox in
the first column of each record that is subject to the action. Options:
Delete
Disable
Enable
Edit

Select

The control in the header of the first column can be used to select
multiple records as the target of action. Mark the checkbox in the first
column of each record that you want to select. Options: Select All /
Deselect All
Save Edits

Edit

764

Applies the current action to selected records.
Opens the record in edit mode. You can accomplish the same thing
by clicking anywhere on the row.

Magento Commerce User Guide

CHAPTER 44: Pages

Workspace Controls

Columns
COLUMN
Select

DESCRIPTION
The checkbox in the first column is used to select multiple records:
Options:
Select All
Deselect All

The ID is an incrementing number that is assigned to each page.

Title

The page title appears at the top of each page.

URL Key

The URL key is similar to a file name, and identifies the page in the
URL.

Layout

Determines if the page appears with sidebars to the right or left of the
main content area. Options:
1 column
2 columns with left bar
2 columns with right bar
3 columns
Empty

Store View

Can be used to associate the page with a specific store view.

Status

Indicates if the page is currently online or offline. Options: Enabled /
Disabled

Created

The date the page was created.

Modified

The data the page was last modified.

Action

The actions that can be applied to an individual record include:

Magento Commerce User Guide

Edit

Opens the page in edit mode.

Delete

Deletes the page.

View

Displays the page in preview mode.

765

Workspace Controls

CHAPTER 44: Pages

Page Search
The Search box in the upper-left of the page grid can be used to find specific pages by keyword.
For a more advanced search, you can filter the search by multiple parameters.

Keyword Search Results

To search by keyword:

766

Enter a search term into the page search box.

Tap Search (

) to display the results. The results include all pages that contain the keyword.

Magento Commerce User Guide

CHAPTER 44: Pages

Workspace Controls

To filter search:
1.

If necessary, click Clear All to clear the previous search criteria.

Tap the Filters (

Complete as many of the filters as necessary to describe the page(s) that you want to find.

Tap Apply Filters to display the results.

) tab to display the selection of search filters.

Filtered Search

Magento Commerce User Guide

767

Workspace Controls

CHAPTER 44: Pages

Search Filters
FILTER

DESCRIPTION

Filter the search by page record ID.

Title

Filter the search based on the page title.

URL Key

Filter the search by the URL Key.

Created

Filter the search by the date the page was created.

Modified

Filter the search based on the date the page was last modified.

Store View

Filter the search based on store view. Options: (All available Store
Views)

Layout

Filter the search based on page layout. Options:
1 column
2 columns with left bar
2 columns with right bar
3 columns
Empty

Status

Filter the search on the page status. Options: Disables / Published
Apply Filters
Cancel

Clear All

768

Applies all filters to the search.
Cancels the current search.
Clears all search filters.

Magento Commerce User Guide

CHAPTER 44: Pages

Workspace Controls

Page Actions
Pages can be edited, disabled, enabled, and deleted. To apply an action to an individual page,
mark the checkbox in the first column. To select or deselect all pages, use the mass actions
control at the top of the column.

Page Actions

To apply an action:
The Action column on the far right can be used to apply any of the following actions to the
individual page:
l

Edit

Delete

View

Single Page Actions

Magento Commerce User Guide

769

Workspace Controls

CHAPTER 44: Pages

Page Grid Layout
The selection of columns and their order in the grid can be changed according to your
preference. To keep the new column arrangement, you can save it as a view.

Moving a Column

To change the selection of columns:
In the upper-right corner, tap the Columns ( ) control. Then, do the following:
l

Mark the checkbox of any column you want to add to the grid.

Clear the checkbox of any column you want to remove from the grid.

To move a column:

770

Tap the header of the column, and hold.

Drag the column to the new position, and release.

Magento Commerce User Guide

CHAPTER 44: Pages

Workspace Controls

To save a view:
1.

Tap the View (

) control. Then, tap Save Current View.

Save Current View
2.

Enter a name for the view. Then, click the arrow (

) to save all changes. The name of the view

now appears as the current view.

To change the view:
Tap the View (

) control. Then, do one of the following:

Choose the view that you want to use.

To change the name of a view, tap the Edit (

) icon. Then, update the name.

Choose a View

Magento Commerce User Guide

771

Workspace Controls

CHAPTER 44: Pages

Scheduled Changes
Page changes can be applied on schedule, and grouped with other content changes. You can
create a new campaign based on scheduled changes to a page, or apply the changes to an
existing campaign. To learn more, see: Content Staging.

Scheduled Changes

772

Magento Commerce User Guide

CHAPTER 44: Pages

Adding a New Page

Adding a New Page
The process of adding a new content page to your store is essentially the same for any type of
page you might want to create. You can include text, images, blocks of content, variables, and
widgets. Most content pages are designed to be read by search engines first, and by people
second. Keep the needs of each of these two very different audiences in mind when choosing the
page title, and URL, and when composing the meta data, and content.
The following instructions walk you through each step to create a basic page. Some advanced
features are skipped over, but are covered in other topics.

Pages

Process Overview:
Step 1: Add a New Page
Step 2: Complete the Content
Step 3: Complete the SEO Information
Step 4: Define the Scope
Step 5: Make Design Changes (Optional)
Step 6: Preview the Page
Step 7: Publish the Page

Step 1: Add a New Page
1.

On the Admin sidebar, tap Content. Then under Elements, choose Pages.

Tap Add New Page.

Magento Commerce User Guide

773

Adding a New Page

CHAPTER 44: Pages

New Page
3.

On the new page, do the following:
a.

By default, a new page is published when the record is saved. If you do not want to
publish the page immediately, set Enable Page to "No."

Enter the Page Title. The Page Title is the name that appears in the breadcrumb trail
navigation.

To schedule design changes, expand

the Custom Design Update section. Then, do the

following:
a.

Use the calendar (

) to choose the From and To dates when the design change is to be in

effect.
b.

If applicable, set New Theme to a different theme that is to be used for the page.

If applicable, set New Layout to one of the following:
l

1 column

2 columns with left bar

2 columns with right bar

3 columns

Empty

Custom Design Update

774

Magento Commerce User Guide

CHAPTER 44: Pages

Adding a New Page

Step 2: Complete the Content
1.

Expand

the Content section.

Content
2.

In the Content Heading box, type the heading that you want to appear at the top of the page.

By default, the editor opens in WYSIWYG mode with the toolbar at the top.
l

If you prefer to work directly with the HTML code, tap Show / Hide Editor.

Complete the content and format the text as needed. You can add images, variables, and
widgets as needed. To learn more, see: Using the Editor.

Tap Save and Continue Edit.

Step 3: Complete the SEO Information
1.

Expand
a.

the Search Engine Optimization section. Then, do the following:

When the page was saved, a default URL key was created that is based on the Content
Heading. You can accept the default, or enter another URL Key that consists of all
lowercase characters, with hyphens instead of spaces.

Enter a Meta Title for the page. The Meta Title should be less than seventy characters in
length, and appears in the browser title bar and tab.

Enter your choice of high-value Meta Keywords that search engines can use to index the
page. Separate multiple words with a comma. Meta keywords are ignored by some search
engines, but used by others.

In the Meta Description field, enter a brief description of the page for search results
listings. Ideally, the description should be from 150-160 characters in length, with a
maximum limit of 255.

Magento Commerce User Guide

775

Adding a New Page

CHAPTER 44: Pages

Search Engine Optimization
2.

Tap Save and Continue Edit.

Step 4: Define the Scope of the Page
1.

Expand

the Page in Websites section.

In the Store View list, select each view where the page is to be available. If the installation has
multiple websites, select each website and store view where the page is to be available.

Pages in Websites

Step 5: Enter Any Design Changes (Optional)
1.

Expand the

Design section. Then, do the following:

Design
a.

776

To change the page layout, set Layout to one of the following:
l

1 column

2 columns with left bar

2 columns with right bar

3 columns

Empty

Magento Commerce User Guide

CHAPTER 44: Pages

Adding a New Page

To include additional layout instructions, enter valid XML code in the Layout Update
XML box.

Step 6: Preview the Page
1.

To return to the Pages grid, tap Save Page.

Fnd the page in the grid. Then in the Action column, select View.

To return to the grid, tap Back in the upper-left corner of the browser window.

Step 7: Publish the Page
1.

In the Action column of the grid, select Edit.

Set Enable Page to "Yes."

Tap Save Page .
Now that your page is complete, it can be added to your store navigation, linked to other
pages, or added as a link in the footer of your store. You can also use it as your new home
page.

Magento Commerce User Guide

777

Adding a New Page

CHAPTER 44: Pages

Switching Home Pages
You can maintain a selection of different home pages, and activate the page that you want to
use as the default home page.

To Change the Home Page:
1.

Complete the steps to add a new page.

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

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

Expand

the Default Pages section. Then, do the following:

Default Pages

Set CMS Home Page to the new page.

Tap Save Config.

In the message at the top of the workspace, tap the Cache Management link, and refresh any
invalid caches.

778

Magento Commerce User Guide

CHAPTER 44: Pages

Media Storage

Media Storage
Media storage helps you organize and gain access to media files that are stored on the server.
The path to the location of the files is determined by the Base URL configuration. Files in
media storage can be accessed from the editor while working on pages and static blocks. Media
storage is usually located in the file system on the same server as the Magento program files.
Alternatively, media files can be managed in a database, or located on a separate server or
content delivery network. The editor can be configured to use either static or dynamic media
URLs for catalog content in category or product descriptions.

Media Storage

Magento Commerce User Guide

779

Media Storage

CHAPTER 44: Pages

To upload files to media storage:
The first two steps are the same as if you are inserting an image.
1.

On the toolbar of the WYSIWYG editor, click Insert Image (

After the Image URL field, click Browse (

In the directory tree on the left, do one of the following:

Navigate to the folder where you want to save the uploaded image.

Navigate to the place where you want to create a new folder, and tap Create Folder. Then,
enter the folder name, and tap OK.

To upload file(s) to media storage, tap Choose Files . Then, do the following:
a.

In the directory of your local computer, navigate to the location of the images.

Select each image that is to be uploaded.

Tap Open.
The images are uploaded to the current media storage folder on the server.

Media Storage

780

Magento Commerce User Guide

CHAPTER 44: Pages

Media Storage

To insert an image from media storage:
Open the page or block to be edited. Then, use one of the following methods to insert an image
from media storage:

Method 1: From WYSIWYG Mode
1.

On the toolbar of the WYSIWYG editor, click Insert Image (

After the Image URL field, click Browse (

Insert Image (WYSIWYG Mode)
3.

In the directory tree on the left, navigate to the folder where the image is stored.

Select the tile of the image. Then, tap Insert File.

Insert File

Magento Commerce User Guide

781

Media Storage

CHAPTER 44: Pages

Method 2: From HTML Mode
1.

Position the cursor in the code where the tag is to be inserted.

Tap Insert Image.

Insert Image (HTML Mode)

782

Magento Commerce User Guide

CHAPTER 44: Pages

Using the Editor

Using the Editor
The editor gives you the ability to enter and format while working in a “What You See Is What
You Get” view of the content. If you prefer to work directly with the underlying HTML code,
you can easily change modes. The editor can be used to create content for pages, blocks, and
product descriptions. When working on product detail, the editor is accessed by clicking the
Show/ Hide Editor button. For a complete list of toolbar buttons, see: Using the Editor in the
online guide.

Editor Toolbar

Inserting a Link
An easy way to insert a link is to use the Link button in the editor toolbar. It doesn’t require
any knowledge of HTML, and the result is the same.

To insert a link:
1.

Highlight the text where you want to create the link. Then, in the editor toolbar, tap the Link
button.

Insert Link Button
2.

In the Link URL field, enter one of the following:
l

The URL Key of a page in your store.

The full URL of an external page to be linked.

Set Target to one of the following:
l

Open link in the same window

Open in a new window

In the Title field, enter the tooltip text to appear when someone hovers over the link.

Tap Insert to create the link.

Magento Commerce User Guide

783

Using the Editor

CHAPTER 44: Pages

Inserting an Image
From the editor, you can insert an image that has been uploaded to Media Storage, or link to
an image that resides on another server.

Media Storage

Method 1: Insert an Image from Media Storage
1.

If necessary, tap Show / Hide Editor to work directly with the code.

Position the cursor where you want the code for the image to be inserted. Then, tap Insert
Image.

Choose the image that you want to use, and tap Insert File .

To view the image in WYSIWYG mode, tap Show / Hide Editor again.

Method 2: Insert an Image from Another Server
Use this method to insert an image that is available online, but resides on another server. You
must have the full URL of the image to complete the process.
1.

If necessary, tap Show / Hide Editor to work in WYSIWYG mode.

Position your cursor where you want the image to appear.

On the Editor toolbar, tap the Insert Image button. Then, do the following:

Insert Image Button

784

Magento Commerce User Guide

CHAPTER 44: Pages

Using the Editor

In the Image URL field, paste the full URL to the image on the other server.

In the Image Description field, enter a brief description of the image.

In the Title field, enter a relevant title for the image.

Tap Insert to complete the process.

Inserting a Widget
The Widget tool can be used to add a variety of content elements to the page, including links to
any content page or node, product, or category. Links can be positioned on the page in a block
format, or incorporated directly into the content. You can use the Widget tool to create links to
the following types of content:
l

Content Pages

Catalog Categories

Catalog Products

By default, links inherit their style from the style sheet of the theme.

To insert a widget:
1.

Open the content page to be edited.

In the panel on the left, choose Content. Then, use either of the following methods:

Method 1: WYSIWYG Mode
1.

Tap Show / Hide Editor to work in WYSIWYG mode.

Position the cursor in the text where you want the widget to appear.

On the editor toolbar, tap Insert Widget.

Method 2: HTML Mode
From the HTML editor, tap Insert Widget.
3.

When prompted, choose the Widget Type. This example shows how to insert a link to a
product.

To use the product name, leave the Anchor Custom Text field empty.

Enter a Anchor Custom Title for best SEO practice. (The title isn't visible on the page.)

Set Template to one of the following:
l

To incorporate the link into text, select “Product Link Inline Template.”

To place the link on a separate line, select “Product Link Block Template.”

Magento Commerce User Guide

785

Using the Editor

CHAPTER 44: Pages

Tap Select Product, and do the following:
a.

In the tree, navigate to the category you want.

In the list, choose the linked product.

Click Insert Widget to place the link on the page. In the HTML, a markup tag for the link
appears at the top of the page, enclosed in double curly braces.

If needed, use Cut (Ctrl + x) and Paste (Ctrl + v) to position the markup tag in the code
where you want the link to appear.

Tap Show / Hide Editor to see the link in WYSIWYG mode.
You can continue editing the page, and incorporate other links into the content.

Inserting a Variable
Your store includes many predefined variables that can be incorporated into content pages and
other communications. In addition, you can include your own custom variables that are
specific to your needs.

To insert a variable on a page:
1.

Do one of the following:
l

Open an existing page.

Create a new page.

In the panel on the left, choose Content. Then from the editor, do one of the following:
l

Position the cursor where you want the variable to appear, and tap Insert Variable.

If you prefer to work with the code, click Show / Hide Editor. Position the insertion point in
the text where you want the variable to appear. Then, tap Insert Variable.

786

In the list of available variables, choose the one you want to insert into the page.

When complete, tap Save.

Magento Commerce User Guide

CHAPTER 44: Pages

Using the Editor

Configuring the Editor
The WYSIWYG editor is enabled by default, and can be used to edit content on CMS pages and
blocks, and in products and categories. From the configuration you can activate or deactivate
the editor, and elect to use static — rather than dynamic — URLS for media content in product
and category descriptions.

WYSIWYG Options

To configure the editor:
1.

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

In the panel on the left under General, choose Content Management.

Expand

the WYSIWYG Options section, and do the following:

Set Enable WYSIWYG Editor to your preference. The editor is enabled by default.

Set Static URLs for Media Content in WYSIWYG for Catalog to your preference for media
content that is included in category and product field descriptions.

When complete, tap Save Config.

Magento Commerce User Guide

787

Page Hierarchy

CHAPTER 44: Pages

Page Hierarchy
Your store’s page hierarchy system gives you the ability to organize your content pages and add
pagination, navigation, and menus. The Privacy Policy page in the sample data is an example
of a page with a menu on the left. If you publish a large amount of content on a regular basis,
you can use page hierarchy to organize your content to make it easy for people to find articles
of interest.
The page hierarchy system uses nodes to identify related pieces of content, and to organize
content pages into a parent/child relationships. A parent node is like a folder that might
contain child nodes and pages. The relative position of each node and page in the hierarchy is
shown as a tree. A node might contain other nodes and content pages, and a single content
page might be associated with multiple nodes and other content pages in a parent/child or
neighbor relationships.

Page with Left Navigation

788

Magento Commerce User Guide

CHAPTER 44: Pages

Page Hierarchy

Configuring Page Hierarchy
The configuration settings activate the page hierarchy system and metadata, and determine the
default menu layout.

CMS Page Hierarchy

To configure page hierarchy:
1.

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

In the panel on the left, under General, choose Content Management.

Expand

When complete, tap Save Config.

the CMS Page Hierarchy section, and make any changes that are necessary.

Magento Commerce User Guide

789

Page Hierarchy

CHAPTER 44: Pages

Adding a Node
The following example shows how to create a node with simple navigation to related content
pages. Although a node does not have a content page associated with it, it does have a URL
Key which can be referenced elsewhere in your site.
For example, you might create a node called “Press Releases” that has navigation to individual
press releases. Then, you can include the link on your “About Us” page to the node. Or you
might create a node for a collection of back issues of your newsletter.
To link to a node, use the Widget tool to create a CMS Hierarchy Node Link. Then, place the
widget in a content block or page.

Navigation Menu on About Us Page

Process Overview:
Step 1: Create a Node
Step 2: Add Pages to the Node
Step 3: Define the Structure
Step 4: Add Pagination Controls
Step 5: Choose the Menu Layout

790

Magento Commerce User Guide

CHAPTER 44: Pages

Page Hierarchy

Step 1: Create a Node
1.

On the Admin sidebar, tap Content. Then under Elements, choose Hierarchy.

Hierarchy - CMS Pages Grid
2.

Above the grid, tap Add Node. Then, do the following:
a.

Under Page Properties, type a Title for the node.

Enter a suitable URL Key in all lowercase characters, using hyphens to separate words,
instead of spaces.

Page Properties
c.

Tap Save . The node appears as a folder in the tree on the left of the page.

Magento Commerce User Guide

791

Page Hierarchy

CHAPTER 44: Pages

Node Added to Page Hierarchy Tree

Step 2: Add Pages to the Node
1.

In the hierarchy tree, click the node to open it in edit mode.

Scroll down to the CMS pages section, and mark the checkbox of each page you want to
include in the hierarchy.

Tap Add Selected Pages(s) to Tree. Each selected page appears in the tree below the node folder.

Pages Added to Tree

792

Magento Commerce User Guide

CHAPTER 44: Pages

Page Hierarchy

Step 3: Define the Structure
1.

If necessary, drag the pages into position to reflect the order that they are to appear in the
menu.

Drag Pages into Position
2.

Click the node at the top of the hierarchy. The Page Properties section now displays
information about the node.

Under Render Metadata in HTML Head, do the following:

Render Meta Data
a.

To identify the node as the top of the hierarchy, set First to “Yes.”

To display a pagination control, set Next/Previous to “Yes.

To organize the pages in the hierarchy as a book, set Enable Chapter/Section to “Yes.”

To assign the node to a specific part of the book, set Chapter/Section to one of the
following:
l

Chapter

Section

Both

Magento Commerce User Guide

793

Page Hierarchy

CHAPTER 44: Pages

If you don’t want to include the node as part of the book, choose “None.”

Step 4: Add Pagination Controls
1.

UnderPagination Options for Nested Pages, set Enable Pagination to “Yes.”

Pagination Options
2.

In the Frame field, enter the number of page links that you want to include in the pagination
control

If there are more pages in the hierarchy that can be included in the pagination control, do the
following:
In the Frame Skip field, enter the number of pages that you want to skip ahead (or back) for
the next set of pagination links.

794

Magento Commerce User Guide

CHAPTER 44: Pages

Page Hierarchy

Step 5: Choose the Menu Layout
1.

If you want the mode to appear in the menu, do the following:
a.

Under Page Navigation Menu Options, set Show in Navigation Menu to “Yes”.

Page Navigation Menu Options
b.

To specify the location of the menu in relation to the content, set Menu Layout ot one of
the following:
l

Use Default

Content

Left Column

Right Column

To specify how much detail is included in the menu, set Menu Detalization to one of the
following:
Only Children

Includes only subpages in the menu.

Neighbours and
Children

Includes subpages and other pages that re at the same level in the
hierarchy.

To determine the depth of the menu, set Maximal Depth to the maximum number of levels
to include.

Magento Commerce User Guide

795

Page Hierarchy

CHAPTER 44: Pages

To format the menu, choose the List Type and corresponding List Style.
Unordered

The menu options are not numbered, and can be formatted with or
without bullets..

Ordered

The menu options are numbered, and can be formatted as numeric,
alphabetic, or roman numerals in either upper-or lowercase.

Under Main Navigation Menu Options, do the following:
If you want the node to be visible in the navigation menu, set Show in Navigation menu to
“Yes”.

Main Navigation Menu Options
3.

When complete, tap Save.

Field Descriptions
FIELD

DESCRIPTION

NODE PROPERTIES
Title

The name of the the node.

URL Key

A unique web address for the node.

RENDER METADATA IN HTML HEAD
This settings in this section apply only to top-level nodes and pages, and define the structure of the
hierarchy.

796

First

Identifies the first page in the hierarchy. Options: Yes / No

Next/Previous

Adds Next and Previous page links so readers can browse in
sequence. Options: Yes / No

Enable Chapter/Section

Determines if the content can be organized as a book, with chapters
and sections. Options: Yes / No

Chapter/Section

Options:

Magento Commerce User Guide

CHAPTER 44: Pages

Page Hierarchy

Field Descriptions (cont.)
FIELD

DESCRIPTION
No

Does not assign a book part to the current
node.

Chapter

Assigns the current node as a chapter.

Section

Assigns the current node as a section.

Both

Assigns the current node as both a chapter
and section.

PAGINATION OPTIONS FOR NESTED PAGES
Enable Pagination

Determines if a pagination control appears at the bottom of the each
page. Options: Yes / No

Frame

Determines the number of pagination links that appear in the
pagination control.

Frame Skip

Specifies the number of pages to skip ahead if there are additional
pages beyond what is visible in the pagination control.

PAGE NAVIGATION MENU OPTIONS
Show in Navigation Menu

Determines if a navigational menu is generated for the page
hierarchy. Options: Yes / No

Menu Layout

Determines the default layout of navigation menu. Options:

Menu Detalization

Maximal Depth

Magento Commerce User Guide

Use Default

Uses the menu style that is specified in the
configuration.

Left Column

The menu appears to the left of the content.

Right Column

The menu appears to the right of the content.

Determines the level of detail that is to be included in the menu.
Options:
Only Children

Includes only subpages i(children) in the
menu.

Neighbors and
Children

Includes both subpages and other pages at
the same level in the hierarchy (neighbors) in
the menu.

Determines the number of levels in the menu.

797

Page Hierarchy

CHAPTER 44: Pages

Field Descriptions (cont.)
FIELD
List Type

DESCRIPTION
Determines the style that is applied to the menu. Options:
Unordered

Creates a list of menu options that can be
styled with or without bullets. List Style
Options:
Default
Circle
Disc
Square

Ordered

Creates a list of numbered menu options that
can be numbered. List Style Options:
Default
Numbers (1, 2, 3,...)
Lower Alpha (a, b, c. ...)
Upper Alpha (A, B, C, ...)
Lower Roman (i, ii, iii, ...)
Upper Roman (I, II, III, ...)

MAIN NAVIGATION MENU OPTIONS
Show in navigation menu

798

Determines if the selected node is visible in the navigation menu.
Options: Yes / No

Magento Commerce User Guide

CHAPTER 45:

Content Blocks
A block is a modular unit of content that can be positioned most anywhere on the page.
Content blocks are sometimes referred to as static blocks, or CMS blocks, and can be used to
display fixed information such as text, images, and embedded video, as well as dynamic
information from a widget or that originates in a database or other source. Most elements on
the home page are blocks that can be easily managed.
You can create custom blocks of content without writing any code, and assign them to appear
in a specific place in the page layout. Blocks can also be defined and positioned by making a
layout update in XML code.

Blocks on Home Page

Magento Commerce User Guide

799

Adding New Blocks

CHAPTER 45: Content Blocks

Adding New Blocks
Custom blocks of content can be added to any page, group of pages, or even to another block.
You can place code for a carousel image slider in a block, and then position the block on the
home page.
The Blocks workspace uses the same basic controls as the Pages workspace to help you find
blocks and perform routine maintenance operations.

Blocks Workspace

800

Magento Commerce User Guide

CHAPTER 45: Content Blocks

Adding New Blocks

To create a block:
1.

On the Admin sidebar, tap Content. Then under Elements, choose Blocks.

In the upper-right corner, tap Add New Block. Then, do the following:

New Block
a.

By default the status of the new block is enabled. If you want to change the status, set
Enable Block to “No.”

Assign a Block Title for internal reference.

Assign a unique Identifier for the block. Use all lowercase characters, with underscores
instead of spaces.

Select each Store View where the block is to be available.

Complete the block Content as needed.
l

Use the editor to format text, create links and tables, images, video, and audio.

If you prefer to work with the HTML code, tap Show / Hide Editor.

When complete, tap Save Block.
The new block appears at the bottom of the list in the Blocks grid.

Magento Commerce User Guide

801

Adding New Blocks

CHAPTER 45: Content Blocks

Adding Social Plugins
Social networking sites have a numerous plugins that can easily be added to your store. In
addition, there are many extensions on Magento Connect that can be used to integrate your
store with social media. The following example shows how to add a Facebook “Like” button to
your store.

Facebook Plugins

Step 1: Get the Button Code
1.

On the Facebook website, go to the button setup page.

In the URL to Like field, enter the URL of the page in your store that you want people to Like.
For example, you might enter the URL of your store’s home page. Then, do the following:

802

Choose the Layout for the button.

Enter the Width in pixels that is available on your site for the button and any associated
text message.

Set Action Type to one of the following:
l

Recommend

Tap Get Code to copy the generated code to the clipboard.

Magento Commerce User Guide

CHAPTER 45: Content Blocks

Adding New Blocks

Like Button Setup

Step 2: Create a Content Block
1.

Return to your store. On the Admin sidebar, tap Content. Then under Elements, choose
Blocks.

In the upper-right corner, click tap Add New Block. Then, do the following:
a.

Enter a descriptive Block Title for internal reference. For example: Facebook Like Button.

Assign a unique Identifier to the block, using all lowercase characters, and underscores
instead of spaces. For example: facebook_like_button.

If your Magento installation has multiple store views, choose each Store View where the
block is to be available.

Paste the snippet of code that you copied from the Facebook site into the Content box.

If the block is not ready to “go live,” set Enable Block to “No.”

When complete, tap Save Block.

Step 3: Place the Block
1.

On the Admin sidebar, tap Content. Then under Elements, choose Widgets.

In the upper-right corner, tap Add Widget. Then, do the following:

In the Settings section, set Type to “CMS Static Block.” Then, tap Continue.

Verify that Design Theme is set to the current theme.

Tap Continue.

In the Storefront Properties section, do the following:

Magento Commerce User Guide

803

Adding New Blocks

CHAPTER 45: Content Blocks

In the Widget Title field, enter a title for internal reference.

Set Assign to Store Views to “All Store Views,” or to the view where the app will be
available. To select more than one, hold the Ctrl key down and select each option.

Enter a number in the Sort Order field to determine the order of the block if it assigned to
appear in the same location on the page as other content elements. The top position is
zero.

In the Layout Updates section, tap Add Layout Update. Then, set Display On to the category,
product, or page where you want the block to appear.
For example, if you choose “All Pages,” and position the block in either the header or footer, the
block will appear in the same place on every page of the store.
To place the block on a specific page, do the following:
a.

Set Display On to “Specified Page.” Then, select the Page where you want the block to
appear.

Choose the Block Reference to identify the place on the page where the block is to be
placed.

Accept the default setting for Template, which is set to "CMS Static Block Default
Template."

Tap Save and Continue Edit.

In the panel on the left, choose Widget Options.

Tap Select Block…. Then in the list, choose the block that you want to place.

When complete, tap Save.

When prompted, follow the instructions at the top of the workspace to update the index and
page cache.
The widget now appears in the Widgets grid.

Step 4: Verify the Location in Your Store
Return to your storefront to verify that the block is in the correct location. To move the block,
you can reopen the widget try a different page or block reference.

804

Magento Commerce User Guide

CHAPTER 45: Content Blocks

Adding New Blocks

Adding a Lightbox or Slider
There is a wide assortment of jQuery-based image lightboxes, sliders, and carousels available
on Magento Marketplace, and some are free.

Slider Extensions
To add a lightbox or slider to your store, download the extension from Magento Markeplace,
and follow the instructions to install the extension. For additional help, see the documentation
provided by the developer.

Magento Commerce User Guide

805

Positioning Blocks

CHAPTER 45: Content Blocks

Positioning Blocks
The code that controls the page layout and placement of blocks is written in XML Widgets
make it easy to position a block at a specific place on the page, and even for a specific product
or category without writing any code. You can choose each option from a list, rather than
trying to remember all of the possible combinations.
The following list shows the locations by page type where blocks are typically placed. To learn
more about how areas on the page are defined, see: Standard Page Layouts.

Category and CMS Pages
BLOCK REFERENCE

806

POSITION

Breadcrumbs

The navigation aid at the top of many pages that shows your current
location as a link. Any additional content placed in the Breadcrumbs
reference floats to the right of the breadcrumbs, if displayed.

Left Column

Content is added to the left column.

Main Content Area

Content is added to the main content area.

My Cart Extra Actions

Content appears below the Cart Subtotal in the My Cart popup
located within the top link.

Navigation Bar

Content appears below the main navigation bar.

Page Bottom

Content appears at the bottom of the page.

Page Footer

Content appears above the footer of the page.

Page Header

Content appears below the header of the page.

Page Top

Content appears at the top of the page.

Right Column

Content appears in the right column.

Store Language

Content appears in the upper-left corner of the header.

Magento Commerce User Guide

CHAPTER 45: Content Blocks

Positioning Blocks

Product Page
BLOCK REFERENCE

POSITION

Alert URLs

Content appears below the title of the product on the product detail
page.

Bottom Block Options
Wrapper

If custom options are added, content appears below the Add to Cart
button.

Breadcrumbs

Content appears to the right of breadcrumbs—the navigation aid that
provides links as a path—that’s showcased below the navigation
bar.

Info Column Options
Wrapper

If a custom options are added, content appears to the right. The
same location applies to configurable options.

Left Column

Content appears below the left column blocks.

Main Content Area

Content appears below the main content area.

My Cart Extra Actions

Content appears below the Cart Subtotal in the My Cart popup
located within the top link.

Navigation Bar

Content appears below the main navigation bar.

Page Bottom

Content appears at the bottom of the page.

Page Footer

Content appears above the footer of the page.

Page Header

Content appears below the header of the page.

Page Top

Content appears at the top of the page.

PayPal Express Checkout
(Payflow Edition) Shortcut
Wrapper

If the PayPal payment method is enabled, content appears below the
PayPal buy button.

PayPal Express Checkout
Shortcut Wrapper

If the PayPal payment method is enabled, content appears below the
PayPal buy button.

Product Tags List

Content appears below the products tag bar.

Product View Extra Hint

Content appears below the main top price of the product.

Right Column

Content appears below the right column blocks.

Store Language

Content appears to the right of the language chooser.

Tags List Before

Content appears above the Add Your Tags field.

Magento Commerce User Guide

807

Positioning Blocks

CHAPTER 45: Content Blocks

Using a Widget
The CMS Static Block widget gives you the ability to place an existing content block most
anywhere in your store.

Process Overview:
Step 1: Choose the Type
Step 2: Complete the Layout Updates
Step 3: Place the Block

Step 1: Choose the Type

808

On the Admin sidebar, tap Content. Then under Elements, choose Widgets.

In the upper-right corner, tap Add Widget. Then do the following:
a.

In the Settings section, set Type to “CMS Static Block.” Then, tap Continue.

Verify that Design Theme is set to the current theme.

Tap Continue.

Magento Commerce User Guide

CHAPTER 45: Content Blocks

Positioning Blocks

Settings
3.

In the Storefront Properties section, do the following:
a.

In the Widget Title field, enter a descriptive title for internal reference.

Set Assign to Store Views to “All Store Views,” or to the view where the app will be
available. To select more than one, hold the Ctrl key down and select each option.

Enter a number in the Sort Order field to determine the order of the block if it assigned to
appear in the same location on the page as other content elements. The top position is
zero.

Storefront Properties

Magento Commerce User Guide

809

Positioning Blocks

CHAPTER 45: Content Blocks

Step 2: Complete the Layout Updates
1.

In the Layout Updates section, tap Add Layout Update. Then, do the following:

Set Display On to the category, product, or page where you want the block to appear. To place
the block on a specific page, do the following:
a.

Choose the Page where you want the block to appear.

Choose the Block Reference that identifies the place on the page where the block is to be
placed.

Accept the default setting for Template, which is set to "CMS Static Block Default
Template."

Layout Updates

Step 3: Place the Block
1.

In the panel on the left, select Widget Options.

Tap Select Block…. Then in the list, choose the block that you want to place.

When complete, tap Save.
The app now appears in the list.

When prompted, follow the instructions at the top of the workspace to update the index and
page cache.

Return to your storefront to verify that the block appears in the correct location. To move the
block, you can reopen the frontend app try a different page or block reference.

810

Magento Commerce User Guide

CHAPTER 45: Content Blocks

Positioning Blocks

Using a Layout Update
Blocks can be placed in the left or right sidebar of a specific page by making a layout update to
the XML code. With a few simple changes to the code, you can position the block in either
sidebar, and control its position in relation to other blocks.
The term callout 1 is sometimes used to refer to a block that is defined as a layout update with
XML code. The term sidebar2 refers to the left or right columns of the page layout. When
entering layout update code, make sure to follow the syntax exactly as shown in the example.
To place a block in the sidebar, the page must have a two-or three-column layout. To learn more,
see: Page Layout.

To place a block in the sidebar of a page:
1.

On the Admin sidebar, tap Content. Then under Elements, choose Blocks.

In the grid, find the block you want to place, and take note of its Identifier. Make sure that you
have the correct spelling.

On the Admin sidebar, tap Content. Then under Elements, choose Pages.

Find the page where you want to place the block, and open the page in edit mode.

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

In the Layout Update XML box, enter the code for the right or left sidebar.
Code for CMS Block in Sidebar

your-block-id

Change the reference name to identify either the “right” or “left” column, according to the
layout of the page.

Change the block_id to the identifier of the block that is being placed.

When complete, tap Save Page.

1A term that is sometimes used to describe a block that is defined as a layout update using XML code.
2The right or left column of a two-column page layout.

Magento Commerce User Guide

811

812

Magento Commerce User Guide

CHAPTER 46:

Banners
Banners can be used to display an image or block of content, and appear for a specific period of
time for a promotion. You can create banners that are visible only to certain customer
segments, or whenever price rule conditions and coupons apply.
When designing banners for your store, take into consideration both the page layout and the
theme you are using. Banners are often designed to appear on a specific page, and in a specific
part of the page layout. Although the header and footer are a fixed width, the width of the
content area and sidebars, can vary according to theme and page layout. When designing a
banner with graphic images, it is important to understand the page layout, so you can put the
available space to best use.

Banner on Home Page

Magento Commerce User Guide

813

Creating a Banner

CHAPTER 46: Banners

Creating a Banner
A banner can be as simple as a text message or image, or contain a combination of text,
images, and code that is triggered by a promotion according to schedule. After the banner is
created, use the Widget tool to place it in your store, or add it to a rotating sequence of
banners.

Free Shipping Banner in Header

Process Overview:
Step 1: Complete the Banner Properties
Step 2: Complete the Banner Content
Step 3: Choose a Related Promotion (optional)
Step 4: Place the Banner

Step 1: Complete the Banner Properties
1.

On the Admin sidebar, tap Content. Then under Elements, choose Banners.

In the upper-right corner, tap Add Banner. Then, do the following:
a.

Enter a Banner Name for internal reference.

Set Status to “Active.”

In the Applies To list, select one of the following:
l

Any Banner Type

Specified Banner Types
This setting determines the location on the page where the banner is placed. (To select
more than one, hold the Ctrl key down and click each option.)

814

Magento Commerce User Guide

CHAPTER 46: Banners

Creating a Banner

Banner Properties
d.

If the banner is to be used for a specific customer segment, set Customer Segments to
“Specified.” Then, choose each customer segment that is associated with the banner.

Step 2: Complete the Banner Content
1.

In the panel on the left, choose Content.

If the banner is to use the same content for each store view, clear the No Default Content
checkbox.

Default Content
3.

In the text box, enter the HTML code that is needed to format the banner. Then, do any of the
following:

Insert Widget
1.

Tap Insert Widget.

Choose the Widget Type.

Complete the Widget Options.

Tap Insert Widget.

Insert Image
1.

Tap Insert Image.

In the text box, position the cursor where you want the image tag to be inserted.

Magento Commerce User Guide

815

Creating a Banner

CHAPTER 46: Banners

Do either of the following:
l

Tap Browse to find the image on your local computer.

Locate the image in the media folders on the left.

Tap Insert File.

Insert Variable

To insert a variable, tap Insert Variable. Then, choose the variable that you want to insert.

Complete the HTML as needed. Depending on the content, the text box might contain a
combination of HTML and markup tags.

To create content for a specific store view, do the following:
a.

In the Store View Specific Content box after the name of the store view, clear the Use
Default checkbox.

Follow the instructions in the previous step to enter the banner content for the store view.

Step 3: Choose a Related Promotion (optional)
1.

In the panel on the left, choose Related Promotions.

Scroll down through the list of available promotions for the type of price rule, and mark the
checkbox of each promotion that can be used with the banner.

Related Promotions
3.

816

When complete, tap Save Banner.

Magento Commerce User Guide

CHAPTER 46: Banners

Creating a Banner

Banner Saved

Step 4: Place the Banner
Use the Widget tool to create a Banner Rotator that places the banner at a specific location in
the store.

Banner Type by Location
LOCATION

DESCRIPTION

Content Area

The width of the main content area varies, depending on the column
layout of the page.

Footer

The bottom section of the page contains the footer links and
copyright notice.

Header

The top section of the page contains your logo, account links, search
box, and top navigation.

Left Column

The left column of a two- or three-column layout.

Right Column

The right column of a two-or three-column layout.

Magento Commerce User Guide

817

Rotating Banners

CHAPTER 46: Banners

Rotating Banners
A banner rotator can be used to display a single banner, or multiple banners in a specific
sequence or random order. The next banner in the sequence appears whenever the page is
refreshed.
The banner rotator is a frontend app that can be assigned to a specific page, product, or
category, and placed most anywhere in your store. In addition, banner rotators can be
associated with a specific cart or catalog price rule.
Process Overview:
Step 1: Create the Individual Banners
Step 2: Add a Widget
Step 3: Configure the Banner Rotator

Step 1: Create the Individual Banners
Create the individual banners that you want to include in the rotator.

Step 2: Add a Widget
Follow the basic steps to add a widget.
l

Set Type to "Banner Rotator."

Under Layout Updates, choose the page and location where the banner rotator is to appear.

Step 3: Configure the Banner Rotator
1.

818

In the left panel, choose Widget Options. Then, do the following:
a.

Set Banners to Display to “Specified Banners.”

(Optional) To limit the banner to a certain area of the page, set Restrict by Banner Types
to the place on the page where you want the banner to appear.

Set Rotation Mode to one of the following:
l

Do not rotate, display all at once

One at a time, Random

One at a time, Series

One at a time, Shuffle

To choose the banners to be included in the rotator, do the following:

Magento Commerce User Guide

CHAPTER 46: Banners

Rotating Banners

In the Specify Banners section, use Search to find the banners you want to include. If
necessary, tap Reset Filter to list all the available banners.

Mark the checkbox of each banner you want to include in the rotator.

To set the sequence of each banner in relation to the others, enter a number in the
Position column. To place a banner in the first position, enter the number 1.

When complete, tap Save.

Banner Layout Update Options
OPTION
Display On Categories

DESCRIPTION
Determines the categories where the banner rotator appears.
Anchor Categories

Appears only on anchored category pages
listed in the layered navigation.

Non-Anchor
Categories

Appears only on non-anchored category
pages, which are category pages that are not
shown in the layered navigation.

Products

Displays the banner rotator for a specific
product, or type of product. Options:
All Product Type
Simple Product
Grouped Product
Configurable Product
Bundle Product
Virtual Product
Gift Card

Other PayPal Solutions

CHAPTER 71: Recommended Solutions

Other PayPal Solutions
PayPal is a global leader in online payments and a fast and secure way for your customers to
pay online. With PayPal and Magento Commerce, you can accept payments from all major
debit and credit cards. PayPal offers additional convenience without extra effort, because even
your customers who don’t have a PayPal account can pay for their purchases with PayPal. In
this guide, PayPal payments solutions are organized as follows:
l

Other PayPal Solutions

PayPal All-In-One Payment Solutions
In the United States, PayPal offers the following PCI-compliant solutions to meet the needs of
your growing business.
l

PayPal Payments Advanced

PayPal Payments Pro

PayPal Payments Standard

PayPal All-In-Payment Solutions

PayPal Payment Gateways
PayPal offers a choice of two payment gateway solutions for your business. You can let PayPal
host your checkout on its secure payment site, or you can take control of the entire payment
experience with a completely customizable solution.
l

PayPal Payflow Pro

PayPal Payflow Link

PayPal Payment Gateways

Magento Commerce User Guide

1157

Other PayPal Solutions

CHAPTER 71: Recommended Solutions

PayPal Payments Advanced
PayPal Payments Advanced is a PCI-compliant solution that lets your customers pay by debit
or credit card without leaving your site. It includes an embedded checkout page that can be
customized to create a seamless and secure checkout experience.

PayPal Payments Advanced
Even customers without a PayPal account can make purchases through PayPal’s secure
payment gateway. Accepted cards include Visa, MasterCard, Switch/Maestro, and Solo credit
cards in the United States and United Kingdom. For additional convenience, PayPal Express
Checkout is included with PayPal Payments Advanced.
You can have two PayPal solutions active at the same time: Express Checkout, plus any All-InOne or Payment Gateway solution. If you change payment solutions, the one that was used
previously is disabled.
PayPal Payments Advanced cannot be used for orders created from the Admin of your store.

Requirements
PayPal Business Account

If you manage multiple Magento websites, you must have a separate PayPal merchant
account for each website.

1158

Magento Commerce User Guide

CHAPTER 71: Recommended Solutions

Other PayPal Solutions

Checkout Workflow
Customer Chooses Payment Method. During checkout, the customer chooses to pay
with PayPal Payments Advanced. The Pay Now button appears instead of the Place
Order button.
Pay Now. The customer taps Pay Now, and a PayPal-hosted form appears. The
customer enters the card information, and the card is verified. If successful, the order
confirmation page appears.
Pay with PayPal. The form also includes the Pay with PayPal button, which redirects
the customer to the PayPal site, where payment can be made with PayPal Express
Checkout.
Troubleshooting. If the transaction fails for any reason, an error message appears on
the checkout page and the customer is instructed to try again. Any issues are managed
by PayPal.

Order Processing Workflow
Processing orders with PayPal Payments Advanced is the same as for any regular PayPal order.
Orders are invoiced and shipped, and credit memos generated for both online and offline
refunds. However, multiple online refunds are not available for orders paid with PayPal
Payments Advanced.
Customer Places Order. In the final stage of checkout, the customer taps the Place
Order button.

PayPal Responds. PayPal evaluates the request. If found to be valid, PayPal
processes the transaction.

Magento Commerce User Guide

1159

Other PayPal Solutions

CHAPTER 71: Recommended Solutions

Magento Sets Order Status. Magento receives response from PayPal, and sets the
order status to one of the following:
Processing

The transaction was successful.

Pending Payment

The system did not receive any response from PayPal.

Canceled

The transaction was not successful for some reason.

Suspected Fraud

The transaction did not pass some of the PayPal fraud filters.
The system receives the response from PayPal that the
transaction is under review by Fraud Service.

Merchant Fulfills Order. The merchant invoices and ships the order.

Setting Up PayPal Payments Advanced
For step-by-step configuration instructions, see PayPal Payments Advanced in the Magento
Commerceonline user guide.

Setting Up PayPal Payments Advanced

1160

Magento Commerce User Guide

CHAPTER 71: Recommended Solutions

Other PayPal Solutions

PayPal Payments Pro
PayPal Payments Pro brings you all the benefits of a merchant account and payment gateway
in one, plus the ability to create your own, fully cu