Configuring the OnApp Billing Plugin

The OnApp Billing plugin integrates with any OnApp platform version to bill your clients for their monthly usage. Once your OnApp usage service renews, your client’s usage stats and the total amount due for the previous period is calculated. The OnApp usage pricing and total due each month is determined by OnApp. Ubersmith simply retrieves the details for billing.

In order to begin billing for this service, you need to configure Ubersmith. Once all the necessary pieces have been configured, any current or new service based on the service plan will be ready. The configuration steps are as follows:

1. Configure Ubersmith (below).
2. Enable the OnApp Billing plugin 
3. Configure the OnApp Billing plugin (below).
4. Disable your OnApp service module, if necessary (below). 
5. Configure your OnApp service plan (below).
6. Configure your OnApp service (below).
7. View OnApp usage 

Configuring Your Ubersmith Instance

• Upgrade to Ubersmith 4.4.0 or later.

Configuring the OnAPP Billing Plugin

1. Access the Plugins page 

2. Click OnApp Billing plugin.
   
   The OnApp Billing plugin page appears.

3. In the OnApp Billing Datasource section, under Modules, click add new.
   
   The Associated Components and Configuration sections appear.
4. Click in the Datasources field to display datasource options and select OnApp Billing Datasource.
   
5. In the OnApp Instance URL field, type your OnApp URL.
6. In the OnApp Username field, type your OnApp user name.
7. In the OnApp Password field, type your OnApp password.
8. In the Request Timeout field, type your desired timeout in seconds. Using zero results in no timeout and is not recommended, because it can result in daily invoice runs being blocked if your OnApp host is unreachable.
   
9. Click save.
   
10. Click Show Instances to display your configuration settings.
    
    
    

Disable Your OnApp Service Module

If you are currently using the OnApp service module, you will need to disable the service plan and the related custom fields. If you do not have the OnApp service module configured, skip this section.

1. Access your OnApp Service Plan Details page.
2. In the Service Module section click edit in the OnApp Billing row.
   
   The Edit Service Module page appears.
3. In the Enabled field, click No to disable the module.
4. Click Update.
   
5. In the Custom Field Defaults section, click edit.
   
   The Edit Service Plan page appears.
6. In the OnApp Billing section, in the Applicable field, select Disable All.
7. Click Update.
   

Configuring the OnApp Service Plan

The service plan can be configured in numerous ways depending on what OnApp services you offer. There are four different billing method options available in Ubersmith, VM resources only, all resources, vCloud resource pool, and CDN resource ID. If you primarily use only one of the four, such as only virtual machines, select that one. Alternatively, you could set up four different service plans, one for each billing method.

1. Add an OnApp service plan, if necessary.
2. Access your OnApp Service Plan Details page.
3. In the Pricing & Period Defaults section, click edit.
   
   The Edit Service Plan page appears.
4. In the Config tab, in the Post Renew field, select Yes to bill at the end of the service period.
5. Click Update.
   
6. In the Usage Plan section, click add usage plan.
   
   The Add Usage Plan page appears.
7. In the Usage Plan Name field, type OnApp Billing.
8. In the Data Source table, select OnApp Billing Datasource.
9. Click Save and Add Resources.
   
   The Add Resources page appears.
10. In the Resource Name field, type OnApp Billing.
11. In the Resource field, select OnApp Billing.
12. In the Markup field, enter either the fixed price or the percentage you want to mark up your resource, and select either the percent or dollar sign, if desired. If you do not want to mark up the price, leave as is.
13. Click Save.
    

Configuring OnApp Services

Before configuring your client’s individual services, ensure you have configured the OnApp Billing plugin and the related service plan these services are based on first.

1. Access your OnApp Service Plan Details page.
2. In the Add Service Wizard, create the basics of your OnApp service.
3. Access the OnApp Billing Service Details page.
   
   A message saying your service's OnApp Billing Method must be configured displays.
4. Click x to clear the message.
5. In the Usage Plan Rate Properties section, click configure datasource.
   
   The OnApp Billing page appears.

6. In the OnApp Billing Method field select User ID - All resources.

7. In the Billing Method ID field, enter your client’s corresponding OnApp ID to be used for the service.
8. Click Save.