Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎About Unban Center For WHMCS)
Line 1: Line 1:
−
<meta name="keywords" content="unban center for whmcs, unban center configuration, whmcs unban center management, whmcs unban center installation, whmcs unban center common problems, about whmcs unban center, whmcs unban center documentation, whmcs unban center faq, whmcs unban center help, whmcs unban center guide, whmcs unban center wiki, whmcs unban center tutorial, whmcs unban center tips, whmcs unban center wiki"></meta>
+
<meta name="keywords" content="zendesk extended for magento 2, zendesk magento 2, magento zendesk, zendesk extended configuration, magento zendesk extended management, magento zendesk extended installation, magento zendesk extended common problems, about magento zendesk extended, magento zendesk extended documentation, magento zendesk extended faq, magento zendesk extended help, magento zendesk extended guide, magento zendesk extended wiki, magento zendesk extended tutorial, magento zendesk extended tips, magento zendesk extended wiki, magento extension"></meta>
−
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Unban Center For WHMCS Module."></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Zendesk Extended For Magento Extension."></meta>
−
=About [http://www.modulesgarden.com/products/whmcs/unban_center/features Unban Center For WHMCS]=
+
 
 +
=About [http://www.modulesgarden.com/products/magento/zendesk-extended-m2 Zendesk Extended For Magento 2]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Unban Center For WHMCS''' allows your clients to easily unban IP addresses in submodules such as cPanel, DirectAdmin, InterWorx and Plesk directly from your WHMCS client area.<br/>Additionally, the module lets you create your own submodules in order to integrate them with other systems and control panels.
+
|style="padding: 10px 0px 5px 0px;"|'''Zendesk Extended For Magento 2''' enables the remote use of Zendesk tools upon the integration built between Magento and Zendesk.<br />
 +
With this extension, all operations on Zendesk tickets or even the creation of Zendesk accounts can be performed within your eCommerce platform.<br />
 +
Your clients, at the same time, will be free to handle each submitted ticket straight in the Magento customer panel.
 
|}
 
|}
−
<!-- fixed -->
+
<!-- comments are awesome, aren't they? -->
−
*'''Client Area Features:'''
+
*'''Customer Panel Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Automatically Detect And Unban IP Address From:
+
|style="padding: 10px 0px 0px 30px;"|✔ Open New Ticket
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Control Panel
+
|style="padding: 0px 0px 0px 30px;"|✔ Add Several Attachments To Each Ticket Message
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Control Panel Hosted On Client's VPS
+
|style="padding: 0px 0px 0px 30px;"|✔ Add Reply To Tickets
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Check If IP Address Is Banned
+
|style="padding: 0px 0px 0px 30px;"|✔ View Tickets
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Show Reason Of Ban
+
|style="padding: 0px 0px 10px 30px;"|✔ View Tickets Statistics
 
|}
 
|}
 +
*'''Admin Panel Features:'''
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ View Time Until Next Available Unban Action
+
|style="padding: 10px 0px 0px 30px;"|✔ View Full Tickets List
 
|}
 
|}
−
*'''Admin Area Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Configure Per Product:
+
|style="padding: 0px 0px 0px 30px;"|✔ Open Ticket Directly From Extension
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Enable/Disable Unban Ability
+
|style="padding: 0px 0px 0px 30px;"|✔ Manage Tickets - Reply, Add Notes, Modify Settings, View Logs
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Configure Unban Behavior
+
|style="padding: 0px 0px 0px 30px;"|✔ Delete Single Or Multiple Tickets
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Black List Of IP Addresses - Protected From Unban Action
+
|style="padding: 0px 0px 0px 30px;"|✔ Display All Selected Customer Tickets On Their Page
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Unban Delay - Protection From Abuse
+
|style="padding: 0px 0px 0px 30px;"|✔ Create Zendesk End-User Accounts For Your Clients Automatically
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Define If Customer Can Unban Other IP Address Than Their Current One
+
|style="padding: 0px 0px 0px 30px;"|✔ View Full Users List
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Set Up Default Settings
+
|style="padding: 0px 0px 0px 30px;"|✔ Add New Admin User Account
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Products Using Product Group Settings - Control Panel
+
|style="padding: 0px 0px 0px 30px;"|✔ Use Default Or Custom Admin Account
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Products Using Default Settings - VPS / Dedicated Server
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Custom Signature For Each Admin
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Unban Single Client From Chosen Product
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Possibility To Add Attachments To Tickets
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Unban Multiple Clients From Chosen Control Panel
+
|style="padding: 0px 0px 0px 30px;"|✔ Export Tickets Overview - CSV And XML
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Check If Client IP Address Is Banned
+
|style="padding: 0px 0px 10px 30px;"|✔ Define Cache Lifetime - With Ability To Disable Cache
 
|}
 
|}
 +
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ View And Clear Logs
+
|style="padding: 10px 0px 0px 30px;"|✔ Supports Multiple Attachments In Single Ticket Message
 
|}
 
|}
−
*'''Supported Modules:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ cPanel & [http://www.modulesgarden.com/products/whmcs/cpanel_extended/features cPanel Extended For WHMCS] - CSF and cPHulk
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports Ticket Tags
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Plesk & [http://www.modulesgarden.com/products/whmcs/plesk_extended/features Plesk Extended For WHMCS] - Fail2Ban
+
|style="padding: 0px 0px 0px 30px;"|✔ Connection Test And Admin Validation
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ DirectAdmin & [http://www.modulesgarden.com/products/whmcs/directadmin_extended/features DirectAdmin Extended For WHMCS] - CSF
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ InterWorx & [http://www.modulesgarden.com/products/whmcs/interworx_extended/features InterWorx Extended For WHMCS] - Native Firewall
+
−
|}
+
−
*'''General Info:'''
+
−
{|
+
−
|style="padding: 10px 0px 0px 30px;"|✔ Supports IPv4 and IPv6
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Intuitive Creation Of Additional Submodules
+
 
|}
 
|}
 
{|
 
{|
Line 89: Line 79:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.4 Up To PHP 7
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports Magento 2.1 And Later
 
|}
 
|}
  
 
=Installation=
 
=Installation=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''This tutorial will show you how to successfully install and configure Unban Center For WHMCS.''' <br />
+
|style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install Zendesk Extended For Magento 2.''' <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. <br />
 
|}
 
|}
 +
==Installation==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''1. Log in to your client area and download the module.'''
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download Zendesk Extended For Magento 2.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 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 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.<br/>It does not apply to open source versions.<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the extension into the main Magento directory.<br />
−
'' '''Note''': You can check current PHP version in your WHMCS. To do so proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+
Extracted files in your Magento directory should look like this:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_2_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|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 />
+
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Zendesk Extended For Magento 2 for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
−
The content of PHP version files should look like this.  
+
File is located in '' '/app/code/Modulesgarden/Zendesk/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:gfhfguj.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Unban Center For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
−
File is located in '' 'modules/addons/unbanCenter/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
Enter your license key between quotation marks as presented on the following screen. You can find your license key at your client area'' → 'My Products' ''.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_3.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ZEM2_4.png]]
−
|}
+
−
{|
+
−
|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 />
+
−
Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area → '' 'My Products'. ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_4.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
+
−
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Unban Center' '' and press '' 'Activate' '' button.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_5.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
+
−
To do so, click on '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes'. ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_6.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''8. Go to '' 'Addons' '' → '' 'Unban Center' '' → '' 'Integration Code' '' tab and follow the instructions of integration to allow access from the client area.'''<br />
+
−
The integration codes differ depending on the WHMCS version and template you are using.<br/>
+
−
Once you perform the integration properly, the status of the integration will change to  '''Done.'''<br/>
+
−
<br/>
+
−
If you run Unban Center on '''WHMCS V5.x''' then you will have to copy and paste the below code:
+
 
|}
 
|}
 +
 +
==Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_7.png]]
+
|style="padding: 10px 0px 15px 15px;"|'''5. Now, log in to Magento and go to '' 'Store' '' → '' 'Configuration' ''.'''<br />
 +
Afterwards, press '' 'Zendesk Extended' '' under '' 'ModulesGarden' '' section.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If you run Unban Center on the latest '''WHMCS V6.x.x''' then you will have to firstly decide which template you use:<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_5.png]]
−
*Integration code for WHMCS V6.x.x, template '''''SIX'''''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_7_1.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''6. In '' 'General' '' section fill in '' 'Subdomain' '', '' 'Username' '' and '' 'Token' '' fields with your connection details. Next, press '' 'Save Config' ''.'''<br />
 +
''Note: '' 'Subdomain' '' is a subdomain used by your Zendesk server.''<br />
 +
''For example, as shown on the following screen, a full URL to Zendesk server is '' '<nowiki>https://mgsupport.zendesk.com</nowiki>' ''.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|
+
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_6.png]]
−
*Integration code for WHMCS V6.x.x, template '''''FIVE'''''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_7_2.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''7. You can also check whether the connection details provided by you are correct, press '' 'Check Connection' '' after saving configuration to do so.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''9. You have just successfully installed Unban Center For WHMCS!'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_7.png]]
−
You can access your module at '' 'Addons' '' → '' 'Unban Center'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_8.png]]
+
|style="padding: 0px 0px 30px 15px;"|'''8. You have just successfully installed Zendesk Extended For Magento 2!'''
 
|}
 
|}
  
 
=Configuration and Management=
 
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Unban Center For WHMCS allows you to provide your clients with an ability to easily unban desired IP addresses from external server.'''<br />
+
|style="padding: 10px 0px 30px 15px;"|'''Zendesk Extended For Magento 2 will help you gain profits from the usage of Zendesk support platform in your own Magento system.'''
−
Additionally, you are able to protect specific IP addresses from the unban action.
+
 
|}
 
|}
−
==Unban Types==
+
==Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Our module has been designed in a way that you may now manage banned IP addresses on several different panels of particular type.<br/>
+
|style="padding: 10px 0px 30px 15px;"|Let's start by showing you other configuration possibilities of our extension.
−
These are:
+
−
*'''cPanel''' - unban on '''CSF, cPHulk''' ''(Blacklist Management and History Reports)'' or '''both''' at once
+
−
*'''DirectAdmin''' - unban on '''CSF'''
+
−
*'''InterWorx''' - unban on '''native firewall'''
+
−
*'''Plesk''' - unban on '''Fail2Ban'''<br/>
+
−
It is also possible to unban only the current IP address. You simply need to select such option ''(i.e. Allow the user to unban a current IP address only)'' <br/>while setting the configuration or create a list of IP addresses that, no matter what type you have chosen, will not be unbanned ''(Black List of IP Addresses).''
+
 
|}
 
|}
 +
===General===
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|Now read the below sections to learn about advanced configuration of banned IPs management in both control panels and VPS/dedicated servers.
+
|style="padding: 10px 0px 15px 15px;"|
 +
In the '' 'General' '' section you can set up access details to your Zendesk server.<br />
 +
It was explained in the installation section of this documentation.<br />
 +
''Please note that you have to save this configuration before you start configuring next sections!''
 
|}
 
|}
  
−
==Control Panels==
+
===Customer Frontend===
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|At the '' 'Control Panels' '' tab you can easily enable and configure unban action for all or for chosen servers only.
+
|style="padding: 10px 0px 20px 15px;"|'' 'Customer Frontend' '' lets you enable/disable attachments to the tickets, as well as define the default sort order of tickets in the customer panel.
 
|}
 
|}
−
===Configuration of Single Product===
+
===Cache===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Let's show you how to enable unban functionality for cPanel Extended product.<br />
+
|style="padding: 10px 0px 20px 15px;"|'' 'Lifetime' '' variable in the '' 'Cache' '' section allows you to define how often changes should be synchronized with Zendesk server.<br />
−
Start with marking '' 'Enabled' '' checkbox and then define time intervals to declare how often your client will be able to perform unban action on a specific product.<br />
+
Any changes made in your Magento result in clearing cache and performing a new synchronization.
−
Afterwards, press '' 'Advanced Settings'.''
+
 
|}
 
|}
 +
===Department===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_11.png]]
+
|style="padding: 10px 0px 15px 15px;"|'' 'Department' '' - choose a default group (agents) in Zendesk that tickets will be passed to.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Next, select desired value from '' 'Unban Type', '' remember that in case of cPanel you may choose between:
+
|style="padding: 0px 0px 30px 25px;"|[[File:ZEM2_8.png]]
−
*Unban on CSF
+
−
*Unban on cPHulk ''(Blacklist Management and History Reports)''
+
−
*Unban on both of the above<br/>
+
−
Enter IP addresses that will be unable to be unbanned into '' 'Black List of IP Addresses' '' textbox if there are such.<br />
+
−
Additionally, you can permit your clients to unban any IP address through unmarking checkbox as shown on the following screen.<br />
+
−
Confirm those settings through pressing '' 'Save Changes' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_12.png]]
+
|style="padding: 10px 0px 15px 15px;"|Finally, click the '' 'Save Config' '' button for the second time for the changes to take effect.
 
|}
 
|}
−
===Configuration of Multiple Products===
+
 
 +
==Settings - Zendesk Account Per Admin==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|You can configure multiple products from one product group at once.<br />
+
|style="padding: 10px 0px 15px 15px;"|Our extension allows your staff to use multiple accounts on a Zendesk server.<br />
−
All product groups containing at least one supported module will be displayed in our module → '' 'Control Panels' '' tab.<br />
+
To set up an account for currently logged in admin, proceed to '' 'Zendesk' '' → '' 'Settings' ''.<br />
−
Press '' 'Advanced Settings' '' next to the desired product group to proceed.
+
Now, select '' 'No' '' from '' 'Use Global Settings' '', otherwise your admin will be using a default account on a Zendesk server.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_12.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|On the following screen you can see unban functionality settings for a product group.<br />
+
|style="padding: 0px 0px 15px 15px;"|New fields shows up, fill them in with access details to your Zendesk user admin account.<br />
−
As you may have noticed there are two tabs, '' 'cPanel' '' and '' 'cPanel Extended For WHMCS'. ''<br />
+
Additionally, using '' 'Signatures' '' text area you can define a signature added to your replies.<br />
−
It means that products in a selected product group are using both cPanel and cPanel Extended For WHMCS modules.<br />
+
Confirm through pressing '' 'Save Settings' ''.
−
This way you can set up unban functionality for cPanel and cPanel Extended products separately.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ZEM2_13.png]]
 
|}
 
|}
 +
 +
==Users==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Product group settings apply only to disabled products or products marked as '' 'Uses Group Settings'. ''<br />
+
|style="padding: 10px 0px 15px 15px;"|'' 'Users' '' page allows you to view the list of users, which contains both admins and end users.<br />
−
Therefore, unban feature settings of product group will not be applied to modified product even if it belongs to that group.<br />
+
As you can see on the following screen, you can find information about each of your users and even search specific ones using filters.<br />
−
Products for which group settings are applied to are marked with '' 'Uses Group Settings' '' as shown on the following screen.
+
Additionally, you can edit and remove each account using buttons at the '' 'Action' '' column.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_2_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_14.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You can force group settings for all products in that group through using '' 'Set For All' '' button.<br />
+
|style="padding: 0px 0px 15px 15px;"|You can easily proceed to the tickets of a specific user.<br />
−
''Note: '' 'Set For All' '' will force group settings only for enabled products.''<br />
+
Simply, press the name as shown below.
−
''In order to apply group settings to all products, disable group, enable it and press '' 'Set For All'. '' ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_12_2_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ZEM2_15.png]]
 
|}
 
|}
−
==VPS/Dedicated Servers==
+
===Add A New User===
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''''VPS/Dedicated Servers''''' tab allows you to set configuration for default submodules and all available products.<br/> Unban IP addresses in several different panels set up on any VPS or dedicated server.
+
|style="padding: 10px 0px 20px 15px;"|In order to add a new user, press '' 'Add User' '' button.
 
|}
 
|}
−
===Default Submodules===
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Our product offers four already configured submodules to perform unban action in. These are:
+
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_16.png]]
−
*cPanel & cPanel Extended for WHMCS ''(unban on CSF, cPHulk or both)''
+
−
*Plesk & Plesk Extened For WHMCS ''(Fail2Ban)''
+
−
*DirectAdmin & DirectAdmin Extended For WHMCS ''(CSF)''
+
−
*InterWorx & InterWorx Extended For WHMCS ''(native firewall)''
+
−
You may also create your own submodules, to learn how to do that, please read carefully this [http://www.docs.modulesgarden.com/Unban_Center_For_WHMCS#Creating_3rd_Party_Submodule section].
+
 
|}
 
|}
−
====Settings====
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Select desired value from '' 'Unban Type' '' and enter IP addresses that will be unable to be unbanned into '' 'Black List of IP Addresses' '' text area.<br />
+
|style="padding: 0px 0px 15px 15px;"|Next, fill in user details and decide what type of account it should be.<br />
−
What is more, you can allow your clients to unban any IP address if you unmark checkbox as shown on the following screen.
+
You can even add tags and notes to the account, press '' 'Save' '' to confirm creation of the account.<br />
 +
''Note: Zendesk end-user account is automatically created for the client who does not have one.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_18.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ZEM2_17.png]]
 
|}
 
|}
  
−
===Available Products===
+
==Tickets==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Check selected product and press '' 'Advanced Settings'. ''
+
|style="padding: 10px 0px 15px 15px;"|Tickets and their details can be viewed at the '' 'Tickets' '' page of our extension.<br />
 +
You can search for a specific ticket using filters.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_18_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ZEM2_18.png]]
 
|}
 
|}
 +
===Ticket Overview===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Enable unban functionality for that product. Now you can either choose to use '' 'Default' '' settings (declared for default submodule)<br/>
+
|style="padding: 10px 0px 20px 15px;"|In order to view a specific ticket, find it on the list of tickets and click on it.
−
or configure new settings for the product separately. Remember to '' 'Save Changes'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_18_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_20.png]]
 
|}
 
|}
−
==Unban Users==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'' 'Unban Users' '' tab allows you to unban your clients IP address from any of the external servers on which they own an account.<br />
+
|style="padding: 0px 0px 15px 15px;"|You will be moved to the ticket page.<br />
−
You can unban IP address assigned to your client accounts as well as custom IP address. Press '' 'Unban' '' as shown on the following screen.<br />
+
As you can see, here you can view a full conversation and add a new reply.<br />
−
''Note: You will be able to unban only from external servers enabled at '' 'Unban Center For WHMCS' '' → '' 'Control Panels' '' and '' 'VPS/Dedicated Servers'. ''
+
Using a sidebar you can easily switch between tabs.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_21.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Data on '' 'VPS host Address', 'Username', 'Password' '' will be filled in automatically. Select '' 'SSL Connection' ''' if you wish.<br/>
+
|style="padding: 0px 0px 20px 15px;"|At '' 'Add Note' '' page you can view previously created notes and add a new one.
−
''Note! These details will appear only in case of VPS products used by the client.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_22.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You may now check the status of the client's IP. Press '' 'Check Client IP Address'. ''
+
|style="padding: 0px 0px 20px 15px;"|To view the other tickets of the client, proceed to '' 'Other Tickets' '' page.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_41.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_23.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Alternatively, fill in IP address to check.
+
|style="padding: 0px 0px 15px 15px;"|You can even change ticket's details at '' 'Options' '' page.<br />
 +
Here you are able to switch ticket's department, subject, priority and status. You can even add a tag to the ticket.<br />
 +
''Note: Zendesk server does not allow to reopen a previously closed tickets, so think twice before closing any.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_42.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_24.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|To unban client's IP, fill in the data just like in case of checking IP status and press '' 'Unban Client IP Address'. ''
+
|style="padding: 0px 0px 20px 15px;"|All replies are logged, to view the full log, move to the '' 'Log' '' tab.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_43.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_25.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You can also type in a given IP and press '' 'Unban' '' then.
+
|style="padding: 0px 0px 20px 15px;"|In order to go back to the list of tickets, press '' 'Back To Tickets' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_12_44.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ZEM2_25_1.png]]
 
|}
 
|}
 +
 +
==Front-End - Client Area==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|To unban multiple accounts at once, select checkbox near accounts to unban and press '' 'Unban Selected' '' as shown on the screen below.
+
|style="padding: 10px 0px 15px 15px;"|Your customers can profit from the integration with Zendesk right away!<br />
 +
Let's log into a client's account and press '' 'My Tickets' '' in order to proceed to the ticket dashboard.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_12_6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_26.png]]
 
|}
 
|}
−
==Client Area==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Please note that client area button '' 'Unban Your IP' '' is visible only if you have properly inserted integration codes, the integration is precisely described in installation section [http://www.docs.modulesgarden.com/Unban_Center_For_WHMCS#Installation point 7.]<br/>
+
|style="padding: 0px 0px 15px 15px;"|As you can see on the following screen, here you can access the list of previously created tickets and ticket's statistics.<br />
−
Let's proceed to the client area → '' 'Services' ''  → '' 'My Services' '' in order to try out unban action.<br />
+
Now, open a new ticket through pressing '' 'Open Ticket' ''.
−
Press '' 'Unban Your IP' '' to proceed to '' 'Unban Center'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_13.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_27.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Now, select product for which you want to perform unban IP address action.
+
|style="padding: 0px 0px 15px 15px;"|Fill in ticket's subject, its message, type of the ticket and its priority.<br />
 +
Optionally, you can add an attachment (if admin allows it). Send the ticket through pressing '' 'Submit' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_14.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_28.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You will see a full product name and its status, underneath you will find IP address to be unbanned and VPS host details (provided you have selected a VPS product).
+
|style="padding: 0px 0px 15px 15px;"|Now, let's take a look at the ticket itself, where some conversation with administration was already made.<br />
 +
''Note: If you attach an image file, pressing on it will result in opening it in a new tab of your browser.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_15.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ZEM2_29.png]]
 
|}
 
|}
 +
 +
=Tips=
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Check if your IP is banned or unban it immediately. Once the action is completed you will be notified about the results.
+
|style="padding: 10px 0px 10px 15px;"|1. Attachments are saved in the '' 'your_magento\pub' '', therefore make sure you set it as writeable.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_15x.png]]
+
|style="padding: 0px 0px 10px 15px;"|2. If you use one Zendesk server with multiple Magento platforms, your clients' tickets will be available throughout all the platforms.
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|In case you have set up a low delay time, you will need to wait for the next unban attempt.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_15_4.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_15_3.png]]
+
−
|}
+
−
==Logs==
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|All unban requests and their results can be found at '' 'Unban Center' '' → '' 'Logs' '' tab.<br />
+
−
You can find here information related to user or admin who requested unban action and its date.<br/>
+
−
Use  '' 'Clear Logs' '' button to delete old and unnecessary log entries.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:UB_16.png]]
+
−
|}
+
−
==Creating 3rd Party Submodule==
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|The main goal of Unban Center For WHMCS is allowing you to quickly and easily create additional submodules.<br />
+
−
All you need is a little knowledge of PHP programming language and documentation of integrated module API.<br />
+
−
Required information regarding the submodule itself is located inside the exemplary submodule.<br />
+
−
It can be found at '' 'your_whmcs/modules/addons/unbanCenter/submodules/'. ''<br />
+
−
Owing to that, you are able to make your offer much more competitive and extend it to other systems, control panels and servers.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:UB_17.png]]
+
−
|}
+
−
{|'
+
−
|style="padding: 0px 0px 30px 15px;"|Start with renaming copy of '' 'sample' '' folder to the name used by 3rd party module. <br />
+
−
Let's say folder with module to integrate with Unban Center For WHMCS, which is located in '' 'your_whmcs/modules/servers/' '' is named '' 'dummyIntegration'. ''<br />
+
−
For that case, your folder at '' 'your_whmcs/modules/addons/unbanCenter/submodules/' '' should be named '' 'dummyIntegration'. ''<br />
+
−
File '' 'sampleUnbanSubmodule' '' located in the previously renamed folder should be renamed to '' 'dummyIntegrationUnbanModule'. ''<br />
+
−
Afterwards, edit file '' 'dummyIntegrationUnbanModule' '' and follow instructions inside.
+
−
|}
+
−
=Tips=
+
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|
+
 
|}
 
|}
  
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|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 0px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 5px 15px;"|2. After update some functionalities are not working properly.<br />
+
|style="padding: 10px 0px 0px 15px;"|'''2. Error '' 'The page you requested was not found, and we have a fine guess why.' '' encountered while choosing '' 'Shipping method' '' condition.'''<br />
−
''Cause:'' Your browser store old JavaScript in its cache.<br />
+
''Reason:'' This is related to Magento bug with missing DHL configuration variables.<br />
−
''Solution:'' Reload full page by using key combination to [http://en.wikipedia.org/wiki/Wikipedia:Bypass_your_cache bypass your cache].
+
''Solution:'' To solve this please go to '' 'System' '' → '' 'Configuration' '' → '' 'Shipping methods' '' → '' 'DHL' '' and save the configuration.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|3. When upgrading your module to the latest version to run on WHMCS V6.x.x, remember to insert appropriate integration code for the template you are using.<br/>
+
|style="padding: 0px 0px 30px 15px;"|3. In case of any problems with the extension, that were not mentioned in this article, proceed to [http://www.docs.modulesgarden.com/General#Common_Problems_With_Magento_Extensions Common Problems With Magento Extensions] article.
−
There is a different code for template ''Five'' and for template ''Six.''
+
 
|}
 
|}

Revision as of 09:02, 26 May 2017

Contents

About Zendesk Extended For Magento 2

Zendesk Extended For Magento 2 enables the remote use of Zendesk tools upon the integration built between Magento and Zendesk.

With this extension, all operations on Zendesk tickets or even the creation of Zendesk accounts can be performed within your eCommerce platform.
Your clients, at the same time, will be free to handle each submitted ticket straight in the Magento customer panel.

  • Customer Panel Features:
✔ Open New Ticket
✔ Add Several Attachments To Each Ticket Message
✔ Add Reply To Tickets
✔ View Tickets
✔ View Tickets Statistics
  • Admin Panel Features:
✔ View Full Tickets List
✔ Open Ticket Directly From Extension
✔ Manage Tickets - Reply, Add Notes, Modify Settings, View Logs
✔ Delete Single Or Multiple Tickets
✔ Display All Selected Customer Tickets On Their Page
✔ Create Zendesk End-User Accounts For Your Clients Automatically
✔ View Full Users List
✔ Add New Admin User Account
✔ Use Default Or Custom Admin Account
✔ Define Custom Signature For Each Admin
✔ Toggle Possibility To Add Attachments To Tickets
✔ Export Tickets Overview - CSV And XML
✔ Define Cache Lifetime - With Ability To Disable Cache
  • General Info:
✔ Supports Multiple Attachments In Single Ticket Message
✔ Supports Ticket Tags
✔ Connection Test And Admin Validation
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7
✔ Supports Magento 2.1 And Later

Installation

This tutorial will show you how to successfully install Zendesk Extended For Magento 2.

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

Installation

1. Log in to your client area and download Zendesk Extended For Magento 2.
ZEM2 1.png
2. Upload and extract the extension into the main Magento directory.

Extracted files in your Magento directory should look like this:

ZEM2 2 1.png
3. When you install Zendesk Extended For Magento 2 for the first time you have to rename 'license_RENAME.php' file.

File is located in '/app/code/Modulesgarden/Zendesk/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

ZEM2 3.png
4. In order to configure your license key, you have to edit a previously renamed 'license.php' file.

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

ZEM2 4.png

Configuration

5. Now, log in to Magento and go to 'Store' → 'Configuration' .

Afterwards, press 'Zendesk Extended' under 'ModulesGarden' section.

ZEM2 5.png
6. In 'General' section fill in 'Subdomain' , 'Username' and 'Token' fields with your connection details. Next, press 'Save Config' .

Note: 'Subdomain' is a subdomain used by your Zendesk server.
For example, as shown on the following screen, a full URL to Zendesk server is 'https://mgsupport.zendesk.com' .

ZEM2 6.png
7. You can also check whether the connection details provided by you are correct, press 'Check Connection' after saving configuration to do so.
ZEM2 7.png
8. You have just successfully installed Zendesk Extended For Magento 2!

Configuration and Management

Zendesk Extended For Magento 2 will help you gain profits from the usage of Zendesk support platform in your own Magento system.

Configuration

Let's start by showing you other configuration possibilities of our extension.

General

In the 'General' section you can set up access details to your Zendesk server.
It was explained in the installation section of this documentation.
Please note that you have to save this configuration before you start configuring next sections!

Customer Frontend

'Customer Frontend' lets you enable/disable attachments to the tickets, as well as define the default sort order of tickets in the customer panel.

Cache

'Lifetime' variable in the 'Cache' section allows you to define how often changes should be synchronized with Zendesk server.

Any changes made in your Magento result in clearing cache and performing a new synchronization.

Department

'Department' - choose a default group (agents) in Zendesk that tickets will be passed to.
ZEM2 8.png
Finally, click the 'Save Config' button for the second time for the changes to take effect.

Settings - Zendesk Account Per Admin

Our extension allows your staff to use multiple accounts on a Zendesk server.

To set up an account for currently logged in admin, proceed to 'Zendesk' → 'Settings' .
Now, select 'No' from 'Use Global Settings' , otherwise your admin will be using a default account on a Zendesk server.

ZEM2 12.png
New fields shows up, fill them in with access details to your Zendesk user admin account.

Additionally, using 'Signatures' text area you can define a signature added to your replies.
Confirm through pressing 'Save Settings' .

ZEM2 13.png

Users

'Users' page allows you to view the list of users, which contains both admins and end users.

As you can see on the following screen, you can find information about each of your users and even search specific ones using filters.
Additionally, you can edit and remove each account using buttons at the 'Action' column.

ZEM2 14.png
You can easily proceed to the tickets of a specific user.

Simply, press the name as shown below.

ZEM2 15.png

Add A New User

In order to add a new user, press 'Add User' button.
ZEM2 16.png
Next, fill in user details and decide what type of account it should be.

You can even add tags and notes to the account, press 'Save' to confirm creation of the account.
Note: Zendesk end-user account is automatically created for the client who does not have one.

ZEM2 17.png

Tickets

Tickets and their details can be viewed at the 'Tickets' page of our extension.

You can search for a specific ticket using filters.

ZEM2 18.png

Ticket Overview

In order to view a specific ticket, find it on the list of tickets and click on it.
ZEM2 20.png
You will be moved to the ticket page.

As you can see, here you can view a full conversation and add a new reply.
Using a sidebar you can easily switch between tabs.

ZEM2 21.png
At 'Add Note' page you can view previously created notes and add a new one.
ZEM2 22.png
To view the other tickets of the client, proceed to 'Other Tickets' page.
ZEM2 23.png
You can even change ticket's details at 'Options' page.

Here you are able to switch ticket's department, subject, priority and status. You can even add a tag to the ticket.
Note: Zendesk server does not allow to reopen a previously closed tickets, so think twice before closing any.

ZEM2 24.png
All replies are logged, to view the full log, move to the 'Log' tab.
ZEM2 25.png
In order to go back to the list of tickets, press 'Back To Tickets' .
ZEM2 25 1.png

Front-End - Client Area

Your customers can profit from the integration with Zendesk right away!

Let's log into a client's account and press 'My Tickets' in order to proceed to the ticket dashboard.

ZEM2 26.png
As you can see on the following screen, here you can access the list of previously created tickets and ticket's statistics.

Now, open a new ticket through pressing 'Open Ticket' .

ZEM2 27.png
Fill in ticket's subject, its message, type of the ticket and its priority.

Optionally, you can add an attachment (if admin allows it). Send the ticket through pressing 'Submit' .

ZEM2 28.png
Now, let's take a look at the ticket itself, where some conversation with administration was already made.

Note: If you attach an image file, pressing on it will result in opening it in a new tab of your browser.

ZEM2 29.png

Tips

1. Attachments are saved in the 'your_magento\pub' , therefore make sure you set it as writeable.
2. If you use one Zendesk server with multiple Magento platforms, your clients' tickets will be available throughout all the platforms.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. Error 'The page you requested was not found, and we have a fine guess why.' encountered while choosing 'Shipping method' condition.

Reason: This is related to Magento bug with missing DHL configuration variables.
Solution: To solve this please go to 'System' → 'Configuration' → 'Shipping methods' → 'DHL' and save the configuration.

3. In case of any problems with the extension, that were not mentioned in this article, proceed to Common Problems With Magento Extensions article.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Hosting_Quota_Notifications_1.X_For_WHMCS&oldid=31021"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community