Configuring Tweak WHMCS Addon

  1. Obtain the plugin.
  2. Download the Modulized: Tweak plugin files from our server using the instructions from your welcome email.
  3. Upload the files to your WHMCS installation. (yourdomain.com/whmcs/modules/addons/tweak).
  4. Log into WHMCS and visit "Setup" → "Addon Modules" and Activate Modulized: Tweak. Also click "Configure" to specify access control properties for the plugin.
  5. Within WHMCS goto "Addons" → "Modulized: Tweak".
  6. Click the "Configurations" tab.
  7. Enter your Addon Licence Key from your welcome email.
  8. Enter your Name.
  9. Enter your Email Address.
  10. Click “Save Configurations”.

Escalation Rules

Escalation rules allow you to specify actions to take automatically if a support ticket has been in a specified state for a set period of time. We have added an additional feature that allows you to specify the time elapse on both Weekdays and Weekends, instead of just one overall elapse time that comes standard with WHMCS.

  1. Create the rules within WHMCS built in features first by going to "Setup" → "Support" → "Escalation Rules".
  2. Once you have created the rules, go to "Addons" → "Modulized: Tweak.
  3. Click "Escalation Rules" tab.
  4. Select the rule you wish to apply the advanced elapse times to from "Generated Rules" drop down menu.
  5. Complete both Time Elapsed fields with the preferred minute number.
  6. Click "Save".

Escalation Rules: Delete

Once you have setup the additional elapse time customisation for your rules, it will continue to overwrite the standard time elapse until you delete it. This can be achieved by doing the following:

  1. Go to "Addons" → "Modulized: Tweak.
  2. Click "Escalation Rules" tab.
  3. Find the rule in the Delete table you wish to remove.
  4. Click the checkbox associated to the rule in the "Delete" column.
  5. Click "Delete Rule".

Accounts: Delete

We have created the ability to delete all closed accounts that haven't been logged into for a specified number of days. Please note that this function can not be undone once activated, so we strongly advise making a database backup. This feature is manually activated by doing the following:

  1. Go to "Addons" → "Modulized: Tweak.
  2. Click "Accounts" tab.
  3. Complete "Number of days" field on "Delete Accounts" form.
  4. You must click the "Confirm Deletion" checkbox for this function to be allowed, this is to prevent any accidents.
  5. Click "Delete".

Accounts: Close

We have created the ability to close all inactive accounts that haven't been logged into for a specified number of days. WHMCS automatically sets accounts to 'Inactive' once all services have been cancelled. Activating this function sets the 'logged' into date of all accounts it is closing to the current date. Please note that this function can not be undone once activated, so we strongly advise making a database backup. This feature is manually activated by doing the follow:

  1. Go to "Addons" → "Modulized: Tweak.
  2. Click "Accounts" tab.
  3. Complete "Number of days" field on "Close Accounts" form.
  4. You must click the "Confirm Closure" checkbox for this function to be allowed, this is to prevent any accidents.
  5. Click "Close".

Invoices: Cancel

We have created the ability to change all invoice status to cancelled if the invoices have past the due date by a specified number of days. This feature can be both manual and automatically triggered. This function can be achieved by doing the following:

  1. Go to "Addons" → "Modulized: Tweak.
  2. Click "Invoices" tab.
  3. Complete "Number of days" field on "Close Accounts" form.
  4. If you only wish this to be triggered automatically the change the cron job hook to activated, if not the leave it de-actiavated.
  5. To run the settings straight the way click "Run Hook", else click "Save"

History

The history table shows the activity that has occurred on the function you chose to see the history of. The logs are displayed in date order, latest being first. You can download a CSV file of all client / invoices (depending on the table you have chosen) data that has been deleted/closed or cancelled. History information can be found at any of the following functions:

  • Delete Accounts.
  • Close Accounts.
  • Cancel Invoices.

Support: Technical Assistance

The support form is useful when you want to raise a support ticket to us, tick the checkbox in the form to automatically add the error.log, this will make it easier and quicker for us to identify the problem. The error.log is located on the root of the tweak addon module folder. Send a technical support by doing the following:

  1. Go to "Addons" → "Modulized: Tweak.
  2. Click "Support" tab.
  3. Select "Technical" on the "Department" drop down menu.
  4. Complete the "Message" field with the feature you would like to see.
  5. Click "Submit"

Support: Recommend A Tweak

Our tweak addon is designed for you to recommend tweaks to us, we want to expand the functionality and need ideas of features that are missing. So if you have an idea of a feature/tool that you wish would be added please let us know by using the support form within your Tweak Addon. This form can be found by doing the following:

  1. Go to "Addons" → "Modulized: Tweak.
  2. Click "Support" tab.
  3. Select "Recommend A Tweak" on the "Department" drop down menu.
  4. Complete the "Message" field with the feature you would like to see.
  5. Click "Submit"

Problems & Support

We hope you do not experience any problems but if you do these tips may help:

  • If you are experiencing issue check for the error.log located on the root of your addon module as well as the activity log in whmcs to establish what the problem might be.
  • If you encounter a white screen once the application is installed please refer to http://docs.whmcs.com/Blank_Pages to display errors causing the issue.
  • If you are unable to get your install working, please provide full details of the errors you are encountering by emailing support@modulized.com or by completing the built in support form found on the "Support" tab within the addon.