Interworks Cloud Platform & WebSitePanel Integration
Interworks Cloud
Platform &
WebsitePanel
Integration
Getting Started Guide
This document contains information proprietary to Interworks and its receipt or possession does not convey any rights to reproduce, disclose, manufacture, or sell anything it might describe. Use without Interworks’ specific written authorization is strictly forbidden. Interworks makes no representations or warranties with respect to the contents or use of this document, and it reserves the right to revise this document any time, without the obligation to notify any person or entity of revisions. Further, Interworks assumes no responsibility or liability for any errors or inaccuracies, makes no warranty of any kind (express, implied, or statutory) with respect to the contents or use of the information, and expressly disclaims any and all warranties of merchantability, fitness for particular purposes, and non-infringement of third-party rights.
Interworks, the Interworks logo, the Interworks Cloud Platform logo, the Interworks Cloud BSS logo, the Interworks Cloud Storefront logo and the Interworks Cloud OSS logo are registered trademarks of Interworks. All other trademarks are the property of their respective owners.
Interworks
Interworks Cloud Platform & WebsitePanel Integration Getting Started Guide Contents
About this guide ...5
Introduction ...5
Support and feedback ...5
PART ONE ...6
Fundamentals ...6
1.
Integration of the Interworks Cloud BSS with WebsitePanel ...6
Resource Management in Website Panel ...9
What is Hosting Plan? ... 10
Creating Hosting Plans ... 10
What is Hosting Add-On? ... 10
Creating Hosting Add-Ons ... 10
2.
Set up your Accounts ... 11
3.
Create a BSS Account and synchronize it with WebsitePanel ... 12
3.1 Synchronize existing Accounts ... 13
3.2 Import Data Wizard ... 14
4.
Give access to your Customers in Storefront Platform ... 19
Storefront Settings ... 21
Rebranding ... 25
5.
Create a new product ... 32
Configurable Products ... 35
Create and Use Pay per Use Products ... 36
BSS and WSP actions ... 41
6.
Manage your Sales ... 42
Subscription Management ... 42
Execute an Order ... 43
Add On, Upgrades/Downgrades ... 44
Subscriptions’ Upgrade/Downgrade ... 45
Payments ... 46
7.
For Storefront Users ... 47
Billing Page... 48
8.
Provisioning in Storefront ... 48
9.
Automated Ordering and Billing Process ... 50
Storefront Registration ... 50
Checking out from Storefront Basket ... 50
Automated Subscription creation and renewal ... 51
Automated suspension and cancellation of the subscriptions ... 52
PART TWO ... 53
Beyond the Basics ... 53
10.
Price Lists ... 53
11.
Contracts / Sales Terms / Rebates ... 54
Contracts Home Page ... 54
Create a Contract ... 54
Contracts Sales Terms ... 54
12.
Sales Module ... 55
Create an opportunity ... 55
Create an offer ... 56
13.
Support Management ... 57
What is a Case ... 57
Create a Case ... 57
14.
Marketing Module ... 59
Manage Campaign and Leads ... 59
What is a Campaign and a Lead? ... 59
Convert a lead / customer / opportunity ... 60
Promotions ... 61
15.
Payments ... 62
Manage your Resellers ... 70
Working with Resellers ... 71
Business Intelligence ... 73
Interworks Cloud Platform & WebsitePanel Integration Getting Started Guide
About this guide
Introduction
This guide provides instructions for integrating Interworks Cloud Platform with WebsitePanel.
Note: This guide is updated as new information becomes available. Before you begin, be sure to check downloads section of the Interworks Cloud Platform support site,
http://www.interworkscloud.com/downloads.en.aspx , to make sure you have the latest
version of the guide. The publication date on the title page indicates the version.
Support and feedback
To receive support for the Interworks Cloud Platform you can visit http://www.interworkscloud.com in order to have access to product downloads and online help and documentation.
PART ONE
Fundamentals
1. Integration of the Interworks Cloud BSS with WebsitePanel
Interworks Cloud Platform integrates with various provisioning services. In the following steps you will be able to see how you can integrate Interworks Cloud Platform with your Website Panel (WSP) provisioning service.
Note: Website Panel 1.2.1 and 2.0 editions are live
To begin with, from your BSS platform you need to set up the integration with WebsitePanel.
Interworks Cloud Platform & WebsitePanel Integration Getting Started Guide
In the Provisioning Platform field, use the drop down menu, to choose WebsitePanel as your provisioning platform.
In the Web API URL field, enter your domain followed by “/webserveapi” (eg:
http://wspportal.mydomain.com/webserveapi)
In the username and password fields, enter the right credentials for User Name and Password of your User in WebsitePanel.
Note: here you enter the User Name and Password of the root user. Each user created or synchronized, should have this user as the “parent” user.
On Default Hosting Plan the user should choose the Hosting Plan of the WebsitePanel which your products and services are based on. (given that you have already defined Hosting Plans in WebsitePanel)
All products connected to a Hosting Plan or a Hosting Add on will be provisioned Through BSS platform End users can instantly check their resources as well as their remaining usage quotas from Storefront.
Note: We also support integration with multiple provisioning platforms (WSP, CPSM). The integration may also be
Interworks Cloud Platform & WebsitePanel Integration Getting Started Guide Resource Management in Website Panel
Resources is the umbrella term used to describe the hosting servers on which services are installed as well as the physical/logical resources on hosting servers, such as mailbox stores and public folder stores for Exchange.
Resources are managed in groups called hosting spaces. A hosting space can be a combination of several services and a hosting space can be allocated to one specific organization, one specific reseller or even be deployed in a remote datacenter.The service provider system administrators can manage the resources and hosting spaces using the service provider control panel.
What is Hosting Plan?
Hosting plan is a set of hosting resources and their corresponding quotas. Hosting resources here are set of services located on a single server of several servers (combined into one entity by mean of “virtual server”). Hosting plan is used as a template for creating customer hosting spaces.
Creating Hosting Plans
To view the list of hosting plans of some reseller click "Hosting Plans" item on the left User Account Menu.
To add a new hosting plan click "Create Hosting Plan" button. Hosting Plan quotas are based on your specific hosting space.
What is Hosting Add-On?
Hosting add-on is a set of hosting resources and corresponding quotas. Hosting add-ons allow extend quotas of existing hosting space without affecting its parent hosting plan. Think of hosting add-ons as a small part of a hosting plan with few quotas assigned.
Creating Hosting Add-Ons
Interworks Cloud Platform & WebsitePanel Integration Getting Started Guide 2. Set up your Accounts
One of the first things you need to do is to import your accounts and contacts and synchronize them with WSP before you start working with your Customers
Click on the “Add” button in Account’s Home Page or, Click on “New Account” In quick create menu Insert all the necessary information and details of the new Account.
When the new Account is enabled for ordering, then billing Information fields are turned on to compulsory.
In ordering section you can define the payment method (i.e. credit card), registration number, as well as your pro rata billing schedule. Pro-rating is the day of the month that the customer will be invoiced. You can enter only specific values (first or last day of the month and values from 2-30). When Customer’s pro-rating is 1 means that the customer will always be invoiced the first day of the month. When the pro-rating is disabled means that the invoices will be generated the day that the subscriptions are activated or at the end of the billing period.
When all Account’s information has been completed click “Save” and go to shortcut menu and click “Add Contact to create Account’s Primary contact. Complete the necessary information. Don’t forget to enter Contact’s e-mail address and to set the contact as “Primary Contact” by enabling the appropriate check box. If you want to set the contact to receive the invoices you should enable the option “Bill to contact” in contact’s detailed view page.
For each Account there is a list of contacts you can associate with. You can keep all your important contacts, manage them, edit them, and assign them with the Account.
Important: Note that the drop down list “Type” might contain a type equal to “Customer”. However, this field
does not characterize the Account as Customer. There is a section where you can define the payment method (i.e. credit card) as well as your pro rata billing schedule (Pro-rating is a feature to allow the invoicing procedure at a certain date. When you have a recurring order, it will generate an invoice per period, for example, a monthly invoice).
3. Create a BSS Account and synchronize it with WebsitePanel
Your Customers/Accounts will have to be synchronized with WebsitePanel, in order to take advantages of the provisioning services provided by Interworks BSS.
To synchronize an Account, you must enter an email address for the Account and you must mark the Account as a Customer (to do so, check the checkbox “Is Customer”, while creating or editing the Account). You should have also established the connection between the two systems as shown in paragraph “Integration of the Interworks Cloud BSS with WebsitePanel”
From the main Account page and the left Shortcut Menu select ‘Synchronization Option’ and fill in the user name and role. There are two types of roles:
(a) Resellers (b) Users
You should use the role "Reseller", whenever the Account is a Reseller and the role "User" whenever the Account is a simple User. Resellers are able to create Hosting Plans based on their quotas, whereas End users are able to use only the particular quotas you have given them.
Enter the appropriate user name and click “Save and Synchronize”
If the synchronization is successful, an Account will be provisioned in WebsitePanel.
Attention! When deleting an Account from BSS, which is synchronized with WSP, the system will also delete the corresponding Account in WSP.
Interworks Cloud Platform & WebsitePanel Integration Getting Started Guide Note: Please make sure that the BSS user was given the permission to sync (set up-administration-users-user permissions – see image below).
3.1 Synchronize existing Accounts
3.2 Import Data Wizard
A Wizard for importing your Customers from WebsitePanel to Interworks Cloud BSS is implemented to help you sync up the two systems. Using the Import Data Wizard, you can import all of your data from WebsitePanel easily, without having to recreate your Customers in BSS manually. The wizard will import your hosting plans, hosting add-ons and your customers in Interworks Cloud BSS. It will also create active subscriptions for the customer’s hosting spaces found in WebsitePanel. The wizard will fully sync up the two systems and you will be ready to immediately start using Interworks Cloud BSS for managing your subscription business.
The wizard will run the first time you log in in Interworks Cloud BSS and during wizard, you will:
setup the connection between Interworks Cloud BSS and WebsitePanel,
specify which of the hosting plans and add-ons you have in WebsitePanel will be imported as products in Interworks Cloud Platform,
create subscriptions in Interworks Cloud Platform for each customer space in WebsitePanel
select what type of users will be imported as Accounts in Interworks Cloud BSS (all the users or only the active users),
decide whether you want Storefront users to be created for your Customers
Note 1: The wizard only runs automatically the first time you login to BSS. If you chose not to run the wizard at that time, you can access the wizard by clicking in the link “WebsitePanel: Import” in Imports in Progress section on the right side of your Home Page (See paragraph “Step 1”). You may also start the wizard from Setup by going to Setup > Administration > System Options > Provisioning Platform Setup. There you can see the button for Importing Data from WebsitePanel.
Note 2: After running the wizard successfully, the link on the Home Page disappears. Each Account you want to create after running the wizard, should be first created in BSS, and then synchronized with WebsitePanel (see paragraph “Create a BSS Account and synchronize it with WebsitePanel”).
In the next of this paragraph we will discuss each step of the Wizard in detail.
Step 1:
Interworks Cloud Platform & WebsitePanel Integration Getting Started Guide
If you chose to run the wizard another time, you can access it using the link in the Home page. In every step you can chose to stop the execution of the wizard and start it another time from where you were left.
Note: It’s important to know that you can only run the wizard only one time. Step 2:
In the second step of the wizard, you should set up the connection between the two systems, so that they can communicate with each other. In the Web API URL field, you should enter the name of your domain, followed by “/webserveapi”. In the username and password fields, you should enter your credentials for WebsitePanel. When you are done, you should click on the “Test Connection” button, in order to verify the connection between the two systems. If everything is ok the message shown in the next screen will appear, and you can then click on the “Next” button.
Note 1: in the Username and Password you should enter the Username and Password of the root user ( the user that you use to login in WSP) Each user created or synchronized, should have this user as his “parent” user.
Note 2: the information that you’ve entered here, can be accessed later on from BSS’s Setup. Simply go to Setup > Administration > System Options > Provisioning Platform Setup.
Step 3:
In this step you can view system’s suggestions on which products to create based on your Hosting Plans and Hosting Add-ons from WebsitePanel. You may modify the names of the Products and you may also specify the appropriate Price/Month. Month is the default billing period, but you may change this option later on from BSS. In this step, you may also enter the appropriate Product Types for each of your Products and Add-ons. Note that an Add-on can only be added to a Product that has the same Product Type as the Add-on. So in order to add Add-ons to your Products, you must insert the same Product Type for both Products and Add-ons.
After completing all the necessary information, you may click in the “Next” button.
Step 4:
In this step, all your users from WebsitePanel will be imported to Interworks Cloud BSS. In BSS, Accounts represent your Customers. An Account may be associated with many Contacts. Contacts are the individual persons, for example “Tom Jones”, “George Smith”, etc., that are associated with each Customer. After successfully running the Wizard, for each of your WebsitePanel users, an Account and/or a Contact will be created based on WebsitePanel user’s info.
At the beginning of this step you can see how many users you have in WebsitePanel and how many of them are active. You can choose to import only your active users or all your users (including the suspended users) by clicking in the appropriate radio button.
In the Billing Day text box, you are given the option to enter the Billing Day that you want your Accounts to have. If you do not use prorata billing you may leave this textbox blank. In case you decide to change this option later on, you can do so, by changing the Billing Day field in the appropriate Account using BSS (Office > Accounts).
Interworks Cloud Platform & WebsitePanel Integration Getting Started Guide Step 5:
In the fifth step, the user is informed that a subscription will be created in Interworks Cloud BSS, for each space found in WebsitePanel that belongs to an active Customer.
For each space a monthly subscription will be created and the subscription’s amount will be the monthly charge defined in step 3.
Step 6:
This is the final step of the Wizard. In this step, the import procedure begins. While the procedure is in progress you won’t be able to make any changes.
After the successful execution of this procedure, you will see what is automatically created for you in BSS in detailed log.
In case the procedure fails, an appropriate message will appear (see Image below), and you will be able to rerun the wizard in order to correct any mistakes by clicking the “Try Again” button.
Note:
a) The most common mistake is to select different Product Types for your Products and Add-ons. As we have discussed in a previous paragraph, Add-ons can only be applied to Products with the same Product Type. In case that this is your mistake, you can click on the “Try again” button, and you will be redirected to Step 3.
Interworks Cloud Platform & WebsitePanel Getting Started Guide 4. Give access to your Customers in Storefront
If you wish to give access to Storefront for one of your customers, you should do the following: Verify that the Account, to which Contact is assigned, is enabled for ordering.
From the Contact’s detailed edit page enable the option “Storefront User” and configure the access of your customer by setting his user name and password.
After filling “Storefront User” section with the appropriate credentials (username and password) click “Save”. A new Storefront user is created for that Contact. The Contact can use these credentials along with the URL you have provided him, to enter Storefront, from where he can change his password and manage his Account.
Important Note: In order to give access to Storefront to a Contact and send a welcome e-mail you should declare a
System mail Account in Setup Area. To do so, go to “Setup > Administration > System Options > Organization
Profile”. On the Email Preferences section, enter the appropriate credentials of a valid email account and click on “Save”
(see paragraph Notifications and E-mail Templates). You should also verify that a system notification named “Welcome to Cloud Storefront” is active.
Interworks Cloud Platform & WebsitePanel Getting Started Guide
Storefront Settings
General
Go to Setup > Administration > System Options >Storefront Configuration and set different colors, images, for your storefront page.
On this page, you can set up the basic parameters for your Storefront. Those parameters refer to settings like the storefront access configuration or the information displayed. In the first section, there are General Settings. Those include the following settings:
Storefront Page Title. You can enter a title for your storefront, which is the title displayed on the browser tab for your
Storefront
Storefront Alias. You can define an Alias for Your Storefront. This means that a URL with your storefront alias will be
created and the users who use this URL will not have to enter the organization ID, but only their username and password.
Note 1: If you choose not to enter an alias to your Storefront, you should provide your Customers with the appropriate Organization Id along with the username and password that you have entered when giving access to Storefront for one of your Contacts.
Storefront Host Header. It enables the Alias defined above. When this option is not checked, then the URL with the
Alias is inactive.
Show Prices to logged in Visitors. When this option is checked, the product prices are displayed in your Storefront.
Otherwise, the prices are not displayed at all.
Include VAT in prices. When this option is checked, the prices displayed in your Storefront is the total amount, tax
included.
Display Invoices. When this option is enabled, the option “Billing” is displayed in the storefront top menu and the user’s
invoices are displayed. Otherwise, the option “Billing” is replaced by the “Subscriptions” option and there are only the user’s subscriptions displayed.
The next section is the Enable Anonymous Access section. Since you have defined an Alias for your Storefront the
organization id is not necessary to log in, you can define whether you prefer users that are not logged in to have access to your storefront. If you enable this option, users who are not logged in will be able see the home page and the product catalog of your Storefront. Since anonymous access is enabled, you can define the following options:
Allow self – registration. When this option is enabled anonymous users will be able to register themselves, filling the
Show prices to anonymous visitors. When this option is checked, prices will be displayed when a non logged in user
is navigating through the storefront.
When having the “Check to allow anonymous access” checkbox checked, you allow anyone to navigate around your Storefront page, and see your Products Catalogue, without having to login to your system. Additionally, with this checkbox checked, you are giving visitors the option to register to your Storefront. We will discuss this option in detail in the rest of this paragraph.
Note: You cannot check the “allow anonymous access” checkbox, if you don’t use an alias.
Self-Registration Settings. This section appears only when the anonymous access is enabled. Those settings include: Payment method. You can choose the default paying method for the users registered.
Enable Prorate Billing. Prorate billing can be defined for the Accounts created by users registered. When this option is
checked, the “Partial Charges Invoicing” is enabled and you can choose the day for the partial invoicing.
Auto invoice notification. When it is enabled, the users receives notifications for his/her invoices.
Self Registration Settings . When you choose this option to be enabled, you have to enter a pricelist which will be
used for the resellers. You enter the pricelist, clicking on the magnifier on the right. In order to be able to enable this option, there must have been defined a responsible user for the resellers in Setup > Administration > System Options > Use of API Usage. (go to Storefront Registration page for more details).
The registration process is completed in WebSitePanel when a storefront user places an order. When a visitor registers online, the system creates an Account and a Contact in BSS but the account is not provisioned in WSP. The provisioning must be performed manually from an Account Manager by filing his sync options in BSS. In this version we automatically set account’s synchronization options as follows:
Role: It will always be user
Interworks Cloud Platform & WebsitePanel Integration Getting Started Guide
When the customer places his first order, the system will first provision the customer in WSP and then it will execute the order for provisioning his services.
In the “Sections Activation” section, you can define the following options:
Suggestions to Customers. By enabling this option, the “Customers also bought” section is displayed at the bottom of
the product view page.
Enable Most Popular Products section. When it is enabled, the “Most Popular” section is displayed in the Storefront
Home Page. You define the products that will be displayed in this section by defining the period in which you want to get the most ordered product.
Enable New Products section. By checking this option, the “New products” section is displayed in the Storefront Home
Page. In this section, the products that have been added in “Home Page New Products” will be displayed.
Home Page Offers. You can add the products that will be displayed in the “Offers” section in the Storefront Home
Page. You have to click on the magnifier, which will display a list of the products that are under promotion. You choose the product you want and click on the “+” sign to add in the list below. You can re-arrange the products by the arrows on the right.
Home Page Featured Products. You can add the products that will be displayed in the “Featured” section in the
Storefront Home Page. You have to click on the magnifier, which will display a list of the products that you have categorized as “Featured” in the Product Storefront Settings. You choose the product you want and click on the “+” sign to add in the list below. You can re-arrange the products by the arrows on the right.
Home Page New Products. You can add the products that will be displayed in the “New” section in the Storefront
Interworks Cloud Platform & WebsitePanel Integration Getting Started Guide Rebranding
The rebranding tab contains all the options concerning the storefront appearance configuration, such as colors and fonts.
General. In this section you can define basic settings for your Storefront appearance.
Font Family. You can enter the fonts you want to use in your Storefront and their default Size.
Default Font size / Font Color. You can define the size in which the font is displayed on your Storefront.
Headers & Tab Color. You define the color of the current active tabs (for example on the product view page
as you can see in the picture below, in which according to the settings in the picture above, the active tab color is orange)
Default Text Box Background Color. The background color of the text boxes (like the username textbox in the Login page) on your Storefront.
Modal pop up Background Color. You can define the color of the modal pop up in your Storefront. This color fills the screen when a page is loading.
Login Page. Incudes the view of the Storefront Login Page.
Background Color. The background color in the Login Page.
Login Page Logo. The Logo displayed in the Login Page. When you click on the “Click to Replace” option, three options appear: You can upload an image, you can insert a URL or you may delete the image you have defined.
Storefront Header. Includes the settings for the Header.
Header Logo. The Logo displayed on the left top corner of your Storefront. When you click on the “Click to Replace” option, three options appear: You can upload an image, you can insert a URL or you may delete the image you have defined.
Interworks Cloud Platform & WebsitePanel Integration Getting Started Guide Footer. Includes settings for the Footer.
Background Color. The Color of the Footer of your Storefront. Font Color. The Font Color on the Footer of your Storefront.
Trade Mark Text: This text is displayed at left lower corner of the page
User Custom Footer. Since this option is checked, you can modify the footer of your Storefront through the editor underneath.
Background Color. The color of the Background of the navigation menu on the top.
Active Background Color. The color of the active option in the top navigation menu.
Font Color. The font color of the top navigation menu options.
Service Catalogue. The following options are not applicable to the new Storefront.
Price Color.
Group Header Background Color. Group Header Border Color. Group Header Font Color.
Service Characteristics Category Background Color. Service Characteristics Category Active Background Color. Service Characteristics Background Color.
Service Characteristics Label Color. Service Characteristics Value Color.
Promotions. Settings for the promotions displayed in Storefront.
Special offer large image. Not applicable to the new Storefront. Special offer small image. Not applicable to the new Storefront.
Interworks Cloud Platform & WebsitePanel Integration Getting Started Guide Buttons: The configuration applies only to the Product view page buttons on the new Storefront.
Background Color. The color of the buttons.
Font Color. The color of the text in the buttons.
Border Color. The color of the borders of the buttons.
Terms of Use. In this section you can define the terms of use for your Storefront. On the left side of the footer there is
Storefront Banners
On this page you can add banners to your Storefront, by upload and editing them in each editor. So, you can add the following banners:
Home Page Banner. It is the banner displayed on Home Page, underneath the navigation menu on the top (in the
image below you can see the editor in which you can add and modify the Home page Banner).
Apps & Services Banner. It is the banner displayed on the Apps & Services Page, under the navigation menu on the
top.
Offers Category Banner. It is displayed on the Offers Category page. If no banner has been added, the banner you
have added for the Apps & Services Page will be also displayed on this page.
New Products Category Banner. It is displayed on the New Products Category page. If no banner has been added,
the banner you have added for the Apps & Services Page will be also displayed on this page.
Interworks Cloud Platform & WebsitePanel Integration Getting Started Guide
After completing the form, the visitor must check the “I accept the Terms of Use” checkbox and click the Register button. By clicking the Register button, the visitor is logged in automatically to your Storefront, and an appropriate Account is created in BSS. The Account name is the Company name the visitor had entered in the above form. A Contact is also created, using the First Name and Last Name, the user had entered. This Contact has access to Storefront with the username and password he had entered in the above form.
You can see the created Account and Contact in BSS, by going to the appropriate modules.
Note: A user from your BSS must be responsible for the Account and Contact that will be automatically created after the registration of a visitor. In order to register an Account, you should create the appropriate permission rules and select the appropriate access rules for API usage.
You can do so by first creating permission rules. Go to Setup > Administration > Personal Setup >
Permission Rules and create an appropriate permission rule (see paragraph Permission Rules for more
details).
After creating an appropriate permission rule, you should go to Setup >Administration >System Options
>Storefront Configuration > Automation Options > Use of API options, and enter the name of the
Responsible User and the permission rules for the related modules (Accounts, Contacts, Invoices, Orders, Subscriptions) and click on the “+” button.
5. Create a new product
To create a product, choose one of the following steps:
Click “Add > Add Product” from “Product’s’ Home Page Click “New Product ” using Quick Create menu
In the following page you will have to insert your Product’s details:
Choose whether the product can be Primary or Add-on product, by selecting the appropriate radio button next to the field “Define Product as”.
Products marked as Add-ons, can be added to Products given that they have the same Product Type.
Interworks Cloud BSS supports 3 different charge types.
o “One time charge”: you use this type of charge for products with non-recurring charge, e.g. Mobile phone. For products of this type of charge, there is no need to create subscriptions.
o “Recurring charge - prepaid”: you use this type of charge for products with recurring
charges, for example every month. For this type of products, appropriate subscriptions must be created when a customer buys the product
o “Recurring charge – Pay-per-use (PPU)”: you use this type of charge for products that
you want your customers to be charged based on the usage of the product. When selecting this type of charge, you can import an excel file to the system (See paragraph Usage Charges) and the appropriate subscriptions will be update.
Important Notes for PPU products:
1. This type of products cannot be upgraded or used for a trial period. 2. You cannot select this type of charge for Add-ons
3. You can choose to charge a PPU product, with two different ways:
a. Charge for partial billing period: you charge the Customer for the days that he used the resource
b. Charge for the whole billing period: you charge the customer for the whole billing period regardless the days that he actually used the resource
4. In the edit of a PPU product, you can choose to edit pricing info by going in the Pricing section in the Product’s detailed view page.
o In the Recurring Charges tab, you can edit the recurring pricing info, such as Purchase and Sell Price for the product, discount list applied, etc.
o In the Usage Charges tab, you can set for which of the Product’s resources, you want usage charges to be applied and what is the type of your resource (metered/allocated – See Paragraph Usage Data). You should also specify which add-on will be used to charge every resource.
The product type will be a drop-down menu where the product types are grouped by the following way:
o There will be a group for each Provisioning Platform that is activated. So, if a customer has the CPSM enabled, you would see the group “Citrix CloudPortal Services Manager” and underneath a list of the system product types derived by CPSM. If a customer has integrated more than one CPSM, then the group name will be “Citrix CloudPortal Services Manager - <INSTANCE NAME>”
o All the web apps that have been enabled (e.g. Panda, FileLocker etc.) will be together under the group “Cloud Apps”.
o All the rest product types that are not system product types, they will be grouped under the
group “Rest Apps”.
Choose the VAT Category for the Product, Unit of Measure, etc.
Choose Industry from the relevant field. This field is a drop-down menu and the user can insert Industries at Setup > Billing > Products > Industries. (this field will be disabled if the product belongs to a product group.
Choose a Category field. (This field will be disabled if the product belongs to a product group). You should also add the Price and the set up fees for your Product, as well as the charge type in
pricing section by selecting the relevant radio buttons (recurring/one-time charge).
If a Product has some special Product characteristics you can fill the appropriate info in the section Product Characteristics.
Trial Products/Services are used to present Services or Products to customers for a short period of time in order to familiarize themselves, and more accurately decide whether they want to buy or not, the specific services or products in the future. Interworks Cloud Platform provides the following abilities:
Create a trial-product for a specific customer for a specific amount of time. Trial Period can be days or even months.
The Number of Trials per customer can be “Total” (i.e. for a specific customer only a specific amount of trials for the same product can be used only once).
The Number of Trials per customer can be “Concurrent” (i.e. For a specific customer only a specific amount of trials for the same product can be used for several times).
Trial Period can be extended. (Users with the appropriate permissions can extend trial subscriptions. This option is enabled in setup > users)
Trial Products/Services can be managed and monitored through BSS and Storefront.
Configure your Products/Services as trials by setting trial period and number of trial per customer. Trial Subscriptions are not charged.
On a Product’s Detailed page view, click “request for trial” to create a trial subscription. Using the Shortcuts menu, you can specify whether the product will appear on your Storefront or
Interworks Cloud Platform & WebsitePanel Getting Started Guide Configurable Products
Configurable is a product that his price changes based on selected order characteristics. The differences from the normal product are the following:
The product price is from XX / month where XX is the price of the minimum configuration
Underneath product’s general info the “Configure your service” section is displayed. This section displays all products’ order characteristics grouped by properties groups.
The groups will be displayed based on their position and underneath the group a description is displayed.
When the user presses the “Calculate cost” button the estimated price will be displayed on the right:
All the information that normal products have in “Pricing and Add-ons” section, all units, setup fee, and discount lists are also displayed.
Connect a product with a hosting plan
Create and Use Pay per Use Products
OverviewPay-per-use products accommodate the need of customers to have access to potentially unlimited resources but only pay for what they actually use.
Pay per use products are handled by the system as recurring products, meaning that a subscription is assigned to them upon ordering, and thereafter the additional ordered resources are monitored and tracked in the subscription.
Create a Pay-per-use (PPU) product
Either from billing menu, select Products and in Products List select "Add" or by selecting "Quick create" menu select "New Product".
The New Product screen will appear. Enter Products’ compulsory information marked with an asterisk.
subscription, b) Charge the whole billing period, meaning that product will be charged for its whole value for the dates that apply for the subscription.
Note: A Pay-per-use product cannot be defined as a Trial or as Add- on product.
Product Pay-per-use Fields
Usage Charges
There are two types of resources that can be defined for a Pay-per-use product. These are named as allocated and
metered resources.
a) Metered Resources. These are resources that are calculated and invoiced for one billing period and then for the next billing period measurement starts from the beginning. Such a resource is e.g. the bandwidth of a web site. In order to charge the bandwidth that has been consumed by a web site, there is the need to measure the total bandwidth that is consumed in a given period and perform the relative charges. For the next billing cycle bandwidth should be re-measured.
b) Allocated Resources (e.g. add-ons). These are resources that are used when a customer will be billed each billing cycle until the resource is cancelled by the customer. Such a resource is e.g. the CPU cores of a Cloud Server. If e.g. a usage file inserted to the system defines that a client has added a CPU core in a virtual machine, then this resource should be added as an add-on on the subscription of the virtual machine and should be charged on the following month too.
In the view page of the product one can find in the field "Pricing" the tab "Usage Charges" that contains the action "Edit Usage Charges" in order to specify which resources could be charged based on usage. Displays a pop-up with the following:
Resource. Is a list of all the product characteristics that relate to the resources.
Usage Type. As mentioned above there are two kinds of resources: the allocated and metered resources. This parameter
specifies what type is the resource. The drop-down menu contains two options: a) Metered and b) Allocation.
Add-on for charge. The use of resources will be billed through add-ons. So for each resource that it is charged based on
usage, there is the need to define based upon which add-on charges will take place. All the add-ons of the PPU product that have been set with a value for the selected product characteristic will be displayed.
Charge Rule. This field is meaningful only for usage type = allocation. For metered resources does not make sense because
the quantity of the resource in multiplied by the unit price. For metered resources becomes disabled. The values set in this field corresponds to the field "Usage Charge Rule" as in the PPU product.
Important: You cannot select twice the same resource.
PPU product in a n offer / order
A PPU product can be inserted in an offer or an order so as at the end a subscription to be created.
Click "Sales > Offers" or "Sales > Orders" depending on what needs to be created and in the field "Products" in Offer/Order select a PPU product. After completing all the compulsory fields of the Offer/Order, click on the cross sign in order to insert the PPU product to the Offer/Order.
After inserting the PPU product, a green line will appear under the product name denoting that: "This product is billed based on usage" and there would be no quantity. Click the cross sign once more in order the product to be inserted.
Execute an order with PPU product
Note that in the product’s tab of the order the PPU product will be marked with the flag "Bill on Subscription End Date". This will denoted by an arrow pointing on the right, next to products name. This is done because PPU products are always charged by the end of the subscription.
The quantity of the PPU product would be zero in the order since the PPU cannot be charged before it is being used thus in a retrospective way.
Selecting to "Execute Order" from the Shortcuts menu the order would be executed thus creating the relevant subscription.
Create a subscription with PPU products
You can create a subscription for a PPU either through an Order or by creating a new subscription from section "Billing > Subscriptions" and selecting the relative PPU product.
A subscription for a PPU product will be characterized it by a distinctive green line on top denoting that "This subscription is billed based on usage". The Quantity of the subscription starts with a zero value and only after it holds a value, usage data for the resources can be inserted.
In the Edit of the subscription the field "Billing Option" states "On Subscription End" and cannot be changed. This is so because the subscription would be invoices at the end of the billing cycle.
In the subscription, after usage data have been inserted, there would be three tabs in a section called "Add-on":
a) Tab "Pay-per-use Data": In this tab will be shown all changes made to the quantity of the subscription including also the following information
Date. The date the change was made to quantity. For imported usage record it is the Start Date of that record.
For manually changed, is the date that the change took place.
Source Type. Three possible values:
If the record produced via file, will have the icon and a link to the corresponding usage data object If the record produced via API, will have the icon and a link to the corresponding usage data object. If changes made manually, will have the icon and name of the user.
Quantity. Can be positive or negative presenting the change in the amount
Subscription Quantity. H quantity of the subscription after application of usage record.
b) Tab "Allocated Resources": In this tab the Usage records for allocated resources are displayed. As explained above, when the system receives a usage record for an allocated resource then adds an add-on to the subscription. For these usage records THERE is on action to edit but only delete.
Add-ons were added either manually or through an order and it is the regularly inserted add-ons. Two additional columns have been added:
Source Type. Three possible values:
If the record produced via file, will have the icon and a link to the corresponding usage data object. If the record produced via API, will have the icon and a link to the corresponding usage data object. If the record came through an order, will have the icon and a link to the order.
Should be blank if someone has added an add-on on the subscription
Total. Representing the total value of the add-on.
If the record produced via file, will have the icon and a link to the corresponding usage data object. If the record came via API, will have the icon and a link to the corresponding usage data object.
Resource.
Quantity. The quantity of metered resource.
Unit. The Unit of the add-on that has been declared for the costs of this metered resource. Total. H total charge for this resource.
Add usage data
In order to be able to handle the imports of usage records, the entity "Usage Data" in the "Billing" module exists. A usage data record will be created for each import that takes place via a file (usually Excel file) or through an API whenever running an import session (e.g. used in Cloud Portal).
When selecting "Billing> Usage Data" for each record displays the following information:
Submission Date. Is the timestamp when the Wizard ran to import or when was made the API call. This field is the "name"
of usage data and will be the link to the usage data view page.
NOTE: Because the import become asynchronous, although not yet completed will exist the record with status in progress but the submission date will not have a Link on view since is hasn’t finished the import yet.
Source Type. This field displays if the data entered via import of a file or entered via API.
Source Name. This field will have a value if the source type is imported from file and gets the name of the excel file. It is
link to open the file.
Submitted By. If the record is from file import, the user who made the import. Log File. A link to the Log file of the imported file or API import session. Status. There are three possible states:
Import in progress. In this case the import has not be completed yet.
Completed successfully. Displayed in green and the case did not show any error during import Completed with error. Displayed in Red if errors are found.
Import Excel File
The user can create an Excel file that contains the following columns:
ACCOUNT CODE
SUBSCRIPTION RECOURCE QUANTITY START DATE
END DATE
Then from module "Billing", can select "Usage Data" and "Import File". A wizard will appear guiding the user to match the columns of the Excel file to the relative fields:
Account Code (mandatory). The account code that relates to the account that the usage record is inserted for. Subscription (mandatory). The name of the subscription for which the usage record is inserted.
Resource (optional). The name of the product characteristic. This field is not mandatory. If there is no value then it means
that the usage record is for pay-per-use charge of the selected subscription (increases subscription’s quantity).
Quantity (required). The quantity to be added / removed.
Start Date (mandatory). The date on which the resource was consumed. In the case of metered resource is the date of
the commencement of the period in which they were measured.
End Date (optional). This is the only non-mandatory field. Makes sense only for metered resources because marks the end
of the period in which they were measured.
Interworks Cloud Platform & WebsitePanel Getting Started Guide
BSS and WSP actions
BSS Actions Website panel resutls
Assign Product to Hosting Plan/ Add-on A hosting plan/Add-on is related to a product/Add-on. Synchronize Account A User/Reseller is created.
Create Order or Subscription Create the relevant hosting space and open resources Add add-on in Order and relate to the subscription
already synchronized with WSP
Add additional resources to the existing and reserve additional hosting space by adding the relevant hosting add-on.
Add add-on in the subscription already synchronized with WSP
Add additional resources to the existing and reserve additional hosting space by adding the relevant hosting add-on.
Setup Services in the subscription Use the relevant resources e.g. create domain. Resources used appear as green in the WSP.
Cancel Add-on
Delete the related services to that add-on and also free the space that was related to the hosting Add-on by decreasing resources.
Suspend Subscription Suspend the hosting space. The relevant space is marked as suspended.
Cancel Subscription Cancel the hosting space. The relevant space is marked as cancelled.
Activate Subscription Active hosting space. Delete subscription Delete relevant hosting space
Un-assign Account The user is not synchronized to the account in BSS Delete Account Delete the synchronized user/reseller
Setup > Administration > Cloud Applications > Interworks Cloud OSS or WebSitePanel >
Settings > Resource Deletion Parameters > Period in Days per Product type
6. Manage your Sales Subscription Management
The Subscriptions Management Module provides a 360 degrees view of all of your customer subscriptions. It provides automatic renewals for your subscriptions and keeps a history track for all renewals. It is integrated with your provisioning platform and display details in real time regarding service activations.
Interworks Cloud Platform & WebsitePanel Getting Started Guide Execute an Order
There are three different options for order execution.
Issue Invoice
An invoice will be issued for all products with non-recurring charge, which have not been invoiced – and for all products with recurring charge for which active subscription exists. Use this selection when you only want to invoice non-recurring charge products.
Automatic Creation
All Subscriptions will be created with the selected start date with all upgrades and Add-ons included. Use this selection when you want to create subscriptions without generating any invoices. (Invoices can be generated manually from the shortcuts menu in Account’s detailed view page or automatically.
When the subscription product is integrated with WSP the subscription will also displayed as synchronized.
In cases where the execution of an order or the creation of a subscription fails because an error is returned by the integration layer, a “Retry” action is displayed in view page. The user must fix the issue the caused the error, and then to retry for completing the provisioning action.
Issue Invoice, with automatic creation of subscriptions for products with recurring charge, applying upgrades and Add-ons
Use this option every time you want to create subscriptions and to invoice the subscriptions or to invoice the non-recurring charge products (it’s a combination of the options 1 and 2)
With Automatic Invoicing, you can define a specific date to automatically generate an Invoice. (Prorate billing). When your choice is applied the results of your action will be displayed in a new popup.
Note 1: In order to be able to execute Orders, you should make the appropriate configuration in Setup section (a) In Setup section (Setup > Sales > Orders > Orders Status - See Setup Paragraph) you have to configure one Order
Status with Type = “Automatic execution”.
Note 2: You can also submit orders from Storefront. In order to be able to execute orders from Storefront, you should have at least
one Storefront Type = “Draft” and
one Storefront Type = “Submitted”
You should also have one Type set up “Automatic Execution” (this is usually set to the Status that is set as “Submitted”). This status will be used in order to execute your Orders either they are submitted from Storefront or from BSS.
Add On, Upgrades/Downgrades
Track and view all add-ons that have been added or removed from a subscription. During the lifecycle of a subscription, the customer can request extra add-ons or cancel previous added add-ons. For each add-on we keep its activation date, its quantity and its status (active or cancelled).
Subscriptions’ Upgrade/Downgrade
Upgrade a subscription to a more advanced service.
Essentially it is the replacement of a service or a product with a new service/product of the same type but with more features, if it is an upgrade or less features if it’s a downgrade.
From the left Shortcut Menu choose Upgrade or Downgrade and a new pop up window will let you choose the product or service you want to upgrade or downgrade to. These actions can also completed from Storefront by any Storefront user.
Payments
The user can either process manually the payments he receives or he has the option to activate one of the supported payment getaways for receiving automatically payment entries from credit card charges.
You can also make a payment manually. You are not limited to supported online payment gateways. You can manually apply payments such as checks, bank deposits etc.
Note: Storefront Users can add add-ons, upgrade or downgrade a subscription directly from Storefront Platform. In this
Interworks Cloud Platform & WebsitePanel Getting Started Guide 7. For Storefront Users
The following information will help you to become familiar with the basic functions of the Storefront and how end customers can place orders over the Internet.
Submit an order For B2C (Business to end Customer)
The customer selects a product he wants to purchase from the Product Catalogue (Home Page or Apps & Services) Click “Add to Basket” at any product on the Storefront home page or from the Apps & Services page.
A purchased order in Storefront can be instantly seen in the BSS platform of your company without having to register it manually. This could be a one-off purchase or it could be a recurring subscription. The same process applies if the customer wants to place an Add-On to a Subscription or to upgrade or downgrade to another plan.
Billing Page
Through billing page you can check all your Account Balance, your invoices, and your subscriptions You can access
individual invoices,
outstanding or overdue invoices
Subscriptions (active cancelled or suspended)
Click on any individual invoice in order to check all the invoice’s details from that particular invoice as well as the items’ details that are included.
8. Provisioning in Storefront
“Manage your hosted organization”
9. Automated Ordering and Billing Process Storefront Registration
A customer is able to browse the product catalogue of an e-shop (Storefront) without being a user of the site. As long as the customer adds something to the basket, the system provides redirection to the web page for either log in or register.
If the customer is an existing user then there is the possibility to log in by using his/her credentials or register in order to get new ones. By selecting Resister customer is redirected to the web so as to fill in his/her registration details.
On completing the registration customer is automatically logged in to Storefront so as to complete the transaction by buying the product added previously in the basket or add additional products and then check out from basket.
On completion of registration the following actions occur in the system:
a) A new account has been created in BSS for that customer. The account is set up with the “Enable Ordering” section activated, so as to be capable of billing.
b) A new contact has been created, containing the customer’s information such as address, email e.t.c. and it is related to the account above. The account is also created to have Storefront access and is marked as “Bill to Contact”.
Checking out from Storefront Basket
BSS Prerequisites
In order the automation procedure to run smoothly, some prerequisite actions must be performed in BSS by the administrator of the system.
In BSS > Setup > Administration > System Options > Payment Gateways, a payment gateway must be set up in order transactions to take place e.g. Pay Pal Standard.
In BSS >Setup > Administration> System Options> Payment Methods, the payment gateway previously set must be defined as payment method for the system of type “Credit Card” and be activated. In this section a default payment method can be set and by selecting “Apply Default Payment Method to Accounts without Payment Method” check box, the default payment method will be set to all accounts without payment method.
By editing an Account in the section “Enable Ordering”, at the “Payment Method”, the payment method for this account can be defined. Once a default payment method has been set as described above, every newly created account will inherit this kind of payment method.
In the account, in the “Enable Ordering” section, the “Auto Invoice Notification” check box should be set also, so as Storefront’s customers to receive a notification that includes the invoice of the transaction. This can also be configured for all the accounts from BSS > Setup > Administration > System Options > Organization Settings > Auto Invoice Notification check box.
the notification containing the invoice, by selecting the link to be redirected to the web page for completing the payment.
Describing the checkout procedure in Storefront
After registration the Storefront customer is able to complete his/her transactions by checking out from the basket. As long as the customer has placed a product in the basket a draft order is being created. This draft order represents the basket itself and can be visible in the account, at Sales section, in orders tab, having the status Draft. No invoice is produced for that order until it is executed, meaning that the check-out takes place and the Order is placed in Storefront.
Once the Order is placed is Storefront, by selecting “Place your Order” option (Step 2: Order Review), the customer is lead to Step 3: Payment, where there is link according to payment method, e.g. if it is Pay Pal, a link to Pay Pal, so by selecting it the customer is redirected to the web page of Pay Pal in order to complete the transaction. If the customer completes the payment, in Step 4: Confirmation, the invoice and the subscription (if the product is for recurring-charge) are created. According to what short of notification have been configured in BSS > Setup > Administration> Notifications > Customer Notification for the invoices, the end customer will receive an email containing the information of his/her transaction and the invoice itself.
In case the customer doesn’t continue with payment procedure e.g. closes the Pay Pal web site, the order that was created before contains a button for adding a payment so the customer could in any time complete the transaction by selecting it. In the Order a yellow label appears stating that the Order is “Awaiting Payment”.
In BSS the order “Awaiting Payment” is also shown containing also a link to an Invoice that is characterized as Proforma Invoice. Proforma Invoice has not been issued yet, therefore it is not visible in Storefront and will be characterized as such until the payment is completed.
Automated Subscription creation and renewal
On the completion of the transaction and after the payment has taken place, a subscription will be created for the product, as long as it is for recurring –charge. Else for One Time Charge products only the invoices will be produced.
The subscription created from a recurring –charged product would have two billing options: a) On Subscription Start, so as the invoices would be issued at the moment the subscription is created, b) On Subscription End, so as the invoices would be issued by the end of the Subscription.
Subscriptions are set to be renewed automatically, the relevant flag is set by the system itself, unless otherwise changed by the system’s administrator.
In order the customer to be notified for the new invoice, created for the new subscription period, in BSS > Setup > Administration> Notifications > Notification Plans a Notification Plan must be set so as to notify the customers and send them the unpaid invoices, that also should contain a link to proceed with e.g. Pay Pal transaction. In any case the invoice has been generated and it is possible for a user to log in to Storefront, find the relevant invoice by its identification number and conclude the payment, since in the invoice there should be present an add payment option.
Automated suspension and cancellation of the subscriptions
As long as the subscription is being paid from the customer, it would be renewed and the relevant invoices would be issued. On the other hand there are cases that a customer doesn’t wishes to continue using the subscription. In cases like that customer has the option to request the cancelation of the subscription by himself/herself through Storefront, by selecting the relevant subscription and selecting the “Request Cancellation” option. In BSS the subscription is also cancelled by this request.
Interworks Cloud Platform & WebsitePanel Getting Started Guide
PART TWO
Beyond the Basics
10. Price Lists
Create price lists for promotions or for setting special prices per customer. Use the Price list to define product prices. A price list can be associated with more than one Account. Any Account can be associated with more than one Price List. Click on “Billing > Price List” to view Price List’s home page
To create a Price List choose one of the following steps -Click “Add” from “Product’s’ Home Page -Click “New Price List” from Quick Create menu
If you wish to assign your products, or a group of products, into a price list you must do the following:
1. Go to Product’s tab Page and click “Quick Add” > “Product”. Search and display the products you want to be included in your Price List and click “Insert to Selected”.
2. Use the command “Same Pricing Rule” for setting the same price rule for all your products 3. Use the command “Different Price Rule” to set different price rule for each Product
11. Contracts / Sales Terms / Rebates
The contracts are used to define discounts and special prices for a customer. Moreover, you can use this module for rebating the customer based on his invoiced items.
In Contrast with Price Lists, one Contract can be assigned only with one Account.
For example, you can make a contract for a customer with a Sales Term so as at the end of the Month to make a discount based on Invoice amount. You can choose when you want the Sales Term to be executed (Every Month/ Quarter / Year) and if you want it for a particular product or for all the invoiced items for this customer. Use contracts to rebate your resellers or your customer based on the turnover they have.
Contracts Home Page
List View: Displays contracts on a list using predefined fields such as Contract No, Description, Account, Start Date, Period, End Date and Status.
Create a Contract
From "Quick-create" menu select "New Contract" or Click "Add" from Contract home page. The New Contract screen will appear. Enter Contract's information. Click "Save" when you are finished or "Save and New" to create a new Contract or "Cancel" to cancel the creation.
Contracts Sales Terms
You have the option to define sales terms for every contract you create. Click from the shortcuts menu the option "Add Sales Term" and define their parameters such as a) which invoice items will be used for applying the sales term b) the items that sales terms will be applied (all invoice items or items of the specific Products) c) when the system will execute the term( Every Month/ Every Quarter / Every Year). d) tiers appliance ( apply in continuous mode or scale mode). Notes:
The sales terms will be executed from the Billing Service.
A sales term is always executed the last day of the term period (e.g. the last day of the calendar month / quarter etc.) regardless customer’s billing day. The service will collect all the valid invoices that are derived from the “Applies To” field. The service will get both debit and credit invoices but it will exclude the credit Invoices that may have been created for rebate.
If the contract is not related with a price list, you can only create a sales term for "All invoice items".
The periods are calendar periods and the beginning of the economic year is set to the Setup > System Options > Organization Profile.
You can add a new tier only if you have values to all the fields of the previous tier. The rebates will be executed only if the contract is active.
You can have 2 or more sales terms of the same type for the same contract but with the following limitation: Either the “Applies To” or the “For” must be different.
You can have 2 rebate terms for all invoices but for different periods (one monthly and one yearly)
You can have 2 monthly rebates for different set of invoice items (e.g. the first is for the SaaS products and the second for the IaaS products)
You cannot have 2 monthly rebates for all invoices.
Interworks Cloud Platform & WebsitePanel Getting Started Guide 12. Sales Module
Opportunity is essentially a pending offer that potentially can lead to an order. Custom fields help you identify and chase that opportunity in the most efficient manner.
Click on “Sales > Opportunities” to view opportunities page. Use the filters to display different view lists like any other page.
Create an opportunity
Click “Add” on Opportunities’ Home Page or,
Click on New “Opportunity” on Quick create menu, or
Create an offer
Opportunity can be turned into an offer in which you can add the products you want
When you are in an Opportunity or an Offer page, from the left side menu (Shortcuts) you can convert an existed Opportunity into an Offer or an Offer into an Order.
