Page tree
Skip to end of metadata
Go to start of metadata
Table of Contents

The Order System is installed by default, but may need to be installed for addon companies.

Installing Order System

  1. Visit [Settings] > [Company] > [Plugins] > Available.
  2. Click the "Install" button within the Order System plugin listing.
  3. To enable the Order System widget, go to [Billing] > Overview, click the "Manage Widgets" link, and drag the Orders widget from the right to the left.

Order System Overview

Once installed, a new link will appear under [Packages] > Order Forms, where order forms can be managed. In the screen below, two order forms have already been created and they can be managed at this location.


Creating an Order Form

To create an order form, click the "Add Order Form" button in the upper right of the overview and fill out the options. Click "Add Form" to create the order form.

Basic

This section requests some basic information regarding the order form and it's configuration including:

  1. Status – This is the status of this order form, Active to enable the order form or Inactive to disable it.
  2. Name – The name of this order form, this will appear in the heading on front facing pages for this order form.
  3. Label – The label helps make up the URL to this order form, which is displayed next to the field, and must be unique.
  4. Type – This is the type of order form, currently the following three are available: Domain and Other, General, and Client Registration. In most cases, the General type is preferred. This selection will determine what options are displayed for the Template.
  5. Template – Select an order form template. The template controls the look and flow of the order form. Wizard boxes is the default template, and is most widely used.

Basic (Continued)

This section contains some additional options within the Basic section.

  1. Default Client Group – This is the client group users who sign up through this order form will be assigned.
  2. Allow Coupons – Whether or not coupons should be allowed on this order form. If coupons are not allowed, the coupon section on the order form will not be displayed.
  3. Require Manual Review and Approval of All Orders – If this is checked, all orders will need to be approved by a staff member before being provisioned, regardless of any anti-fraud settings.
  4. Force Secure Connection (HTTPS) – If checked, the order form will force https:// URLs.
  5. Require Human Verification Challenge for All Signups – If checked, reCaptcha human verification will be used, depending on the Setting under the Settings tab.
  6. Require Agreement to Terms of Service – If checked, users will be required to agree to the terms of service before checking out.
  7. Terms of Service URL – Enter the URL to your terms of service page. This isn't necessary if "Require Agreement to Terms of Services" isn't checked.

Package Groups & Currencies

These sections determine what Package Groups (And hence Packages) are available through this order form as well as what currencies are accepted.

  1. Assigned Groups & Available Groups – Move Package Groups from the right box (Available Groups) to the left box (Assigned Groups) to make them available on this order form.  As of v4.3.0 Package Groups are displayed on the order form in the order shown here under 'Assigned Groups'.
  2. Currencies – Select which currencies to accept on this order form. If only one currency is selected, the currency selector will not appear on the order form.

Settings

The Order System supports various settings for human verification, fraud detection, embed codes, marketing emails, and allows the default order form to be selected. The default order form appears at ~/order/ and is linked to from the Portal page. Settings consist of several sections.

Basic Options
  1. Default Order Form – Select which order form should be the default order form. It will be available at ~/order/ and linked to directly from the portal page. Alternatively, select "None - Show Listing" which will instead show a listing of all order forms at ~/order/.
  2. Human Verification – Select from None or reCaptcha. None disables human verification, reCaptcha v2 is an option to prevent bots from signing up. Each require an account and additional unique settings which can be obtained from them. reCaptcha requires a Site Key and Shared Key.

Anti-Fraud

Type – The type of anti-fraud to use. The current options are None, Maxmind, and FraudLabsPro. None disables anti-fraud checks, Maxmind enables them through Maxmind, and FraudLabsPro enabled them through FraudLabsPro. An account with Maxmind is required to use Maxmind anti-fraud. An account with FraudLabsPro is required to use FraudLabsPro anti-fraud. The following options assume that Maxmind has been selected.

The following settings assume Maxmind was selected:

  1. Type: Maxmind
  2. Anti-Fraud Frequency – When to run anti-fraud checks.  It is recommended to select the option to "Run fraud checks for all orders and customer signups".
  3. Server – The server URL for Maxmind, this is typically: minfraud.maxmind.com
  4. License Key – The license key obtained from Maxmind.
  5. Minimum Score to Reject – The minimum score to reject an order. This should typically be set high, 80 is the default value. If Maxmind reports a value equal to or greater than this, the order will be outright rejected.
  6. Minimum Score to Review – This should be lower than the minimum score to reject, default is 10. If the score of an order is equal to or greater than this but lower than the minimum score to reject, the order will be flagged for review. When an order is flagged for review it will remain as a Pending order until moved to either the Accepted or Fraud category by a staff user, at which time the client account will be automatically marked as active or fraud.

The following settings assume FraudLabsPro was selected:

  1. Type: FraudLabsPro
  2. Anti-Fraud Frequency – when to run anti-fraud checks. It's recommended to "Run fraud checks for all orders and customer signups".
  3. API Key – The API key you obtained from FraudLabsPro
  4. Minimum Score to Reject – The minimum score to reject an order. This should typcilally be set high, 80 is the default value. If FraudLabsPro reports a value equal to or greater than this, the order will be outright rejected.
  5. Minimum Score to Review – This should be lower than the minimum score to reject, default is 10. If the score of an order is equal to or greater than this but lower than the minimum score to reject, the order will be flagged for review. When an order is flagged for review it will remain as a Pending order until moved to either the Accepted or Fraud category by a staff user, at which time the client account will be automatically marked as active or fraud.
  6. Automatically Reject/Review based on recommendation frod FraudLabs Pro – Yes is recommended, result will depend on what FraudLabs Pro suggests.

 

Embed Code

The embed code field allows any HTML or JavaScript to be directly injected, as written, into the footer of pages on the order form. Tag replacement is supported (see Customizing Emails), including a tag for the order_page so that you may set content only on specific pages.

The "order_page" tag contains the controller and action that references a specific page, which may include any one of the following:

{{order_page}} valueNotes
signup/indexThe new account registration page

main/index

The package selection page
main/packagesA specific package selection page
forms/indexThe order form listing page
config/indexA specific package configuration page
config/preconfigA specific package pre-configuration page
checkout/indexThe payment page
checkout/completeThe completed order page
cart/indexThe cart page

For example, the following embed code will display a message at the bottom of the registration page. You can use the {% debug %} tag to display all data available to aid in determining which variables you want to use, but this tag should not be used in production. Note that the data available will change depending on what stage in the order process you are.

{% if order_page == "signup/index" %}
<h1>We are on the signup page</h1>
{% endif %}
Marketing

While the Order plugin does not send marketing emails, prospective clients may need to opt-in or opt-out of receiving marketing emails that you or the system may later send.

Order Emails

Order related email templates can be found under [Settings] > [Company] > [Emails] > Email Templates, in the section labeled "Plugin Templates".

Order Received

The order received email templates allow for the following tags:

TagsDescriptionNotes

{order.id}

The system-level order ID 
{order.number}The order numbere.g. "519131eb623b8"
{order.client_id}The system-level client ID of the client this order belongs to 
{order.client_id_code}The friendly client ID code 
{order.client_first_name}The first name of the client 
{order.client_last_name}The last name of the client 
{order.client_company}The client's company name 
{order.client_address1}The client's primary address 
{order.client_email}The client's email address 
{invoice.id}The system-level invoice ID of the invoice created for this order 
{invoice.id_code}The friendly invoice ID code 
{invoice.date_due}The UTC datetime stamp of the invoice due dateFormatted as "YYYY-MM-DD HH:MM:SS"
{invoice.date_billed}The UTC datetime stamp of the invoice bill dateFormatted as "YYYY-MM-DD HH:MM:SS"
{invoice.total}The total amount due on the invoicee.g. "8.00"
{invoice.paid}The total amount paide.g. "0.00"
{invoice.due}The remaining amount duee.g. "8.00"
{invoice.currency}The currency that the invoice is ine.g. "USD"
 Additional Tags

Due to the nature of tag objects containing several fields, many of which are likely irrelevant for use in email templates, but may be useful to you in certain circumstances, a dump of the tags are shown below.

The {order} object
stdClass Object
        (
            [id] => 52
            [order_number] => 519131eb623b8
            [order_form_id] => 1
            [invoice_id] => 19983
            [fraud_report] => 
            [status] => pending
            [date_added] => 2013-05-13 18:33:15
            [fraud_status] => 
            [order_form_label] => my_order_form
            [order_form_name] => My Order Form
            [client_id] => 3
            [total] => 8.0000
            [paid] => 0.0000
            [currency] => USD
            [date_closed] => 
            [invoice_id_code] => PD-15695
            [client_id_code] => PD-1501
            [client_first_name] => Mark
            [client_last_name] => Stevens
            [client_company] => Comp Co.
            [client_address1] => 123 Test St.
            [client_email] => user@domain.com
            [services] => Array
                (
                    [0] => stdClass Object
                        (
                            [order_id] => 52
                            [service_id] => 234
                        )

                )

        )
The {invoice} object
stdClass Object
        (
            [id] => 19983
            [id_format] => PD-{num}
            [id_value] => 15695
            [client_id] => 3
            [date_billed] => 2013-05-13 18:33:15
            [date_due] => 2013-05-13 18:33:15
            [date_closed] => 
            [date_autodebit] => 
            [status] => active
            [subtotal] => 8.0000
            [total] => 8.0000
            [paid] => 0.0000
            [previous_due] => 2635.4700
            [currency] => USD
            [note_public] => 
            [note_private] => 
            [id_code] => PD-15695
            [delivery_date_sent] => 
            [due] => 8.0000
            [line_items] => Array
                (
                    [0] => stdClass Object
                        (
                            [id] => 54940
                            [invoice_id] => 19983
                            [service_id] => 234
                            [description] => Bronze Standard - domain.com
                            [qty] => 1.0000
                            [amount] => 8.0000
                            [subtotal] => 8.00000000
                            [taxes] => Array
                                (
                                )

                            [taxes_applied] => Array
                                (
                                )

                            [tax_subtotal] => 0
                            [tax_total] => 0
                            [total] => 8
                            [total_w_tax] => 8
                        )
                )

            [delivery] => Array
                (
                    [0] => stdClass Object
                        (
                            [id] => 20716
                            [invoice_id] => 19983
                            [method] => email
                            [date_sent] => 
                        )
                )

            [meta] => Array
                (
                )

            [tax_subtotal] => 0
            [tax_total] => 0
            [taxes] => Array
                (
                )

        )
The {services} array of objects
Array
        (
            [0] => stdClass Object
                (
                    [id] => 234
                    [parent_service_id] => 
                    [package_group_id] => 1
                    [id_format] => PD-{num}
                    [id_value] => 229
                    [pricing_id] => 22
                    [client_id] => 3
                    [module_row_id] => 6
                    [coupon_id] => 
                    [qty] => 1
                    [status] => in_review
                    [date_added] => 2013-05-13 18:33:14
                    [date_renews] => 2013-06-13 18:33:14
                    [date_last_renewed] => 
                    [date_suspended] => 
                    [date_canceled] => 
                    [id_code] => PD-229
                    [fields] => Array
                        (
                            [0] => stdClass Object
                                (
                                    [key] => cpanel_confirm_password
                                    [value] => password
                                    [serialized] => 0
                                    [encrypted] => 1
                                )

                            [1] => stdClass Object
                                (
                                    [key] => cpanel_domain
                                    [value] => domain.com
                                    [serialized] => 0
                                    [encrypted] => 0
                                )

                            [2] => stdClass Object
                                (
                                    [key] => cpanel_password
                                    [value] => password
                                    [serialized] => 0
                                    [encrypted] => 1
                                )

                            [3] => stdClass Object
                                (
                                    [key] => cpanel_username
                                    [value] => domainco
                                    [serialized] => 0
                                    [encrypted] => 0
                                )

                        )

                    [package_pricing] => stdClass Object
                        (
                            [id] => 22
                            [package_id] => 13
                            [term] => 1
                            [period] => month
                            [price] => 8.0000
                            [setup_fee] => 0.0000
                            [cancel_fee] => 0.0000
                            [currency] => USD
                        )

                    [package] => stdClass Object
                        (
                            [id] => 13
                            [id_format] => {num}
                            [id_value] => 1
                            [module_id] => 4
                            [name] => Bronze Standard
                            [description] => 
                            [description_html] => <p>
	<span style="color:#008000;"><em>Good Value!</em></span></p>

                            [qty] => 
                            [module_row] => 6
                            [module_group] => 
                            [taxable] => 0
                            [status] => active
                            [company_id] => 1
                        )

                    [name] => domain.com
 
                    [coupon] => stdClass Object
                        (
                            [id] => 2
                            [code] => knW3Lesn
                            [company_id] => 1
                            [used_qty] => 16
                            [max_qty] => 0
                            [start_date] => 2017-02-02 08:00:00
                            [end_date] => 2018-02-03 07:59:59
                            [status] => active
                            [recurring] => 0
                            [limit_recurring] => 0
                            [apply_package_options] => 1
                            [internal_use_only] => 0
                            [type] => exclusive
                            [amounts] => Array
                                (
                                    [0] => stdClass Object
                                        (
                                            [coupon_id] => 2
                                            [currency] => USD
                                            [amount] => 5.0000
                                            [type] => amount
                                        )
                                )
                            [packages] => Array
                                (
                                    [0] => stdClass Object
                                        (
                                            [coupon_id] => 2
                                            [package_id] => 80
                                        )
                                    )
                                )
                            )
                        )
                )

        )

Order Received (Mobile)

The ticket received email template allows for the following tags:

TagsDescriptionNotes

{order.id}

The system-level order ID 
{order.number}The order numbere.g. "519131eb623b8"
{order.client_id}The system-level client ID of the client this order belongs to 
{order.client_id_code}The friendly client ID code 
{order.client_first_name}The first name of the client 
{order.client_last_name}The last name of the client 
{order.client_company}The client's company name 
{order.client_address1}The client's primary address 
{order.client_email}The client's email address 
{invoice.id}The system-level invoice ID of the invoice created for this order 
{invoice.id_code}The friendly invoice ID code 
{invoice.date_due}The UTC datetime stamp of the invoice due dateFormatted as "YYYY-MM-DD HH:MM:SS"
{invoice.date_billed}The UTC datetime stamp of the invoice bill dateFormatted as "YYYY-MM-DD HH:MM:SS"
{invoice.total}The total amount due on the invoicee.g. "8.00"
{invoice.paid}The total amount paide.g. "0.00"
{invoice.due}The remaining amount duee.g. "8.00"
{invoice.currency}The currency that the invoice is ine.g. "USD"
 Additional Tags

Due to the nature of tag objects containing several fields, many of which are likely irrelevant for use in email templates, but may be useful to you in certain circumstances, a dump of the tags are shown below.

The {order} object
stdClass Object
        (
            [id] => 52
            [order_number] => 519131eb623b8
            [order_form_id] => 1
            [invoice_id] => 19983
            [fraud_report] => 
            [status] => pending
            [date_added] => 2013-05-13 18:33:15
            [fraud_status] => 
            [order_form_label] => my_order_form
            [order_form_name] => My Order Form
            [client_id] => 3
            [total] => 8.0000
            [paid] => 0.0000
            [currency] => USD
            [date_closed] => 
            [invoice_id_code] => PD-15695
            [client_id_code] => PD-1501
            [client_first_name] => Mark
            [client_last_name] => Stevens
            [client_company] => Comp Co.
            [client_address1] => 123 Test St.
            [client_email] => user@domain.com
            [services] => Array
                (
                    [0] => stdClass Object
                        (
                            [order_id] => 52
                            [service_id] => 234
                        )

                )

        )
The {invoice} object
stdClass Object
        (
            [id] => 19983
            [id_format] => PD-{num}
            [id_value] => 15695
            [client_id] => 3
            [date_billed] => 2013-05-13 18:33:15
            [date_due] => 2013-05-13 18:33:15
            [date_closed] => 
            [date_autodebit] => 
            [status] => active
            [subtotal] => 8.0000
            [total] => 8.0000
            [paid] => 0.0000
            [previous_due] => 2635.4700
            [currency] => USD
            [note_public] => 
            [note_private] => 
            [id_code] => PD-15695
            [delivery_date_sent] => 
            [due] => 8.0000
            [line_items] => Array
                (
                    [0] => stdClass Object
                        (
                            [id] => 54940
                            [invoice_id] => 19983
                            [service_id] => 234
                            [description] => Bronze Standard - domain.com
                            [qty] => 1.0000
                            [amount] => 8.0000
                            [subtotal] => 8.00000000
                            [taxes] => Array
                                (
                                )

                            [taxes_applied] => Array
                                (
                                )

                            [tax_subtotal] => 0
                            [tax_total] => 0
                            [total] => 8
                            [total_w_tax] => 8
                        )
                )

            [delivery] => Array
                (
                    [0] => stdClass Object
                        (
                            [id] => 20716
                            [invoice_id] => 19983
                            [method] => email
                            [date_sent] => 
                        )
                )

            [meta] => Array
                (
                )

            [tax_subtotal] => 0
            [tax_total] => 0
            [taxes] => Array
                (
                )

        )
The {services} array of objects
Array
        (
            [0] => stdClass Object
                (
                    [id] => 234
                    [parent_service_id] => 
                    [package_group_id] => 1
                    [id_format] => PD-{num}
                    [id_value] => 229
                    [pricing_id] => 22
                    [client_id] => 3
                    [module_row_id] => 6
                    [coupon_id] => 
                    [qty] => 1
                    [status] => in_review
                    [date_added] => 2013-05-13 18:33:14
                    [date_renews] => 2013-06-13 18:33:14
                    [date_last_renewed] => 
                    [date_suspended] => 
                    [date_canceled] => 
                    [id_code] => PD-229
                    [fields] => Array
                        (
                            [0] => stdClass Object
                                (
                                    [key] => cpanel_confirm_password
                                    [value] => password
                                    [serialized] => 0
                                    [encrypted] => 1
                                )

                            [1] => stdClass Object
                                (
                                    [key] => cpanel_domain
                                    [value] => domain.com
                                    [serialized] => 0
                                    [encrypted] => 0
                                )

                            [2] => stdClass Object
                                (
                                    [key] => cpanel_password
                                    [value] => password
                                    [serialized] => 0
                                    [encrypted] => 1
                                )

                            [3] => stdClass Object
                                (
                                    [key] => cpanel_username
                                    [value] => domainco
                                    [serialized] => 0
                                    [encrypted] => 0
                                )

                        )

                    [package_pricing] => stdClass Object
                        (
                            [id] => 22
                            [package_id] => 13
                            [term] => 1
                            [period] => month
                            [price] => 8.0000
                            [setup_fee] => 0.0000
                            [cancel_fee] => 0.0000
                            [currency] => USD
                        )

                    [package] => stdClass Object
                        (
                            [id] => 13
                            [id_format] => {num}
                            [id_value] => 1
                            [module_id] => 4
                            [name] => Bronze Standard
                            [description] => 
                            [description_html] => <p>
	<span style="color:#008000;"><em>Good Value!</em></span></p>

                            [qty] => 
                            [module_row] => 6
                            [module_group] => 
                            [taxable] => 0
                            [status] => active
                            [company_id] => 1
                        )

                    [name] => domain.com

                    [coupon] => stdClass Object
                        (
                            [id] => 2
                            [code] => knW3Lesn
                            [company_id] => 1
                            [used_qty] => 16
                            [max_qty] => 0
                            [start_date] => 2017-02-02 08:00:00
                            [end_date] => 2018-02-03 07:59:59
                            [status] => active
                            [recurring] => 0
                            [limit_recurring] => 0
                            [apply_package_options] => 1
                            [internal_use_only] => 0
                            [type] => exclusive
                            [amounts] => Array
                                (
                                    [0] => stdClass Object
                                        (
                                            [coupon_id] => 2
                                            [currency] => USD
                                            [amount] => 5.0000
                                            [type] => amount
                                        )
                                )
                            [packages] => Array
                                (
                                    [0] => stdClass Object
                                        (
                                            [coupon_id] => 2
                                            [package_id] => 80
                                        )
                                    )
                                )
                            )
                        )
                )

        )

Linking to Order Pages

A link to each order page is displayed in the staff area, under [Packages] > [Order Forms]. It's also possible to link directly to a specific package, pricing option, or step.

Linking to a Specific Order Form

The default order form exists at /order/, relative to your installation path. Other order forms may be accessed through their unique label identifier. Below are a few examples:

NameLabelURIDefault Order Form
Web Designdesign

/order/

or

/order/main/index/design

YES
VPS Serversvps/order/main/index/vpsNO
Domain Registrationdomains/order/main/index/domainsNO

 

Linking to a Specific Product

The following examples demonstrate how to link to a particular product or price point.

DescriptionParametersURI
Display Package Group
  • group_id The ID of the package group to display.
/order/main/packages/label/?group_id=1
Display Package Group with Package Selected
  • group_id The ID of the package group to display.
  • package_id The ID of the package to select by default.

    Note that this is the ID of the package as seen in the URL when editing the package.

/order/main/packages/label/?group_id=1&package_id=2
Display Package Configuration with Price Selected
  • group_id The ID of the package group to display.
  • pricing_id The ID of the package pricing.

    The pricing_id is the ID of a particular price point as defined under the package.

Order TemplateURI

AJAX Boxes

AJAX Slider

AJAX List

/order/main/packages/label/?group_id=1&pricing_id=5

Wizard Boxes

Wizard Slider

Wizard List

Standard

/order/config/index/label/?group_id=1&pricing_id=5

 

Linking to an Order Form to Include a Coupon

As of version 2.4.0 of the Order plugin, a coupon can be set in the URL to an order form, and will be applied automatically as the user continues through the order process. The coupon may be set automatically when added to a URL at /order/main/, or /order/config/ (in v2.6.0), using the parameter coupon. Consider a couple examples:

When including a coupon code in a URL, the coupon code must be URL encoded.

DescriptionParametersURINotes
Set a Coupon to an Order Form
  • coupon The coupon code to apply to the order
/order/main/index/label/?coupon=CPN123In this example, the
  • Coupon code is CPN123
  • Order form label is label
Set a Coupon to a Specific Product
  • group_id The ID of the package group to display
  • package_id The ID of the package to select by default

    Note that this is the ID of the package as seen in the URL when editing the package.

  • coupon The coupon code to apply to the product
/order/main/index/vps/?group_id=1&package_id=5&coupon=10off

In this example, the

  • Coupon code is 10off
  • Order form label is vps
  • Package Group ID is 1
  • Package ID is 5

 

Common Issues

  • reCaptcha always returns "The captcha entered was invalid. Please try again."
    • This may be a result of allow_url_fopen being disabled in your PHP config. To confirm, check your Blesta logs for: general.WARNING: E_WARNING: file_get_contents(): https:// wrapper is disabled in the server configuration by allow_url_fopen=0 This directive must be changed for reCaptcha to work properly.
  • No labels

2 Comments

  1. Anonymous

    What is the purpose of this plugin? what is it interfacing with?

    1. This plugin is responsible for order forms, and is installed by default. All public facing order forms are created through, and approved or rejected, through this plugin.