Difference between revisions of "SolusIO"
| Line 66: | Line 66: | ||
The landing page is controlled by templates and can be customized. To make changes, we recommend copying the file /modules/addons/solusio/templates/post-pay/landing-page.tpl into the active WHMCS client area template directory under the path /templates/{active_template}/modules/addons/solusio/post-pay/landing-page.tpl. All paths are relative to the WHMCS root installation directory. From there, you can make changes to the template within your WHMCS client area template directory and these customisations will be preserved during module updates. | The landing page is controlled by templates and can be customized. To make changes, we recommend copying the file /modules/addons/solusio/templates/post-pay/landing-page.tpl into the active WHMCS client area template directory under the path /templates/{active_template}/modules/addons/solusio/post-pay/landing-page.tpl. All paths are relative to the WHMCS root installation directory. From there, you can make changes to the template within your WHMCS client area template directory and these customisations will be preserved during module updates. | ||
| − | ====Invoicing | + | ====Configuration==== |
| + | |||
| + | =====Post-Pay Limit Group===== | ||
| + | |||
| + | The limit group settings allow you to control settings related to limits imposed on new Post-Pay enabled users. | ||
| + | |||
| + | <table class="table table-striped"> | ||
| + | <tr><th>Setting Name</th><th>Description</th></tr> | ||
| + | <tr><td>New User Limit Group</td><td>Select the limit group you wish to be applied by default to all new Post-Pay users. (* Limit groups must be created and defined within the SolusIO control panel)</td></tr> | ||
| + | </table> | ||
| + | |||
| + | =====Post-Pay General Settings===== | ||
| + | |||
| + | The general settings allow you to control general settings. | ||
| + | |||
| + | <table class="table table-striped"> | ||
| + | <tr><th>Setting Name</th><th>Description</th></tr> | ||
| + | <tr><td>Post-Pay Terms & Conditions</td><td>An optional URL to Terms & Conditions for the Post-Pay Billing service for SolusIO. Use this to provide additional terms relating to the invoicing and payment of Post-Pay service usage.</td></tr> | ||
| + | </table> | ||
| + | |||
| + | =====Post-Pay Invoicing===== | ||
The invoicing settings allow you to control settings related to invoices generated for Post-Pay usage. | The invoicing settings allow you to control settings related to invoices generated for Post-Pay usage. | ||
| Line 74: | Line 94: | ||
<tr><td>Invoicing Grace Period</td><td>The number of days you want to allow after generation before an invoice is considered overdue.</td></tr> | <tr><td>Invoicing Grace Period</td><td>The number of days you want to allow after generation before an invoice is considered overdue.</td></tr> | ||
</table> | </table> | ||
| + | |||
| + | =====Suspension Settings===== | ||
| + | |||
| + | The suspension settings allow you to control settings related to service restrictions for non-payment of Post-Pay usage. | ||
| + | |||
| + | <table class="table table-striped"> | ||
| + | <tr><th>Setting Name</th><th>Description</th></tr> | ||
| + | <tr><td>Lock Overdue Users</td><td>The number of days you want to allow before locking a user account in SolusIO. This is the number of days from the due date.</td></tr> | ||
| + | <tr><td>Suspend Overdue Users</td><td>The number of days you want to allow before suspending a user account in SolusIO. This is the number of days from the due date.</td></tr> | ||
| + | </table> | ||
| + | |||
| + | For more information regarding locking and suspension restrictions, please refer to the SolusIO documentation. | ||
| + | |||
| + | ===Settings=== | ||
| + | |||
| + | The settings tab allows you to modify connection and pricing settings. | ||
| + | |||
| + | ====Token Pricing==== | ||
| + | |||
| + | Token Pricing must be set for each active currency within WHMCS. | ||
| + | |||
| + | Token Pricing can be set up to 4 decimal places. | ||
| + | |||
| + | The prices entered should be the monetary cost in each given current for 1 unit of token usage. | ||
| + | |||
| + | ====API Connection==== | ||
| + | |||
| + | The API Connection panel can be used to modify and update the Installation URL and API Key at any time. | ||
| + | |||
| + | To make a change, enter both the Installation URL and an API Key and click the '''Test Connection''' button to validate the inputs. | ||
| + | |||
| + | If a connection is successful, the URL and API Key used by WHMCS will be updated. | ||
| + | |||
| + | ==SolusIO Setup== | ||
| + | |||
| + | The following articles describe configuration and setup within the SolusIO system itself. | ||
| + | |||
| + | ===WHMCS Billing Integration=== | ||
| + | |||
| + | Within the SolusIO product, it is possible to configure ''Billing Integration Settings''. | ||
| + | |||
| + | The billing integration allows SolusIO to retrieve token pricing information as well as perform single sign-on to the WHMCS billing portal. | ||
| + | |||
| + | WHMCS will auto-configure the WHMCS Billing Integration values for you every time a successful connection is established between the WHMCS SolusIO module and a SolusIO target instance. It is not possible to generate and set these values manually. | ||
| + | |||
| + | Should there be a need to re-configure or re-setup the connection at any time, you will need to re-establish the API Connection with the SolusIO target instance using the API Connection panel located within the Settings tab of the SolusIO WHMCS integration module. | ||
Revision as of 14:58, 7 September 2020
Our SolusIO Integration is the official integration between WHMCS and the SolusIO Virtual Infrastructure Management Platform.
Supporting 3 methods of billing integration:
- Self-Service VM Provisioning with Post-Pay Billing - Available now - Allow customers to register for access to VM provisioning, manage virtual machines and provision on-demand via the SolusIO control panel, and have billing performed at set intervals by WHMCS in a post-pay (pay after use) model.
- Self-Service VM Provisioning with Pre-Pay Credits - Coming Soon! - Allow customers to register for access to VM provisioning, deposit funds in advance, and manage virtual machines and provision on-demand via the SolusIO control panel. Usage charges are assessed against the customers available balance in real-time.
- Retail VM Selling - Coming Soon! - Sell pre-configured VPS plans through your WHMCS online store. Offer traditional style VPS and virtual machines with a fixed monthly price, prepaid up front and billed on a regular fixed billing cycle. Customers will not need to use the SolusIO control panel.
For more information, please refer to our SolusIO FAQ
Installation
- Download the latest version of the integration via the WHMCS Marketplace: link coming soon
- Extract the zip file
- Upload the 'solusio' directory to the '/modules/addons' folder of your WHMCS installation.
First Use
- Login to the WHMCS Admin Area
- Navigate to Setup > Addon Modules
- Locate the SolusIO module in the list
- Click the Activate button
- Upon success, click the Configure button
- Under Access Control, select the user group to which your admin user is assigned
- Click Save Changes
- After the page reloads, navigate to Addons > SolusIO
You will then be guided through the process of connecting to your SolusIO instance
Accessing the SolusIO Integration
You can access the SolusIO module within WHMCS at any time by navigating to Addons > SolusIO within the WHMCS admin area.
Connecting to SolusIO
Upon accessing the SolusIO module for the first time you will see a screen as follows.
Enter the URL to your SolusIO installation. This should be the url you use to access the web interface.
Enter your API Key. This can be retrieved by navigating to Account > API Tokens > Generate API Token when logged into the SolusIO user area.
Click Test Connection to verify a connection can be established with the SolusIO system
Upon success, you will be redirected to management screen.
Setup & Use
Post-Pay
Upon accessing the SolusIO module post connecting to SolusIO, you will be presented with the following screen which allows you to set settings related to Post-Pay billing.
Landing Page
The WHMCS SolusIO Post-Pay functionality comes with a ready made landing page designed to make it quick and easy to get up and running with offering SolusIO services. The link is provided here for convenience. This page can only be accessed when Post-Pay billing is enabled.
Menu items are automatically added to the WHMCS client area when enabled. For logged out users, it can be accessed via a Cloud Hosting option in the main menu. For logged in users, it can be accessed via a Cloud Hosting menu option under the Website & Security dropdown menu.
Customising the Landing Page
The landing page is controlled by templates and can be customized. To make changes, we recommend copying the file /modules/addons/solusio/templates/post-pay/landing-page.tpl into the active WHMCS client area template directory under the path /templates/{active_template}/modules/addons/solusio/post-pay/landing-page.tpl. All paths are relative to the WHMCS root installation directory. From there, you can make changes to the template within your WHMCS client area template directory and these customisations will be preserved during module updates.
Configuration
Post-Pay Limit Group
The limit group settings allow you to control settings related to limits imposed on new Post-Pay enabled users.
| Setting Name | Description |
|---|---|
| New User Limit Group | Select the limit group you wish to be applied by default to all new Post-Pay users. (* Limit groups must be created and defined within the SolusIO control panel) |
Post-Pay General Settings
The general settings allow you to control general settings.
| Setting Name | Description |
|---|---|
| Post-Pay Terms & Conditions | An optional URL to Terms & Conditions for the Post-Pay Billing service for SolusIO. Use this to provide additional terms relating to the invoicing and payment of Post-Pay service usage. |
Post-Pay Invoicing
The invoicing settings allow you to control settings related to invoices generated for Post-Pay usage.
| Setting Name | Description |
|---|---|
| Invoicing Grace Period | The number of days you want to allow after generation before an invoice is considered overdue. |
Suspension Settings
The suspension settings allow you to control settings related to service restrictions for non-payment of Post-Pay usage.
| Setting Name | Description |
|---|---|
| Lock Overdue Users | The number of days you want to allow before locking a user account in SolusIO. This is the number of days from the due date. |
| Suspend Overdue Users | The number of days you want to allow before suspending a user account in SolusIO. This is the number of days from the due date. |
For more information regarding locking and suspension restrictions, please refer to the SolusIO documentation.
Settings
The settings tab allows you to modify connection and pricing settings.
Token Pricing
Token Pricing must be set for each active currency within WHMCS.
Token Pricing can be set up to 4 decimal places.
The prices entered should be the monetary cost in each given current for 1 unit of token usage.
API Connection
The API Connection panel can be used to modify and update the Installation URL and API Key at any time.
To make a change, enter both the Installation URL and an API Key and click the Test Connection button to validate the inputs.
If a connection is successful, the URL and API Key used by WHMCS will be updated.
SolusIO Setup
The following articles describe configuration and setup within the SolusIO system itself.
WHMCS Billing Integration
Within the SolusIO product, it is possible to configure Billing Integration Settings.
The billing integration allows SolusIO to retrieve token pricing information as well as perform single sign-on to the WHMCS billing portal.
WHMCS will auto-configure the WHMCS Billing Integration values for you every time a successful connection is established between the WHMCS SolusIO module and a SolusIO target instance. It is not possible to generate and set these values manually.
Should there be a need to re-configure or re-setup the connection at any time, you will need to re-establish the API Connection with the SolusIO target instance using the API Connection panel located within the Settings tab of the SolusIO WHMCS integration module.