Parallels Plesk Billing 6.0 Administrator Guide Administrator’s Admin

User Manual: parallels Plesk Billing - 6.0 - Administrator’s Guide Free User Guide for Parallels Plesk Software, Manual

Open the PDF directly: View PDF PDF.
Page Count: 232 [warning: Documents this large are best viewed by clicking the View PDF Link!]

Parallels® Plesk Billing
Legal and Copyright Notice
ISBN: N/A
Parallels
660 SW 39th Street
Suite 205
Renton, Washington 98057
USA
Phone: +1 (425) 282 6400
Fax: +1 (425) 282 6444
© Copyright 2009,
Parallels, Inc.
All rights reserved
Distribution of this work or derivative of this work in any form is prohibited unless prior
written permission is obtained from the copyright holder.
Product and service names mentioned herein are the trademarks of their respective owners.
Contents
Preface 8
About This Product ........................................................................................................................ 9
Typographical Conventions ......................................................................................................... 10
Feedback ..................................................................................................................................... 11
Parallels Plesk Billing Licensing 12
Upgrading Free Version of Parallels Plesk Billing ....................................................................... 13
Upgrading Current License Key .................................................................................................. 14
Rolling Back to Your Previously Used License Key .................................................................... 15
Getting Started 16
Overview ...................................................................................................................................... 17
Domain Registration .......................................................................................................... 18
Hosting Provisioning .......................................................................................................... 18
Payment Gateways ........................................................................................................... 20
Administrator Interface ...................................................................................................... 21
Client Interface .................................................................................................................. 21
Order Interface .................................................................................................................. 22
Configuration Wizard ................................................................................................................... 23
Domain Registration Settings ............................................................................................ 24
Parallels Plesk Panel IP Settings ...................................................................................... 24
Payment Gateway Settings ............................................................................................... 24
Encryption Settings ........................................................................................................... 25
Tax Settings ....................................................................................................................... 25
Fraud Settings ................................................................................................................... 25
Setting Up Global Account .......................................................................................................... 26
Setting Up Payment Groups ........................................................................................................ 27
Configuring Order Forms ............................................................................................................. 29
Setting Up Control Panels ........................................................................................................... 30
Setting Up Domain Registrar Modules ........................................................................................ 31
Changing Company Settings ....................................................................................................... 32
Setting Up Administrators 33
Viewing Administrators ................................................................................................................ 33
Creating New Administrators ....................................................................................................... 34
Setting Up Administrator Groups ................................................................................................. 34
Editing Administrator Profiles ...................................................................................................... 35
Configuring Administrator Interface ............................................................................................. 36
Using the Dashboard ......................................................................................................... 36
Using Bookmarks .............................................................................................................. 39
Choosing Interface Language ........................................................................................... 40
Choosing Interface Theme ................................................................................................ 40
Viewing System Settings 41
Viewing Module Information ........................................................................................................ 41
Viewing License Information ........................................................................................................ 41
Viewing PHP Information ............................................................................................................. 42
Preface 4
Viewing System Information ........................................................................................................ 42
Viewing Parallels Plesk Billing Version ........................................................................................ 42
Enabling Parallels Plesk Billing Automation 43
Understanding Events ................................................................................................................. 44
ProcessInvoices ................................................................................................................ 45
ProcessPaymentQueue .................................................................................................... 45
ProcessSuspensions ......................................................................................................... 45
ProcessUnsuspensions ..................................................................................................... 45
ProcessUsage ................................................................................................................... 45
ProcessCancellation .......................................................................................................... 45
ProcessExpiredCreditCards .............................................................................................. 45
ProcessDomainSynchronization ....................................................................................... 46
Setting Up System Queue ........................................................................................................... 46
Setting Up the Cron Job .............................................................................................................. 47
Step 1. Copy the Remote Access Hash ............................................................................ 48
Step 2. Check Your Cron User Permissions ..................................................................... 48
Step 3. Set Up Your Crontab to Run runevents.php File .................................................. 49
Managing Cron Job in Linux .............................................................................................. 50
Setting Up IP Queue .................................................................................................................... 51
Setting Up Payment Queue ......................................................................................................... 52
Enabling Auto-Suspend ............................................................................................................... 53
Unsuspend/Auto-Enable ................................................................................................... 53
Configuring Payment Settings 54
Setting Up Encryption .................................................................................................................. 55
Adding Payment Groups ............................................................................................................. 56
Configuring Gateways ................................................................................................................. 56
Setting Up Authorize.net ................................................................................................... 58
Setting Up PayPal ............................................................................................................. 58
Using Virtual Terminals................................................................................................................ 59
Configuring Hosting Settings 61
Adding a Server Group ................................................................................................................ 62
Adding Panels to a Server Group ................................................................................................ 63
Centova Cast ..................................................................................................................... 64
Cortex ................................................................................................................................ 65
cPanel ................................................................................................................................ 66
Cube Panel ........................................................................................................................ 67
DirectAdmin ....................................................................................................................... 68
EMS-Cortex ....................................................................................................................... 69
eNomHost .......................................................................................................................... 69
Parallels Plesk Panel ......................................................................................................... 71
Parallels Pro Control Panel ............................................................................................... 72
Configuring Domain Settings 74
Configuring Registrar Modules .................................................................................................... 74
Adding a TLD ............................................................................................................................... 75
Editing TLDs ................................................................................................................................ 76
Setting Up Domain Sync Count ................................................................................................... 76
Adding ID Protect as an Add-on for Domains ............................................................................. 76
Step 1. Create a Custom Question ID Protect .................................................................. 77
Step 2. Add the ID Protect Option to the Domain Product ................................................ 78
Preface 5
Setting Up Invoices and Billing 79
Understanding Billing Modes ....................................................................................................... 79
Anniversary Billing Mode ................................................................................................... 80
Monthly Billing Mode ......................................................................................................... 81
Setting Up Invoicing ..................................................................................................................... 82
Configuring Taxes ........................................................................................................................ 84
Creating Tax Zones ........................................................................................................... 85
Creating Tax Zone Groups ................................................................................................ 86
Handling VAT Taxation ..................................................................................................... 86
Creating Coupons ........................................................................................................................ 89
Adding Cycle Discounts ............................................................................................................... 90
Setting Up E-mails 92
Understanding E-mail Template Variables .................................................................................. 93
Package Info E-mail .......................................................................................................... 93
Invoice E-mail .................................................................................................................... 94
Credit Card Payment ......................................................................................................... 96
eCheck Payment ............................................................................................................... 97
Bank Draft Payment .......................................................................................................... 98
Secondary Gateway Payment ........................................................................................... 99
Declined Payment ........................................................................................................... 100
Payment Error ................................................................................................................. 101
Domain Renewal Notice .................................................................................................. 102
Domain Transfer - Success E-mail.................................................................................. 103
Domain Transfer - Failure E-mail .................................................................................... 104
Credit Card Expiration Notification E-mail ....................................................................... 105
Package Suspension E-mails .......................................................................................... 106
Package Enable E-mail ................................................................................................... 107
Adding E-mail Template Groups ............................................................................................... 108
Setting Up Your Locales ............................................................................................................ 109
Editing Template Content .......................................................................................................... 110
Reloading E-mail Templates ..................................................................................................... 111
Resending Previously Sent E-mails .......................................................................................... 111
Getting Your System Ready to Send E-mail Messages ............................................................ 112
Converting Version 4 E-mail Templates to Version 5 ................................................................ 113
Customizing E-mail Templates .................................................................................................. 114
Updating the E-mail Header ............................................................................................ 114
Updating the E-mail Layout ............................................................................................. 115
Creating Attributes and Add-ons 116
Setting Up Product Attributes .................................................................................................... 117
Setting Up Order Form Attributes .............................................................................................. 119
Setting Up Generic Attributes .................................................................................................... 121
Creating Control Panel Attributes Add-ons................................................................................ 123
Selling Products 125
Configuring Product Management Settings ............................................................................... 127
Adding Billing Cycles ................................................................................................................. 128
Making a Product Upgradable/Downgradable ........................................................................... 128
Creating General Ledger Entries for a Product ......................................................................... 129
Creating Product Groups ........................................................................................................... 130
Creating Pricing Options ............................................................................................................ 131
Creating Domain Registration Products .................................................................................... 132
Preface 6
Product Details ................................................................................................................ 133
Order Forms .................................................................................................................... 133
Cycles .............................................................................................................................. 134
TLDs ................................................................................................................................ 134
Options ............................................................................................................................ 135
Prices ............................................................................................................................... 135
Miscellaneous Options .................................................................................................... 136
Attributes ......................................................................................................................... 137
Add-ons ........................................................................................................................... 138
Ledger Entries ................................................................................................................. 138
Clone Product .................................................................................................................. 138
Creating Hosting Products ......................................................................................................... 138
Hosting Provisioning in Parallels Plesk Billing ................................................................ 139
Preparing Your System for Creating a Hosting Product ................................................. 140
Setting Up a Hosting Product .......................................................................................... 142
Setting Up SSLFactory .............................................................................................................. 150
Types of SSL Certificates .......................................................................................................... 150
Step 1. Sign Up for an SSLFactory Account ................................................................... 151
Step 2. Submit Your SSLFactory Account Data .............................................................. 151
Step 3. Create Products for Each SSL Certificate Type ................................................. 152
Configuring the products.php Page ........................................................................................... 153
Using Multiple products.php Pages ........................................................................................... 154
Configuring Order Settings 155
Configuring Order Forms ........................................................................................................... 155
Adding a Second or Third Order Form ...................................................................................... 156
Branding Multiple Order Forms ................................................................................................. 157
Customizing Order Forms ......................................................................................................... 158
Setting Up E-mail Banning ........................................................................................................ 159
Using Website Widgets.............................................................................................................. 160
Configuring Website Widgets .......................................................................................... 161
Customizing Website Widgets ......................................................................................... 162
Setting Up FraudGuardian ......................................................................................................... 163
Step 1. Sign Up for a FraudGuardian Account ................................................................ 163
Step 2. Submit Your FraudGuardian Account Data ........................................................ 163
Step 3. Create a Fraud Set ............................................................................................. 164
Step 4. Create a Country Threshold ............................................................................... 165
Step 5. Tie Fraud Sets with Order Forms and Thresholds ............................................. 167
Serving Your Customers 168
Managing Packages .................................................................................................................. 169
Packages Details ............................................................................................................. 170
Changing Package Status ............................................................................................... 170
Suspending/Unsuspending Packages ............................................................................ 172
Adding an Add-on to a Package...................................................................................... 172
Running Package Events ................................................................................................ 173
Canceling Packages ........................................................................................................ 174
Method 1 - Canceling a Package Tied to a Server Group .............................................. 174
Method 2 - Canceling a Package Not Tied to a Server Group ........................................ 174
Activating a Customer Package ...................................................................................... 175
Administering Clients ................................................................................................................. 176
Adding New Clients ......................................................................................................... 177
Managing Existing Clients ............................................................................................... 181
Using Client Groups................................................................................................................... 202
Adding Client Groups ...................................................................................................... 202
Managing Client Group Attributes ................................................................................... 202
Performing Manual Payments ................................................................................................... 203
Preface 7
Generating and Running Payment Queue ...................................................................... 204
Capturing Uncaptured Payments .................................................................................... 205
Issuing Refunds ............................................................................................................... 205
Capturing Authentication-only Payments ........................................................................ 206
Using a Credit Card to Pay an Invoice ............................................................................ 206
Managing Invoices ..................................................................................................................... 206
Generating Invoices Manually ......................................................................................... 208
Viewing Invoices .............................................................................................................. 208
Editing Invoices ............................................................................................................... 210
Removing Invoices .......................................................................................................... 211
Taking Credit Card Payments ......................................................................................... 211
Applying Payments Manually .......................................................................................... 211
Applying Credits .............................................................................................................. 212
Voiding Invoices .............................................................................................................. 212
Printing Invoices .............................................................................................................. 213
Manually Paying an Invoice Using Saved Credit Card Information ................................ 213
Providing Client Support ............................................................................................................ 214
FAQs ............................................................................................................................... 214
News ................................................................................................................................ 215
Internal Helpdesk ............................................................................................................ 217
Setting Up ModModernBill Module ............................................................................................ 218
Migrating Subscriptions from version 4 to version 5 .................................................................. 219
Charging for E-mail Account Usage (SPLA) Ensim Unify ......................................................... 220
Managing Accounting 221
Generating Accounting Reports ................................................................................................ 222
Generating Daily Journals ......................................................................................................... 223
Viewing General Journal ........................................................................................................... 224
Generating General Ledgers ..................................................................................................... 224
Integrating Parallels Plesk Billing with Parallels Plesk Panel 225
Setting Up Global Accounts ....................................................................................................... 226
Setting Up a Single Sign-On Server from Parallels Plesk Billing .................................... 226
Creating a Global Account .............................................................................................. 227
Changing Global Account Password ............................................................................... 227
Disconnecting From Global Account ............................................................................... 227
Repairing SSO Accounts ................................................................................................. 228
Migrating Parallels Plesk Billing from Standalone to Bundled Version ..................................... 228
Appendix A. Parallels Plesk Panel Attributes 230
General Options .............................................................................................................. 230
Limits ............................................................................................................................... 230
Web Limits ....................................................................................................................... 231
E-mail Limits .................................................................................................................... 232
Management and Feature Options.................................................................................. 232
In this chapter:
About This Product ............................................................................................ 9
Typographical Conventions ............................................................................... 10
Feedback .......................................................................................................... 11
CH A P T E R 1
Preface
About This Product
Parallels Plesk Billing is an ordering, billing, and provisioning automation solution aimed at
small-to-mid-level hosting providers. Parallels Plesk Billing comes in two different
distributions: Standalone and Bundle (with Parallels Plesk Panel).
The software package comes bundled with an intuitive order process, complete with
“shopping cart,” allowing your customers to build an order of any size or complexity with a
single checkout (as opposed to the customer having to run through your order form multiple
times if they want multiple items).
Upon checkout, Parallels Plesk Billing supports your customers paying in a variety of ways
including:
credit card (through strong integrations between Parallels Plesk Billing and many
merchant gateways)
third-party gateway (such as PayPal, WorldPay, etc.)
other manual options such as check, bank draft, and simply issuing an invoice.
Each of these payment options can be enabled/disabled and configured according to your
companys specific business practices.
Parallels Plesk Billing can provision the following:
Any domain name package can be automatically registered through any of the resellers
with which Parallels Plesk Billing integrates (such as eNom, OpenSRS, etc.).
Any hosting package can be automatically provisioned through any of the panels with
which Parallels Plesk Billing integrates (such as Plesk, cPanel etc.).
Any SSL Certificate can be automatically provisioned through the SSLFactory.com API
(provided you have a Parallels SSLFactory reseller account).
Any virtual private server package can be automatically provisioned through Parallels
Virtuozzo Containers.
Customers will receive notification upon completed provisioning, as well as any
passwords, etc. that are related to the customer accessing/using their purchased service.
Each of these provisioning options can be configured in Parallels Plesk Billing administrator
panel according to your companys specific business practices.
The total time it takes for the customer to be fraud checked, charged, and their services
turned on can be as little as a few minutes. The entire idea here is to save as much time as
possible so that your companys team can focus on more important things than manually
setting up client accounts.
The automation does not stop once a customer has paid and had their order setup. Parallels
Plesk Billing is fully customizable and can be configured to automatically generate invoices
and collect payment from customers when needed, send out late notices when customers do
not pay on time, and even suspend a customers hosting package after they have neglected
to pay long enough.
Parallels Plesk Billing can even renew domains at your registrar as soon as your clients pay
the invoice. Clients can “upgrade” or “downgrade” their services from the client interface and
not only have the changes automatically provisioned out to the panel, but also receive a pro-
rated credit/debit for the difference in monthly price and begin receiving invoices for the
package they upgraded or downgraded to.
Typographical Conventions
Before you start using this guide, it is important to understand the documentation conventions
used in it.
The following kinds of formatting in the text identify special information.
Formatting convention
Type of Information
Example
Special Bold
Items you must select,
such as menu options,
command buttons, or
items in a list.
Go to the System tab.
Titles of chapters,
sections, and
subsections.
Read the Basic
Administration chapter.
Italics
Used to emphasize the
importance of a point, to
introduce a term or to
designate a command
line placeholder, which is
to be replaced with a real
name or value.
The system supports the
so called wildcard
character search.
Monospace
The names of
commands, files,
directories, and domain
names.
The license file is located
in the
http://docs/common/
licenses directory.
Preformatted
On-screen computer
output in your command-
line sessions; source
code in XML, C++, or
other programming
languages.
# ls al /files
total 14470
Preformatted
Bold
What you type,
contrasted with on-screen
computer output.
# cd /root/rpms/php
CAPITALS
Names of keys on the
keyboard.
SHIFT, CTRL, ALT
KEY+KEY
Key combinations for
which the user must
press and hold down one
key and then press
another.
CTRL+P, ALT+F4
Feedback
If you have found a mistake in this guide, or if you have suggestions or ideas on how to
improve this guide, please send your feedback using the online form at
http://www.parallels.com/en/support/usersdoc/. Please include in your report the guides title,
chapter and section titles, and the fragment of text in which you have found an error.
Standalone Parallels Plesk Billing 6.0 introduces licensing through a unified Parallels
key administration system.
You will need a new license key if you are going to:
Purchase or lease Parallels Plesk Billing 6.0
Upgrade the number of accounts. Mind that the number of accounts is restricted to
active and suspended clients, archived and pending accounts are not counted.
To update earlier Parallels Plesk Billing versions to the latest 6.0, contact Parallels
Sales.
Purchasing and Leasing Parallels Plesk Billing
Before installing Parallels Plesk Billing, go to http://www.parallels.com/store/ppb/ to
purchase or lease Parallels Plesk Billing. Parallels Plesk Billing licenses are limited by
number of accounts.
Every new purchase license includes 12 months of Software Update Service (SUS) that
entitles you to version upgrade licenses throughout the life of your SUS. All leased
license keys (monthly) include SUS.
Parallels Plesk Billing keys can be updated to support newer versions of the software
when they are SUS enabled. When the SUS feature of your key is up-to-date, you can
perform the upgrade of the key without extra costs. In case you run out of this service,
please contact our sales representatives in order to renew/reinstate it.
Important: Parallels SUS is a subscription base service that must be renewed in
advance of its expiration date. In case you pay in advance, the cost of the renewal for
purchase keys will be 25% of the retail cost of the key. Otherwise, if you have not
renewed and decide later to upgrade, you will need to pay 65% of the retail cost of the
key to get it reinstated.
In this chapter:
Upgrading Free Version of Parallels Plesk Billing .............................................. 13
Upgrading Current License Key ......................................................................... 14
Rolling Back to Your Previously Used License Key ........................................... 15
CH A P T E R 2
Parallels Plesk Billing Licensing
Parallels Plesk Billing Licensing 13
Upgrading Free Version of Parallels Plesk
Billing
If you installed the Free Version of Parallels Plesk Billing which is limited to 10 client
accounts, you need to purchase a valid license from Parallels to switch to full-featured
Parallels Plesk Billing.
To buy a new license key:
1 Go to Server Settings -> System Info -> License Management and click Order
New Key.
2 The Parallels online store will open in a separate browser window. In
this window, select the items and features you want to include into
your Parallels Plesk Billing license and click Submit. In the next steps,
indicate the currency, number of license keys, provide contact details,
billing address, and payment method, and submit the form. The new
key will be sent to the specified e-mail address.
3 Save the new key to the hard drive on your local machine.
4 Open again the License Management screen in Parallels Plesk Billing and
click Upload Key.
5 Paste the license key as a text. Alternatively, you can enter the path
to the key file that you saved on your local machine or click Browse to
locate it.
6 Click OK to install the new key.
To install your license if you received an activation code from your sales
representative:
1 Go to Server Settings -> System Info -> License Management and click License
Key Activation
2 Input the activation code.
3 Click Submit.
To manually load a license through the file system:
1 Get your license file (xxx.xml or xxx.xml.zip).
2 Put your license file in the root directory of your Parallels Plesk Billing
installation named key.xml or key.xml.zip depending on whether
it is zipped or not.
3 Log in to the administrator area of your Parallels Plesk Billing.
14 Parallels Plesk Billing Licensing
4 After you log in, Parallels Plesk Billing will automatically load the
license and prompt you to delete the license file. After you delete the
file, the license should be loaded properly.
Parallels Plesk Billing license keys have a built-in expiration date, so, to keep your
license active, Parallels Plesk Billing will periodically connect to the licensing server and
retrieve the latest license key. This process is run automatically, and the date the next
upgrade is scheduled for is displayed on the Server Settings -> System Info -> License
Management screen. You can manually prolong your current license by clicking Retrieve
Keys link.
Upgrading Current License Key
If you plan to expand the maximum number of customers allowed by your current
license, you need to upgrade your license key.
To upgrade a license key:
1 Go to the Server Settings -> System Info -> License Management page and
click the Order Key Upgrade button.
2 The Parallels online store will open in a separate browser window.
Select the desired upgrade option and click Submit.
3 In the next step, indicate purchase details and submit the form. You
will be notified by e-mail when your order is processed.
4 After you receive the e-mail notification, return to the License
Management page and click Retrieve Keys to retrieve the ordered license
key. License Manager will retrieve the purchased license key from the
licensing server, automatically upload it to your control panel, and
update your current key.
Parallels Plesk Billing Licensing 15
Rolling Back to Your Previously Used
License Key
When you upload a new license key to Parallels Plesk Billing, the currently installed
license key is saved as a backup. To restore it, use the Roll Back License Key option.
To roll back to your previously used license key:
1 Go to the License Management page and click Roll Back Key.
2 When the page with previously installed license keys appears, choose
the necessary key and click Change Key.
3 The previously installed license key will be restored.
In this chapter:
Overview ........................................................................................................... 17
Configuration Wizard ......................................................................................... 23
Setting Up Global Account ................................................................................ 26
Setting Up Payment Groups .............................................................................. 27
Configuring Order Forms ................................................................................... 29
Setting Up Control Panels ................................................................................. 30
Setting Up Domain Registrar Modules ............................................................... 31
Changing Company Settings ............................................................................. 32
Aliasing Directories ............................................................................................ 32
CH A P T E R 3
Getting Started
Overview
Parallels Plesk Billing is a billing automation system, used primarily in online business, such
as:
Domain registration
Hosting provisioning
Selling SSL certificates
Other non-hosting online stores
Parallels Plesk Billing provides a control panel with different levels of administration (you
have the Administrator interface, Client interface, and the integrated Order form interface) on
top of a solid recurring billing/invoicing engine written in PHP. This engine will take care of
generating and sending out invoices to your customers on whatever cycle that the
good/service your customer has with you renews (monthly, yearly, or even hourly the
package renewal cycles are configurable down to minutes). Parallels Plesk Billing will
facilitate credit card, PayPal or other payment gateways, appropriately mark invoices as paid
and enforce auto-suspension rules for non-payment.
Parallels Plesk Billing has a modular structure in terms of using third-party resources.
Payment gateways, domain registration services (registrars), hosting control panels are
integrated into Parallels Plesk Billing as modules. To use these resources, you need to
configure them in Parallels Plesk Billing administrator interface.
Later in this guide we will explain the basic Parallels Plesk Billing concepts and give some
insights into the four above-mentioned business models served by Parallels Plesk Billing.
In this section:
Domain Registration .......................................................................................... 18
Hosting Provisioning .......................................................................................... 18
Payment Gateways............................................................................................ 20
Administrator Interface ....................................................................................... 21
Client Interface .................................................................................................. 21
Order Interface .................................................................................................. 22
Domain Registration
Parallels Plesk Billing supports integration with several domain registrars including:
eNom
Register.com
OpenSRS
DistributeIT
Nominet/
Namecheap
EuroDNS
Dotster
ISPProxy
ResellOne
Parallels Plesk Billing supports instant domain availability checking through your order form
regardless of whether youre using one of the above registrars.
However, if youre using one of these registrars, your customers can purchase/transfer a
domain name, pay for it, and Parallels Plesk Billing will issue a call automatically to that
registrars API to purchase/transfer the domain name and place it under that clients account
in your Parallels Plesk Billing for management (setting name servers, hosting records, etc.).
You can configure Parallels Plesk Billing to sell one, some, or all of the TLDs available
through a particular registrar and charge your customers whatever price you want for their
domain registration. Your account with your registrar will be charged whatever your standard
reseller rate is for that given domain TLD. One of the clear benefits of this is that you can (for
example) process .com sales through a certain registrar and .ca sales through another
registrar, allowing you to use multiple registrars to make sure youre being charged the lowest
possible price per TLD for the domains that you resell.
Hosting Provisioning
Parallels Plesk Billing supports integration with several hosting control panels including:
cPanel
cPanel (Reseller)
DirectAdmin
eNom Exchange
eNom Hosting
EnsimUnify
FreeRadius
Virtuozzo
Hostopia
Interworx
Parallels Helm
Parallels Pro Control Panel (former Ensim Pro)
Parallels H-Sphere
Parallels Plesk Panel for Windows
Parallels Plesk Panel for Linux
Parallels Plesk Expand
and Parallels Plesk Billing itself (for License Reselling)
Note: Parallels Plesk Billing 6 is fully integrated with Parallels Plesk Panel 9.
When you create a product in Parallels Plesk Billing, it can be configured to provision one (or
more, simultaneously) of the above hosting control panels. Customers purchasing a product
of yours that is connected with one of the above panels can have their service online and
login details e-mailed to them within minutes of paying.
In Parallels Plesk Billing, you create pools of servers of the same type, called server groups.
For example, you could have a server group of seven Plesk for Linux machines your
company hosts customers on. Your Plesk hosting product(s) would be associated with this
server group, and anyone purchasing one would be provisioned onto the Plesk machine in
that group which has the fewest accounts on it (for the purposes of pseudo-load-balancing).
After the purchase, most of the above panels support further automation as well. Your
customer could upgrade or downgrade their base package, associate necessary addons, or
cancel their package. Parallels Plesk Billing will collect payment and issue the appropriate
API calls to the machine(s) on which their product is provisioned to take care of all of their
needs without your intervention needed.
Payment Gateways
Parallels Plesk Billing supports integration with several payment gateways including:
Primary Gateways
Authorize.net
BluePay
Echo, Inc.
eWay
InternetSecure
LinkPoint
Moneris
PayFlowPro
ProTX
PSiGate
Quantum
Velocity Pay
Third-Party Gateways
PayPal
WorldPay
Also, some payment gateways are supported but unstable. They are marked as Testing:
Primary Gateways
CyoGate
EchoInc
eProgressingNetwork
MerchantCommerce
MerchantPartners
PagoPorInternet
Planet Payment
QuickCommerce
RTware
SagePayments
SecurePay AU
SecurePay US
Third-Party Gateways
Credit Card - 2CO
Credit Card - 2CO Recurring
Most of the supported payment modules allow for charge, pre-auth, finalize, void, and refund
abilities through Parallels Plesk Billing.
Parallels Plesk Billings payment gateway system, like the other two systems described
above, is modular. This allows you to choose one or more payment gateways through which
to process customer payments. Thus, you can (for example) allow your customers to choose
between paying by credit card (and run those charges through your BluePay account) or
paying by PayPal.
Taking this a step further, you can even utilize multiple gateway modules to allow for
collecting payment in multiple currencies. This can be very useful for customers that (for
example) prefer to offer services in both United States and Canadian Dollars to attract a
larger customer base. For this purpose, you can create custom payment groups and choose
one primary one primary payment gateway and several third-party gateways for each
payment group. See Payment Groups (on page 54) for details.
For the default payment group, you can choose and configure payment gateways in
Configuration Wizard (on page 23).
Administrator Interface
Parallels Plesk Billing administrator interface to Parallels Plesk Billing is where you
administrate it. The current guide is dedicated to the functionality of the administrator
interface.
Administrator interface is by default available at http://host.name/path/to/plesk-billing/admin/
for standalone version of Parallels Plesk Billing. For Parallels Plesk Billing bundled with
Parallels Plesk Panel it can be accessed at https://host.name:8443/plesk-
billing/admin/.
Client Interface
The client interface to Parallels Plesk Billing is a complete portal for your clients to perform
such actions as:
Pay invoices
View past invoices
Create a support ticket
Upgrade their package
Downgrade their package
Cancel their package
Manage DNS on their purchased domain name
Login to the hosting panel associated with their package
The client interface is completely customizable and can be templated to integrate seamlessly
into your existing web site look and feel.
Client interface is by default available at http://host.name/path/to/plesk-billing/client/ for
standalone version of Parallels Plesk Billing. For Parallels Plesk Billing bundled with
Parallels Plesk Panel it can be accessed at https://host.name:8443/plesk-
billing/client/.
Order Interface
Parallels Plesk Billing, unlike most host-based billing platforms currently available, includes
support for a shopping cart built into your website, making it easier for your clients to
purchase more in a single checkout.
As a result, the concept of an order form is a little bit different in Parallels Plesk Billing. As it is
currently known, an order form in Parallels Plesk Billing is primarily a way to group products
by currency. Generally, you should only have one order form per currency offered. It is not a
page where your products are listed with order now buttons.
There are two awesome methods of adding products to clients shopping cart. Below is a brief
overview of each.
With the first, weve changed the paradigm in billing solutions a bit with the introduction of
web site widgets. These are little snippets of code you simply drop into your company web
site that feature any subset of products you want in any format you want (listing, drop-down,
etc). As it’s merely a snippet of code, these can be dropped anywhere on your web site
where you want to sell products and they require no special templating as it’s merely included
in your existing web site.
The latter is for the customer that prefers a finer grained control of the way theyd like to sell
products on their web site. By linking anywhere on your web site (from text, image, whatever)
to specially formed URLs, you can allow your customers to add any product or products to
their shopping cart with a single click.
Finally, the shopping cart and checkout processes are completely customizable so you can
template them to match the rest of your web site seamlessly.
Order interface is by default available at http://host.name/path/to/plesk-billing/order/ for
standalone version of Parallels Plesk Billing. For Parallels Plesk Billing bundled with
Parallels Plesk Panel it can be accessed at https://host.name:8443/plesk-
billing/order/.
Configuration Wizard
After the Parallels Plesk Billing is installed as a standalone application, or activated as a
module in Parallels Plesk, you need first to run the Configuration Wizard. When you login to
the Parallels Plesk Billing admin panel for the first time, on the page that appears click Start
Configuration to proceed to the Configuration Wizard. It will guide you through:
Registrar Settings. Choose and configure one or more registration services, such as Enom
or OpenSRS.
Payment Gateway Settings. Choose and configure one primary gateway and, optionally, third
party gateways.
Tax Settings. Configure taxable products from the list.
Encryption Settings. Enable encryption to reach the maximum security in transactions.
Fraud Settings. Here you can enable and configure a FraudGuardian account.
Later, you can revisit the Configuration Wizard by choosing Configuration Wizard in the System
menu.
In this section:
Domain Registration Settings ............................................................................ 24
Parallels Plesk Panel IP Settings ....................................................................... 24
Payment Gateway Settings ................................................................................ 24
Encryption Settings ............................................................................................ 25
Tax Settings ...................................................................................................... 25
Fraud Settings ................................................................................................... 25
Domain Registration Settings
To configure domain registration services in Configuration Wizard:
1 Go to System > Configuration Wizard, click Begin Configuration and proceed to the
Domain Registration Settings form.
2 The list of registrars will appear. Choose the primary registrar by clicking
the box in front of its name.
3 As soon as you checked the box, you will see the configuration form for
this registrar consisting of 4 parts.
Admin Account. Enter the user name and password to the registrar and configure
registrar-specific connection settings.
Admin Contact. Set the contact information (name, address, phone, etc.) for the
registrar.
Aux Billing Contact. Set auxiliary billing contact information.
Domain Name Servers. Specify the registrars primary and secondary name servers.
4 Click Continue >> to proceed to the next step of Configuration Wizard.
Later on, you will be able to configure any available domain registration service from
the System > Domain Settings > Registrar Modules menu.
Parallels Plesk Panel IP Settings
(for Parallels Plesk Billing bundled with Parallels Plesk Panel only)
To configure Parallels Plesk Panel IP Settings:
1 Enter the Shared IP Address that will be used for hosting purposes.
2 Click Continue >> to proceed to the next step of Configuration Wizard.
Payment Gateway Settings
On the Payment Gateway Settings page you can choose and configure one primary gateway and
one or several third-party gateways you wish to use.
To select and configure payment gateways:
1 Click a radio button in front of a primary payment gateway you wish to
choose.
2 A form with the options specific to this gateway will appear. Fill out the
options.
3 Click check boxes to select as many third-party gateways as you wish and
fill out gateway-specific options.
4 Click Continue >> to proceed to the next step.
Encryption Settings
Here you can enable encryption for Parallels Plesk Billing transactions and enter the LEK pin
code you generated as a customer on the Parallels Plesk Billing support page.
To enable encryption for Parallels Plesk Billing.
1 Check the box in front of the Encryption Enabled field.
2 In a separate window or tab, open http://www.pleskbilling.com/, log in using
your members area user name and password and generate an LEK (Local
Encryption Key) Hash pin code there.
Note: You need to remember your LEK Pin whenever you need to manually decrypt a
customers credit card number or manually run a billing process.
3 Under the Choose a Pin field, enter the same pin you generated into the LEK
Pin and Confirm text boxes.
4 Set a secret passphrase in the Passphrase field. It may remain empty if you
wish, and then the system will generate a random passphrase for you.
5 Click Continue>> to go on with Configuration Wizard.
You can later return to the encryption settings in the System > System Settings >
Encryption Settings menu. See Encryption Settings for details.
Tax Settings
Here you can assign a single tax to selected taxable products or add-ons.
1 Enter the Tax Settings page.
Enable Taxes. Check this button to enable the tax to the taxable products selected
below.
Tax Amount. Enter tax value in percents.
Tax Description. Enter the tax name that all the customers will see. For example, VAT.
Taxable Products. Here all available tax products or add-ons are listed. Select the
required variants by checking boxes in front of them.
2 Click Continue >> to apply the tax.
You can provide advanced tax settings in the System > System Configuration > Invoice and
Billing Settings > Tax Settings page. See Taxes for details.
Fraud Settings
To configure fraud settings:
1 On the Fraud Settings page, fill out the following form:
Enable FraudGuardian. Check this box to enable fraud settings
User name, Password. Enter your user name and password once you have registered at
FraudGuardian: http://www.pleskbilling.com/products/fraudguardian/.
2 Click Continue >> to apply FraudGuardian settings and complete
Configuration Wizard.
After that, go to System > System Configuration > Order Settings > Manage Fraud Settings for
advanced fraud configuration. See Setting Up FraudGuardian (on page 163) for details.
Setting Up Global Account
(for Parallels Plesk Billing bundled with Parallels Plesk Panel only)
It is highly recommended to connect your local Parallels Plesk Billing accounts to a global
account for convenient operation in case of bundled installation. This will allow you to switch
between your Parallels Plesk Panel and Parallels Plesk Billing accounts without entering your
credentials every time.
Please see the Setting Up Global Account (on page 226) chapter for details.
Setting Up Payment Groups
Configuring a payment group is a fairly straightforward process. First, youre going to need to
ask yourself a few questions in regards to how your business wants to accept money.
Do you plan to accept credit cards?
If so, will you be storing credit card details (all encrypted, of course) in your Parallels
Plesk Billing database?
What types of credit cards do you want to accept (Visa/MasterCard/etc.)?
Will you accept forms of payment through a third-party gateway such as PayPal or
WorldPay?
If you plan to accept credit cards, you are going to need a merchant account with an online
payment processing service. Parallels Plesk Billing supports a variety of payment gateways
(on page 20) which you can choose as a primary gateway, and some others as third-party
gateways.
If you plan to accept payment from third-party gateways (either solely, or along with accepting
credit cards) you will need to have an account at one or more of the below supported third-
party gateways:
PayPal
WorldPay
The general idea behind payment groups is for the purpose of multiple currency support. You
should have one payment group for each type of currency that you accept. If you only accept
one currency, you should, thus, only have one payment group.
IMPORANT: You can add and remove payment processor modules within a payment group
as much as you want. But you should never remove a payment group once you have
customers actively using it. Removing a payment group that is in use will cause customers
billing accounts to no longer be tied to a means of charging them.
To add a payment group:
1 Go to the System > Payment Settings > Payment Groups.
2 At this point, you should see a default payment group already exists. Click
the Edit icon to the right side of the payment group. On the screen that
comes up, you can configure the Payment Group Name to be whatever you
want, this is purely for your reference and no customer will ever see the
Payment Group Name. By default, the initial payment group is setup with USD
(United States Dollars) currency. You may leave this as is, or, if you need
to accept a different currency, change this to the appropriate 3-character
ISO-4217 currency code.
3 Now, most importantly, you will need to select the primary and third-party
gateways you use from the drop down lists. At this time, you can only
select one of each category. Though, if you accept more than one third-
party gateway (for example, PayPal and WorldPay) you can come back to
this Edit screen later and add it. Please note that you can only configure
one primary gateway per payment group.
4 After you have selected the gateways you use, click the edit button at the
bottom of the screen and it will return you to the Payment Groups overview
screen. You should now see your newly-modified payment group with the
payment processor modules you selected. At this point, you can now click
the Edit icon next to each of those payment processors listed and configure
them appropriately (details for the configuration options available for each
payment processor are later in this document).
5 If you plan to accept multiple currencies, click the Add Payment Group button
and repeat the above detailed procedure.
If you are planning on accepting credit cards and storing them in your Parallels Plesk Billing
database for the purposes of recurring billing, you will need to configure encryption on your
system. Parallels Plesk Billing uses a strong encryption algorithm to keep your data as safe
as possible. Please refer to Setting Up Encryption (on page 55) for details.
Configuring Order Forms
As previously described in this guide, the concept of an order form is a little bit different in
Parallels Plesk Billing. As it is currently known, an order form in Parallels Plesk Billing is
primarily a way to group products by currency. Generally speaking, you should only have one
order form per currency offered. It is not a page where your products are listed with order
now buttons.
To configure your order form(s):
1 Go to System > System Settings > Order Form Settings. You will see that one
default order form already exists in your Parallels Plesk Billing.
2 Click the edit button next to it. On this page, you should select the payment
group, default language, and default country to be used on this order form.
There are also a variety of other options on this page you can choose, but
those three are the most important to getting you up and running right now.
3 For each payment group you have, create a new order form, and assign it
to that payment group.
Your Parallels Plesk Billing is now configured to accept payment from customers.
Warning: Never delete an order form that already has had packages purchased through it.
Please refer to the Setting Up Order Forms (on page 141) chapter.
Setting Up Control Panels
Parallels Plesk Billing supports integration with Parallels Plesk Panel and some other control
panels (on page 18).
This section outlines the steps you need to take to get your Parallels Plesk Billing installation
to successfully store the connection information needed to provision customers packages to
your servers.
For each type of control panel that you offer, you should have one Server Group. For example,
if you provide cPanel and Plesk for Linux hosting, you would need two server groups one
for each control panel. Within each of these server groups, you will add a Server Module for
each physical server of that type. Going on our above example, if you had 7 machines
running cPanel and 5 machines running Plesk for Linux, you would need 7 cPanel server
modules in your cPanel server group and 5 Parallels Plesk Panel for Linux modules in your
Parallels Plesk Panel for Linux server group. Please refer to Managing Server Groups (on
page 61) document for details on how you can add a Server Group.
IMPORTANT: if there are control panel modules within server groups to which you do not
intend on provisioning anymore packages (for example, a server that you are slowly trying to
move clients off of, or a test server for testing settings), then you have to set their status to
Enabled: No. This will cause accounts that have already been provisioned to this module to still
be fully automated (suspend, unsuspend, cancellation, etc), but no new accounts will be
provisioned to that server.
Finally, the most impacting parameter across most all the types of server modules we offer is
Server Weight. You can give each of your products a specific weight (typically, this would refer
to the number of resources this product is going to use once provisioned, in terms of disk
space, bandwidth, etc.). Each control panel module you add can have a Maximum Server
Weight. Configure this setting appropriate to how you plan to specify weights on your products
so you can be confident you will not be overselling your equipment as each time a package
is provisioned to one of your servers, the weight of that package will be added to the total
weight already provisioned on the server.
You can use this so as to implement a pseudo-load-balancing setup. If you go back to your
Server Groups settings page and click the Edit icon next to your server group, you can specify
whether provisioned packages will be provisioned onto each server you have, filling them
one-by-one, or (more preferably, for most) provisioned onto the server with the least server
weight.
Once you have configured a server group for each type of server you offer, and the
appropriate control panel modules for each physical server you have within each group, your
Parallels Plesk Billing will have been successfully connected to automate package
provisioning.
Setting Up Domain Registrar Modules
Parallels Plesk Billing supports integration with a variety of domain registration services (on
page 18).
There are two steps in getting your system configured with one or more of the domain
registrar through which you resell and to tie to appropriate TLDs to each of those registrars:
1 Configure domain registrar modules (on page 74)
2 Assign TLDs (on page 75).
Changing Company Settings
The company settings page sets many of the variables that the system will use to populate
many values. For example, the e-mail templates will pull your company name and contact
information from this area when creating e-mails. It is important to keep this information up-
to-date. These values are initially filled with information gathered during the installation
process.
To change company settings:
1 Go to System > System Configuration, then click System Settings > Company Settings.
2 Change the following as needed:
Name. Enter the name of your company here, as you would like it to appear to your
clients.
Short Description. Please provide a brief description of what your company does.
Description. You may enter a longer description here.
URL. This is the URL to your companys web page.
Client URL. If you have made any changes to your Parallels Plesk Billing directory
structure, you will want to edit this entry to reflect these changes. This URL determines
where the system tries to take you when you click Login as Primary Contact on the client
details screen.
Order URL. This is the URL to your main order page. Most clients use a custom order
page, so this may need to be updated.
E-mail. Please enter your companys main contact e-mail address.
Address 1. Enter the first address line of your companys physical address.
Address 2. Enter the second address line of your companys physical address, or a PO
box if you use one.
City. Enter the city of your companys address.
State. Enter the state of your companys address.
Country. Enter the country of your companys address.
Phone 1. Enter a primary phone number, so your clients can contact you if they need
to.
Phone 2. Enter a second phone number if you have one.
Fax. If you have a separate fax number, please enter it here.
Tax ID Number. If you have a Tax ID Number, enter it here.
3 Click Save Changes.
Parallels Plesk Billing provides a flexible system for setting up administrators within the
system. Using administrator groups, you can create custom privileges for various
different kinds of administrators, such as billing administrator and server provisioning
administrator. By default, Parallels Plesk Billing creates four administrators: the root
user, an order form user, an API user, and a cron user. The root user is created using the
information you entered during the installation process, and is the main login you use to
enter Parallels Plesk Billing. The order form, API, and cron users enable these parts of the
system to have the level of access they need to function properly. Do not remove these
administrators.
In this chapter:
Viewing Administrators ...................................................................................... 33
Creating New Administrators ............................................................................. 34
Setting Up Administrator Groups ....................................................................... 34
Editing Administrator Profiles............................................................................. 35
Configuring Administrator Interface ................................................................... 36
Viewing Administrators
To view the list of your administrators:
1 Go to System > System Settings > Admin Settings.
2 Once the page loads, you will see a list of all the administrators you
have created.
CH A P T E R 4
Setting Up Administrators
34 Setting Up Administrators
Creating New Administrators
You can add any number of Parallels Plesk Billing administrators to your system
according to your specific business needs.
To add a Parallels Plesk Billing administrator:
1 Go to System > System Settings > Admin Settings > Add New Admin.
2 Fill in the necessary information:
First Name. The first name of the administrator.
Last Name. The last name of the administrator.
E-mail. The e-mail address of the administrator.
User name. The user name you would like the administrator to have.
New Password. Enter the password the administrator will use.
Enter Password Again. Enter the password a second time for verification.
Theme. If you have a custom theme, you can choose for the administrator to use
it.
Language. Choose the language you would like Parallels Plesk Billing to appear
in for this administrator. Parallels Plesk Billing will use the language and country
choice to determine which locale best fits this administrator.
Country. Enter the country in which this administrator resides. This helps
determine the locale to use for the administrator. For example, if you choose
Portuguese, Parallels Plesk Billing can either use the Portuguese locale or the
Brazilian Portuguese locale, depending on where your administrator lives.
Active. You can activate and deactivate administrator as you need.
Assigned Admin Groups. You must choose a group to assign this administrator to.
You can create additional administrator groups as needed.
3 Click Add Admin Profile.
The newly added administrator will appear on the Manage Admins page.
Setting Up Administrator Groups
Creating administrator groups allows you to grant specific sets of actions to certain
administrators or groups of administrators. For example, if you have an employee who
will be taking care of billing for you, but who does not need to look at any reports, you
can create an administrator group called billing, add actions to this group relating to
generating and paying invoices, and remove any actions relating to reporting.
To view the list of existing administrator groups:
1 Go to System > System Settings > Admin Settings > Manage Admin Groups.
Setting Up Administrators 35
2 Once the page loads, you will see the list of all administrator groups in
the system.
To assign more administrators to a group:
1 Click the Manage Actions control for the group.
2 Add more administrators under Assigned Admins.
3 Here, you can also unassign administrator from a group.
To edit privileges of administrators in a group:
1 Click the Manage Actions control for the group.
2 Configure privileges in the displayed categories as you want.
Note: If you are not sure what each actions represents in the system, you can use
the built-in recording feature.
To use the recording feature:
1. Click Click to record actions.
2. Go through the system as if you were an administrator in this group. Each page
or feature you use will be recorded. If you do not want an administrator to have
access to a particular page or feature in the system, do not view the page or use
the feature. While the recording feature is turned on, a red spiral icon and the
text stop recording appear to the left of the Dashboard.
3. When you are finished recording the actions for this group, click stop recording.
The page will automatically reload. Scroll down the list of actions and you will
see all the actions that you viewed in the system moved from the Deny list to the
Allow list. You can adjust the actions according to your specific needs by double-
clicking the action or using the arrow button.
3 Click Update Action Assignments.
Editing Administrator Profiles
If you need to change any of the settings for one of your administrators, you will follow
a procedure similar to creating an administrator.
To edit an administrator profile:
1 Go to System > System Settings > Admin Settings.
2 When the page loads, click on the magnifying glass icon in the Actions
column for an administrator whose profile you want to edit.
3 Click Edit.
4 Edit the administrators profile accordingly. You will note that the
password fields are empty. Do not put anything in these fields unless
you want to change the password.
5 Click Update Profile.
Configuring Administrator Interface
In this section:
Using the Dashboard ......................................................................................... 36
Using Bookmarks .............................................................................................. 39
Choosing Interface Language ............................................................................ 40
Choosing Interface Theme................................................................................. 40
Using the Dashboard
Each time you log in to Parallels Plesk Billing, you will be taken first to the Dashboard. The
Dashboard allows you access to all parts of the system, and displays important information
about new clients and items that need to be addressed.
In this section:
New Customers ................................................................................................. 37
To-Dos............................................................................................................... 37
New Customers
When a new client signs up through the order form, an entry will appear in the New Customers
area. At this point, the new clients status in the system is set to Pending while Parallels Plesk
Billing waits for you to approve the account. You have the opportunity to review the account,
and choose to approve the account, cancel it, or mark it as fraud.
Whatever status you choose to assign to the client, their account will remain in Parallels
Plesk Billing. Only approved clients will become active and be able to log into the system. If
you suspect than an account is fraud, you can cancel it in a special way, marking it as fraud
for future reference.
To-Dos
Parallels Plesk Billing is designed for automation. Sometimes, however, the system needs
your assistance. A hosting package may not have provisioned correctly, for example. Or
there may be some trouble with a clients domain registration. When this happens, Parallels
Plesk Billing will send you a note by creating a To-Do and posting it to the dashboard. You
will want to log in regularly to check for To-Dos.
The purpose of the To-Do list is an automated reminder tool. Each task that you create will be
listed until the action item is completed. For example, a To-Do task can be anything from
reminding yourself to run by the accountants office on Thursday to being an internal
reminder to create a website on a control panel because the control panel you are using does
not support automation of that action. Tasks can be assigned to any users in the system.
In this section:
Viewing To-Do Items ......................................................................................... 37
Editing To-Do Items ........................................................................................... 38
Adding To-Do Items ........................................................................................... 38
Viewing To-Do Items
To view To-Do items:
1 Go to Events > To-Dos.
2 When the page loads you will see the available To-Do items. The list
shows you what is currently due now, 24 hours from now, and 1 week from
now.
From this page you can manage your To-Dos. There is also another way to view your To-Dos
by going to Events > To-Dos > Show All To-Dos.
Editing To-Do Items
To edit To-Do items:
1 Go to Events > To-Dos > Show All To-Dos.
2 When the page loads, you will see the available To-Do items. Locate the
item you want to edit and click the green pencil icon for it.
3 You can change the title and description, assign it to other administrators
in the system, change the status from Open to Closed, and change the
date due.
Note: If a To-Do item is public, it is seen by all the administrators in the system.
Adding To-Do Items
To add a To-Do item:
1 Go to Events > To-dos > Add New To-do.
2 Set the following:
Title. Enter a title for the To-Do you are creating.
Description. Enter a description for the To-Do you are creating.
Assigned Admins. Select the administrator you want to assign the To-Do in the drop
down menu.
Status. Select Open or Closed from the drop down menu.
Is Public. Is the To-Do available to all administrators? If so, check the box accordingly.
Date Due. Select the date you want the To-Do to be due.
3 Click Add Todo.
Using Bookmarks
Easily create bookmarks of any page inside the Parallels Plesk Billing system. This allows
you to quickly visit those pages you view the most quickly. Follow the instructions below to
learn how to create bookmarks.
In this section:
Adding a Bookmark ........................................................................................... 39
Managing Bookmarks ........................................................................................ 39
Adding a Bookmark
To add a bookmark:
1 Go to the page you want to bookmark within the Parallels Plesk Billing
system.
2 In the upper left-hand corner of the page there is a line with Bookmarks
shown. To the left of Bookmarks there is an add icon. Click on that icon to
add the page you are on as a bookmark.
3 A pop-up text field will appear. Enter the name you want to use as a
reference to the page you are setting as a bookmark. Then click Save.
4 When you reload the page you will see your bookmarks listed next to
Bookmarks on every page. At any time you can click on your bookmark links.
The page you chose will load accordingly.
Managing Bookmarks
If you have previously created bookmarks you can close or remove the bookmarks according
to your own personal preference. Each user in the system can have his/her own set of
bookmarks.
To manage bookmarks:
1 Go to System > System Settings > Admin Settings.
2 Click on the details icon for the user you want to manage bookmarks for in
the Actions column.
3 When the page loads, you have two options:
clone a bookmark to let another administrator use it
delete a bookmark
4 Find the bookmark you want to clone or delete and click on the icons
accordingly.
Choosing Interface Language
To change Parallels Plesk Billing interface language:
1 Enter Your Profile form. You can do it by clicking Profile on the upper bar of
administrator interface, or from the Settings > Admin Settings > Profiles menu.
2 On the profile form select your language from the Language drop-down list.
3 Enter your administrator accounts password in the New Password and Enter
Password Again to confirm the change.
4 Click Update Profile to apply changes.
Choosing Interface Theme
To change Parallels Plesk Billing interface theme (skin):
1 Enter Your Profile form. You can do it by clicking Profile on the upper bar of
administrator interface, or from the Settings > Admin Settings > Profiles menu.
2 On the profile form select a desired skin from the Theme drop-down list.
3 Enter your administrator accounts password in the New Password and Enter
Password Again to confirm the change.
4 Click Update Profile to apply changes.
In this chapter:
Viewing Module Information .............................................................................. 41
Viewing License Information .............................................................................. 41
Viewing PHP Information ................................................................................... 42
Viewing System Information .............................................................................. 42
Viewing Parallels Plesk Billing Version .............................................................. 42
Viewing Module Information
To see a list of all the modules available for use with Plesk, click System > Server Settings
> System Info > ModernBill Module Info. Here you will find the modules organized by type.
You will also see displayed the status of the module (whether stable or testing), the
latest version number, the author, and DRM information. A green button in the DRM list
means that your license allows access to the module listed.
Viewing License Information
To view information relating to the license for your Parallels Plesk Billing software, click
System > Server Settings > System Info > ModernBill License Info. Here you will find the
following:
Parallels Plesk Billing. This will tell you the version number you are running. The build
number is not included here - you can find the build number at the bottom of each
screen.
Admin UI. The version of the user interface you are using.
License. This will tell you what kind of license you have, whether a developers
license, perpetual license, or recurring license. Note: Developers and perpetual
licenses are no longer available.
Registered to. This is the company the license is officially registered to.
Max Clients. Each license has a particular client capacity. This will tell you the
maximum number of non-archived clients you can have in your system before you
need to upgrade to a larger capacity license.
Renews on. Each month, your system calls out to our licensing server to verify that
your license is still valid. The date listed here lets you know when the next call is
due to occur.
You can also find the license information at the bottom of each screen.
CH A P T E R 5
Viewing System Settings
42 Viewing System Settings
Viewing PHP Information
To view PHP information, go to System > Server Settings > System Info > PHP Info.
The PHPinfo script displays detailed information about your php settings. We include
access to this script inside Parallels Plesk Billing to enable you to see clearly which php
Parallels Plesk Billing is using, and what the settings are. Having access to the PHPinfo
script can also be extremely useful for Parallels Plesk Billing support technicians, as
system incompatibilities can be easily identified and suggestions for corrections made.
Disabling the phpinfo function in php will disable this view in Parallels Plesk Billing as
well.
Viewing System Information
Clicking System > Server Settings > System Info > Server Info will provide you with a brief
rundown of your server information:
Server Information. Here you should see the type of OS and web server you are
running, including version number.
PHP Information. A brief display of the php version you are running. A full printout of
your phpinfo information can be found here.
Database Information. This is the version of the database you are using.
cURL Information. The version of cURL you are using, including SSL information.
This information is cursory, and is not meant to be exhaustive. It functions mainly to
provide our technicians basic information in the event they need to investigate a
problem in your Parallels Plesk Billing.
Viewing Parallels Plesk Billing Version
To view your Parallels Plesk Billing version, go to System > System Settings > Versions.
Note: The versions feature is specific to Parallels Plesk Billing developers only. This
will be relocated and hidden in a future release.
System queue allows you to process all automated items in your Parallels Plesk Billing
system.
Parallels Plesk Billing was designed not only to be a billing system, but to be a billing
automation system. While it is possible to use Parallels Plesk Billing without
automation, it was built with the assumption that users will set up the system to be run,
by and large, automatically.
Setting up automation requires two main steps:
1 Configuring Parallels Plesk Billing with settings that do not conflict, so
that when various events are run no conflicts occur.
2 Setting up a cron job on your server to run the events themselves.
Note: If you are using a Windows server, you will need to set up an event in your event
manager.
In this chapter:
Understanding Events ....................................................................................... 44
Setting Up System Queue ................................................................................. 46
Setting Up the Cron Job .................................................................................... 47
Setting Up IP Queue ......................................................................................... 51
Setting Up Payment Queue ............................................................................... 52
Enabling Auto-Suspend ..................................................................................... 53
CH A P T E R 6
Enabling Parallels Plesk Billing
Automation
44 Enabling Parallels Plesk Billing Automation
Understanding Events
One of the central parts of Parallels Plesk Billing automation system is Events. By
events here we are not referring to events in a Windows system, but events within
Parallels Plesk Billing itself. When Parallels Plesk Billing is initially installed, there are
eight events created by default. These events run some of the important tasks like
generating invoices, suspending clients who do not pay their bills, and charging credit
cards.
In addition to the eight events explained below, Parallels Plesk Billing will also create
events to carry out other actions. These include domain registration and renewals,
provisioning packages, and, if you choose to do so manually, generating invoices and
processing credit cards. Each event, when created, is given a time stamp that tells the
system when the event should be run.
In this section:
ProcessInvoices ................................................................................................ 45
ProcessPaymentQueue ..................................................................................... 45
ProcessSuspensions ......................................................................................... 45
ProcessUnsuspensions ..................................................................................... 45
ProcessUsage ................................................................................................... 45
ProcessCancellation .......................................................................................... 45
ProcessExpiredCreditCards .............................................................................. 45
ProcessDomainSynchronization ........................................................................ 46
Enabling Parallels Plesk Billing Automation 45
ProcessInvoices
Part of the configuration process involves telling Parallels Plesk Billing how soon before
a package renews you would like the invoice for that package to be generated. Each
day, this event searches through your list of active packages. It finds any that are due
to be invoiced, and generates them. It also sends by e-mail a copy to your clients,
reminding them that another payment is due.
ProcessPaymentQueue
Once Parallels Plesk Billing has generated invoices, it searches the system for invoices
that are both due and set to be paid by a credit card kept on file. It will collect payment
on these invoices, if they meet the criteria you set in your payment queue settings.
ProcessSuspensions
If you are using the auto-suspend rules, this event will run once a day and send notices
to clients with past due bills. It will also create events to suspend accounts that reach
your final threshold.
ProcessUnsuspensions
When a clients package has been suspended, they still have access to their client
account and can log in and pay their bill. This event runs every 20 minutes, looking for
past due invoices that have been paid. Like ProcessSuspensions, this event will
then create an event to unsuspend the clients account.
ProcessUsage
If you charge usage fees for some of your products, this event will run daily. It searches
your system for any packages that require usage billing, then contacts the server to pull
this information over to Parallels Plesk Billing for local storage.
ProcessCancellation
When a package is canceled it is marked as such. Packages can either be cancelled
immediately, or at the end of the billing cycle. ProcessCancellation runs once a
day, searching for package that need to be canceled and then carrying out that action.
ProcessExpiredCreditCards
46 Enabling Parallels Plesk Billing Automation
Once a week, this event searches through the database for credit cards that will be
expiring soon. If it finds any, it will e-mail the account holder to which the card is tied,
letting reminding them the card is going to expire soon and asking them to update the
card information to avoid missing a payment.
ProcessDomainSynchronization
This event runs once a week. If you are using the eNom module, it will send a call out
to eNom and update the renewal dates for all domains that are listed in your system as
being registered in eNom.
NOTE: This event does not change the package renewal dates, only the renewal date
listed for the domain in the domain details screen.
Setting Up System Queue
All events, whether they were created by default or by another system process, are
placed into the system queue. Some of the rules that govern how these events carry
out their tasks can be configured in the administrative interface. There are also a small
number of settings in the main configuration file that may affect the way the system
queue is run.
The system queue allows you to:
1 Run any amount of items at a time.
2 Create accounts on any supported control panel.
3 Auto-Suspend/Enable accounts on any supported control panel.
4 Process payments.
5 Process domains.
To configure System Queue settings:
1 Go to System > Automation Settings > System Queue Settings.
2 Choose the desired options for the displayed fields:
Type in the number of items you want the system queue to process at a time.
The default value is set to 3.
Active clients Run if. To denote when provisioning occurs, choose an option from
the following:
Customer paid this items invoice.
Client does not have a balance due.
Even if the invoice has not been paid.
Do not run these items.
System Queue Push Minutes: If an event does not pass these run rules it will be
updated to run this many minutes in the future.
Enabling Parallels Plesk Billing Automation 47
Here is an example of settings that work for majority of customers:
Number of System Queue items to run at a time: 3.
Active clients Run if: Customer paid this items invoice.
New Clients Run if: Do not run these items.
New Client Domain orders Run if: Do not run these items.
Domain Active Type: Customer paid this items invoice.
Domain Renewals Run if: Customer paid this items invoice.
Domain/Hosting calls: Run the panel call first.
System Queue Push Minutes: 15.
3 Click Save Settings.
Setting Up the Cron Job
Note: During Parallels Plesk Billing 6.0 bundle installation or bundle update from
version 5.6 the cron job is set up automatically. Skip this step if you are running the 6.0
bundle version.
The last step in configuring your Parallels Plesk Billing to run with automation is to set
up a cron job on your server (or event, if youre using Windows). When this job starts, it
will run a script that will sift through the events in your system queue, looking for any
events that are due to be run, and then process them.
The system automatically adds an administrator user called Cron User. This user has a
Remote Access Hash needed to run the System Queue for complete automation.
Follow the steps below to get your cron job setup.
Also, refer to the Cron Job in Linux (on page 50) section for general guidelines on this
matter.
In this section:
Step 1. Copy the Remote Access Hash ............................................................. 48
Step 2. Check Your Cron User Permissions ...................................................... 48
Step 3. Set Up Your Crontab to Run runevents.php File.................................... 49
Managing Cron Job in Linux .............................................................................. 50
48 Enabling Parallels Plesk Billing Automation
Step 1. Copy the Remote Access Hash
To copy the hash for your Cron user:
1 Go to System > System Settings > Admin Settings.
2 Find the Cron User record.
3 Click the magnifying glass icon.
4 Copy the Remote Access Hash.
5 Log in to your server using SSH.
6 Open your /path/to/ppb/lib-
billing/include/config/config.php file and paste the Remote
Access Hash as shown below:
$CONF[remoteAccessHash] =
f2ad7647377beb58808b8ffceff5527d4f9d4c1d;
7 Save the file.
Step 2. Check Your Cron User Permissions
In order for cron and automation to run properly, your cron admin user must be
assigned the permissions needed to run cron.
To Check Your Cron User Permissions:
1 Go to System > Admin Settings > Admin Settings.
2 Find the Cron User record.
3 Click the pencil icon.
4 In the row Assigned Admin Groups, make sure the cronadmin box is
checked.
5 Click Update Profile to save changes.
Enabling Parallels Plesk Billing Automation 49
Step 3. Set Up Your Crontab to Run runevents.php File
Parallels Plesk Billing requires a single cronjob to start and run the system queue.
To set up your crontab to run runevents.php file:
1 Log in to your server using SSH.
2 Edit your crontab. To do this, type the following command and press
ENTER:
crontab -e
3 Your entry for Parallels Plesk Billing should follow this format:
*/5 * * * * /path/to/php /path/to/ppb/admin/sbin/runevents.php
The timing you see here sets the cronjob to run every five minutes. It can be
adjusted if you like, but this is recommended.
Note: In order to determine the path to your systems PHP binary, run the following
command:
# which php
4 Save the file.
50 Enabling Parallels Plesk Billing Automation
Managing Cron Job in Linux
A cron job (run from a cron daemon) is a recurring process that executes commands
at specific dates and times. To schedule such a recurring task, you would edit your
crontab, which lists all recurring processes on your server.
To add to or edit your crontab file:
1 Log in to your server using SSH.
2 Run:
crontab -e
To print the contents of your crontab file:
1 Log in to your server using SSH
2 Run:
crontab -l
To remove your crontab file:
1 Log in to your server using SSH
2 Run:
crontab -r
If the user under which Parallels Plesk Billing is installed does not already have a
crontab file, you can use the commands above to create one.
Crontab Syntax
The crontab command creates a crontab file containing commands and how often cron
should execute them. Each entry in a crontab file consists of six fields, specified in the
following order:
minute 0-59 - the exact minute that the command sequence executes.
hour 0-23 - the hour of the day that the command sequence executes.
day 1-31 - the day of the month that the command sequence executes.
month 1-12 - the month of the year that the command sequence executes.
weekday 0-6 - the day of the week that the command sequence executes. Sunday =
0, Monday = 1, Tuesday = 2, and so forth.
command - the complete command sequence variable that is to be executed.
Each of the patterns from the first five fields may either be an asterisk (*) (meaning all
legal values) or a list of elements separated by commas. An element is either a number
or two numbers separated by a minus sign (meaning an inclusive range. Note that the
specification of days may be made by two fields (day of the month and day of the
week). If both are specified as a list of elements, both are followed. For example:
MAILTO=user@domain.com
0 5 * * * /big/dom/xdomain/cgi-bin/scriptname.cgi
Enabling Parallels Plesk Billing Automation 51
The cron daemon would run the program scriptname.cgi in the cgi-bin directory
whenever the hour is 5 and the minute is 0. In other words, this script would one
once per day at 5:00 AM.
An alternate example is below:
MAILTO=user@domain.com
0 0 * * 1 /big/dom/xdomain/cgi-bin/scriptname.cgi
The program would then only run on Mondays and email the results to
user@domain.com.
Note: If a cron job specified in your crontab entry produces any error messages when it
runs, they will be reported to you via email.
Setting Up IP Queue
You can use the IP Queue settings to sell Parallels Plesk Panel hosting products that
have dedicated IP addresses.
To sell Parallels Plesk Panel hosting products with dedicated IP:
1 Add IPs in Parallels Plesk Panel as described in the section Adding
and Removing IP Addresses of Parallels Plesk Control Panel for
Linux/Unix Administrators Guide. Select exclusive for IP type.
2 Add a range of exclusive Parallels Plesk Panel IPs to the IP log in
Parallels Plesk Billing:
1. Go to System > Server Settings > Server Groups.
2. Find Parallels Plesk Panel server group and click its ID.
3. Find the line Plesk > IP Queue: 0 and click 0 to enter the List IP Log page.
4. Click Add IP Log.
5. Enter IP range of dedicated IPs you are going to provide with your Parallels
Plesk Panel hosting product.
6. Click Submit.
Also, make sure Dedicated IP option is enabled for the Parallels Plesk Panel hosting
product.
To check if the Dedicated IP option is enabled:
1 Go to Products > Products > Show Products > Hosting Product.
2 Choose your Parallels Plesk Panel hosting product.
3 Click the Attributes link.
4 Check the box near Dedicated IP in the GENERAL OPTIONS section.
With these IP queue settings each Parallels Plesk Panel hosting package will
use a dedicated IP.
52 Enabling Parallels Plesk Billing Automation
Setting Up Payment Queue
If you are using a top-tier gateway such as authorize.net or bluepay to process
your credit card transactions, the payment queue settings govern how and when
invoices are added to and processed by the event ProcessPaymentQueue.
To set up a payment queue:
1 Go to System > Payment Settings > Payment Queue.
2 Set the following:
Payment Queue Action. This determines whether the items in the payment queue
get sent to the gateway as Charge, also called AUTH_CAPTURE, or Authorization
Only, which will require a payment capture at a later point in time. Generally, this
is set to Charge. If you wish to have the gateway just authorize transactions and
collect payment later, then set this to Authenticate Only. Please be aware that if
you do this, you will need to manually capture the funds for all recurring credit
card transactions.
Process New Invoices. Do you want to process new invoices? If set to No, you will
need to run all new invoices manually.
Process Declined Transactions. Do you want to process invoices with declined
transactions? If set to Yes, the system will process these invoices according to
the failure retry time set in the file lib-
billing/include/config/config.php. If set to No, Parallels Plesk Billing
will never automatically retry declined invoices. You will have to do this
manually.
Process Errored Transactions. Do you want to process invoices with errored
transactions? If set to Yes, the system will process these invoices according to
the failure retry time set in the file lib-
billing/include/config/config.php. If set to No, Parallels Plesk Billing
will never automatically retry errored invoices. You will have to do this manually.
Charge On Due Date Only. Do you want to charge the invoices only on the date
invoices are due? If this is set to Yes, invoices will only be added to the queue on
their due date (the due date for invoices is set in Invoice Settings). If set to No,
invoices will be added to the payment queue after they are created.
Clear The Payment Queue First. This should be set to Yes. If you do not clear the
payment queue before a new one is generated, then invoices may be run
multiple times.
Try Lesser Amounts. The feature planned for this setting has not been
implemented yet. Please set to No.
Enable Advanced Share Editing. This feature allows you to assign several different
billing accounts to pay a single package, and then assign custom weights to
each of these. For example, if a client wants to use three credit cards to pay for
one package, and wants to have 75% charged to one card, 20% to another, and
5% to another, you will need to enable this setting to allow this.
Generate Batch Prior To Due Date (Number of Days). How many days before the due
date do you want to generate the payment queue? A normal value for this is 1.
Enabling Parallels Plesk Billing Automation 53
Payment Queue Line Item Threshold. How many line items do you want to be run by
the payment queue before the process ends and spawns another one? Because
php has timeout limits for processes, this value helps tell Parallels Plesk Billing
how many items to run in a single process. This helps to prevent your payment
processes from hitting the timeout in php and dying.
3 Click Save Settings.
Enabling Auto-Suspend
To enable auto-suspend:
1 Go to System > Automation Settings > Auto-Suspend Settings.
2 Set the following:
Enable Auto-Suspend. To enable auto-suspend settings, select Yes.
Auto-Suspend First Notice. Set the number of days after the unpaid invoice is due
to send the first notice e-mail.
Auto-Suspend Second Notice. Set the number of days after the unpaid invoice is
due to send the second notice e-mail.
Auto-Suspend Third Notice. Set the number of days after the unpaid invoice is due
to send the third notice e-mail.
Auto-Suspend Clean Notice. Set the number of days after the unpaid invoice is due
to send the clean notice e-mail. This e-mail indicates the package has been
removed from the server completely.
Enable Auto-Suspend Send Email. Select Yes to enable all e-mails.
3 Click Save settings.
Important: The auto-suspend settings will not be automated until you setup the cron
job. View the Setting Up The Cron Job (on page 47) document to learn more.
Unsuspend/Auto-Enable
If you enable auto-suspend, the Events queue will automatically check suspended
packages every twenty (20) minutes to see if the associated invoice has been paid. If it
has been paid, the system will unsuspend/auto-enable the package.
Gateways are how you accept payment from your clients. Unless you are intending to
take all payment via check, you will want to set up at least one gateway to work with
Parallels Plesk Billing, and to do this, you will need to first set up a payment group.
The payment group page is where you configure the Parallels Plesk Billing integration
with the payment gateway modules you intend to use. You can add several gateway
modules to a single payment group, but each must be for the same currency. Further,
each currency must have its own payment group.
By default, Parallels Plesk Billing creates the first payment group for you. Before you
can have Parallels Plesk Billing automate the process of collecting payment from your
clients, you need to add gateway modules to your payment group, and then configure
these gateway modules.
In this chapter:
Setting Up Encryption ........................................................................................ 55
Adding Payment Groups ................................................................................... 56
Configuring Gateways ....................................................................................... 56
Using Virtual Terminals ..................................................................................... 59
CH A P T E R 7
Configuring Payment Settings
Configuring Payment Settings 55
Setting Up Encryption
If you are intending to use a top-tier gateway and take credit card payments, you must
set up encryption. This is required even if you do not intend to use recurring billing, as
the order process will store the card before it charges it as well. You can use either
passphrase or LEK encryption. If you intend to use automation, you will need to set up
LEK encryption.
To configure encryption settings:
1 Go to the System > System Settings > Encryption Settings page.
2 Enter agree in the Encryption Agree field.
3 In a separate window or tab, open http://www.pleskbilling.com/ and
log in using your members area user name and password.
1. Enter an encryption key of your choice in the text box provided. Be sure to write
this value down, as we have no method to recover this information.
2. Select your four-digit PIN from the four drop down menus.
3. Click the Generate LEK Hash button.
4. When the page loads, the Encryption Hash is generated. Copy the Encryption Hash.
4 Paste the hash into the New Hash text ox.
5 Enter the pin you selected when you created your Encryption Hash in
the LEK Pin field, and then again in the LEK Pin Again field.
6 Set a secret passphrase. It may remain empty if you wish. Enter the
same passphrase into the Passphrase and Confirm fields.
7 Click the Submit Changes button.
56 Configuring Payment Settings
Adding Payment Groups
If you are only collecting payment in a single currency (for example, USD or GBP), then
you can use the default payment group. Please skip to the next section.
To add a payment group:
1 Go to System > Payment Settings > Payment Groups.
2 Click Add Payment Group in the top, right-hand corner.
3 On the next page, fill in the necessary information:
Primary Gateway. A primary gateway is your main gateway known as a real
gateway such as BluePay, Authorize.net, etc.
Secondary Gateway. A secondary gateway is a 3rd party gateway such as PayPal,
WorldPay, and 2Checkout. You can have as many secondary gateways as you
want per payment group. For example, you have Payment Group 1. Your
Primary Gateway is BluePay. Then you have two secondary gateways, PayPal
and WorldPay set up.
Note: There can be only one Primary Gateway per Payment Group, but you can
have as many secondary gateways as you need (as long as they are supported) per
Payment Group.
4 Click Add this Payment Group. You will be taken back to the payment
group page, and should be able to see your new payment group.
To add additional gateway modules, click on the green pencil icon for the payment
group itself. From this screen you can also remove a gateway module, change the
payment group name, or change the currency the payment group is associated with.
Once you have added all the needed gateway modules to your payment group, you will
want to configure your gateway modules.
Configuring Gateways
Before you can setup your gateway, make sure you have added it a payment group.
To configure a gateway:
1 Go to System > Payment Settings > Payment Groups.
2 Click on the id of the Payment Group you added your gateway to in
the Payment Group ID column. Your gateway will appear in a list.
3 Click on the Edit icon in the Actions column next to the gateway label
you want to configure.
4 Fill in the necessary information.
5 Click Save Settings.
Note: For gateway-specific settings, refer to the topics below.
Configuring Payment Settings 57
In this section:
Setting Up Authorize.net .................................................................................... 58
Setting Up PayPal ............................................................................................. 58
58 Configuring Payment Settings
Setting Up Authorize.net
This page provides clarifications on some fields you need to fill in when configuring
Authorize.net.
Authorize.net Login ID. This is the API Login ID that is available from within your
authorize.net account.
Authorize.net Password. This is the API Transaction Key.
Gateway URL. Select Live URL when you want to use your Authorize.net module in a
production environment. Make sure the Gateway Testing mode is set to No in the field
above. If you want to test your Authorize.net module, make sure the Gateway Testing
mode is set to Yes in the field above. Then go to
http://developer.authorize.net/testaccount/ and create a test account. Make sure you
select Test URL for Gateway URL. Use your test account login information.
Setting Up PayPal
This page provides clarifications on some fields you need to fill in when configuring
PayPal.
ID. yourname@yourdomain.com (Enter your primary PayPal e-mail address).
Item Name. Enter a comment or description about your product or service. This will
appear on the customers PayPal receipt.
Return URL. Enter your install URL - https://your_install_dir/
Cancel URL. Enter your install URL - https://your_install_dir/
Display Logo. Enter the URL to your display logo. This is the logo that will show up
on the PayPal payment page once they go through the Parallels Plesk Billing
shopping cart. This is a logo you create.
Submit Image. Enter the URL to your submit image.
IPN URL. Enter the URL to your IPN. Parallels Plesk Billing automatically enters the
URL to your IPN in the system.
Subscription Enable. Do you allow PayPal subscriptions (Recurring payments)?
Paypal Accept Addresses. Enter any PayPal addresses at which you would like to
receive payments, separated either by comma or a new line for each address.
Example: billing@yourdomain.com, service@yourdomain.com,
domains@yourdomain.com.
Note: Any address listed here must be an active PayPal account.
After you save your PayPal settings, do the following:
1 Go to System > System Settings > Admin Settings.
2 When the page loads, find the OrderForm row in the First Name column.
3 Click on the details icon in the Actions column.
4 Copy the remote access hash string value in the Remote Access Hash
entry.
Configuring Payment Settings 59
5 Log in to your server via SSH.
6 Open the gateway.php file located in the lib-
billing/include/config directory. Line 5 shows the following:
//$CONF[IPNAccessHash] =
451c6dbb1d801828e7470fcdbe25201dbc2633d9; // same as the
order form users hash.
7 Uncomment the line by removing the two slashes at the start of the
line and enter the remote access hash you copied above. Placing a
valid remote access hash allows for the IPNs to register with the
system.
8 Save the file.
Note: After you have tested the connection with PayPal, be sure to change Gateway
Testing to No to accept live payments.
Using Virtual Terminals
If your gateway account supports it, you can use Parallels Plesk Billings virtual terminal
to connect directly to your gateway account. This can be useful for two main things:
1 Testing your connection during the configuration process
2 Charging a clients card without having to use Parallels Plesk Billings payment
process.
To use the virtual terminal:
1 Go to System > Payment Settings > Virtual Terminals. The first page asks two
questions:
Create Income Accounting Entries. If you would like this transaction to create
Income Accounting Entries, please check the box. Generally, you will want to
have this checked. If you are testing, however, you may want to uncheck this, as
the transactions you are putting through the terminal are not for accounting, but
to verify connectivity.
Gateway. Please choose the gateway you would like to connect to via the virtual
terminal. You will not normally have more than one choice unless you are selling
products in multiple currencies.
2 Click Next.
3 This page acts as the actual terminal. Enter as much information here
as you have access to.
First Name. Enter the first name of the client to be charged.
Last Name. Enter the last name of the client to be charged.
Customer Email. Enter the email address of the client to be charged.
Customer Address. Enter the clients billing address.
Suite. Enter the suite, of applicable.
60 Configuring Payment Settings
City. Enter the city of the billing address.
State. Enter the state of the billing address.
Zip. Enter the zip code of the billing address.
Customer Country. Enter the country for the billing account.
Phone. Enter the clients phone number.
Fax. Enter the clients fax number, if applicable.
Amount Of Payment. Enter the exact amount of the payment to be charged.
Payment Comments. Enter any comments you want to accompany the payment.
You may want to enter your company name here.
Payment Type. Enter the payment type here. The virtual terminal will only work
with payment types that are enabled in your gateway account.
Charge Action. Choose to either authorize this transaction only, or to charge the
card.
Credit Card. Fill in the credit card information:
Name on Credit Card. Enter the clients name as it appears on their credit card.
Credit Card Type. Enter the credit card type.
Credit Card Number. Enter the credit card number, with no spaces.
Expiration Date. Enter the credit card expiration date.
CVV2 Code. Enter the clients CVV2 code, if this is required by your gateway.
Issue Number. If you are using certain debit cards, you must enter this information
(if you do not know what this is, its likely you dont need to use this).
Start Date. Like the Issue Number, if you are using certain debit cards, you must
enter this information.
4 Click Charge.
Server groups enable you to organize sets of panel modules together, and tie that
group to a product or products. For example, if you want to sell Plesk hosting, and you
have five Plesk servers, you would create a single server group and add all five panel
modules to that single server group. Then, while setting up your products, you have to
option to tie each product with a server group - for your Plesk hosting products you
would choose the Plesk server group.
You can reach the server group page by going to System > Server Settings > Server
Groups. Each server group can have only one type of control panel. This includes
differences between Plesk for Linux and Plesk for Windows, for example. These are
different panels, working with different kinds of servers, so they must be in different
server groups.
In this chapter:
Adding a Server Group ...................................................................................... 62
Adding Panels to a Server Group ...................................................................... 63
CH A P T E R 8
Configuring Hosting Settings
62 Configuring Hosting Settings
Adding a Server Group
By default, your system comes with a server group already created. If you only need
one server group, you can simple configure the default group.
To add a server group:
1 Go to System > Server Settings > Server Groups.
2 Clicking Add Server Group in the upper right hand corner of the server
groups page.
3 On the second page, enter the name you would like to use for the
server group. This is not something your clients will see, so it can be
whatever is meaningful to you. Then choose the fill type you would
like:
Add to the Least Full panel. If you choose this fill option, Parallels Plesk Billing will
add the next new account to the panel with the smallest number of accounts.
Fill panels until full, one by one. This option tells Parallels Plesk Billing that you
want it to fill each panel one at a time, adding accounts to first one server, and
then the next, until each is full.
Note: fill type rules only apply if you have more than one panel module configured
in the server group. Otherwise, Parallels Plesk Billing will just add all new accounts
to the one panel module.
4 Click Add Server Group.
Configuring Hosting Settings 63
Adding Panels to a Server Group
Once you have created a server group, you should be taken back to the main server
group page. From here, you should see your new server group, with the words Add a
Panel and a drop down menu visible next to it.
To add a panel to a server group:
1 Choose the panel type you would like to add.
2 Click add.
3 You will be taken to the panel module configuration page.
While many panels are configured similarly, each panel module has at least
slight differences. Please refer to the specific instructions for each panel module
to understand how it must be configured. Here is a list of our panel modules,
linked to each modules configuration page.
In this section:
Centova Cast .................................................................................................... 64
Cortex ............................................................................................................... 65
cPanel ............................................................................................................... 66
Cube Panel ....................................................................................................... 67
DirectAdmin ....................................................................................................... 68
EMS-Cortex ....................................................................................................... 69
eNomHost ......................................................................................................... 69
Parallels Plesk Panel ......................................................................................... 71
Parallels Pro Control Panel ............................................................................... 72
64 Configuring Hosting Settings
Centova Cast
Once the configuration page loads, you have the following options available to you.
Server Name. This is a name used to identify the Centova Cast server and is for your
own reference purposes only.
Enabled. This option allows you to disable or enable Parallels Plesk Billings ability to
auto-provision to the server. Please note that hosting accounts already tied to the
server will continue to function regardless of the enabled status of the module.
Administrator Password. This is the administrator accounts password through which you
would like to access your Centova Cast server.
Centova Cast URL. This is the fully qualified domain name and path at which Parallels
Plesk Billing will attempt to access your Centova Cast servers administrator interface
(i.e. http://www.example.com/centovacast/).
Show Server Load. This allows you to enable or disable the Server Load status on your
Server Group Settings page. Some Centova Cast installations do not support this, in
which case you should disable this option.
Configuring Hosting Settings 65
Cortex
Once the configuration page loads, you have the following options available to you.
Server Name. This is a name used to identify the Cortex server and is for your own
reference purposes only.
Enabled. This option allows you to disable or enable Parallels Plesk Billings ability to
auto-provision to the server. Please note that hosting accounts already tied to the
server will continue to function regardless of the enabled status of the module.
Cortex Username. This is the administrator accounts user name through which you would
like to access your Cortex server.
Cortex Password. This is the administrator accounts password through which you would
like to access your Cortex server.
Cortex URL. This is the domain/IP and port at which Parallels Plesk Billing will attempt to
access your Cortex servers administrator interface (example:
https://www.mydomain.com:8365).
Cortex IP. This is the IP Address that is sent to customers in the packageInfo e-mails.
Account Name Rule. This is the rule by which Parallels Plesk Billing will create account
user names for your customers in Cortex. Your customers will receive the resulting user
name in their packageInfo e-mail and may log into the Cortex user interface with it.
Prefix or Suffix. This is added to the beginning or end of the order form input user name
only if you are using Add Suffix or User Name Prefix as the Account Name Rule. Any
alphanumeric character is allowed as a prefix/suffix.
Sequence. This is the sequence that will be added to the end of order form input user
names only if you are using Add Sequence as the Account Name Rule. Only numbers are
allowed in this field; whatever is entered will automatically increment by one each time
a new account is created on the Cortex server.
66 Configuring Hosting Settings
cPanel
Once the configuration page loads, you have the following options available to you.
Server Name. This is a name used to identify the cPanel server and is for your own
reference purposes only.
Enabled. This option allows you to disable or enable Parallels Plesk Billings ability to
auto-provision to the server. Please note that hosting accounts already tied to the
server will continue to function regardless of the enabled status of the module.
Username. This is the administrator accounts username through which you would like to
access your cPanel server.
Host. This is the domain/IP at which Parallels Plesk Billing will attempt to access your
cPanel servers admin interface (example: cpanel.mydomain.com).
Access Hash. This is the access hash generated from within cPanel that corresponds to
the user name entered above. If they exist, make sure you remove the ------BEGIN
WHM ACCESS KEY------ and -------END WHM ACCESS KEY------- lines in
your cPanel Access Hash.
Use SSL. This allows you to connect to your cPanel server in SSL mode on port 2087 (if
your cPanel is configured for this).
Account Name Rule. This is the rule by which Parallels Plesk Billing will create account
user names for your customers domain names in cPanel. Your customers will receive
the resulting user name in their packageInfo e-mail and may log into the cPanel user
interface with it.
Display a panel login link on the client side? This allows you to display a panel login link in
the Parallels Plesk Billing client interface that, when click, will automatically log your
customers into their cPanel account.
Prefix or Suffix. This is added to the beginning or end of the order form input user name
only if you are using Add Suffix or User Name Prefix as the Account Name Rule. Any
alphanumeric character is allowed as a prefix/suffix.
Sequence. This is the sequence that will be added to the end of order form input user
names only if you are using Add Sequence as the Account Name Rule. Only numbers are
allowed in this field; whatever is entered will automatically increment by one each time
a new account is created on the cPanel server.
Configuring Hosting Settings 67
Cube Panel
Once the configuration page loads, you have the following options available to you.
Server Name. This is a name used to identify the Cube Panel server and is for your own
reference purposes only.
Enabled. This option allows you to disable or enable Parallels Plesk Billings ability to
auto-provision to the server. Please note that hosting accounts already tied to the
server will continue to function regardless of the enabled status of the module.
Cube Panel Username. This is the administrator accounts user name through which you
would like to access your Cube Panel server.
Cube Panel Password. This is the administrator accounts password through which you
would like to access your Cube Panel server.
IP. This is the IP at which Parallels Plesk Billing will attempt to access your Cube Panel
servers administrator interface.
Show Server Load. This allows you to enable or disable the Server Load status on your
Server Group Settings page. Some Cube Panel installations do not support this, in which
case you should disable this option.
Account Name Rule. This is the rule by which Parallels Plesk Billing will create account
user names for your customers in Cube Panel. Your customers will receive the
resulting user name in their packageInfo e-mail and may log into the Cube Panel user
interface with it.
68 Configuring Hosting Settings
DirectAdmin
Once the configuration page loads, you have the following options available to you.
Server Name. This is a name used to identify the DirectAdmin server and is for your own
reference purposes only.
Enabled. This option allows you to disable or enable Parallels Plesk Billings ability to
auto-provision to the server. Please note that hosting accounts already tied to the
server will continue to function regardless of the enabled status of the module.
Username. This is the administrator accounts user name through which you would like
to access your DirectAdmin server.
Password. This is the administrator accounts password through which you would like to
access your DirectAdmin server.
URL. This is the domain/IP and port at which Parallels Plesk Billing will attempt to
access your DirectAdmin servers administrator interface (i.e.
https://www.mydomain.com:2222).
IP. This is the IP Address that is sent to customers in the packageInfo e-mails. It is also
the IP Address to which DirectAdmin will bind the Apache VirtualHost for each created
hosting account.
Show Server Load. This allows you to enable or disable the Server Load status on your
Server Group Settings page. Some DirectAdmin installations do not support this, in which
case you should disable this option.
Account Name Rule. This is the rule by which Parallels Plesk Billing will create account
usernames for your customers domain names in DirectAdmin. Your customers will
receive the resulting username in their packageInfo e-mail and may log into the
DirectAdmin user interface with it.
Prefix or Suffix. This is added to the beginning or end of the order form input username
only if you are using Add Suffix or Username Prefix as the Account Name Rule. Any
alphanumeric character is allowed as a prefix/suffix.
Sequence. This is the sequence that will be added to the end of order form input
usernames only if you are using Add Sequence as the Account Name Rule. Only numbers
are allowed in this field; whatever is entered will automatically increment by one each
time a new account is created on the DirectAdmin server.
Configuring Hosting Settings 69
EMS-Cortex
Once the configuration page loads, you have the following options available to you.
Server Name. This is a name used to identify the EMS-Cortex server and is for your own
reference purposes only.
Enabled. This option allows you to disable or enable Parallels Plesk Billings ability to
auto-provision to the server. Please note that hosting accounts already tied to the
server will continue to function regardless of the enabled status of the module.
Ems Cortex Username. This is the administrator accounts user name through which you
would like to access your EMS-Cortex server.
Ems Cortex Password. This is the administrator accounts password through which you
would like to access your EMS-Cortex server.
Ems Cortex URL. This is the domain at which Parallels Plesk Billing will attempt to access
your EMS-Cortex servers administrator interface.
Account Name Rule. This is the rule by which Parallels Plesk Billing will create account
user names for your customers in EMS-Cortex. Your customers will receive the
resulting user name in their packageInfo e-mail and may log into the EMS-Cortex user
interface with it.
Prefix or Suffix. This is added to the beginning or end of the order form input user name
only if you are using Add Suffix or Username Prefix as the Account Name Rule. Any
alphanumeric character is allowed as a prefix/suffix.
Sequence. This is the sequence that will be added to the end of order form input user
names only if you are using Add Sequence as the Account Name Rule. Only numbers are
allowed in this field; whatever is entered will automatically increment by one each time
a new account is created on the EMS-Cortex server.
eNomHost
Once the configuration page loads, you have the following options available to you.
Server Name. This is a name used to identify the DirectAdmin server and is for your own
reference purposes only.
Enabled. This option allows you to disable or enable Parallels Plesk Billings ability to
auto-provision the eNom Hosting plan. Please note that hosting accounts already tied
to eNom Hosting will continue to function regardless of the enabled status of the
module.
User name. This is the eNom Reseller accounts user name through which you would
like to access your eNom Account.
Password. This is the eNom Reseller accounts password through which you would like
to access your eNom Account.
70 Configuring Hosting Settings
Account Name Rule. This is the rule by which Parallels Plesk Billing will create account
user names for your customers domain names in eNom. Your customers will receive
the resulting user name in their packageInfo e-mail and may log into the eNom user
interface with it.
Prefix or Suffix. This is added to the beginning or end of the order form input user name
only if you are using Add Suffix or User Name Prefix as the Account Name Rule. Any
alphanumeric character is allowed as a prefix/suffix.
Sequence. This is the sequence that will be added to the end of order form input user
names only if you are using Add Sequence as the Account Name Rule. Only numbers are
allowed in this field; whatever is entered will automatically increment by one each time
a new eNom hosting account is created.
Configuring Hosting Settings 71
Parallels Plesk Panel
Before you can set up your Plesk module, you must have a Server Group (on page 61)
for Parallels Plesk Panel setup. Once you have successfully created a Server Group,
follow the instructions below.
To set up a Plesk Module:
1 Go to System > Server Settings > Server Groups.
2 Click the + PleskUnix or + PleskWin link.
3 When the page loads, fill in the panel options:
Server Name. Enter the name you want to call this Plesk server.
Enabled. Select Yes.
User name. Enter the user name to the Plesk interface.
Password. Enter the password to the Plesk interface.
URL. Enter the URL to the Plesk server.
IP. Enter the IP to the Plesk server.
Show Server Level. specify if you want to show the server load level for this Plesk
module.
Account Name Rule. Select the type of name rule you want to apply to the
username.
Prefix or Suffix. Enter the prefix/suffix you want to apply to the user name.
Username Sequence. Enter the numeric value you want to use for the user name
sequence.
Try to register Plesk Server in SSO. Specify if you want to register this server in a
Single Sign On system.
Minimum User name Length. Enter the minimum length for the user name.
Maximum User name Length. Enter the maximum length for the user name.
Minimum Password Length. Enter the minimum length for the password.
Maximum Password Length. Enter the maximum length for the password.
Maximum Server Weight. Enter the maximum server weight for this server.
Current Number of Accounts. How many accounts are currently on the server?
Enter the number.
Name server. Specify the name server.
Name server IP. Specify the IP.
4 Click the Save button.
After setting up your Plesk module, you will be able to configure the Plesk
attributes for each of your products. For more information, view the Appendix A.
Parallels Plesk Panel Attributes (on page 230) document.
72 Configuring Hosting Settings
Parallels Pro Control Panel
Once the configuration page loads, you have the following options available to you.
Server Name. This is a name used to identify the Parallels Pro server and is for your own
reference purposes only.
Enabled. This option allows you to disable or enable Parallels Plesk Billings ability to
auto-provision to the server. Please note that hosting accounts already tied to the
server will continue to function regardless of the enabled status of the module.
Symbolic Link Append String. This is where you enter the symbolic link appending string. It
is already set to -XYZ by default.
Shared IP. This is the IP address to your Parallels Pro Control Panel server. This is also
the IP Address that is sent to customers in the packageInfo e-mails.
Account Name Rule. This is the rule by which Parallels Plesk Billing will create account
user names for your customers domain names in Parallels Pro. Your customers will
receive the resulting user name in their packageInfo e-mail and may log into the
Parallels Pro user interface with it.
Prefix or Suffix. This is added to the beginning or end of the order form input user name
only if you are using Add Suffix or User Name Prefix as the Account Name Rule. Any
alphanumeric character is allowed as a prefix/suffix.
Sequence. This is the sequence that will be added to the end of order form input user
names only if you are using Add Sequence as the Account Name Rule. Only numbers are
allowed in this field; whatever is entered will automatically increment by one each time
a new account is created on the Parallels Pro server.
Once you pressed Save, configure also the following:
1 Create symbolic links to the VirtDomain scripts on the local server,
using the Symbolic Link Append String you entered while editing Parallels
Pro options.
Example:
cd /usr/local/bin
ln -s AddVirtDomain AddVirtDomain-XYZ
ln -s DeleteVirtDomain DeleteVirtDomain-XYZ
ln -s EnableVirtDomain EnableVirtDomain-XYZ
ln -s DisableVirtDomain DisableVirtDomain-XYZ
ln -s EditVirtDomain EditVirtDomain-XYZ
ln -s ListAllVirtDomains ListAllVirtDomains-XYZ,
ln -s DomainExists DomainExists-XYZ,
ln -s AddReseller AddReseller-XYZ
2 Edit the file /etc/sudoers. Add the following lines to the end of the
file, substituting your link names as needed:
Cmnd_Alias ENSIM = /usr/local/bin/AddVirtDomain-XYZ, \
/usr/local/bin/DeleteVirtDomain-XYZ, \
/usr/local/bin/EnableVirtDomain-XYZ, \
</