Personal tools
Namespaces

Variants
Actions

Emoji Picker For WHMCS

From ModulesGarden Wiki
Revision as of 15:21, 9 May 2018 by Joanna (Talk | contribs)

Jump to: navigation, search

Article update is ongoing on this page, watch out for broken links, unclear descriptions and images!
We are sorry for the inconvenience caused.

Contents

About Emoji Picker For WHMCS

Emoji Picker For WHMCS will let you and your clients add emojis to your ticket conversations.

As an administrator you will be empowered to decide which ticket departments shall display emojis and which not.
The module also provides support for emoji domains, allowing to convert 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 departments will support emojis.
    Your clients will be able to use emojis while creating or replying tickets as well as view emojis in email notifications.
    Note that you can also change multiple departments status by using mass actions as well.
  • Emoji In Admin Area - toggle if you want the administrators to also view and use emojis when creating and replying to tickets.
    Otherwise the emojis will be visible only to the clients, and in the admin area they will be visible only in the form of emoji codes.
    Note that your support can still type emoji codes from memory which will continue to be visible as artworks for your clients.
  • Replace Domains With Emoji - toggle if you want have emoji domains support.
    This will allow your clients view already provided domains in Punycode format (for example www.xn--qei8618mfvb.tld) with unicode emoji (for example www.❤🍺😉.tld) in their client area
    Note that this will also convert Punycode to the unicode emoji on the related domains emails as well as on their HTML invoices.
EM 8.png

Logs

In logs you can view for which orders of domains, invoices or email massages the emojis have been successfully applied or if any errors occurred.
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 domains instead in Punycode format.

Support Tickets

Client Area

Once you are in client area, you can open a ticket in one of your departments where you enabled emoji support.
EM 10.png
When you start composing a message you can insert emoji by pressing : (colon).
This will start showing 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 finish 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 send the inserted emoji codes will be replaced to emoji artworks.
EM 13.png
This also includes the tickets notifications emails.
EM 14.png

Admin Area

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

Note that your support can still then type emoji codes from memory which will continue to be visible as artworks but only for the clients.

EM 16.png

Domains

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

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

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

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

Note: The domains are using 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. Note that 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
As well as for HTML invoices.

Note: Currently in the PDF invoices the domains 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 are planing to use emoji domains, it is recommended that the 'Allow IDN Domains' option is enabled in your WHMCS general settings.
3. The replacing domains with emoji feature works only for the client area.
In admin area these domains will still display as 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 broken emoji domain registration system in WHMCS itself.
It is a WHMCS problem 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 the emoji one (e.g. when client use the existing domain for their service or the Punycode is placed manually into domain field by administrator)
3. The current version does not yet replace domain Punycode format in PDF invoices. This feature works so-far only in HTML invoices.
4. On the WHMCS versions prior to 7.5 the emoji domain replacement will not work on the order summary, so it is diplayed in Punycode format.
This is due to lack of needed WHMCS hook.
5. It may happen 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 the message itself is sent to the client correctly.
6. The module is currently not compatible with Multibrand For WHMCS or with Resellers Center For WHMCS functionality. Do not use this modules together.
Navigation
WHMCS Modules
WHMCS Translations
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
FAQ
Community
Emoji Picker For WHMCS