Module Settings Overview

Next thing you have to do is style your pop-up form and e-mail. To do so, you have to access the module's settings first and navigate to the Settings tab. The tab has some fields and two text editors within itself. The first part looks like this:

text

Admin notification by Email: This is a drop-down menu field with the options of Enabled and Disabled. You can enable it if you want to receive e-mails to your store's email every time a customer subscribes to an out of stock product.

Styling the Pop-up form

Pop-up Width: This field allows you to set the width dimension of your pop-up form in pixels. By default, it is set to 250px.

Pop-up Title: This field allows you to set a title for your pop-up.

The text editor: The text editor allows you to easily style your form. You can format the text in it by changing its font, size and alignment etc. Use the short-codes on the left to determine the position of the input fields. Short-codes are as follows:

NoteNote that there are tabs for the different languages (if your store is running on more than one language) and you can create different pop-ups for each.

{name_field} - Use this short-code to position the field for the customer's name

{email_field} - Use this short-code to position the field for the customer's e-mail

{submit_button} - Use this short-code to position the submit button

ImportantMake sure you use all the short-codes. Not using them all might cause the module to malfunction at some point.

This is how the pop-up from the example looks like:

notification

Styling the E-mail

The second text editor is to style the e-mail customers are going to receive when a product they are subscribed for comes back in stock:

email

It has all the functions of the first one. The title field is replaced by Email Subject and serves the purpose of setting a subject for your email. The short-codes available for this text editor are as follows:

{c_name} - replaces the given customer's name

{p_name} - replaces the given product's name

{p_image} - this stands for the product's image

{p_link} - this replaces the product's URL. You can also use that short-code with the Link button.

This is how the email from the example will look for a customer by the name of George:

in_stock

At the bottom of the page, there is a text-area by the name of Custom CSS. It is an opportunity for anyone familiar with CSS to add custom styles to the Pop-up.

Once you are done with creating your templates, scroll up and click the green Save Changes button.

Waiting List, Archive & Statistics

Within the module's settings, there are two tabs by the names of Waiting List and Archive. They both contain one table each.

Waiting List

The table in this tab lists all the customers that are awaiting notification for a given product.

It consists of 6 columns. This is how a row from the table looks like:

waiting_list

Customer Email: This column contains the email the user has input in the pop-up form.

Customer Name: This column contains the name the user has input in the pop-up form.

Product: This column is for the product's name.

Date: Here you can find the date the customer has subscribed to the given product.

Language: Since NotifyWhenAvailable can have different pop-up and email templates for the different languages in your store (if you have such), this column shows what language the customer had been using when he/she made the subscription. Therefore, it also represents the language the sent e-mail will be in.

Action: This is the only column with functionality within it. With the Remove button you can delete customers from the record.

NoteDeleted customers will not be notified.

Right below the table, there are 2 buttons labeled Export to CSV and Remove all:

csv

Export to CSV: By clicking on this button, you will automatically download an Excel file, containing all the data from the current page of the table.

Remove all: This button will delete all the data from table. Bear in mind, none of it can be restored unless you have database backup.

Archive

Content-wise, the table in this tab is absolutely the same as the one in the Waiting List. The only difference is that the customers listed in this table are the already notified ones.

Also, this page does not include the Export to CSV function but still has the Remove all one.

Statistics

This tab provides a visualization of the waiting/archived customers for each product in the form of a column chart:

statistics

On the bottom, you have each product's name.

Orange columns show already notified (archived) customers, while the blue ones stand for customers that are awaiting notification. By hovering your mouse over each of the columns, you can see the exact number of customers each column represents.

Scheduled tasks & CRON jobs

NotifyWhenAvailable is designed to track all product quantity changes that are done from the Catalog > Products > Edit. So, whenever you change a product's quantity from 0 to a number greater than 0, NotifyWhenAvailable will spot that and act upon the matter by sending emails to all customers that are subscribed to the given product. However, if you change a product's quantity from somewhere else (quick edit modules, directly from the database or the inventory system), you will need the scheduling tasks in order to alert NotifyWhenAvailable and, therefore, the customers about the changes.

That said, you should only continue reading if you are planning on changing products' quantities from a place different than the Product Edit page. Otherwise, you will be just fine.

Scheduled tasks

To enable NotifyWhenAvailable's scheduled tasks, you should navigate to the module's settings. Then, in the Control Panel tab, there is a field by the name of Scheduled Tasks. It is a drop-down menu that should be set to Enabled in order for NotifyWhenAvailable's scheduled tasks to be activated.

Testing & Setup

Upon choosing Enabled from the drop-down menu, a set of options will appear:

testing

Testing

First off, you have to check whether your server supports CRON jobs. To do so, click on the orange Test Cron button. If everything is as it should be, the newly-appeared window should look like this:

cron

If the texts in the red rectangle differ from these and say Disabled, then you should:

  • Contact your hosting provider on that matter
  • Check out the information behind the blue My server does not support cron jobs button

Provided they are as shown, continue reading.

ImportantIf you know your server does support CRON jobs, but the shown-above modal window shows that the feature is disabled, this means that the automatic creation of CRON commands is disabled. In that case, you should use this URL string: {path_to_your_site}/vendors/notifywhenavailable/sendMails.php 0 in your hosting config panel. The 0 at the end stands for your store ID, which is 0 by default.

CRON Setup Options

Receive notification when the task is executed: This field is a drop-down menu with two options - Enabled and Disabled. If you Enable it, you will receive an email to your OpenCart store email every time a scheduled task is executed.

  • Type: This field determines whether you want CRON jobs to run checks on Fixed dates or Periodically.
  • Fixed dates: If you choose this option, you will get the chance to set dates and time in the Type field. The date/s and time/s you choose will be the moments when CRON jobs checks whether something quantity-related from the products with subscribers has changed. Provided it has, NotifyWhenAvailable is going to notify subscribed users about it.
  • Periodic: This options allows you to set a fixed period for a CRON job to run its checks. You can choose whether you want to do it every day/week/month or year and specify everything up to the hours and minutes.

Once you are ready with setting your scheduled tasks up, you can scroll up and click the Save Changes button.