Professional Documents
Culture Documents
2
• Incomplete Order Process...................................................................................................................... 30
Certificate Generation Process .......................................................................................................................... 31
cWatch License Key Generation Process ........................................................................................................... 37
cWatch License Upgrade ................................................................................................................................... 38
CodeGuard Order Process ................................................................................................................................. 39
CodeGuard Order Upgrade ............................................................................................................................... 41
CodeGuard Management Actions on Client Side .............................................................................................. 42
• Edit User ................................................................................................................................................ 43
• Add Additional User ............................................................................................................................... 43
• Delete Additional User........................................................................................................................... 43
• Access CodeGuard Dashboard ............................................................................................................... 44
• Cancel Order .......................................................................................................................................... 44
CodeGuard Management Actions on Admin Side ............................................................................................ 44
• Suspend ................................................................................................................................................. 44
• Unsuspend............................................................................................................................................. 45
• Terminate .............................................................................................................................................. 45
Certificate Generation Using AutoSSL................................................................................................................ 45
Certificate Details Page ..................................................................................................................................... 48
• On Client Area........................................................................................................................................ 48
• On Admin Area ...................................................................................................................................... 50
Management action buttons on the client side ................................................................................................. 50
• Change Approval Method ...................................................................................................................... 51
• Resend Approval Email .......................................................................................................................... 51
• Download Auth File ............................................................................................................................... 51
• Download Certificate ............................................................................................................................. 51
• Download Private Key ............................................................................................................................ 51
• Install Certificate .................................................................................................................................... 52
• Certificate Re-issue ................................................................................................................................ 52
• Certificate Re-issue using AutoSSL ......................................................................................................... 53
• Certificate Cancellation .......................................................................................................................... 54
Management action buttons on the Admin side ............................................................................................... 55
Auto Renewal .................................................................................................................................................... 56
Product Synchronization ................................................................................................................................... 56
3
• Synchronization Cron ............................................................................................................................. 56
1. Sync Manually .................................................................................................................................. 57
2. Sync Only Alterations ....................................................................................................................... 57
3. Sync Alterations & Removal ............................................................................................................. 57
4. Sync All ............................................................................................................................................. 57
1. Desired Profit Margin ....................................................................................................................... 58
2. Default Product Group ..................................................................................................................... 58
3. Default Currency .............................................................................................................................. 58
• Sync Products Page ................................................................................................................................ 58
Activity Log Reporting........................................................................................................................................ 59
Reports .............................................................................................................................................................. 60
• Datewise Sales Report ........................................................................................................................... 60
• Renewal Report ..................................................................................................................................... 61
• Profit & Loss Report ............................................................................................................................... 62
Symantec Replacement Orders List ................................................................................................................... 63
Purchase Additional SANS for Multi-Domain SSL certificate ............................................................................ 64
What’s New ....................................................................................................................................................... 64
• In version 4.7 ......................................................................................................................................... 64
• In version 4.6 ......................................................................................................................................... 65
• In version 4.5 ......................................................................................................................................... 65
• In version 4.4.3 ...................................................................................................................................... 65
• In version 4.4.2 ...................................................................................................................................... 65
• In version 4.4.1 ...................................................................................................................................... 65
• In version 4.4 ......................................................................................................................................... 65
Multilingual Support .......................................................................................................................................... 66
Bug Reports ....................................................................................................................................................... 66
4
General Overview
At the SSL Store™, we understand the importance of automation and ease of use. It’s these principles that
have led to the development of our WHMCS Module. At WHMCS’s core, automation is not only essential,
but refined to handle anything and everything you manage to throw at it. We have harnessed our years
of experience in the industry and developed the most robust WHMCS SSL module on the planet.
The SSL Store’s WHMCS Module has undergone both extensive testing and research to make any and all
interactions with security a breeze. By adopting the core values of WHMCS, we’ve developed our module
to be capable of being setup within minutes with product importation. Days are now saved from
painstakingly having to setup each individual product and product configurable option. While that’s a nice
benefit in and of itself, our module doesn’t stop there. We’ve also developed a fully automated renewal
system to prevent any issues with expired/forgotten certificates.
Prior to going live, we’d recommend testing your configuration with our Sandbox environment. This will
allow you to test everything from purchasing, re-issuing, and certificate management without any cost on
your part. To sign-up for an account, you’ll want to proceed to our Sandbox website
(sandbox.thesslstore.com). Upon signing up, your account will be instantly approved and allow you to
generate both your Test Token and Test Code.
If you click the “Configure” button for the module, it will present you with “Access Control.” Access
Control will allow you to permit or limit the module functionality for your team.
Once you’ve setup your desired configuration, you can click “Save Changes.” At this point, go to Admin
home by clicking on the WHMCS logo. Now you should see the option titled “TheSSLStore Module
Admin” under the “Addons” menu tab.
5
By clicking on the “TheSSLStore Module Admin” you’ll be brought to a page similar to the above
screenshot. On the left-hand sidebar is where all the magic happens. The first part of configuration is
“Module Settings”, this is where you’ll begin setting up the module.
On the “Module Settings” page, you will need to input both your “Partner Code” and “Auth Token” for
both your “Live” and “Test” accounts with us. You can generate your “Live” inputs here and your “Test”
inputs here.
Once pasted over, you can decide the “Operation Mode” of the module. The “Operation Mode” allows
for you to run two types of environments, one that is made for actual use (Live) and one made for testing
(Test).
Upon completion of your inputs and choice of mode, you can proceed by clicking the “Save & Validate”
button at the bottom.
6
• Technical Contact Information
Here you can enter and save all the fields related to your “Technical Contact”. This information
will be used for the certificate generation process on the client side by default. If you leave the
option “unchecked,” then you will be asked to input the technical contact information during
the certificate generation process on the client side.
7
• Other Settings
• Expiration Reminder Email Days
• Additional Days for New Order
• Additional Days for Renew Order
• Default Web Server on Certificate Generation
• Download certificate including Nginx and Apache?
• Hide the AutoInstall SSL hosting profile section from client Area?
If you were to input "7" and your Invoice Generation is set to "14" the module would have
WHMCS dispatch an email your client 21 days prior the renewal.
To disable “additional days” for new order, WHMCS admin must set “0” in the “Additional Days
for New Order” option.
If WHMCS admin has set up renewal reminder days for an order’s field “Override Additional
days for Re-New Order”, then the certificate will get additional days based on this setting.
To Disable “additional days” in renewal order, WHMCS admin must set “0” in the “Additional
Days for Renew Order” option.
Hide the AutoInstall SSL hosting profile section from client Area?
If this option is "enabled" then the AutoInstall SSL hosting profile section will be hidden from the
client Area. This option is enabled by default.
8
Dashboard
On the homepage of our plugin we have introduced a dashboard which has three different versions of
the homepage depending upon if the user has an update available, fresh install, and the standard version
(when everything is fine).
2. When the user clicks “Begin Setup” they will be brought to “Step 2” titled “API Credentials” of
the onboarding process of the “Fresh Install Dashboard” which will ask for their API Credentials.
Once they’ve input their credentials and clicked ‘Save’, they will be brought to the next page of
the setup process.
9
3. After inputting their API Credentials in “Step 2” of the “Fresh Install Dashboard”, the user will be
brought to “Step 3” titled “Import Products” of the “Fresh Install Dashboard”, which will allow
the user to import all the products into their WHMCS.
4. Once the import of all the products is complete, the user will be brought to “Step 4” titled “Cron
Setup” of the “Fresh Install Dashboard” which will instruct the user how to setup and how often
to run all the cron jobs of the module to automate their SSL Experience.
10
5. After completion of “Step 4” the user will be brought to a confirmation page titled “You’re Ready
to Embark!” with a statement like the “Introduction” portion of the onboarding process.
11
Update Available Dashboard
If the “Update-Check” API detects that the Reseller is behind in their module version, we will present
them with the “Update Available Dashboard”. This dashboard contains most of content from the
“Standard Version Dashboard” but will also contain a hero banner that informs the reseller there is an
update available.
12
Auto import and setup all the products from the admin area
After saving your credentials on the “Module Settings” page, you’re now ready to import all the security
products. To do this, click on the option titled “Import Products” on the left-hand sidebar.
First, you have to setup “USD” Currency Code and the “Base Conv. Rate” with your default currency from
the menu “Setup >> Payments >> Currencies”. Otherwise, the page will give an error message.
Once the page loads, there will be two options for you to choose as below.
• Import Product with % margin
• Import Product with individual pricing
Note: There’s no need toworry about configurable options such as Additional SANs or Additional
Servers, our importation will automatically create these for any products that require them.
After providing the “Product Group”, “Currency Code”, “Desired Profit Margin” and “Product
Selection” you can proceed with clicking the “Import Products” button below. The importation
could take a few minutes to process depending upon server load.
13
• Import Product with individual pricing
Once you select this option, there will be two options for you to configure prior to beginning
the importation of the security products. The first option is the “Select Product Group”, which
asks you to select which “Product Group” you’d like the products to be imported into. The
second option is the “Select Currency Code”, which asks you to select which “Currency” you’d
like the products price to be setup into.
Also, from now you have the option to select individual products which you want to import. For
the selected products, you must enter the price in their respective fields.
After providing the “Product Group”, “Currency Code”, “Product Selection” and “Price Setup”
you can proceed with clicking the “Import Products” button below. The importation could take a
few minutes to process depending upon server load.
Upon successful completion of the importation, you can proceed to “Setup >> Products/Services
>> Products/Services” to review of all the products successfully created for the module.
14
Adjust Products and SAN/SERVER pricing from the admin area
If the time ever comes that you find you need to update your pricing, you can do so by going to “Setup
Product Pricing” on the left-hand sidebar. If you’re uncertain of your pricing tier, you can click the “View
Reseller Pricing” which will provide you with your current pricing tier.
From here, you can manually adjust the one, two, and three-year pricing for every product imported. The
same can be done for the configurable options such as SANs and Server Licenses. You can also mass action
pricing adjustments for both products and configurable options by selecting “Currency Code”, inputting a
new “Desired Profit Margin” and clicking “Apply to All Products.”
At the same time, you can also hide individual products from appearing on your order forms. To do this,
you’ll want to review the product list and check the “Hidden” checkbox provided in the first column of the
table.
Aftercompleting all your adjustments, clickthe green“Save” button. This will apply any adjustments you’ve
made to your WHMCS system.
NOTE: To make this function work, please set "max_input_vars = 4000" in your php.ini file and then restart
your webserver.
15
Alert to update the products pricing for the live environment
Whenever you change your “Operation Mode” from “Test” to “Live” from the “Module Settings,” you will
be directed to the “Setup Product Pricing” page to confirm your current pricing structure. Upon being
directed to the page, there should be a green notification similar to below.
Once the page loads, there will be two options for you to choose as below.
• Import order from SSL Store
• Import order using CSV
16
• Import order from SSL Store
Once you select this option, there will be an input field to Enter SSL Store Order ID. Below that
field there will be two more options for you to select as below.
After selecting the “Client”, “Payment Method”, “Generate Invoice” and “Send Email”, you can
proceed by clicking the “Import Order” button below.
After entering the “WHMCS Service Id,” you can proceed by clicking the “Import Order” button
below.
17
• Import order using CSV
Once you select this option, you can import your existing orders - which were placed in your
control panel or from another provider - using a “.CSV” file to your WHMCS system. The data
you input into the .CSV file and upload into WHMCS, will not create any live orders or charge
your account or client. This data is purely informational. Our system will automatically start the
renewal process and generate the client’s invoice - using the "placeorder_cron.php" cron job -
once the "Due Date" of the existing order is within 21 days.
Note: If the imported orders "Due Date" is already within 21 days until expiration, unfortunately,
our system will not automatically start the renewal process and you will be required to handle
this manually for your client.
18
CSV File Field Declaration
When importing the “.CSV,” it’s vital that the format be the same as what’s listed below;
otherwise it will result in an error. Until the error is corrected, you will not be able to import the
“.CSV” containing your orders into your WHMCS.
userid Please enter the user id of your existing user for which you are importing the
order.
productgroupid Please enter the existing Product Group Id. Go to Setup >> Product/Services >>
Product/Services and click on product group and you can see the id.
numberofsan Please enter thevalid number of additional SAN for the multidomain products.
Note: “numberofsan” field is used to purchase additional SAN for the product.
In many multidomain products few SAN are included by default.
numberofwildcardsan Please enter the valid number of wildcard SAN for the Digicert Flex products.
Note: “numberofwildcardsan” field is used to purchase additional wildcard SAN
for the Digicert Flex products.
additionalserver Please enter thevalid number of Additional Server for the supported Symantec
Products.
billingcycle Please enter the valid billing cycle e.g. Annually/ Biennially/ Triennially.
paymentmethod Please enter the valid Payment Method Name e.g. banktransfer / paypal.
duedate Please enter the valid Due Date. Basedon this date reminder email will send to
the user email address and order will place to The SSL Store™.
19
On this page, you can search for your order(s) by any filed associated with the imported order.
There are a sorting options for all the fields to assist in managing orders. Within the table you can
edit the “Due Date” for an order by just clicking on the “Edit” action of that order, this opens a
date picker for you to select the new date.
Also, there is an option to view or delete the order accordingly. Also, you can change the number
of records to display in the table from the dropdown at the top left-hand corner of the table.
Email Templates
We Uses the “Custom” identification for all our email templates to inform you that the email templates
are custom.
Below is the default text of the order email for all products except Certum, PCI Compliance, Site
Seal and scanning-related products, & Code Signing and Email Signing Products. You may also
customize the email templates based on your requirements.
Subject: Your SSL Certificate - Enrollment steps
Dear {$client_name},
You’ve successfully completed the purchasing process for an SSL Certificate! But wait, your SSL
still requires a few more steps which can be easily done at the following URL:
20
{$ssl_configuration_link}
OR
If you are using AutoInstall SSL®, then please follow the below steps:
Now that your SSL purchase is complete, it’s time to set up and install your new SSL certificate
automatically!
To use our AutoInstall SSL technology, the fastest and easiest way to get your new SSL certificate
set up, please login to your cPanel/Plesk control panel, click on the AutoInstall SSL icon. Then
use the following Token for the automatic installation of Store Order ID: {$storeorder_id}.
Token: {$token}
You’ll be guided through the entire process from there, and it should only take a few minutes.
If you experience any problems or have any questions throughout the process, please feel free
to open a support ticket, we know all the ins and outs of SSL and can quickly help you with any
issues. Thank you for trusting us with your web security needs.
{$signature}
Available merge fields declaration:
{$client_name}: Client Name
{$signature}: Signature
Dear {$client_name},
21
You’ve successfully completed the purchasing process for your web security product! But
wait, your order still requires a few more steps which can be easily done at the following
URL:
{$ssl_configuration_link}
If you experience any problems or have any questions throughout the process, please feel
free to open a support ticket, we know all the ins and outs of the process and can quickly
help you with any issues. Thank you for trusting us with your web security needs.
{$signature}
{$signature}: Signature
Dear {$client_name},
This is a reminder that your "SSL Certificate" for {$service_domain} will going to expire in
{$reminder_days} days. Renew now before it's too late...
If you do not proceed with the same, your certificate will be expired.
{$signature}
Available merge fields declaration:
{$client_name}: Client Name
{$signature}: Signature
22
• Your SSL Certificate - Renewal Reminder Email
Below is the default text of the Renewal Reminder Email. You may also customize the email
templates based on your requirements.
Subject: Your SSL Certificate - Renewal Reminder Email
Dear {$client_name},
This is a reminder that your "SSL Certificate" will going to Renew in {$reminder_days} days.
Below are the order details...
Domain Name: {$domain}
Product Code: {$productcode}
User Email: {$useremail}
Billing Cycle: {$billingcycle}
Payment Method: {$paymentmethod}
Thank you for using our services!
{$signature}
{$signature}: Signature
Below is the default text of the renewal order email. You m a y also customize the email
templates based on your requirements.
Subject: Your Renewal SSLCertificate - Enrollment steps ({$domain_name})
Dear {$client_name},
You’ve successfully completed the renewal process of a SSL Certificate for the domain
{$domain_name}! But wait, your SSL still requires a few more steps which can be easily done at
the following URL:
23
{$ssl_configuration_link}
OR
If you are using AutoInstall SSL then please follow the below steps:
Now that your SSL renewal process is complete, it’s time to set up and install your new SSL
certificate automatically!
To use our AutoInstall SSL technology, the fastest and easiest way to get your new SSL certificate
set up, please login to your cPanel/Plesk control panel, click on the AutoInstall SSL icon. Then
use the following Token for the automatic installation of Store Order ID:{$storeorder_id}.
Token : {$token}
Domain : {$domain_name}
You’ll be guided through the entire process from there, and it should only take a few minutes.
If you experience any problems or have any questions throughout the process, please feel free
to open a support ticket, we know all the ins and outs of SSL and can quickly help you with any
issues. Thank you for trusting us with your web security needs.
{$signature}
{$signature}: Signature
Dear {$client_name},
This is a notice that your {$service_product_name} for {$common_name} must be reissued by
{$cert_expiry_date}.
24
No purchase is necessary, but to remain compliant with the CA/B Forum, a reissue is required to
maintain security. You may choose to reuse your CSR and reissue the certificate, making
installation a breeze. Or, you can use a new CSR, keeping your encryption as secure as possible.
{if $reissue_link neq "“} Click Here to ReIssue certificate{/if}
{$signature}
Dear {$client_name},
This is a notice that your {$service_product_name} for {$common_name} must be reissued by
{$cert_expiry_date}.
No purchase is necessary, but to remain compliant with the CA/B Forum, a reissue is required to
maintain security. You may choose to reuse your CSR and reissue the certificate, making
installation a breeze. Or, you can use a new CSR, keeping your encryption as secure as possible.
{if $reissue_link neq "“} Click Here to ReIssue certificate{/if}
{$signature}
25
• Profit Margin Not Available for Sync Products
Subject: Profit Margin Not Available for Sync Products
Dear Admin,
We’re sorry to inform you but the new certificates couldn’t be added as we don’t know your
desired profit margin and/or product group. To resolve this please update your desired profit
margin and/or product group at {$module_setting_page_url} to resolve these issues.
{$signature}
{$signature}: Signature
Dear Admin,
There appears to be a few certificates that are currently out of date and need your attention.
Please review these certificates at {$sync_product_page_url} to resolve these issues.
{$signature}
{$signature}: Signature
Dear Admin,
{if $log_of_changes neq ""}
Our system has detected that you have a few certificates that have out of date Configurable
Options. But not to worry, however, as they are now corrected and the changes are listed below.
{$log_of_changes}
{/if}
{if $product_add_or_remove eq "y"}
It appears there are a few certificates that are either waiting to be added to your WHMCS or
needing to be disabled. Please review these products at {$sync_product_page_url} to resolve
these issues.
26
{/if}
{$signature}
{$signature}: Signature
Dear Admin,
{if $log_of_changes neq ""}
Our system has detected that you had a few certificates that were either no longer being carried
or had their configurable options out of date. These issues are now corrected and the changes
are listed below.
{$log_of_changes}
{/if}
{if $product_added eq "y"}
It appears there are some new certificates ready to be added to your system! Please review these
new products at {$sync_product_page_url} to add them to your WHMCS.
{/if}
{$signature}
{$signature}: Signature
Dear Admin,
Our system has detected that you had a few certificates that were either out of date,
discontinued, or newly added. Not to worry, however, as they have now been corrected and the
changes are listed below.
{$log_of_changes}
27
{$signature}
{$log_of_changes}: Log of the changes of the configurable options, Add products, disabled
products
{$signature}: Signature
28
Cron Jobs Setup
To enable the automation features to run on the WHMCS system, create the following Cron Job
using PHP.
php -q / your whmcs path /crons/cron.php
29
Product Synchronization
This operation will check if there are any differences between your imported WHMCS security
products and The SSL Store’s currently offered API products.
30
Certificate Generation Process
Once the order has been accepted, the customer will receive the enrollment email which will provide them
with a link to generate their order. At the same time, the customer can proceed to their order details page
(“Services >> My Services >> Order Details”) and click on “Generate Cert Now” button that will appear.
Upon starting the generation process, some of the information being requested by the vendor will be pre-
filled based upon the credentials the client has on their profile within WHMCS. If their pre-filled details are
incorrect, the client can proceed to change them to whatever they wish.
During the first step of the generation process, the client will be asked to input both their technical and
administration information as well as their Certificate Signing Request (CSR), Web Server Type, Alternative
Names, Signature Algorithm, Organization Information for OV & EV certificate etc.
31
32
DigiCert Organization Information
For DigiCert products whenever you place an order with the new organization info. On the
successful response the organization info will be stored in the WHMCS database. So, for the
next time whenever you will be going to generate the certificate for the DigiCert product It will
show you two option for the Organization Information.
33
On the second step of the generation process, the client will be asked to select the Domain Authentication
Method they would like to choose from “HTTP (File-Based Authentication)” or “DNS (CNAME)” or
“EMAIL”.
If you select the EMAIL option, you can choose from the following pre-authorized email addresses
associated with your domain. For COMODO multidomain products, end-user can select a global alias (i.e.
admin@domain.com) for all their SAN entries. When clicking “Apply” it will populate the address
throughout all the entries. IF the end-user clicks “Clear Selection” it will default select back to “Please
choose one…”.
Note: - While ordering COMODO multidomain products you can choose the individual Authentication
method for individual domain. e.g. For main domain you can choose the HTTP, for the first SAN you can
choose EMAIL and for the other SAN you can choose DNS.
34
Once all the required details have been provided by the client and he/she click on “Click to Continue”, our
module will provide a confirmation page informing the client that the certificate has been generated
successfully. At this point the certificate request has been dispatched to the Certificate Authority (CA) for
validation.
Note:
1) If the client has selected “File-Based Authentication” the confirmation page will contain the auth file
details and download button.
35
2) If the client has selected “CNAME” the confirmation page will contain the CNAME details.
36
cWatch License Key Generation Process
Once the order has been accepted, the customer will receive the email which will provide them with a link
to generate their license. At the same time, the customer can proceed to their order details page
(“Services >> My Services >> Order Details”) and click on “Generate License Key” button that will appear.
Upon starting the generation process, some of the information being requested by the vendor will be pre-
filled based upon the credentials the client has on their profile within WHMCS. If their pre-filled details are
incorrect, the client can proceed to change them to whatever they wish.
During the generation process, the client will be asked to input their administrator contact information as
well as the domain name for which the client wish to generate the license key.
Once all the required details have been provided by the client and he/she click on “Click to Continue”, our
module will provide a confirmation page informing the client that You’ve successfully claimed your cWatch
Web license key. At this point the license key request has been dispatched to the cWatch for validation.
Also, the confirmation page will contain the license key details and Download cWatch Guide button.
37
cWatch License Upgrade
To upgrade your license:
When the add site operation was completed successfully from the vendor end, you will see the
“Upgrade License” button on the cWatch order details page.
Once you click on “Upgrade License”, a new screen will open with the list of upgrade options e.g.
cWatch Web Starter, cWatch Web Pro and cWatch Web Premium. Click on the appropriate “Upgrade
License” button which you wish to upgrade from the current license. A confirmation dialog will be
displayed.
When you click “Ok” on the dialog box, the new service will be created in WHMCS and an invoice will
be generated. The cWatch upgrade order will be placed to The SSL Store™ based on the configuration
settings on “Module Settings” tab of the Products/Services. The new license key will be automatically
linked with the domain.
38
CodeGuard Order Process
Once the certificate has been purchased, a support member that has access to the module should go
into the WHMCS Admin side to approve the order. To approve the order, the support member will go
to “Orders > Pending Orders” and approve the order(s) by checking the box in the first column and
click “Accept Order” at the bottom.
After the order has been accepted on the backend of WHMCS, at the same time our module will place
an order to the CodeGuard API. This order process will use the required details, Name & Email, based
on the client profile within WHMCS to Assign the CodeGuard license to that customer. If the client
wishes to update those details, they can proceed to “Edit User” from the client-side order details page.
39
40
CodeGuard Order Upgrade
After the order process has been successfully completed, your clients can place upgrade orders
themselves if you have permitted it in the product configuration. This allows clients to order upgrades
and complete them automatically without the needing your involvement.
In order to place an upgrade order, the client has to login, navigate to the Services > My Services
section, click into view the full details for the product or service they wish to manage, and then select
the options to upgrade the license.
Note: - CodeGuard products will only support the upgrade for the same billing cycle. Downgrades are
not supported for CodeGuard products.
Once you click on “Upgrade”, it will open a new configuration screen where you can select the new plan
to upgrade the current order to.
After selecting the product and completing the checkout process, and once the upgrade invoice has
been paid, the Upgrade Order request will be fulfilled with CodeGuard and the product will be updated
in WHMCS.
41
CodeGuard Management Actions on Client Side
Our module allows for customers to take control and manage their orders with just a few clicks. Your
client can perform all the necessary actions such as Edit User, Add Additional User, Delete Additional
User, Access the CodeGuard Dashboard, and Cancel the subscription. Depending upon the status of
the order some features might not be available, more details on that below.
42
• Edit User
This action is used to update an existing CodeGuard user’s details. Once a user clicks on the “Edit
User” button, a new screen will open where a user can update their Name and Email Address.
Once all the required details have been entered, the user must click on “Click to Continue”
button to successfully submit user details.
43
• Access CodeGuard Dashboard
Click on the “Access CodeGuard Dashboard” button, it will generate a Single Sign-On link for this
CodeGuard license and redirect you to the CodeGuard dashboard. Here you can take action on
adding FTP, adding a website or Database etc.
• Cancel Order
The cancellation flow of the CodeGuard product is the same as other products.
• Suspend
With a successful response, clicking the “Suspend” button, will disable a CodeGuard license and
all user account access. After suspension, all backups will be disabled.
44
• Unsuspend
With a successful response, clicking the “Unsuspend” button, will re-enable a suspended
CodeGuard license and allow user account access. All backups will be re-enabled.
• Terminate
With a successful response, clicking the “Terminate” button, will delete existing CodeGuard
license and all associated Website and Database records.
Enter Name, IP Address, Maximum No. of Accounts, Type: CPanel, Username, Password etc. and click on
Save.
45
46
After that, click on“Create New Group” and enter the Name, Add the Server and click on “Save Changes.”
If you have configured the server correctly and cPanel Hosting Accounts linked with the WHMCS client
account, then you will see the “AutoInstall” option on the certificate generation page of your client’s side.
Note: - AutoInstall option is only available for WHM/cPanel servers, and automates the processes of
CSR generation, verification when possible, and installation of the certificate. Existing CSR option can
be used for all other cases and requires manual generation of CSR and installation of the certificate.
47
Once you click on the “AutoInstall” option, the tab will be open upon which some of the information
being requested by the vendor will be pre-filled based upon the credentials the client has on their
profile within WHMCS. If their pre-filled details are incorrect, the client can proceed to change them
to whatever they wish.
During the generation process, the client will be asked to select the domain which will be populate
their based on the hosting profile, input CSR details (company, division, city etc.), input both their
technical and administration information, Alternative Names, Signature Algorithm, Organization
Information for OV & EV certificate etc.
Once all the required details have been provided by the client and the client clicks on “Click to
Continue”, it will automatically: Generate the CSR; Validate the domain; Download the certificate and
Install the certificate on the domain. In addition, our module will provide a confirmation page
informing the client that the certificate has been generated successfully.
• On Client Area
Certificate-related details will be displayed in the client area. Information like Order Status, Store
Order ID, Vendor Order ID, Vendor Status, Token, Admin Details, Technical Details, Authentication
Statuses etc. will be visible for review.
48
49
• On Admin Area
Like above, certificate information such as Order Status, Store Order ID, Vendor Order ID, Vendor
Status, Token, Admin Details, Technical Details, Authentication Statuses etc. will be displayed on
the backend of WHMCS to assist your support staff.
50
• Change Approval Method
The “Change Approval Method” button will allow your client to switch the Authentication
Method as well as change the verification email if the certificate is in the “Pending” or “Re-issue
Pending” status. Our module will present all the Certificate Authority (CA) pre-approved email
aliases as default, with an additional option labeled “Retrieve Domain WHOIS Email”, if the user
selects that option then it will attempt to pull whois emails for the domain and present the
options retrieved from vendor.
• Download Certificate
Once the certificate status is “Active”, the client will be capable of downloading the certificate
in a “.zip” format anytime at the bottom of the order details page. The “.zip” file will contain
both the certificate and the intermediate certificates need to establish trust across browsers.
51
Your Certificate Private Key is stored upon your cPanel Server and, when clicked, will be retrieved
by from the cPanel Server.
• Install Certificate
Note: - This option will display only If you have configured the server correctly, cPanel Hosting
Accounts linked with the WHMCS client account and the order proceed using the Auto Generate
option.
Once the certificate status is “Active”, the Install Certificate option will be displayed there. If the
client wishes to install/reinstall the certificate, then he/she can do it with this option. Once the
client clicks on the button the certificate will be downloaded and installed on the server.
• Certificate Re-issue
In the event of server corruption, lost private keys or wanting to add additional subject alterative
names on the certificate, the customer can re-issue their certificate. By re-issuing the certificate,
the customer is given the opportunity to submit a new Certificate Signing Request (CSR) and/or
change or add subject alternative names etc. on the certificate.
52
• Certificate Re-issue using AutoSSL
Note: - This option will display only if you have configured the server correctly. cPanel Hosting
Accounts linked with the WHMCS client account and the order proceed using the Auto Generate
option.
Once the certificate status is “Active”, the client will be able to reissue the certificate using
AutoSSL. This option will automate the processes of CSR generation, verification when possible,
and installation of the certificate.
53
• Certificate Cancellation
Depending upon if you’ve enabled the setting “Show Refund button on client area?” within the
“Module Settings” page, there will be a “Cancel Certificate” button that will allow the client to
cancel the certificate. Once the certificate is ordered by your client, they will have up to thirty
(30) days to cancel as per our refund policy.
54
Cancellation Steps:
• When client clicks on the “Cancel Certificate” button on client Area page, a confirmation
dialog box will open.
• When client clicks Ok button on the Dialog Box, he/she will be redirected to the
cancellation request page.
• The client is prompted to provide a cancellation reason and provided 2 choices for the
cancellation - either Immediate (on next cron run) or at the End of the Current Billing
Cycle.
• If the client chooses the option of “End of Billing Period,” then our module will update the
billing cycle to “One Time” of that service to prevent the Auto Renewal on due date.
• Any unpaid invoices for the product will be cancelled (if enabled)
• A notification email is sent to administrators and you will be able to review the reason
provided in Clients > Cancellation Requests.
Manual Cancellation
If the Cancellation Request setting is not enabled, then at this point you must navigate to the
cancellation requests page, click through to the service page and click the Terminate module
command button to remove the account from the server. The cancellation request is then
moved from the Open Requests page to Completed Requests.
Automated Cancellation
If the Cancellation Request setting is enabled, the cancellation request will be called into action
when the daily automation cron runs on the appropriate day. For example, if the Immediate
option was selected, it will be terminated on the next cron run. If End of Billing Period was
selected, it will be terminated when the cron runs on the service's Next Due Date.
55
Auto Renewal
To assist in the simplicity of our plugin, we’ve developed a fully automatic renewal system. As long as the
“Payment Type” was set to “Recurring” during setup (if you’ve imported there’s no need to worry),
renewal invoices will be created for the certificate. To prevent any issues with site downtime, the module
will carry out the renewal process thirty (15) days prior to expiration. Below is a simple breakdown of how
the renewal process will be carried out.
• When run, if our <cron> detects any certificates expiring within the next thirty (15) days, WHMCS
will create a renewal invoice.
• Once the renewal invoice gets paid, our module will automatically create an incomplete order for
the same product previously purchased.
• As soon as the incomplete order is placed, the module will check for the previously submitted
details from your WHMCS database.
o If the required details are found, the module will automatically apply the details and
generate the order for the client.
o If any required details are missing, the module will dispatch an email to the client
containing the link to begin certificate generation within WHMCS.
Product Synchronization
As part of our ongoing commitment to automation, we’ve developed a feature for synchronizing all our
products. Due to changes both in the industry as well as with vendors, there could be times where new
products get added, products get discontinued, or configurable options of the product are amended
(SANs, Server Licenses, Validity Periods etc.). With that in mind, you’re now capable of synchronizing the
products you’ve imported so there’s never an error with a discontinued certificate or the configurable
options of a product.
In order to set up Product Synchronization, you’ll want to make sure you’ve set up the “Synchronization
Cron” to run daily and selected the way of processing synchronized products on the “Module Settings”
page of WHMCS. Depending upon your selection, everything can sync automatically for you or allow you
to manually process everything.
• Synchronization Cron
This cron job will check if there’s any differences between your imported WHMCS security
products and with The SSL Store’s currently offered API products. Upon running, it will populate
data into the “Sync Products” page table for you to keep track of and record. If there’s any issues
it will check against the “Synchronization Setting” and depending upon the setting, proceed to
carry of the selection of the administrator.
To configure the “Sync Settings” for the module, you’ll want to proceed to the “Module
Settings” page under Addons >> TheSSLStore Module Admin >> Module Settings. On this page
is where you can make your selection for how you’d like the module to carry out the
synchronization.
56
After making your selection of how you’d like the module to carry out the synchronization, you
can click the “Save” button to store this information for the cron job.
1. Sync Manually
If there's any product(s) that need to have their "Configurable Options" updated, be added
or removed, WHMCS will send an email to the WHMCS Admin on how to process.
4. Sync All
If there are any products that are missing, needing alterations, or are discontinued, the
system will automatically process them to correct any issues and will be emailed to the
WHMCS Admin.
57
For the synchronization, it will also require that you set up product import settings.
3. Default Currency
To import the new product, the default currency is required under which the new product
price will be setup.
Note: The data presented in the table will only populate upon a successful run of the
“Synchronization Cron.”
58
Activity Log Reporting
We’ve developed a feature for Module Activity Log Reporting. Each and every activity of the module will
be logged into the database with the request and response. From the WHMCS admin area, Admin can
download the log file of module activity. Also, admin can directly send an email to TheSSLStore Support
team with the attachment of the Activity Log file. If for any reason, the email functionality does not work,
Admin may send an email to “support@thesslstore.com” with the activity log file.
To do this, click on the option titled “Activity Logs Reporting” on the left-hand sidebar.
• Select the date for which you want to send or download the activity log report
• Provide some information in the comments area, it will help the support guy to understand your
concern quickly
• Click on “SEND EMAIL” button, will send an email to TheSSLStore Support team with the
attachment of the Activity Log file. (email copy will be sent to the WHMCS admin)
• You can download the activity log file with the help of “DOWNLOAD FILE” button
59
Reports
We now have a reporting option for the Admin to access. We have also provided the option to export
the report to CSV file.
This module currently provides following reports.
60
• Renewal Report
This report provides a list of certificates which will expire in the near future or have already expired
based on selected number of days like “30 Days”, ”60 Days”, “90 Days” or “Expired”.
61
• Profit & Loss Report
This report provides information related to total gross profit and total number of SSL certificate
issued with in selected date range.
62
Symantec Replacement Orders List
We now have available an option of Symantec Replacement Orders List on Admin side. Here, Admin can
check the Symantec Replacement Order list if there are any order associated to their account. We have
also given an option to export the report to CSV file. We also have an alert message in certificate details
page on client side for the orders that are part of the Symantec Order Replacement list.
63
Purchase Additional SANS for Multi-Domain SSL certificate
With the release of version 3.8, end-users can now purchase additional SANs on an active multi-domain
order. In order to complete this process, the end-user would need to click the “Purchase Additional
SANs” button that is displayed in the order detail page in the client area in the “Total SANS” portion.
One clicked; the end-user will be brought to a confirmation page asking the end-user how many
additional SANs they would like to purchase. On submission, an invoice will be generated for the pricing
set upon product setup and will require payment prior to modifying the SAN count on the order.
After completion of payment, the end-user will be able to “Reissue” the certificate and see the newly
purchased fields available for input.
What’s New
• In version 4.7
✓ [Feature] A new option for “Disable Expiration Check” has been added to plugin settings area that will
disable the order renewal date check. When enabled, the order can be renewed at any time without
error or blocking from the plugin.
Please note that any roll-over days or days remaining on the old certificate may be forfeit if it is outside of
the vendor allowed 30-day early renewal period.
✓ [Improvement] We have removed any due date adjustments from the plugin code, so the due date will
match the WHMCS issued due date (matching the order exp), unless otherwise designated in the plugin
settings area set by the reseller.
64
✓ [Improvement] We have added a “retire” function to bring our plugin more in-line with WHMCS
standard product flows and to prevent database discrepancies for older orders using legacy products.
✓ [Improvement] The “Symantec replacement list” has been removed since it is no longer relevant.
✓ [Improvement] Minor UI improvements for wildcard DCV options and SiteLock products.
✓ [Resolved] Changes to resolve duplicate invoicing experienced by some users.
✓ [Resolved] Fixed an issue when trying to bulk update product pricing using plugin tool was returning an
error.
✓ [Resolved] Fixed issue where updating the DCV method after submission on Flex products was not
syncing or submitting properly.
✓ [Resolved] Fixed issues with AutoInstall flow in WHMCS because its function was not consistent.
• In version 4.6
✓ [Feature] Added Code Signing Product's Industry changes.
✓ [Resolved] Issue of Getting error after Invoice paid.
✓ [Resolved] Renewal orders not syncing with old orders.
✓ [Resolved] Minor Bug fixes.
• In version 4.5
✓ [Feature] Added ability to add product as Add-Ons.
✓ [Resolved] Issue of Getting error after Invoice paid.
✓ [Resolved] Cannot redeclare class domain.
✓ [Resolved] Reissue count issue.
✓ [Resolved] Minor Bug fixes.
• In version 4.4.3
✓ [Resolved] Minor Bug fixes.
• In version 4.4.2
✓ [Resolved] Issue of Getting error after Invoice paid.
✓ [Resolved] Minor Bug fixes.
• In version 4.4.1
✓ [Improvement] Improved Plugin compatibility with WHMCS v8.6.
✓ [Improvement] Added support of PHP v8.1.
✓ [Resolved] SiteLock Monitor product, set to annual instead of monthly subscription.
✓ [Resolved] Reissue reminder email not sent issue has been solved.
✓ [Resolved] A bug because of some data conflict, which causes issue in cron run.
✓ [Resolved] Minor Bug fixes.
• In version 4.4
✓ [Feature] Added SiteLock product compatibility.
65
✓ [Improvement] Improved Plugin compatibility with WHMCS v8.5.1.
✓ [Improvement] Improved CodeGuard product compatibility to WHMCS.
✓ [Resolved] A bug because of Order Expiry date misconfigured with Next Due date and
NextInvoice date, which causes issue of Duplicate Invoice generation for same service.
✓ [Resolved] A bug because of some data conflict with email parameters of Autoinstall on
SSLRenewal process, which causes issue in cron run.
Multilingual Support
Multilingual support is fully integrated with WHMCS. When you change the default language of your
WHMCS, it will also change language for fields used in the module. Please note that you will need to create
a custom %yourlanguage%.php file in “lang” directory at modules/servers/thesslstorefullv2/lang” and
“modules/addons/thesslstorefullv2_admin/lang” for some fields that are not translated automatically. You
may use the default english.php as a translation template.
Bug Reports
This is an updated version of the plugin, so for any comments/suggestions/feedback, please send an email
to support@theSSLstore.com. We look forward to growing with you and your company and having a very
successful partnership.
66