Difference between revisions of "Chartmogul"
(→Module Features:) |
|||
| (25 intermediate revisions by the same user not shown) | |||
| Line 9: | Line 9: | ||
== Module Features: == |
== Module Features: == |
||
| − | * Synchronize: |
+ | * '''Synchronize:''' |
** Clients |
** Clients |
||
** Invoices |
** Invoices |
||
| Line 18: | Line 18: | ||
** Transactions |
** Transactions |
||
** Refunds |
** Refunds |
||
| + | ** Setup trial settings. |
||
* View Logs |
* View Logs |
||
* View cron status |
* View cron status |
||
| + | == Requirements == |
||
| − | |||
| − | |||
| − | |||
| − | * Requirements |
||
* WHMCS 6 o greater |
* WHMCS 6 o greater |
||
| Line 32: | Line 30: | ||
| + | '''Installation''' |
||
| − | Instal |
||
| + | 1. Log in to your client area and download the module. |
||
| − | |||
| + | [[File:login.jpg]] |
||
| − | Unzip chartmogul.zip |
||
| + | 2. Unzip chartmogul.zip |
||
| − | Copy "modules/addons/chartmogul" to "modules/addons" in your whmcs install. |
||
| + | 3. Copy "modules/addons/chartmogul" to "modules/addons" in your whmcs install. |
||
| − | Enable the addon at setup->addon modules |
||
| + | |||
| + | 4. Enable the addon at setup->addon modules |
||
| + | |||
| + | [[File:ch5.jpg]] |
||
Whmcs admin username: Whmcs admin username with permissiosn to use the whmcs API. |
Whmcs admin username: Whmcs admin username with permissiosn to use the whmcs API. |
||
| Line 49: | Line 51: | ||
Chartmogul secret key: Chartmogul API secret key. |
Chartmogul secret key: Chartmogul API secret key. |
||
| − | |||
| − | chartmogul api |
||
Access control: What admin role can access the addon. |
Access control: What admin role can access the addon. |
||
| Line 56: | Line 56: | ||
Module license: Whmcsmod.com license. |
Module license: Whmcsmod.com license. |
||
| + | == Setup == |
||
| − | |||
| − | Usage |
||
| + | == Manual export == |
||
| − | |||
| − | |||
| − | Steaps to make after the install |
||
| + | It is not recommended to make a bulk client synchronization using the admin addon, instead, the cronjob will automatically synchronize your data ( check the cronjob section ). |
||
| − | |||
1- To initialize the chartmogul data go to addons->chartmogul. |
1- To initialize the chartmogul data go to addons->chartmogul. |
||
| + | [[File:initialize.png]] |
||
| − | addon home |
||
| − | 2- Export your whmcs plans by clicking the " |
+ | 2- Export your whmcs plans by clicking the "Synchronize products" link and then "start import". |
| + | [[File:export-plan.png]] |
||
| − | addon plans import |
||
| − | |||
| − | |||
| − | For each whmcs plan biling cycle a chartmogul plan will be created. |
||
| + | Note: For each whmcs plan biling cycle a chartmogul plan will be created. |
||
| − | 3- Once the plan export has been completed, the whmcs customers can be exported in the " |
+ | 3- Once the plan export has been completed, the whmcs customers can be exported in the "Synchronize client" link. |
| − | The clients will be exported in btaches of 5 clients to avoid timeouts. The export is automatic while the modal window is opened but if it is closed the process will be suspended. You can resume the imported anytime since the last client exported or start a new import from scratch. |
||
| + | [[File:export-customers.png]] |
||
| − | If there's any error importing data, a log entry will be created at ""utilities->logs->module log" if "enable debug logging" is enabled. |
||
| − | |||
| + | == Trial settings == |
||
| − | |||
| + | [[File:trial.png]] |
||
| − | addon import clients |
||
| + | == Automatic export( cron ) == |
||
| − | |||
| + | To automatically export the data from WHMCS to chartmogul a cron job must be created. The "Cron" tab will display the cron task command to be run: |
||
| − | New signups will be automatically exported to Chartmogul, the following events are supported: |
||
| + | [[File:cron.jpg]] |
||
| − | - New client. |
||
| − | - Client profile update. |
||
| + | == Logs == |
||
| − | - Invoice paid. |
||
| + | Will display event logs or warning/error messages from chartmogul. |
||
| − | - Invoice refunded. |
||
| + | [[File:logs.jpg]] |
||
| − | - Service terminated/cancelled, |
||
| − | |||
| − | FAQ |
+ | == FAQ== |
| − | "The number of active clients in whmcs is greater than in chartmogul" |
+ | 1. ''"The number of active clients in whmcs is greater than in chartmogul"'' |
| − | + | Any client with an active service in whmcs is an active client in whmcs even if it was a one payment one. In chartmogul an active client is one with recurring payments. |
|
| + | 2. ''"Some whmcs invoice transactions are not displayed in chartmogul"'' |
||
| − | |||
| − | |||
| − | "Some whmcs invoice transactions are not displayed in chartmogul" |
||
The addon will only export invoice transactions, if there's any transactions in whmcs not linked with an invoice it is not exported. |
The addon will only export invoice transactions, if there's any transactions in whmcs not linked with an invoice it is not exported. |
||
| + | 3. ''"The amount of invoices is greater in whmcs than in chartmogul"'' |
||
| − | |||
| − | "The amount of invoices is greater in whmcs than in chartmogul" |
||
| − | |||
| − | |||
The addon will only export invoice paid or refunded. |
The addon will only export invoice paid or refunded. |
||
Latest revision as of 12:41, 13 November 2018
Contents
About Chartmogul For WHMCS
The Chartmogul addon will synchronize the date between WHMCs and Chartmogul. The data can be synchronized manually or automatically with cron jobs.
Module Features:
- Synchronize:
- Clients
- Invoices
- Transactions
- Export Automatically:
- Clients
- Invoices
- Transactions
- Refunds
- Setup trial settings.
- View Logs
- View cron status
Requirements
- WHMCS 6 o greater
- PHP 5.6 o greater
Installation
1. Log in to your client area and download the module.
2. Unzip chartmogul.zip
3. Copy "modules/addons/chartmogul" to "modules/addons" in your whmcs install.
4. Enable the addon at setup->addon modules
Whmcs admin username: Whmcs admin username with permissiosn to use the whmcs API.
Chartmogul datasource: Chartmoful data source name to be created in chartmogul.
Chartmogul account token: Chartmogul API token
Chartmogul secret key: Chartmogul API secret key.
Access control: What admin role can access the addon.
Module license: Whmcsmod.com license.
Setup
Manual export
It is not recommended to make a bulk client synchronization using the admin addon, instead, the cronjob will automatically synchronize your data ( check the cronjob section ).
1- To initialize the chartmogul data go to addons->chartmogul.
2- Export your whmcs plans by clicking the "Synchronize products" link and then "start import".
Note: For each whmcs plan biling cycle a chartmogul plan will be created.
3- Once the plan export has been completed, the whmcs customers can be exported in the "Synchronize client" link.
Trial settings
Automatic export( cron )
To automatically export the data from WHMCS to chartmogul a cron job must be created. The "Cron" tab will display the cron task command to be run:
Logs
Will display event logs or warning/error messages from chartmogul.
FAQ
1. "The number of active clients in whmcs is greater than in chartmogul"
Any client with an active service in whmcs is an active client in whmcs even if it was a one payment one. In chartmogul an active client is one with recurring payments.
2. "Some whmcs invoice transactions are not displayed in chartmogul"
The addon will only export invoice transactions, if there's any transactions in whmcs not linked with an invoice it is not exported.
3. "The amount of invoices is greater in whmcs than in chartmogul"
The addon will only export invoice paid or refunded.
