User Tools

Site Tools


amp:home

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
amp:home [2018/06/29 14:50]
rsk [Changelog]
amp:home [2020/03/25 12:29] (current)
rsk [Abuse Manager Pro (WHMCS Module)]
Line 1: Line 1:
 ====== Abuse Manager Pro (WHMCS Module) ====== ====== Abuse Manager Pro (WHMCS Module) ======
  
-Abuse Manager Pro (AMP) is a WHMCS addon that helps admins with the daily chores of abuse reports, and followups and turns their lives into a walk in the park!+<color #​ffc90e>​__This article ​is being updated for the latest release v3.x__</​color>​
  
-Although many people use support tickets, ​that method requires a lot of work and many different methods to help streamline ​the process. With AWP, everything is within the module and there is no need to use multiple pages, and applications no more with traditional messy set up.+Abuse Manager Pro (AMP) is a WHMCS addon module ​that helps admins with the daily chores linked ​to abuse reports, and turns their lives into walk in the park!
  
-The system allows you to receive abuse reports from 3rd partieseither by emails (using ​fetching technique by php_imap) or by a public facing report abuse page. As well as that, you can create abuse reports of your own.+Although many people use support ticketsthat method requires ​lot of work and many different strategies to help define an inefficient process for admins - that method ​can never be relied on. With AMP, everything is within the module, and there is no need to use multiple pages, external applications,​ or even other 3rd party solutions.
  
-When an abuse report is submitted by 3rd parties (public facing page or via the email address ​that is to be fetched)it goes into a queue and awaits your moderation and then you can assign it to a customer if you see fit. Queued ​abuse reports ​also try to help you by showing you which customer and service the abuse report could be linked to.+The system allows you to receive ​abuse reports from 3rd parties, either by emails ​(using a fetching technique by PHP_IMAP - great for automatically processing your abuse@domain.com address for example) or by enabling a public facing ​abuse reporting ​page. As well as that, you can create ​abuse reports ​of your own.
  
-Admins can have conversations with clients, and vice versa - all in favor of reaching a solution and ultimately closing/​resolving the abuse report.+When an abuse report is submitted by 3rd parties (public facing page or via the email address that is to be fetched), it goes into a queue and awaits your moderation. This allows you to vet the abuse report, and when you are satisfied, you can assign it to a customer. Queued abuse reports also try to help you by showing you which customer and service the abuse report could be linked to. 
 + 
 +Admins can have conversations with clients, and vice versa - all in favour ​of reaching a solution and ultimately closing/​resolving the abuse report.
  
 Admins have the ability of not suspending the service that relates to the abuse report, or suspend it immediately,​ or suspend it after a certain time limit passes. They also have the option to allow a customer to unsuspend themselves if required. Admins have the ability of not suspending the service that relates to the abuse report, or suspend it immediately,​ or suspend it after a certain time limit passes. They also have the option to allow a customer to unsuspend themselves if required.
  
-To understand the module better, please have a look at the screenshots,​ as well as the different feature sets for admins, ​public ​users, and registered users below.+To understand the module better, please have a look at the screenshots,​ as well as the different feature sets for admins, ​registered ​users, and public guests ​below.
  
 **Proud to say that Ajax is supported, and no template modifications are required at all!** **Proud to say that Ajax is supported, and no template modifications are required at all!**
Line 19: Line 21:
 ---- ----
  
-===== IMPORTANT CHANGE FOR THOSE USING WHMCS VERSIONS 7.5.0+ ===== 
- 
-Some clients where finding issues with the version of WHMCS 7.5.0 (or above) when using our modules. 
- 
-This is due to an issue with the way WHMCS verifies ioncube encoded files. 
- 
-To solve this, if you are using WHMCS 7.5.0 (or above) please update to latest version and then perform the following steps: 
- 
- 
-  * Login to your WHMCS admin area 
-  * Go to the Setup tab 
-  * Click on General Settings 
-  * Go to the "​Other"​ Tab 
-  * Select '​Attempt to load all files' for Encoded File Loading option and save 
- 
-There is nothing to worry about with loading all files, and WHMCS has released this option to tackle to this issue. 
- 
-Please read about it [[https://​docs.whmcs.com/​Version_7.5.1_Release_Notes|here]] for the release notes from WHMCS, and refer to the steps [[https://​docs.whmcs.com/​Other_Tab#​Encoded_File_Loading|here]]. 
- 
----- 
 ===== Screen Shots ===== ===== Screen Shots =====
  
-{{gallery>:​amp?​lightbox&​1600X1200&​nocache }}+{{gallery>:​amp:​screenshots?​lightbox&​1600X1200&​nocache }}
 ===== Admin Features ===== ===== Admin Features =====
   * Abuse Dashboard that shows you quick statistics and important information   * Abuse Dashboard that shows you quick statistics and important information
Line 48: Line 30:
   * Quick links to client'​s details and service from within reports and from open, closed, and queued report pages   * Quick links to client'​s details and service from within reports and from open, closed, and queued report pages
   * Ability to create a new abuse report using ajax to quickly select a customer, their product, and IP address   * Ability to create a new abuse report using ajax to quickly select a customer, their product, and IP address
 +  * Ability for the admin to set a custom IP address or use one of the IPs assigned to the service when creating a report
   * Ability to set the service in question to either not suspend, suspend immediately,​ or suspend after a time limit   * Ability to set the service in question to either not suspend, suspend immediately,​ or suspend after a time limit
   * Ability to allow the client to unsuspend their service on their own   * Ability to allow the client to unsuspend their service on their own
-  * Ability to view, close, reopen, and delete - open and closed abuse reports +  * Ability to view, edit, close, reopen, and delete - open and closed ​abuse reports 
-  * Ability to assign to client, and delete - queued abuse reports (from 3rd parties)+  * Ability to view, and download attachments from open, closed and queued ​abuse reports 
 +  * Ability to assign to client, and delete - queued abuse reports (from 3rd parties ​from Public Page & Mail Fetch)
   * Ability to see suggestions on which customer and service the queued abuse report might belong to   * Ability to see suggestions on which customer and service the queued abuse report might belong to
 +  * Ability to use the new magic import "use these values"​ button to use the suggested customer details & service the queued abuse report might belong to
   * Ability to see details of abuse report from within an abuse report   * Ability to see details of abuse report from within an abuse report
   * Ability to start a conversation with the client from within open abuse reports   * Ability to start a conversation with the client from within open abuse reports
   * Ability to see a read-only abuse report, when an abuse report is closed   * Ability to see a read-only abuse report, when an abuse report is closed
-  * Ability to see the imported email body or abuse report from 3rd parties from within queued abuse reports+  * Ability to see the imported email body with attachments ​or abuse report from 3rd parties from within queued abuse reports
   * Ability to lock down client area if a customer has any open abuse reports   * Ability to lock down client area if a customer has any open abuse reports
   * Ability to set a maximum amount of open abuse reports before a customer is flagged on admin side   * Ability to set a maximum amount of open abuse reports before a customer is flagged on admin side
Line 62: Line 47:
   * Ability to lift the automatic suspension, before the service is suspended from within an open abuse report   * Ability to lift the automatic suspension, before the service is suspended from within an open abuse report
   * Ability to create as many different abuse categories as you see fit   * Ability to create as many different abuse categories as you see fit
 +  * Ability to rename links in WHMCS navbar
 +  * Ability to reroute/​disable/​modify admin notifications (new WHMCS notifications system)
 +  * Admin notifications on 3rd party queued abuse reports
   * Multiple staff can work on the same abuse report   * Multiple staff can work on the same abuse report
   * reCaptcha Support   * reCaptcha Support
   * gravatar Support in admin replies   * gravatar Support in admin replies
   * Custom email templates which are sent to staff and customers, which can also be edited and include merge fields   * Custom email templates which are sent to staff and customers, which can also be edited and include merge fields
-===== Public Features ===== 
-  * Report Abuse link in top navigation bar (automatically shown), which is a public facing abuse report page, which allows 3rd parties to send you abuse reports easily 
-  * reCaptcha Support to avoid spam 
- 
 ===== Customer Features ===== ===== Customer Features =====
   * Resolution Center link in top navigation bar (automatically shown), which shows a customer all their abuse reports - open and closed, with the ability to view both   * Resolution Center link in top navigation bar (automatically shown), which shows a customer all their abuse reports - open and closed, with the ability to view both
 +  * Added 'last reply by' & '​service'​ columns to the overview page
   * Report details show vital information to the customer, including the service in question, the IP, date of incident, the category of the abuse report, as well as the abuse report it self.   * Report details show vital information to the customer, including the service in question, the IP, date of incident, the category of the abuse report, as well as the abuse report it self.
   * Ability to view a read-only abuse report if an abuse report is set as closed   * Ability to view a read-only abuse report if an abuse report is set as closed
Line 77: Line 62:
   * Ability to self unsuspend a service (if enabled for a customer on abuse report creation or assigning)   * Ability to self unsuspend a service (if enabled for a customer on abuse report creation or assigning)
   * gravatar Support in client replies   * gravatar Support in client replies
- +===== Public Features ===== 
- +  * Report Abuse link in top navigation bar (automatically shown), which is a public facing abuse report page, which allows 3rd parties to send you abuse reports easily 
 +  * reCaptcha Support to avoid spam
  
 ===== Requirements ===== ===== Requirements =====
  
-To be able to make use of abuse manager pro, you have to make sure that the following requirements are fulfilled:+To be able to make use of Abuse Manager Pro, you have to make sure that the following requirements are fulfilled:
  
-  * Ioncube +  * Latest ​Ioncube ​Loaders 
-  * Non strict firewall (to perform license checks)+  * Non strict firewall (to perform ​software ​license checks)
   * Latest version of WHMCS   * Latest version of WHMCS
   * A License Key to run the script   * A License Key to run the script
   * FTP client to assist with file upload   * FTP client to assist with file upload
 +  * PHP_IMAP if fetching/​importing emails & attachments
  
  
 ===== Quick Setup Guide ===== ===== Quick Setup Guide =====
  
-  * Purchase ​a license for the script +  * Purchase the script, and get a license code 
-  * download ​the .zip file +  * Download ​the latest ​.zip file from the client area 
-  * Unzip the .zip file and place the contents into whmcs'​s ​directory +  * Unzip the .zip file and place the contents into the WHMCS directory 
-  * Then login to the admin side of WHMCS, and go to Setup > Addon Modules+  * Login to the admin side of WHMCS, and go to Setup > Addon Modules
   * Activate Abuse Manager Pro (AMP), then click on configure   * Activate Abuse Manager Pro (AMP), then click on configure
   * Enter your license key, and fill the settings according to your choices and press save   * Enter your license key, and fill the settings according to your choices and press save
   * Remember to give administrators access by ticking the check boxes respectively in access control   * Remember to give administrators access by ticking the check boxes respectively in access control
-  ​* Email pipe is now deprecated and not supported. +  * To fetch mail automatically, simply put the mail server hostname and port (i.e. mail.domain.com:​143),​ email address, password, and select the SSL/TLS options. The emails will be fetched and queued into abuse manager pro. 
-  ​* To fetch mail, simply put the mail server hostname and port (i.e. mail.domain.com:​143),​ email address, ​and password ​select the TLS options. The emails will be fetched and queued into abuse manager pro. This is to be done on the module settings page+  * (Optional) To enable the WHMCS'​s admin widget to be displayed on home page (admin side), go to Setup > Staff Management > Administrator Roles and edit the role you want it to be displayed for, and tick the check box under Widgets that says "Abuse Manager Pro - Reports Requiring Your Reply"​ 
-  * [**Only for versions prior to WHMCS 7. If you are running WHMCS 7 you should have your main WHMCS cron only - auto suspend will work automatically!**]To enable the auto suspend feature, go to cPanel ​(or any other hosting control panel you use), then go to crons or cron jobs and create the exact same cron job entry as the main one for WHMCS, but end it with two flags : do_updaterates skip_report (e.g. your entry should look like <​php>/​usr/​local/​bin/​php -q /​home/​[username]/​public_html/​[whmcs directory]/​crons/​cron.php do_updaterates skip_report</​php>​ ) and make it run either every 5 minutes or every 10 minutes. +  * (Optional) ​[[amp:​integrate_multilang|Click here for the integration guide for multiple languages ​on the client side (multilang)]] 
-  * (optional) To enable the WHMCS'​s admin widget to be displayed on home page (admin side), go to Setup > Staff Management > Administrator Roles and edit the role you want it to be displayed for, and tick the check box under Widgets that says "Abuse Manager Pro - Reports Requiring Your Reply"​ +  * (Optional ​/ Advanced[[amp:​amp_api|API Documentation & example PHP Curl Script to interact with Abuse Manager Pro programmatically]]
-  * [[amp:​integrate_multilang|Integrate ​multiple languages ​for client side (multilang)]] (Optional)+
 ===== Upgrade Guide ===== ===== Upgrade Guide =====
  
 If you are upgrading from an older version of the script, after you upload the new files, you have to visit the Admin side of the module (Usually at http://​yourdomain.com/​whmcs/​admin/​addonmodules.php?​module=abusemanagerpro) for the upgrade system to update any needed settings/​etc. If you are upgrading from an older version of the script, after you upload the new files, you have to visit the Admin side of the module (Usually at http://​yourdomain.com/​whmcs/​admin/​addonmodules.php?​module=abusemanagerpro) for the upgrade system to update any needed settings/​etc.
 +
 +===== Common Issues =====
 +
 +^ Issue ^ Resolution ^
 +| Emails are imported twice when using PHP_IMAP Fetch | This usually happens when there is more than one cron entry, and can be fixed by keeping the main/​default WHMCS cron entry only|
 +| [WHMCS Application] ERROR: Error: Call to undefined function imap_open() | This usually happens when '​IMAP_OPEN'​ function is missing in PHP. Make sure IMAP is installed correctly. Also, this could be an issue with the CRON invoking wrong PHP (e.g. if invoking CRON from web works fine) |
  
 ===== Changelog ===== ===== Changelog =====
  
 A Changelog will be posted on the page linked [[https://​marketplace.whmcs.com/​product/​1326#​changelog|here]],​ upon any updates. A Changelog will be posted on the page linked [[https://​marketplace.whmcs.com/​product/​1326#​changelog|here]],​ upon any updates.
amp/home.1530276619.txt.gz · Last modified: 2018/06/29 14:50 by rsk