User Tools

Site Tools


amp:home

This is an old revision of the document!


Abuse Manager Pro (WHMCS Module)

This article is being updated for the latest release v3.0

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 a walk in the park!

Although many people use support tickets, that method requires a lot of work and many different strategies to help define an inefficient process for admins - this 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.

The system allows you to receive abuse reports from 3rd parties, either by emails (using a fetching technique by PHP_IMAP) or by enabling a public facing abuse reporting page. As well as that, you can create abuse reports of your own.

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.

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!


Screen Shots

Admin Features

  • Abuse Dashboard that shows you quick statistics and important information
  • Admin Widget on WHMCS admin home page which shows abuse reports that require your attention
  • Filter records using a filter on top of open, closed, queued abuse reports pages to quickly find what you are looking for
  • 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 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 view, close, reopen, and delete - open and closed abuse reports
  • Ability to assign to client, and delete - queued abuse reports (from 3rd parties)
  • Ability to see suggestions on which customer and service the queued abuse report might belong to
  • 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 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 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 specify amount of time before a service is automatically suspended (only if report is set to suspend a service after a time limit)
  • 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
  • Multiple staff can work on the same abuse report
  • reCaptcha Support
  • gravatar Support in admin replies
  • Custom email templates which are sent to staff and customers, which can also be edited and include merge fields

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
  • 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 start a conversation with staff from within open abuse reports
  • Ability to self unsuspend a service (if enabled for a customer on abuse report creation or assigning)
  • 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

To be able to make use of abuse manager pro, you have to make sure that the following requirements are fulfilled:

  • Latest Ioncube
  • Non strict firewall (to perform software license checks)
  • Latest version of WHMCS
  • A License Key to run the script
  • FTP client to assist with file upload
  • PHP_IMAP if fetching/importing emails & attachments

Quick Setup Guide

  • Purchase a license for the script
  • download the .zip file
  • Unzip the .zip file and place the contents into whmcs's directory
  • Then login to the admin side of WHMCS, and go to Setup > Addon Modules
  • Activate Abuse Manager Pro (AMP), then click on configure
  • 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
  • Email pipe is now deprecated and not supported.
  • 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.
  • [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 /usr/local/bin/php -q /home/[username]/public_html/[whmcs directory]/crons/cron.php do_updaterates skip_report ) and make it run either every 5 minutes or every 10 minutes.
  • (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”

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.

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

Changelog

A Changelog will be posted on the page linked here, upon any updates.

amp/home.1580296247.txt.gz · Last modified: 2020/01/29 12:10 by rsk