Difference between revisions of "SolusIO"
From WHMCS Documentation
(→First Use) |
|||
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| + | == About this Addon Module == | ||
| + | |||
Our SolusIO Integration is the '''official integration''' between WHMCS and the SolusIO Virtual Infrastructure Management Platform. | Our SolusIO Integration is the '''official integration''' between WHMCS and the SolusIO Virtual Infrastructure Management Platform. | ||
| − | + | This supports '''Self-Service VM Provisioning with Post-Pay Billing''' as a billing mode. Post-Pay Billing allows 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. | |
| − | + | <table class="table" style="text-align:center;margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;width:100%;"> | |
| − | + | <tr> | |
| − | + | <th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Addon Name</th> | |
| + | <th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Latest Release</th> | ||
| + | <th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Current Version</th> | ||
| + | <th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Compatible With</th> | ||
| + | <th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Included in WHMCS</th> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td style="border:1px #AAA solid;padding:0.2em;">SolusIO</td> | ||
| + | <td style="border:1px #AAA solid;padding:0.2em;">N/A</td> | ||
| + | <td style="border:1px #AAA solid;padding:0.2em;">N/A</td> | ||
| + | <td style="border:1px #AAA solid;padding:0.2em;">WHMCS 7.8 and later</td> | ||
| + | <td style="border:1px #AAA solid;padding:0.2em;color:darkred;">No</td> | ||
| + | </tr> | ||
| + | </table> | ||
| − | + | == Activating SolusIO == | |
| − | + | You will need to download and upload the module before you can activate the addon through the Admin Area. | |
| + | |||
| + | To do this: | ||
| − | + | # Download the latest version of the integration [https://marketplace.whmcs.com/product/5619-solusio-official-integration via the WHMCS Marketplace]. | |
| − | + | # Extract the zip file. | |
| − | # Download the latest version of the integration | + | # Upload the <tt>solusio</tt> directory to the <tt>/modules/addons</tt> folder of your WHMCS installation. |
| − | # Extract the zip file | + | # Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Addon Modules]]''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''. |
| − | # Upload the | + | # Click '''Activate''' for '''SolusIO'''. |
| − | + | # Click '''Configure'''. | |
| − | + | # Select the admin role groups who will have access to this addon. | |
| − | |||
| − | |||
| − | # | ||
| − | |||
| − | # Click | ||
| − | |||
| − | # | ||
# Click '''Save Changes'''. | # Click '''Save Changes'''. | ||
| − | |||
| − | + | == Using the Addon == | |
| − | + | You can access the SolusIO module within WHMCS at any time by navigating to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules''' within the WHMCS admin area. | |
| − | + | ===Connecting to SolusIO=== | |
| − | + | To connect to SolusIO: | |
| − | + | # Access SolusIO. When you do this for the first time, you will see the following screen:[[File:SolusIOConnect.png]] | |
| + | # Enter the URL to your SolusIO installation. This is the URL that you use to access the web interface. | ||
| + | # Enter your API Key. You can find this at '''Account > API Tokens > Generate API Token''' in the SolusIO user area. | ||
| + | # Click '''Test Connection''' to verify that you can establish a connection with the SolusIO system. | ||
| − | + | ===Setup=== | |
| − | + | ====Post-Pay==== | |
| − | + | When you access the SolusIO module after connecting to SolusIO, you can set your settings for Post-Pay billing. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
[[File:SolusIOPostPaySetup.png]] | [[File:SolusIOPostPaySetup.png]] | ||
| Line 58: | Line 60: | ||
====Landing Page==== | ====Landing Page==== | ||
| − | The WHMCS SolusIO Post-Pay functionality comes with a | + | The WHMCS SolusIO Post-Pay functionality comes with a premade landing page. You can only access this page after you have enabled Post-Pay billing. |
[[File:SolusIOPostPayLandingPage.png]] | [[File:SolusIOPostPayLandingPage.png]] | ||
| − | + | This also automatically adds menu items to the Client Area if they are enabled. | |
| + | |||
| + | * Logged-out users can access this using the '''Cloud Hosting''' option in the main menu. | ||
| + | * Logged-in users can access this using the '''Cloud Hosting''' option in the '''Website & Security''' menu. | ||
====Customising the Landing Page==== | ====Customising the Landing Page==== | ||
| − | + | Customizable templates control the landing page. To make changes, we recommend copying the <tt>/modules/addons/solusio/templates/post-pay/landing-page.tpl</tt> file into the active WHMCS Client Area template directory at <tt>/templates/{active_template}/modules/addons/solusio/post-pay/landing-page.tpl</tt>. Both of these paths are relative to the WHMCS root installation directory. | |
| + | |||
| + | After you copy the file, you can make changes to the template within your WHMCS Client Area template directory. The system will preserve these customizations during module updates. | ||
====Configuration==== | ====Configuration==== | ||
| Line 72: | Line 79: | ||
=====Post-Pay Limit Group===== | =====Post-Pay Limit Group===== | ||
| − | The | + | The Limit Group settings allow you to control settings for the limits on new Post-Pay enabled users. |
<table class="table table-striped"> | <table class="table table-striped"> | ||
<tr><th>Setting Name</th><th>Description</th></tr> | <tr><th>Setting Name</th><th>Description</th></tr> | ||
| − | <tr><td>New User Limit Group</td><td>Select the limit group | + | <tr><td>'''New User Limit Group'''</td><td>Select the limit group to apply by default to all new Post-Pay users. You must create and define limit groups within the SolusIO control panel.</td></tr> |
</table> | </table> | ||
=====Post-Pay General Settings===== | =====Post-Pay General Settings===== | ||
| − | The | + | The General Settings allow you to control basic SolusIO settings. |
<table class="table table-striped"> | <table class="table table-striped"> | ||
<tr><th>Setting Name</th><th>Description</th></tr> | <tr><th>Setting Name</th><th>Description</th></tr> | ||
| − | <tr><td>Post-Pay Terms & Conditions</td><td>An optional URL to | + | <tr><td>'''Post-Pay Terms & Conditions'''</td><td>An optional URL to the terms and 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> | </table> | ||
=====Post-Pay Invoicing===== | =====Post-Pay Invoicing===== | ||
| − | The | + | The Invoicing settings allow you to control settings for invoices for Post-Pay usage. |
<table class="table table-striped"> | <table class="table table-striped"> | ||
| Line 99: | Line 106: | ||
=====Post-Pay Suspension===== | =====Post-Pay Suspension===== | ||
| − | The | + | The Suspension settings allow you to control settings for service restrictions for non-payment of Post-Pay usage. |
<table class="table table-striped"> | <table class="table table-striped"> | ||
<tr><th>Setting Name</th><th>Description</th></tr> | <tr><th>Setting Name</th><th>Description</th></tr> | ||
| − | <tr><td>Lock Overdue Users</td><td>The number of days | + | <tr><td>'''Lock Overdue Users'''</td><td>The number of days 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 | + | <tr><td>'''Suspend Overdue Users'''</td><td>The number of days to allow before suspending a user account in SolusIO. This is the number of days from the due date.</td></tr> |
</table> | </table> | ||
| − | |||
| − | |||
===Settings=== | ===Settings=== | ||
| − | The | + | The '''Settings''' tab allows you to modify connection and pricing settings. |
====Post-Pay Token Pricing==== | ====Post-Pay Token Pricing==== | ||
| − | Token Pricing | + | You must set Token Pricing for each active currency within WHMCS. |
| + | |||
| + | * You can set Token Pricing with up to four decimal places. | ||
| + | * Enter prices as the total price in each currency for one unit of token usage. | ||
| + | |||
| + | ====API Connection==== | ||
| + | |||
| + | The '''API Connection''' panel can modify and update the installation URL and API key at any time. | ||
| + | |||
| + | To make a change, enter the installation URL and an API key and then click '''Test Connection'''. If a connection is successful, WHMCS will update the URL and API key that it uses. | ||
| − | + | ==WHMCS Billing Integration== | |
| − | + | Within the SolusIO product, you can configure ''Billing Integration Settings''. | |
| − | ==== | + | 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 these values for you every time the WHMCS SolusIO module and SolusIO target instance establish a connection. You '''cannot''' generate and set these values manually. | ||
| + | |||
| + | To reconfigure the connection, you must reestablish the API connection with the SolusIO target instance. To do this, use the '''API Connection''' panel in the '''Settings''' tab of the SolusIO WHMCS integration module. | ||
| + | |||
| + | == FAQ == | ||
| + | |||
| + | ====How do users sign-up?==== | ||
| + | |||
| + | With the Post-Pay Model of billing, there is no purchase or order necessary. Users can sign up or activate their SolusIO user account via the provided landing page. | ||
| + | |||
| + | The enrollment process requires that the user create a WHMCS client account, complete email verification, and agree to your '''Terms of Service''' and (optionally) Post-Pay specific '''Terms & Conditions'''. This process uses the following workflow: | ||
| + | |||
| + | # The user requests creation of an account for VM provisioning. | ||
| + | # The user enters their name, company, email address, and a desired password. | ||
| + | # The user receives an email containing a link to complete the signup process. | ||
| + | # After they click the link, the user must agree to your '''Terms of Service''' and Post-Pay '''Terms & Conditions'''. | ||
| + | # SolusIO provisions the user account. | ||
| + | |||
| + | Users can then access SolusIO at any time via a provided SSO link in the Client Area homepage. | ||
| + | |||
| + | ====How do users access the SolusIO system?==== | ||
| + | |||
| + | With Post-Pay, customers use the SolusIO control panel to provision and manage virtual machines. The Client Area homepage will show one of the following panels, depending on the user's current SolusIO enrollment status: | ||
| + | |||
| + | [[File:SolusIOPanels2.png]] | ||
| + | |||
| + | Enrolled users can click '''Log in to SolusIO''' to access the SolusIO control panel via automated single sign-on. | ||
| + | |||
| + | Unenrolled users can use a shortcut to the provided landing page to learn more and sign up. | ||
| + | |||
| + | ====How does invoicing work?==== | ||
| + | |||
| + | The system generates invoices on the first of each month for all accrued usage in the immediately preceeding month. For example, on the 1st of August, it will generate invoices for usage by all users in the month of July. | ||
| − | + | ====How does the system calculate usage?==== | |
| − | + | SolusIO tracks the uptime of every virtual machine. It bills uptime at the hourly rate of tokens that you define within the SolusIO software. | |
| − | + | When it becomes time to generate an invoice, WHMCS will request the uptime totals for each user from the SolusIO system. It creates an invoice with an itemized list of resources (aka virtual machines) and the amount due. The amount due is the token usage value in the SolusIO system multiplied by the token pricing in WHMCS. | |
| − | == | + | ====How is billing triggered?==== |
| − | The | + | A cron task manages invoice generation and user management. The system executes the cron task automatically once per day, and you can trigger it manually using the following command: |
| − | + | php crons/cron.php do --SolusioAutomation -vvv | |
| − | + | Invoice generation only occurs on the first day of each month. | |
| + | == Troubleshooting == | ||
| − | + | ''N/A'' | |
| − | + | == Change Log == | |
| − | + | ''N/A'' | |
Latest revision as of 16:32, 28 December 2022
Contents
About this Addon Module
Our SolusIO Integration is the official integration between WHMCS and the SolusIO Virtual Infrastructure Management Platform.
This supports Self-Service VM Provisioning with Post-Pay Billing as a billing mode. Post-Pay Billing allows 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.
| Addon Name | Latest Release | Current Version | Compatible With | Included in WHMCS |
|---|---|---|---|---|
| SolusIO | N/A | N/A | WHMCS 7.8 and later | No |
Activating SolusIO
You will need to download and upload the module before you can activate the addon through the Admin Area.
To do this:
- Download the latest version of the integration via the WHMCS Marketplace.
- Extract the zip file.
- Upload the solusio directory to the /modules/addons folder of your WHMCS installation.
- Go to Configuration () > System Settings > Addon Modules or, prior to WHMCS 8.0, Setup > Addon Modules.
- Click Activate for SolusIO.
- Click Configure.
- Select the admin role groups who will have access to this addon.
- Click Save Changes.
Using the Addon
You can access the SolusIO module within WHMCS at any time by navigating to Configuration () > System Settings > Addon Modules or, prior to WHMCS 8.0, Setup > Addon Modules within the WHMCS admin area.
Connecting to SolusIO
To connect to SolusIO:
- Access SolusIO. When you do this for the first time, you will see the following screen:
- Enter the URL to your SolusIO installation. This is the URL that you use to access the web interface.
- Enter your API Key. You can find this at Account > API Tokens > Generate API Token in the SolusIO user area.
- Click Test Connection to verify that you can establish a connection with the SolusIO system.
Setup
Post-Pay
When you access the SolusIO module after connecting to SolusIO, you can set your settings for Post-Pay billing.
Landing Page
The WHMCS SolusIO Post-Pay functionality comes with a premade landing page. You can only access this page after you have enabled Post-Pay billing.
This also automatically adds menu items to the Client Area if they are enabled.
- Logged-out users can access this using the Cloud Hosting option in the main menu.
- Logged-in users can access this using the Cloud Hosting option in the Website & Security menu.
Customising the Landing Page
Customizable templates control the landing page. To make changes, we recommend copying the /modules/addons/solusio/templates/post-pay/landing-page.tpl file into the active WHMCS Client Area template directory at /templates/{active_template}/modules/addons/solusio/post-pay/landing-page.tpl. Both of these paths are relative to the WHMCS root installation directory.
After you copy the file, you can make changes to the template within your WHMCS Client Area template directory. The system will preserve these customizations during module updates.
Configuration
Post-Pay Limit Group
The Limit Group settings allow you to control settings for the limits on new Post-Pay enabled users.
| Setting Name | Description |
|---|---|
| New User Limit Group | Select the limit group to apply by default to all new Post-Pay users. You must create and define limit groups within the SolusIO control panel. |
Post-Pay General Settings
The General Settings allow you to control basic SolusIO settings.
| Setting Name | Description |
|---|---|
| Post-Pay Terms & Conditions | An optional URL to the terms and 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 for invoices 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. |
Post-Pay Suspension
The Suspension settings allow you to control settings for service restrictions for non-payment of Post-Pay usage.
| Setting Name | Description |
|---|---|
| Lock Overdue Users | The number of days 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 to allow before suspending a user account in SolusIO. This is the number of days from the due date. |
Settings
The Settings tab allows you to modify connection and pricing settings.
Post-Pay Token Pricing
You must set Token Pricing for each active currency within WHMCS.
- You can set Token Pricing with up to four decimal places.
- Enter prices as the total price in each currency for one unit of token usage.
API Connection
The API Connection panel can modify and update the installation URL and API key at any time.
To make a change, enter the installation URL and an API key and then click Test Connection. If a connection is successful, WHMCS will update the URL and API key that it uses.
WHMCS Billing Integration
Within the SolusIO product, you can configure Billing Integration Settings.
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 these values for you every time the WHMCS SolusIO module and SolusIO target instance establish a connection. You cannot generate and set these values manually.
To reconfigure the connection, you must reestablish the API connection with the SolusIO target instance. To do this, use the API Connection panel in the Settings tab of the SolusIO WHMCS integration module.
FAQ
How do users sign-up?
With the Post-Pay Model of billing, there is no purchase or order necessary. Users can sign up or activate their SolusIO user account via the provided landing page.
The enrollment process requires that the user create a WHMCS client account, complete email verification, and agree to your Terms of Service and (optionally) Post-Pay specific Terms & Conditions. This process uses the following workflow:
- The user requests creation of an account for VM provisioning.
- The user enters their name, company, email address, and a desired password.
- The user receives an email containing a link to complete the signup process.
- After they click the link, the user must agree to your Terms of Service and Post-Pay Terms & Conditions.
- SolusIO provisions the user account.
Users can then access SolusIO at any time via a provided SSO link in the Client Area homepage.
How do users access the SolusIO system?
With Post-Pay, customers use the SolusIO control panel to provision and manage virtual machines. The Client Area homepage will show one of the following panels, depending on the user's current SolusIO enrollment status:
Enrolled users can click Log in to SolusIO to access the SolusIO control panel via automated single sign-on.
Unenrolled users can use a shortcut to the provided landing page to learn more and sign up.
How does invoicing work?
The system generates invoices on the first of each month for all accrued usage in the immediately preceeding month. For example, on the 1st of August, it will generate invoices for usage by all users in the month of July.
How does the system calculate usage?
SolusIO tracks the uptime of every virtual machine. It bills uptime at the hourly rate of tokens that you define within the SolusIO software.
When it becomes time to generate an invoice, WHMCS will request the uptime totals for each user from the SolusIO system. It creates an invoice with an itemized list of resources (aka virtual machines) and the amount due. The amount due is the token usage value in the SolusIO system multiplied by the token pricing in WHMCS.
How is billing triggered?
A cron task manages invoice generation and user management. The system executes the cron task automatically once per day, and you can trigger it manually using the following command:
php crons/cron.php do --SolusioAutomation -vvv
Invoice generation only occurs on the first day of each month.
Troubleshooting
N/A
Change Log
N/A