Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
−
<meta name="keywords" content="servertastic ssl for whmcs, servertastic ssl configuration, whmcs servertastic ssl management, whmcs servertastic ssl installation, whmcs servertastic ssl common problems, about whmcs servertasticssl, whmcs servertastic ssl documentation, whmcs servertastic ssl faq, whmcs servertastic ssl help, whmcs servertastic ssl guide, whmcs servertastic ssl wiki, whmcs servertastic ssl tutorial, whmcs servertastic ssl tips, whmcs servertastic ssl wiki"></meta>
+
<meta name="keywords" content="emoji for whmcs, whmcs emoji configuration, whmcs emoji management, whmcs emoji installation, whmcs emoji common problems, about whmcs emoji, whmcs emoji documentation, whmcs emoji faq, whmcs emoji help, whmcs emoji guide, whmcs emoji wiki, whmcs emoji tutorial, whmcs emoji tips, whmcs emoji wiki, emoticons for whmcs, whmcs emoticons configuration, whmcs emoticons management, whmcs emoticons installation, whmcs emoticons common problems, about whmcs emoticons, whmcs emoticons documentation, whmcs emoticons faq, whmcs emoticons help, whmcs emoticons guide, whmcs emoticons wiki, whmcs emoticons tutorial, whmcs emoticons tips, whmcs emoticons wiki"></meta>
−
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Servertastic SSL For WHMCS Module."></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Emoji Picker For WHMCS Module."></meta>
  
−
 
+
=About [https://www.modulesgarden.com/products/whmcs/emoji-picker Emoji Picker For WHMCS]=
−
=About [https://www.modulesgarden.com/products/whmcs/servertastic-ssl Servertastic SSL For WHMCS]=
+
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Servertastic SSL For WHMCS''' will allow you to offer SSL certificates to your clients. They will be able to define and order a certificate directly in the client area.<br />
+
|style="padding: 10px 0px 5px 0px;"|'''Emoji Picker For WHMCS''' will let both your clients and support teams add emojis to ticket conversations.<br />
−
Moreover, the module will give you the access to SSL configuration details as well as enable you to terminate certificates and renew them after their expiration date.
+
You will be empowered to choose support departments that should display emojis and decide whether these symbols shall be visible in the admin area.<br />  
 +
The module also provides support for emoji domains, allowing conversion of your clients' domain names from a Punycode format to emoji artworks.
 
|}
 
|}
−
<!--a comment maybe? -->
+
*'''Client Area Features:'''
−
*'''Admin Area Features:'''
+
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Create Certificate
+
|style="padding: 10px 0px 0px 30px;"|✔ Use Emoji In Tickets By:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Terminate Certificate
+
|style="padding: 0px 0px 0px 45px;"|✔ Typing Emoji Code
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Resend Configuration Email
+
|style="padding: 0px 0px 0px 45px;"|✔ Using Emoji Search Picker
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Renew Certificate
+
|style="padding: 0px 0px 0px 30px;"|✔ Display Emoji In Ticket-Related Email Notifications
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Approver Email
+
|style="padding: 0px 0px 0px 30px;"|✔ Replace Punycode With Emoji Domains On:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View And Edit Order ID
+
|style="padding: 0px 0px 0px 45px;"|✔ Domains List And Domain Details
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Certificate Status
+
|style="padding: 0px 0px 0px 45px;"|✔ Services List And Service Details
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Choose Certificate Type
+
|style="padding: 0px 0px 0px 45px;"|✔ HTML Invoice
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Toggle Synchronization Of Expiration Date
+
|style="padding: 0px 0px 10px 45px;"|✔ Specific Email Notifications
 
|}
 
|}
−
*'''Client Area Features:'''
+
 
 +
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Configure Certificate
+
|style="padding: 10px 0px 0px 30px;"|✔ Toggle Emoji Availability For Each Support Department
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Basic Certificate Details
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Emoji Visibility In Admin Area
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Modify Approver Email
+
|style="padding: 0px 0px 0px 30px;"|✔ Use Emoji In Tickets By:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Download Generated Certificate
+
|style="padding: 0px 0px 0px 45px;"|✔ Typing Emoji Code
 
|}
 
|}
−
*'''Configurable Options:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Additional SAN Domain
+
|style="padding: 0px 0px 0px 45px;"|✔ Using Emoji Search Picker
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Server Count
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Converting Of Punycode To Emoji Domains
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Certificate Validity
+
|style="padding: 0px 0px 10px 30px;"|✔ View And Delete Logs
 
|}
 
|}
 +
 +
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Certificate Type
+
|style="padding: 10px 0px 0px 30px;"|✔ Supports Emoji Artworks Provided By [https://www.emojione.com/ EmojiOne]
 
|}
 
|}
−
*'''cPanel Tokens Integration:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Create Certificate Tokens For [https://www.modulesgarden.com/products/cpanel/servertastic-ssl Servertastic SSL For cPanel] Module
+
|style="padding: 0px 0px 0px 30px;"|✔ Custom Templates Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Choose Certificate Type
+
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define SAN Values
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Server Count
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Management Page Link
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7.2 And Later
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Management Page Link Visibility For Client Area
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Send Generated Token Via Email
+
−
|}
+
−
*'''General Info:'''
+
−
{|
+
−
|style="padding: 10px 0px 0px 30px;"|✔ Renewal Support - Automatically Creates New Certificate For Recurring Products After Expiration Date
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.4 Up To PHP 7
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 And V7
+
 
|}
 
|}
  
 
=Installation and Configuration=
 
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install and configure Servertastic SSL For WHMCS.''' <br />
+
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure Emoji Picker For WHMCS.''' <br />
−
We will guide you step by step through the whole installation and configuration process.
+
We will guide you step by step through the whole installation and configuration process.  
 
|}
 
|}
 
==Installation==
 
==Installation==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download Servertastic SSL For WHMCS.'''
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:EM_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/>
−
Files in your WHMCS directory should look like this.
+
'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:e4rt5e45.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
−
 
−
==Configuration of Product==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''4. In order to create and configure a product, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.'''<br />
−
Click on '' 'Create a New Group' ''.
+
The content of your PHP version files should look like this.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:EM_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''5. Enter product group name and press '' 'Save Changes' ''.'''
+
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Emoji Picker For WHMCS for the first time, you have to rename the '' 'license_RENAME.php' '' file.'''<br />
 +
This file is located in '' 'yourWHMCS/modules/addons/Emoji/license_RENAME.php'.'' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:EM_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. When you have a product group, you can create your product.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit the previously renamed '' 'license.php' file. '' '''<br />
−
To create a product click on '' 'Create a New Product' ''.
+
Enter your license key between the quotation marks as presented on the following screen. You can find your license key in our client area → '' 'My Products'. ''  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_7.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:EM_4.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''7. Afterwards, choose your product group and type from dropdown menus, fill in your product name and press '' 'Continue' ''.'''
+
|style="padding: 0px 0px 15px 15px;"|'''6. Now, set up the  '' 'storage' '' folder as recursively writable.'''<br />
 +
This folder is available at '' 'yourWHMCS/modules/addons/Emoji/' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_8.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:EM_5.png]]
 
|}
 
|}
 +
 +
==Activation==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. Now, go to '' 'Module Settings' '' section, choose '' 'Servertastic SSL' '' from a dropdown menu.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''7. Now, you have to activate the module in your WHMCS system.'''<br />
−
Next, click on '' 'Save Changes' ''.'''
+
Log in to your WHMCS admin area and proceed to '' 'Setup' '' → '' 'Addon Modules'. ''<br />
 +
Afterward, find '' 'Emoji Picker' '' and press the '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:EM_6.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''9. Finish by filling in '' 'API Key' '' and selecting desired certificate type.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. In the next step you need to permit access to this module.'''<br />
−
To obtain 'API Key' log in to your '[http://reseller.servertastic.com Reseller Panel]' and click '' 'View your API Key' '':
+
To do so, click on the '' 'Configure' '' button and tick the checkboxes to assign desired admin roles.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_10_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:EM_7.png]]
 
|}
 
|}
 
{|
 
{|
−
{|
+
|style="padding: 0px 0px 30px 15px;"|'''9. Congratulations, you have just successfully installed Emoji Picker For WHMCS!'''
−
|style="padding: 0px 0px 15px 15px;"|Additionally, mark '' 'Update Next Due Date' '' if you want to renew the certificate after reaching its expiration date (recurring products only).<br />
+
−
Confirm through pressing '' 'Save Changes' ''.<br />
+
−
''Note: You can mark '' 'Test Mode' '' to connect with the test API.''
+
 
|}
 
|}
 +
 +
==Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_10.png]]
+
|style="padding: 10px 0px 30px 15px;"|'''Now you need to configure your newly installed module.'''<br/>
 
|}
 
|}
 +
===Settings===
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|'''Congratulations! Your module is ready for use.'''
+
|style="padding: 10px 0px 15px 15px;"|Proceed to '' 'Addons' → 'Emoji' → 'Settings' '' to configure the following options:
−
|}
+
  
−
=Management=
+
* '''Support Department Settings''' - Choose which of your support departments will display emojis.<br/> Your clients will be able to use emojis while creating or replying in tickets, as well as view emojis in email notifications.<br/>''Note that you can change the status of multiple departments at once by using mass actions.''
−
{|
+
 
−
|style="padding: 10px 0px 30px 15px;"|Servertastic SSL For WHMCS allows you to offer fully configurable Servertastic certificates to your clients.<br />
+
* '''Emoji In Admin Area''' - toggle on if you want the administrators to view and use emojis when creating and replying in tickets.<br/>If disabled, they will be visible in the admin area only in the form of emoji codes.<br/>''Note that your support can still type remembered emoji codes which will continue to be visible as artworks for your clients.
−
Additionally, you have the ability to view certificate details and manage each provisioned certificate.
+
 
 +
* '''Replace Domains With Emoji''' - toggle on if you want to have support for [https://en.wikipedia.org/wiki/Emoji_domain emoji domains].<br/>This will allow your clients to view already provided domains in [https://en.wikipedia.org/wiki/Punycode Punycode] format (''for example www.xn--qei8618mfvb.tld'') with [https://unicode.org/emoji/charts/emoji-list.html unicode emoji] (''for example www.''❤🍺😉''.tld'') in your client area<br/>''Note that this will also convert Punycode to the unicode emoji in the domain-related emails as well as on the HTML invoices.''
 
|}
 
|}
−
==Admin Area==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In the admin area you can view the details of a product and find SSL configuration status.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:EM_8.png]]
−
Additionally, you can create/terminate product, resend configuration email and even change approver email.
+
 
|}
 
|}
 +
 +
===Logs===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_11.png]]
+
|style="padding: 10px 0px 20px 15px;"|The logs provide data about particular domain orders, invoices or email massages to which emojis have been successfully applied. The section also includes information concerning any existing errors.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|In order to change approver email, fill in a new email and press '' 'Save Changes' '' as shown on the screen below.
+
|style="padding: 0px 0px 30px 25px;"|[[File:EM_9.png]]
 
|}
 
|}
 +
 +
=Management=
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ST_12.png]]
+
|style="padding: 10px 0px 30px 15px;"|'''Once Emoji Picker For WHMCS is installed and configured, you can use emoji in tickets as well as view them in domain names instead of a Punycode format.'''<br/>
 
|}
 
|}
−
 
+
==Support Tickets==
−
==Client Area==
+
===Client Area===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Servertastic SSL For WHMCS allows your customers to order and configure SSL certificates.<br />
+
|style="padding: 10px 0px 20px 15px;"|In the client area, you can use emojis in tickets submitted in any of support departments with enabled emoji support.
−
As you can see on the following screen, it also allows to choose from configurable options during an order.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ST_13.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:EM_10.png]]
 
|}
 
|}
−
===Configuration===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|A new SSL certificate needs to be configured before it can be used.<br />
+
|style="padding: 0px 0px 15px 15px;"|When you compose a message, you can insert emoji by pressing ''':''' (colon).<br/>This will show the list of available emojis. Continue typing the name to search for available emoji.<br/>When ready, click on the chosen emoji to insert it or end its name using ''':''' (colon) again.
−
Press '' 'Configure Now' '' to proceed, you will be forwarded to an external page.<br />
+
−
Proceed with configuration of your SSL certificate there.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_14.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:EM_11.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|In the end of the process, you will receive a configuration email.<br />
+
|style="padding: 0px 0px 20px 15px;"|You can also view, browse and search through all available symbols by clicking on emoji picker.
−
As soon as you receive the email and go to the approval site, your certificate will be generated.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ST_15.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:EM_12.png]]
 
|}
 
|}
−
===Management===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|On the following screen you can see a successfully configured product.<br />
+
|style="padding: 0px 0px 20px 15px;"|When the composed massage is sent, the inserted emoji codes are replaced with emoji artworks.
−
Here you can find provision and expiration dates, and its status.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_16.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:EM_13.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Additionally, you can download the certificate.
+
|style="padding: 0px 0px 20px 15px;"|This also applies to the tickets-related email notifications.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ST_17.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:EM_14.png]]
 
|}
 
|}
  
−
==Configurable Options==
+
===Admin Area===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The module enables you to set up configurable options allowing clients to define the products they order.<br />
+
|style="padding: 10px 0px 15px 15px;"|If you have the '' 'Emoji In Admin Area' '' option enabled in the addon [https://www.docs.modulesgarden.com/Emoji_Picker_For_WHMCS#Settings settings], your support administrators can view and use emojis in their tickets as well. <br/>
−
Below you can find the list of configurable options with descriptions of how they will affect an order: <br />
+
−
'''Certificate Type''' - allows client to choose from types provided in configuration, a chosen type will overwrite configuration in '' 'Module Settings' ''.<br />
+
−
'''Years''' - client can choose the amount of years when certificate is valid. Make sure you will not exceed the maximum number of years for a particular certificate.<br />
+
−
Maximum number of years for a particular certificate type can be found after a brand name followed by '' '| ''' on the '' 'Certificate Type' '' in '' 'Module Settings' '' tab.<br />
+
−
'''Servers Count''' - (required for Thawte and most of VeriSign certificates) if applicable, its range stretches from 1 to 500.<br />
+
−
'''SAN Count''' - (SAN certificates only) client can define the maximum number of domains supported by a certificate.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|1. Let's create configurable options group containing each one of presented configurable options.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:EM_15.png]]
−
Start by proceeding to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Configurable Options' '' and pressing '' 'Create a new Group' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_18.png]]
+
|style="padding: 0px 0px 15px 15px;"|Otherwise, your support administrators will not be able to enter emojis, neither they will see them as artworks in messages.<br/>
 +
'' '''Note''' that your support can still type remembered emoji codes which will continue to be visible as artworks for your clients.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|2. Afterwards, fill out the form with a group name and a description, select products you wish to apply to this group by holding Ctrl and clicking on each of the products.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:EM_16.png]]
−
Afterwards, press '' 'Save Changes' ''.
+
 
|}
 
|}
 +
 +
==Domains==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_19.png]]
+
|style="padding: 10px 0px 15px 15px;"|The module can convert domains in the Punycode format to emoji domains.<br/>This applies to client area domain lists, service lists with domains, their details, as well as HTML invoices and email notifications related to domains.<br/>
 +
 
 +
'' '''Important:''' Read the second point of [https://www.docs.modulesgarden.com/Emoji_Picker_For_WHMCS#Common_Problems common problems] section explaining WHMCS problems with registration of emoji domains.''
 +
<br/><br/>
 +
For example, WHMCS displays a list of emoji domains in their original Punycode format by deafult.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|3. Press '' 'Add New Configurable Options' ''.
+
|style="padding: 0px 0px 20px 25px;"|[[File:EM_17.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_20.png]]
+
|style="padding: 0px 0px 15px 15px;"|When you enable the '' 'Replace Domains With Emoji' '' option in the addon [https://www.docs.modulesgarden.com/Emoji_Picker_For_WHMCS#Settings settings], the Punycode will be replaced in the client area with the emoji format.<br/>
 +
'' '''Note:''' The domains use [https://unicode.org/emoji/charts/full-emoji-list.html unicode emoji], not the graphical artworks as presented in tickets. This means that their appearance may differ depending on the web browser.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|4a. (Years, Servers Count, SAN Count) Now, fill in option name, select '' 'Quantity' '' option type and fill in minimum and maximum allowed quantity.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:EM_18.gif]]
−
Afterwards, set up price per one unit and press '' 'Save Changes' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_21.png]]
+
|style="padding: 0px 0px 15px 15px;"|This will also apply to several email notifications related to the domains. Currently, the supported email templates are:
 +
*Support Ticket Reply
 +
*Support Ticket Opened
 +
*Support Ticket Opened by Admin
 +
*Invoice Created
 +
*Order Confirmation
 +
*Invoice Payment Confirmation
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|4b. (Certificate Type, Years, Servers Count, SAN Count) Fill in option name and select '' 'Dropdown' '' from option type.
+
|style="padding: 0px 0px 20px 25px;"|[[File:EM_19.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_22.png]]
+
|style="padding: 0px 0px 15px 15px;"|The same goes for HTML invoices.<br/>
 +
'' '''Note:''' Currently, the domains on the PDF invoices will still be shown in the Punycode format.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|5. Now, you have to add each option separately.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:EM_20.png]]
−
Do it by filling in its name, setting up its price and pressing '' 'Save Changes' '' for each of the options.<br />
+
−
''Note: As you may notice on the following screen, name is divided by '' 'I' '' sign. ''<br />
+
−
''The first part concerns system name of an option (or value) while the second part is a name under which option will be visible for client.'''
+
 
|}
 
|}
 +
 +
=Tips=
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_23.png]]
+
|style="padding: 10px 0px 10px 15px;"|1. The module supports only '''the WHMCS built-in ticket system'''.<br/>Separate ticketing systems such as [https://www.modulesgarden.com/products/whmcs/zendesk Zendesk], [https://www.modulesgarden.com/products/whmcs/kayako Kayako], [https://www.modulesgarden.com/products/whmcs/freshdesk Freshdesk] etc. are '''not''' supported by this module.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|6. Now, let's order a product using previously created configurable options.<br />
+
|style="padding: 0px 0px 10px 15px;"|2. If you plan to use emoji domains, it is recommended that the  '' '[https://docs.whmcs.com/Domains_Tab#Allow_IDN_Domains Allow IDN Domains]' '' option is enabled in your WHMCS general settings.
−
As you can see, using configurable option allows you to use fewer product while still allowing a full customization of the product.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ST_24.png]]
+
|style="padding: 0px 0px 30px 15px;"|3. The feature of replacing domains with emoji works only for the client area.<br/>In the admin area, these domains will be still displayed using Punycode.
 
|}
 
|}
  
−
=cPanel Tokens Configuration=
+
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|To enable selling of certificates with [https://www.modulesgarden.com/products/cpanel/servertastic-ssl Servertastic SSL For cPanel] module, configure the token generator using the provisioning module for WHMCS. <br/>
+
|style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
−
Your WHMCS will now bill customers for the ordered certificates and generate tokens, which can be then used by customers to add their certificates in cPanel.
+
Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!<br/>
−
<br/><br/>
+
To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<br/>
−
 
+
−
In order to start selling tokens for cPanel certificates you need to add a new product following the steps described in the '' '[https://www.docs.modulesgarden.com/Servertastic_SSL_For_WHMCS#Configuration_of_Product Configuration of Product]' '' section.<br/>
+
−
Select '' 'ServerTasticToken' '' from the module settings, enter your '' 'API Key' '' found in the ''step 9'' and save the settings.<br/>
+
 
|}
 
|}
 +
=Common Problems=
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_25.png]]
+
|style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|After saving the settings in the  ''' '' 'Certificate Type' '' ''' dropdown, available certificates will appear.<br/>
+
|style="padding: 0px 0px 10px 15px;"|2. This module '''does not''' fix the problem of broken emoji domain registration system occurring directly in WHMCS.<br/>It is due to WHMCS solely that the registration attempt of a domain with emoji artworks or with emoji already converted to Punycode is automatically cleared from the '' 'Domain' '' field after placing an order.<br/>Our module only converts the already properly applied Punycode domain into emoji (e.g. when a client uses the existing domain for their service or the Punycode is placed manually into the domain field by the administrator).
−
'' '''Note:''' If you are using a test API key, first make sure that the 'Test Mode' option is enabled.''<br/><br/>
+
−
Then set the remaining options corresponding to the selected certificate:
+
−
*'''SAN Values''' - enter how many domain names can be protected with a single certificate.  
+
−
*'''Server Count''' - enter how many different servers can indicate the domains protected by a given certificate.  
+
−
*'''Management Page Link''' - Specify the address at which the customer will be able to see the generated certificate directly in the '' 'Servertastic' '' panel.
+
−
*'''Show Order Management Page link''' - select whether you want your customers to see a direct link to the certificate in the '' 'Servertastic' '' panel.
+
−
'' '''Note:''' Make sure that SAN and Server vaules are supported by the selected type of certificate. You can find more relevant information on [https://github.com/servertastic/servertastic-api/blob/master/api2.md#further-field-definitions here.]''
+
−
 
+
−
Finally, save the changes and do not forget to generate '' 'Custom Field' and '' 'Email Template' ''.
+
−
 
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_26.png]]
+
|style="padding: 0px 0px 10px 15px;"|3. The 1.0 version does not replace the domain Punycode format on PDF invoices. This feature works only with HTML invoices for the time being.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|After placing an order for a configured product, the customer will have access to the generated '' 'certificate token' '', its '' 'status' '' and a direct link to the order at the '' 'Servertastic' '' panel (if that option has been enabled).
+
|style="padding: 0px 0px 10px 15px;"|4. In the WHMCS versions prior to 7.5, the emoji domain replacement will not work on the order summary, and the domain will still be diplayed in the Punycode format there.<br/> This is caused by lack of a required WHMCS hook.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_27.png]]
+
|style="padding: 0px 0px 10px 15px;"|5. It may turn out that when you preview an email in the WHMCS client's profile in the admin area, the message is suddenly cut off at the point where the emoji domain name should start.<br/>This is a WHMCS bug and despite this inconvenience, the message itself is sent to the client correctly.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|The client should now copy the token and complete the certificate configuration directly in the cPanel. <br/>
+
|style="padding: 0px 0px 30px 15px;"|6. Emoji Picker For WHMCS is currently '''not''' compatible with [https://www.modulesgarden.com/products/whmcs/multibrand Multibrand For WHMCS] or [https://www.modulesgarden.com/products/whmcs/resellers-center Resellers Center For WHMCS] modules. Do not use these products together.
−
These steps are described on the [https://www.docs.modulesgarden.com/Servertastic_SSL_For_cPanel#Request Servertastic SSL For cPanel] wiki.
+
−
|}
+
−
 
+
−
=Tips=
+
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|1. When you press '' 'Renew' '' button in the admin area '' ('Client Profile → Products/Services') '', a new order for selected domain will be created.
+
−
:The admin can place it as '' 'Renewal' '' order type but only 90 days before the expiration date.  
+
−
|}
+
−
 
+
−
=Common Problems=
+
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
+
 
|}
 
|}

Revision as of 14:24, 21 May 2018

Contents

About Emoji Picker For WHMCS

Emoji Picker For WHMCS will let both your clients and support teams add emojis to ticket conversations.

You will be empowered to choose support departments that should display emojis and decide whether these symbols shall be visible in the admin area.
The module also provides support for emoji domains, allowing conversion of your clients' domain names from a Punycode format to emoji artworks.

  • Client Area Features:
✔ Use Emoji In Tickets By:
✔ Typing Emoji Code
✔ Using Emoji Search Picker
✔ Display Emoji In Ticket-Related Email Notifications
✔ Replace Punycode With Emoji Domains On:
✔ Domains List And Domain Details
✔ Services List And Service Details
✔ HTML Invoice
✔ Specific Email Notifications
  • Admin Area Features:
✔ Toggle Emoji Availability For Each Support Department
✔ Define Emoji Visibility In Admin Area
✔ Use Emoji In Tickets By:
✔ Typing Emoji Code
✔ Using Emoji Search Picker
✔ Toggle Converting Of Punycode To Emoji Domains
✔ View And Delete Logs
  • General Info:
✔ Supports Emoji Artworks Provided By EmojiOne
✔ Custom Templates Support
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7.2
✔ Supports WHMCS Template Six
✔ Supports WHMCS V7.2 And Later

Installation and Configuration

This tutorial will show you how to successfully install and configure Emoji Picker For WHMCS.

We will guide you step by step through the whole installation and configuration process.

Installation

1. Log in to our client area and download the module.
EM 1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.
It does not apply to open source versions.

Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.

PHP56 72.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of your PHP version files should look like this.

EM 2.png
4. When you install Emoji Picker For WHMCS for the first time, you have to rename the 'license_RENAME.php' file.

This file is located in 'yourWHMCS/modules/addons/Emoji/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

EM 3.png
5. In order to configure your license key, you have to edit the previously renamed 'license.php' file.

Enter your license key between the quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.

EM 4.png
6. Now, set up the 'storage' folder as recursively writable.

This folder is available at 'yourWHMCS/modules/addons/Emoji/' .

EM 5.png

Activation

7. Now, you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area and proceed to 'Setup' → 'Addon Modules'.
Afterward, find 'Emoji Picker' and press the 'Activate' button.

EM 6.png
8. In the next step you need to permit access to this module.

To do so, click on the 'Configure' button and tick the checkboxes to assign desired admin roles.

EM 7.png
9. Congratulations, you have just successfully installed Emoji Picker For WHMCS!

Configuration

Now you need to configure your newly installed module.

Settings

Proceed to 'Addons' → 'Emoji' → 'Settings' to configure the following options:
  • Support Department Settings - Choose which of your support departments will display emojis.
    Your clients will be able to use emojis while creating or replying in tickets, as well as view emojis in email notifications.
    Note that you can change the status of multiple departments at once by using mass actions.
  • Emoji In Admin Area - toggle on if you want the administrators to view and use emojis when creating and replying in tickets.
    If disabled, they will be visible in the admin area only in the form of emoji codes.
    Note that your support can still type remembered emoji codes which will continue to be visible as artworks for your clients.
  • Replace Domains With Emoji - toggle on if you want to have support for emoji domains.
    This will allow your clients to view already provided domains in Punycode format (for example www.xn--qei8618mfvb.tld) with unicode emoji (for example www.❤🍺😉.tld) in your client area
    Note that this will also convert Punycode to the unicode emoji in the domain-related emails as well as on the HTML invoices.
EM 8.png

Logs

The logs provide data about particular domain orders, invoices or email massages to which emojis have been successfully applied. The section also includes information concerning any existing errors.
EM 9.png

Management

Once Emoji Picker For WHMCS is installed and configured, you can use emoji in tickets as well as view them in domain names instead of a Punycode format.

Support Tickets

Client Area

In the client area, you can use emojis in tickets submitted in any of support departments with enabled emoji support.
EM 10.png
When you compose a message, you can insert emoji by pressing : (colon).
This will show the list of available emojis. Continue typing the name to search for available emoji.
When ready, click on the chosen emoji to insert it or end its name using : (colon) again.
EM 11.png
You can also view, browse and search through all available symbols by clicking on emoji picker.
EM 12.png
When the composed massage is sent, the inserted emoji codes are replaced with emoji artworks.
EM 13.png
This also applies to the tickets-related email notifications.
EM 14.png

Admin Area

If you have the 'Emoji In Admin Area' option enabled in the addon settings, your support administrators can view and use emojis in their tickets as well.
EM 15.png
Otherwise, your support administrators will not be able to enter emojis, neither they will see them as artworks in messages.

Note that your support can still type remembered emoji codes which will continue to be visible as artworks for your clients.

EM 16.png

Domains

The module can convert domains in the Punycode format to emoji domains.
This applies to client area domain lists, service lists with domains, their details, as well as HTML invoices and email notifications related to domains.

Important: Read the second point of common problems section explaining WHMCS problems with registration of emoji domains.

For example, WHMCS displays a list of emoji domains in their original Punycode format by deafult.

EM 17.png
When you enable the 'Replace Domains With Emoji' option in the addon settings, the Punycode will be replaced in the client area with the emoji format.

Note: The domains use unicode emoji, not the graphical artworks as presented in tickets. This means that their appearance may differ depending on the web browser.

EM 18.gif
This will also apply to several email notifications related to the domains. Currently, the supported email templates are:
  • Support Ticket Reply
  • Support Ticket Opened
  • Support Ticket Opened by Admin
  • Invoice Created
  • Order Confirmation
  • Invoice Payment Confirmation
EM 19.png
The same goes for HTML invoices.

Note: Currently, the domains on the PDF invoices will still be shown in the Punycode format.

EM 20.png

Tips

1. The module supports only the WHMCS built-in ticket system.
Separate ticketing systems such as Zendesk, Kayako, Freshdesk etc. are not supported by this module.
2. If you plan to use emoji domains, it is recommended that the 'Allow IDN Domains' option is enabled in your WHMCS general settings.
3. The feature of replacing domains with emoji works only for the client area.
In the admin area, these domains will be still displayed using Punycode.

Update Instructions

Essential guidance through the process of updating the module is offered here.

Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
To take advantage of it, simply use the License Upgrade button located on the product's page and a discounted invoice will be generated automatically.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. This module does not fix the problem of broken emoji domain registration system occurring directly in WHMCS.
It is due to WHMCS solely that the registration attempt of a domain with emoji artworks or with emoji already converted to Punycode is automatically cleared from the 'Domain' field after placing an order.
Our module only converts the already properly applied Punycode domain into emoji (e.g. when a client uses the existing domain for their service or the Punycode is placed manually into the domain field by the administrator).
3. The 1.0 version does not replace the domain Punycode format on PDF invoices. This feature works only with HTML invoices for the time being.
4. In the WHMCS versions prior to 7.5, the emoji domain replacement will not work on the order summary, and the domain will still be diplayed in the Punycode format there.
This is caused by lack of a required WHMCS hook.
5. It may turn out that when you preview an email in the WHMCS client's profile in the admin area, the message is suddenly cut off at the point where the emoji domain name should start.
This is a WHMCS bug and despite this inconvenience, the message itself is sent to the client correctly.
6. Emoji Picker For WHMCS is currently not compatible with Multibrand For WHMCS or Resellers Center For WHMCS modules. Do not use these products together.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Hosting_Quota_Notifications_1.X_For_WHMCS&oldid=38938"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community