Table of Contents for
Magento 2 - Build World-Class online stores

Version ebook / Retour

Cover image for bash Cookbook, 2nd Edition Magento 2 - Build World-Class online stores by Jonathan Bownds Published by Packt Publishing, 2017
  1. Cover
  2. Table of Contents
  3. Magento 2 - Build World-Class online stores
  4. Magento 2 - Build World-Class online stores
  5. Credits
  6. Preface
  7. 1. Module 1
  8. 1. Magento Fundamentals
  9. XAMPP installation
  10. Magento
  11. Summary
  12. 2. Magento 2.0 Features
  13. An introduction to the Magento order management system
  14. Magento 2.0 command-line configuration
  15. The command-line utility
  16. Summary
  17. 3. Working with Search Engine Optimization
  18. Store configuration
  19. SEO and searching
  20. SEO catalog configuration
  21. Google Analytics tracking code
  22. Optimizing Magento pages
  23. Summary
  24. 4. Magento 2.0 Theme Development – the Developers' Holy Grail
  25. Magento 2.0 theme structure
  26. The Magento Luma theme
  27. Magento theme inheritance
  28. CMS blocks and pages
  29. Custom variables
  30. Creating a basic Magento 2.0 theme
  31. Summary
  32. 5. Creating a Responsive Magento 2.0 Theme
  33. Composer – the PHP dependency manager
  34. Building the CompStore theme
  35. CSS preprocessing with LESS
  36. Applying new CSS to the CompStore theme
  37. Creating the CompStore logo
  38. Applying the theme
  39. Creating CompStore content
  40. Customizing Magento 2.0 templates
  41. Summary
  42. 6. Write Magento 2.0 Extensions – a Great Place to Go
  43. Using the Zend framework
  44. Magento 2.0 extension structure
  45. Developing your first Magento extension
  46. The Twitter REST API
  47. The TweetsAbout module structure
  48. Using TwitterOAuth to authenticate our extension
  49. Developing the module
  50. Summary
  51. 7. Go Mobile with Magento 2.0!
  52. Adjusting the CompStore theme for mobile devices
  53. The Magento 2.0 responsive design
  54. The Magento UI
  55. Implementing a new CSS mixin media query
  56. Adjusting tweets about extensions for mobile devices
  57. Summary
  58. 8. Speeding up Your Magento 2.0
  59. Indexing and caching Magento
  60. Indexing and re-indexing data
  61. The Magento cron job
  62. Caching
  63. Fine-tuning the Magento hosting server
  64. Selecting the right Magento hosting service
  65. Apache web server deflation
  66. Enabling the expires header
  67. Minifying scripts
  68. Summary
  69. 9. Improving Your Magento Skills
  70. Magento knowledge center
  71. Improving your Magento skills
  72. Summary
  73. 2. Module 2
  74. 1. Magento 2 System Tools
  75. Installing Magento 2 sample data via GUI
  76. Installing Magento 2 sample data via the command line
  77. Managing Magento 2 indexes via the command line
  78. Managing Magento 2 cache via the command line
  79. Managing Magento 2 backup via the command line
  80. Managing Magento 2 set mode (MAGE_MODE)
  81. Transferring your Magento 1 database to Magento 2
  82. 2. Enabling Performance in Magento 2
  83. Configuring Redis for backend cache
  84. Configuring Memcached for session caching
  85. Configuring Varnish as the Full Page Cache
  86. Configuring Magento 2 with CloudFlare
  87. Configuring optimized images in Magento 2
  88. Configuring Magento 2 with HTTP/2
  89. Configuring Magento 2 performance testing
  90. 3. Creating Catalogs and Categories
  91. Create a Root Catalog
  92. Create subcategories
  93. Manage attribute sets
  94. Create products
  95. Manage products in a catalog grid
  96. 4. Managing Your Store
  97. Creating shipping and tax rules
  98. Managing customer groups
  99. Configuring inventories
  100. Configuring currency rates
  101. Managing advanced pricing
  102. 5. Creating Magento 2 Extensions – the Basics
  103. Initializing extension basics
  104. Working with database models
  105. Creating tables using setup scripts
  106. Creating a web route and controller to display data
  107. Creating system configuration fields
  108. Creating a backend data grid
  109. Creating a backend form to add/edit data
  110. 6. Creating Magento 2 Extensions – Advanced
  111. Using dependency injection to pass classes to your own class
  112. Modifying functions with the use of plugins – Interception
  113. Creating your own XML module configuration file
  114. Creating your own product type
  115. Working with service layers/contracts
  116. Creating a Magento CLI command option
  117. 3. Module 3
  118. 1. Planning for Magento
  119. Technical considerations
  120. Global-Website-Store methodology
  121. Planning for multiple stores
  122. Summary
  123. 2. Managing Products
  124. Managing products the customer focused way
  125. Creating products
  126. Managing inventory
  127. Pricing tools
  128. Autosettings
  129. Related products, up-sells, and cross-sells
  130. Importing products
  131. Summary
  132. 3. Designs and Themes
  133. The concept of theme inheritance
  134. Default installation of design packages and themes
  135. Installing third-party themes
  136. Inline translations
  137. Working with theme variants
  138. Customizing themes
  139. Customizing layouts
  140. Summary
  141. 4. Configuring to Sell
  142. Payment methods
  143. Shipping methods
  144. Managing taxes
  145. Transactional e-mails
  146. Summary
  147. 5. Managing Non-Product Content
  148. Summary
  149. 6. Marketing Tools
  150. Promotions
  151. Newsletters
  152. Using sitemaps
  153. Optimizing for search engines
  154. Summary
  155. 7. Extending Magento
  156. The new Magento module architecture
  157. Extending Magento functionality with Magento plugins
  158. Building your own extensions
  159. Summary
  160. 8. Optimizing Magento
  161. Indexing and caching
  162. Caching in Magento 2 – not just FPC
  163. Tuning your server for speed
  164. Summary
  165. 9. Advanced Techniques
  166. Version control
  167. Magento cron
  168. Backing up your database
  169. Upgrading Magento
  170. Summary
  171. 10. Pre-Launch Checklist
  172. System configurations
  173. Design configurations
  174. Search engine optimization
  175. Sales configurations
  176. Product configurations
  177. Maintenance configurations
  178. Summary
  179. Index

Magento cron

If you're not up on Unix lingo, a cron job is a scheduled action that occurs at preset intervals on your server. For instance, Magento can create a new sitemap for your store according to the time interval you configure in the backend.

What is confounding to many new to Magento is that configuring cron intervals for various Magento functions doesn't actually cause anything to happen. The reason is that your server must still be told to run the configured tasks.

Cron jobs are configured by using what are called crontabs. These are expressions that dictate how often the server is to run the particular task.

Magento cron jobs

There are a few inherent functions included with Magento that can be run periodically, including:

  • Catalog pricing rules
  • Sending out scheduled newsletters
  • Customer alerts for product price changes and availability
  • Retrieval of currency exchange rates
  • Creating sitemaps
  • Log cleanup

Some third-party modules also include scheduled tasks, such as Google Product feeds. The frequency of most of these can be configured in your Magento backend. For those that aren't, you can find the crontab-style setting for each in the config.xml file of each module.

For example, the following is the cron schedule for the function that sends out scheduled newsletters, from app/code/Mage/Newsletter/etc/config.xml:

    <crontab>
        <jobs>
            <newsletter_send_all>
                <schedule><cron_expr>*/5 * * * *</cron_expr></schedule>
                <run><model>newsletter/observer::scheduledSend</model></run>
            </newsletter_send_all>
        </jobs>
    </crontab>

According to this crontab, Magento looks every 5 minutes to see if any newsletters need to be sent out.

Module

Cron job

Default frequency

Active?

Catalog

Reindex pricing

Every day at 2am

Yes

CatalogIndex

Reindex the entire catalog

Every day at 2am

No

CatalogIndex

Run queued indexing

Every minute

No

CatalogRule

Daily catalog update

Every day at 1am

Yes

Directory

Update currency rates

Controlled by Currency Setup | Scheduled Import Settings

Yes

Log

Clean logs

Every 10 minutes

No

Newsletter

Send scheduled newsletters

Every 5 minutes

Yes

PayPal

Fetch settlement reports

Controlled by PayPal | Settlement Report Settings

Yes

ProductAlert

Send product alerts to subscribing customers

Controlled by Catalog | Product Alerts Run Settings

Yes

Sales

Clean expired quotes

Every day at midnight

Yes

Sales

Generate aggregate reports (there are actually five configured)

Every day at midnight

Yes

SalesRule

Generate aggregate coupon data report

Every day at midnight

Yes

Sitemap

Generate sitemaps

Controlled by Google Sitemap | Generation Settings

Yes

Tax

Generate aggregate tax report

Every day at midnight

Yes

Many of Magentos core modules contain crontab scripts, although some are commented out. The following is a list of Magento Community 1.5 crontabs I have found within Magento, indicating for each whether the script is active or not. To make a script active, simply remove the comment tags surrounding the <crontab> code in the appropriate config.xml file.

Note

Note that some crontabs run according to values stored in your Magento database. The paths to these settings within System | Configuration in your backend are included in this table. Even if these crontabs are active, your backend configuration may need to be enabled in order for these to run.

Triggering cron jobs

For your staging environment, you may want to keep cron jobs from running automatically. Rather, you may wish to have Magento run through its list of scheduled tasks at your command so you can watch for any problems or errors.

A wrinkle in Magento 2.0 is that there's no longer a cron.php, so Magento's cron can no longer be triggered from the command line (manually).

To manually run any scheduled jobs, access the magento file found in your site's root folder from the terminal and use the following command:

php <path to magento root>/bin/magento cron:run

For your production server, you'll want cron jobs to run as scheduled around the clock. To do this, you have to create a cronjob for your server, telling it how often to trigger Magento's cron tasks. For most servers — Unix and Linux — the cron program operates as a continuous daemon, waiting to take some action according to any programmed crontabs. In this case, we want to have the magento binary (also in our Magento root folder) run by the server every few minutes or so.

Tip

Generally, I set this to run every 15 minutes (we'll see in a moment how you can make sure that jobs set to run every 5 minutes by Magento are still completed).

The most straightforward way to schedule a cron job is to do so from the command line. Start by opening up a command prompt as the root user and typing in the following command:

crontab –e
Triggering cron jobs

This command will take you to a screen where you can add entries to schedule the cron. To automate the Magento cron, you'll want to add entries that look like this:

Triggering cron jobs

You can schedule crons to run every X number of minutes, hours, days, or months. You can schedule them to run only during certain times of the day, days of the week, or months of the year. Cron is an amazingly flexible system. The following screenshot shows the logic for scheduling crons:

Triggering cron jobs

This can be a bit obtuse to understand, though; if you want a quick way to sort out timing for a cron job, you can visit one of the many crontab generating websites. One example is http://crontab-generator.org/. As you can see, this site provides assistance and makes it a bit easier to generate the desired schedule:

Triggering cron jobs

Tuning Magento's schedules

The Magento binary does a number of things when your server cron job runs:

  • It executes any scheduled tasks
  • The script generates schedules for any future tasks
  • Finally, the script cleans up any history of scheduled tasks

The parameters that control this behavior are configured in your Magento backend:

  1. Go to Stores | Configuration | Advanced | System.
  2. Expand the Cron (Scheduled Tasks) panel.
  3. For each item, fill in the number of minutes.
  4. Click on Save Config.

Each field in this panel controls the timing actions of the cron script, as follows:

  • Generate Schedules Every means that new schedules will not be created more frequently than the number of minutes configured.
  • Schedule Ahead for is the number of minutes that will be generated in future schedules.
  • Missed if Not Run Within tells the script to run any tasks that were scheduled within the indicated number of minutes before the script ran, but which haven't run already.
  • History Cleanup Every deletes old history entries in the cron_schedule database table. This will help keep the table from growing too large.
  • Success History Lifetime similarly purges successful entries from the cron_schedule table.
  • Failure History Lifetime does just what you imagine: purges failure entries.

There remains considerable debate among bloggers on what values are ideal for this configuration. However, from my observations, there are some principles I follow when configuring Magento cron jobs.

Setting your frequency

Decide the frequency of your server cron job. If you configure your server cron to run every 15 minutes, then you do not need any Magento crontab or cron configuration to be set at anything less than 15 minutes. For example, the Send Newsletter crontab, as shown in the earlier table, is configured by default to run every 5 minutes.

If your system cron task runs every 15 minutes, then when cron.php is executed, the send newsletter task is actually run three times, since Magento schedules ahead and looks back to run any scheduled tasks. In order words, if your system cron runs at 10:00 am, it will run any tasks that were scheduled to run between 9:45 am (the last time it ran) and 10:00 am. Since the send newsletter task was scheduled to run every 5 minutes, at 9:45 am, Magento scheduled it to run at 9:50, 9:55, and 10:00. The task did not run at those times, but instead were all run at once at 10:00 when your system cron ran.

Therefore, you may want to go back through the various module config.xml files (such as the ones in the earlier table) and set the frequency of the jobs to match or be less frequent than your system cron.

Creating compatible settings

Once you have modified any crontabs to match your system cron job frequency, you should now configure the Store | Configuration | Advanced | Cron (Scheduled Tasks) panel:

  • Use the same number of minutes as your system cron job frequency for Generate Schedules Every.
  • Use the same value for Schedule Ahead For. In this way, you are capturing all the upcoming cron jobs Magento intends before your next system cron runs.
  • Use the same value for Missed If Not Run Within to run any scheduled tasks that did not run during the last system cron.
  • Use the same value for History Cleanup Every. You can use a larger interval if you wish, as this is not a critical function to running the necessary cron jobs for your store.
  • For Success History Lifetime and Failure History Lifetime, you can use whatever settings you feel are most important. Generally, when launching a new Magento store, I set the Failure History Lifetime for a long time (as much as 3 days, or 4320 minutes) so that if something seems amiss, I can go into the cron_schedule database table and see if there are any failure messages that can help me diagnose the problem. In fact, even if your store is running smoothly, keeping this number large should not grow your database, as there will be no failure messages to record.

So, for example, if I set my system cron job to run every 15 minutes, my Cron (Scheduled Tasks) panel might look like this:

Creating compatible settings