Interworks Cloud Platform & CloudPortal Integration

(1)

Interworks Cloud Platform & CloudPortal Getting Started Guide Page 1 of 75

Interworks S.A

Interworks Cloud Platform &

CloudPortal Integration

Getting Started Guide

Published: March, 2014

(2)

Interworks Cloud Platform & CloudPortal Getting Started Guide Page 2 of 75 This document contains information proprietary to Interworks S.A. 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 Platform BSS logo, the Interworks Cloud Platform Storefront logo and the Interworks Cloud Platform OSS logo are registered trademarks of Interworks S.A. All other trademarks are the property of their respective owners.

Interworks S.A

http://www.interworkscloud.com/

(3)

About this guide Introduction

This guide provides instructions for integrating Interworks Cloud Platform with CloudPortal

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.

1. Support and feedback

To receive support for the Interworks Cloud Platform use the following link http://www.interworkscloud.com/ to access product downloads and online help and documentation

Note: When you login to BSS Platform, you have the option to communicate online with one of our

representatives from our Support Departments, simple by clicking the icon on the right side of the Home Page.

(6)

PART ONE Fundamentals

1. Integration of the Interworks Cloud Platform with Citrix CloudPortal.

Interworks Cloud Platform has the ability to integrate with various provisioning services. In the following steps you will be able to see how you can integrate Interworks Cloud Platform with your CloudPortal provisioning service

- First thing you need to do, is to go and set up your integration of BSS platform with CloudPortal

- From Set Up-Administration-System options, you enter Integration with Provisioning Platform

(7)

 In the Provisioning Platform Set up you need to fill in the fields that will allow you to have access to your CloudPortal service

 From the top drop down menu, choose Citrix CloudPortal as your provisioning platform

 In the Web API URL, enter the CloudPortal API URL (API has to be enabled). The Web API URL, should follow the form: https://[CPSM Site]/CortexAPI where [CPSM Site] is the IP address or the site host header, where CloudPortal Services Manager WebServer, was installed. For further information see 'Citrix CloudPortal Services Manager API User’s Guide'.

 On the “Reseller” field, insert the customer code as it has been defined in Citrix CloudPortal.

(8)

 1. If you are a Telco / service provider, it is the code of the root customer in CloudPortal.

 2. If you are a reseller, it is the code of the customer your service provider has created for you in CloudPortal.

 In the User Name field, enter the username of the admin user of the reseller you defined in the previous field. The credentials for this user will be used for accessing CloudPortal API, so this user must have at least one security role with the entity “API Access” enabled. He should also have security roles that grant him access to manage customers / services.

 The field “Default Customer Admin Role” is displayed after you save the form. In this field you must set the default security role. In the case of CloudPortal it’s either User Service Administrator or Customer Administrator. Security permissions are set in CloudPortal.

 After completing the above fields, press the “Get Services Definition”. This actions needs to be repeated each time you add or edit or deprovision any service from CPSM.

 This action will create for each service deployed in CloudPortal, a correspondent product type in Interworks Cloud Platform BSS. If a service has been deployed to more than one location, a product type for each location will be created in Interworks Cloud Platform BSS. You can not change or delete these product types.

Note: In 225 releases we support integration with multiple provisioning platforms (WSP, CPSM). The integration may also be established with different instances of the same provisioning platform (eg: WSP 2.0.0 and WSP 1.2.1)



 If you go to Set Up-Billing-Products-Product Types you would be able to see the product types that you have synchronized which correspond to the services that you have deployed in CloudPortal.

 If you click on a Product Type, and check the properties, you will see that a property has been created for each service configuration setting that exists in CloudPortal.

(9)

 For the Hosted Exchange service, you will see that for each user plan a correspondent numeric property has been defined. For the Citrix Service, you will see that for each application / application group / Citrix application / resource defined in CloudPortal, a correspondent property has been defined in product type.

 Every time you want to create a new product in the BSS platform you must assign either of these two product types and choose the respective properties from each of those types.

 Every time you change the configuration of a service in CloudPortal (e.g. add / delete a new HE customer / user plan or a new application for Citrix Service), you must re-run the “Get Service Definition” action of Interworks Cloud Platform BSS.

(10)

 The action will check what changes have taken place in CloudPortal and will update the correspondent product types.

This action also checks if the service has been deployed to a new location in order to create a new product type for this location.

 If you expand the Advanced Settings you can further see the user plans for each of the components of the service.

(11)

2. Set up your Accounts

One of the first things you need to do is to import your accounts / contacts and synchronize them with CloudPortal before you start working with your Customers

Create New Account

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) 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-29). 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.

(12)

Account Billing Information

In Account’s detailed page you can also view billing indicators about the Account in the Billing Information.

 Account Balance: The total overdue payments of the customer and it is calculated based on unpaid invoices due date

 Overdue Payments: It's the total amount of the invoices that have not been paid until now. (Where the due day of the invoice is any day before today).

 Annual Subscriptions: It's the annual amount before VAT of all active subscriptions (total amount of a monthly subscription

*12).

 LifeTime Subscription: It's the annual amount including VAT of all active subscriptions (total amount of a monthly subscription *12).

 Monthly Run Rate: The amount of annual subscription divided by 12.

 Next Invoice Date: It's the date where the next invoice will be generated.

 Last Invoice: It's the date where the last invoice generated for this Account.

(13)

3. Synchronize Accounts with CloudPortal

Synchronize a new Account

In order to have a customer to use the BSS platform and take advantage of the provisioning services, first you need to synchronize Account with CloudPortal. An Account must have a primary Contact.

From the Account’s detailed view page and the left Shortcut Menu choose Synchronization > Synchronization Options and fill in the Synchronization Options that include: Account’s Primary Domain, the role of this Account and the location of the services and the username of the admin user that will be created for this Account. Customer’s Code is not necessary to be filled. In case it is blank the system will automatically generate one for the current account. Click “Save” in order to save the synchronization details.

Note:

-You can now mark an Account as Reseller and it will be created as Reseller in Cloud Portal.

-You can also define in synchronization options from which locations he can get reseller services.

Press Synchronize Account. A new Account has been created in CloudPortal and is synchronized with BSS Successfully. Note that the option “Synchronize Account” in Shortcuts menu is available only the first time you are synchronizing an Account with CloudPortal.

Synchronize existing Accounts

If you Customer have already been created in CloudPortal you should only synchronize them with BSS platform. Create an Account in BSS platform and click “Synchronization option” from the shortcuts menu.

In the field “Code” enter Account’s Code as it is defined in CloudPortal Account. Code is used for matching and synchronizing BSS Accounts with CloudPortal Accounts.

If you go to CloudPortal and check Customers you will be able to see the Account you’ve just created and synchronize with CloudPortal.

(14)

4. Create a 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 Platform 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.

 Choose the appropriate Product Type (given that you have declared the Product Types in the Setup).

The product type will be a drop-down menu where the product types are grouped by the following way:

(15)

Interworks Cloud Platform & CloudPortal Getting Started Guide Page 15 of 75 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”.

Also, for each product type an image can be inserted. The user can insert an image from Setup > Billing >

Products> Product Types by selecting the desired product type and “Click to Replace” option.

 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:

(16)

 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 not. You can do so by clicking on “Storefront Configuration”, and checking the checkbox “Show in Storefront”. (All new products are not visible in Storefront by default)

(17)

Interworks Cloud Platform & CloudPortal Getting Started Guide Page 17 of 75 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.

The last difference from the normal products is the “Available Add-ons” tab. Because all the pricing has been moved to configuration section, in this tab we display up to 4 add-ons.

(18)

 If the product is set as an “Add on”, it must have the same Product Type with the “Normal” product that we want to assign it with.

 It is important to set up the fields in “Pricing” section. First, you need to set the charging type of the product. You should choose whether it will be a one-time charge product or a recurring-charge product.

 You can also set a Discount List to that particular product.

 Using the Shortcuts menu, you can specify whether the product will appear on your Storefront or not. You can do so by clicking on “Storefront Configuration”, and checking the checkbox “Show in Storefront”

Note: We now provide full support of the following Services:

-Virtual Machine -Blackberry -Hosted Exchange -File Sharing -SharePoint 2010 - Citrix Services

(19)

Interworks Cloud Platform & CloudPortal Getting Started Guide Page 19 of 75 Implementation of a generic mechanism for provisioning services

We implemented a generic mechanism for provisioning any service that has been deployed in CPSM and is based on customer and user plans. The action “Get Services Definition” now creates a correspondent product type for every service that has been deployed in CPSM. The properties of these product types are the following:

 Package: We create a list property that contains all the service customer plans.

 A property for each user plan. For each user plan we create a numeric property with the same name.

 A property for each resource. For each service resource we create a numeric property with the same name.

With the product types in place, it is very easy for the account manager to define new products for these services and publish them in his Storefront. When an order in placed for such services, Cloud BSS provisions the service in CPSM by

 Applying the customer plan defined in Package property

 Setting the values of the user plan limits and resources to those defined during product definition.

(20)

Interworks Cloud Platform & CloudPortal Getting Started Guide Page 20 of 75 Implementation of Chargeback Data Collector for CPSM

The Chargeback Data Collector component is a service that retrieves in a daily basis the usage data from CPSM and imports them in Cloud BSS.

To get the data, the component uses the CPSM eCommerce SDK. This SDK includes Usage API that is actually a thin layer on top of CPSM Data Warehouse. The following table summarizes the out-of-the-box supported services and their meterable settings:

Service Quantity Unit of Measure

For all services Count of provisioned users Per User

For all services Count of provisioned customers Per User

Citrix Count of Applications Provisioned to Users Per Application

MySQL Count of Databases Per Database

Sharepoint2010 Count of Provisioned Sites Per Site

SQL2005Hosting Count of Provisioned Databases Per Database

VirtualMachine Count of Provisioned Virtual Machines Per Machine

WinWebHost Count of Provisioned Sites Per Site

WSS Count of Provisioned Sites Per Site

For more information regarding eCommerce SDK see http://www.citrix.com/downloads/cloudportal/product- software/ecommercesdkforcloudportalservicesmanagerv10.html”.

When the Chargeback Data Collector service runs, it executes the following actions:

 For each PPU subscription in Cloud BSS, it requests the usage data for the specific customer / service combination. If the customer is a CPSM reseller, it loops into reseller customers and finds which services their users are using.

 It creates a Usage Data object for keeping all usage records.

 Usage records are related to the PPU subscription. Historic usage records are kept for every billing cycle.

(21)

5. Manage your Sales

Subscription Management

The Subscriptions Management Module provides a Platform 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 displays in real time details.

Note:

Every time you create a new subscription that is being synchronized with CloudPortal there is an indicator that signifies the status of your provisioning sync with CloudPortal. You can now go to a Subscription’s page in BSS and check on the upper section of the main page the Provisioning Sync Status whether it is Synchronized, In Progress or Failed.

Execute an Order

Every time you execute an order with a product that has a recurring charge, a subscription will automatically be created and an Invoice for that subscription will be issued.

All subscriptions will be created with the selected start date.

Invoices are generated automatically or manually when an order is executed or a subscription is renewed.

 Go to CloudPortal’s Customer page and see the small green ball that is placed before each service which means that the service has just been provisioned.

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”.

(b) You should also define in Setup > Billing > Invoices > Invoice Status two Statuses. The first one should be of Type

= “Paid” and the second one should be set to “Unpaid”. You may also have as many types as you want, but you should at least have the above mentioned.

(22)

Interworks Cloud Platform & CloudPortal Getting Started Guide Page 22 of 75 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 order status that is defined as “Draft” in Storefront Type

 one order status that is defined as “Submitted” in Storefront Type

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.

(23)

Interworks Cloud Platform & CloudPortal Getting Started Guide Page 23 of 75 Automatic Invoicing

The system can generate invoices automatically when an order is executed or a subscription is created or renewed. You can always generate invoices manually if it is necessary by selecting the command of “generate invoices” from shortcut’s menu in Account’s or Subscription detailed view page”.

When the subscription product is integrated with CPSM 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.

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.

(24)

(25)

Interworks Cloud Platform & CloudPortal Getting Started Guide Page 25 of 75 Payments

 Automatic payments processing: Activate payment gateways for automatic credit card payment clearance. Each payment can be associated with a list of invoices and subscriptions for which the invoices were generated for.

 Manual Payment entry: You are not limited to supported online payment gateways. You can manually apply payments such as checks, bank deposits etc.

6.

(26)

7. Give access to your Customers in Storefront Platform

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.

You can also create a contact and a storefront user by selecting “ Add Storefront User” from Account’s shortcut menu.

(27)

Interworks Cloud Platform & CloudPortal Getting Started Guide Page 27 of 75 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 Platform Storefront” is active.

We support SSL and TLS Encryption for email accounts (see paragraph Notifications – in Setup area- for further information).

(28)

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 registration form (go to Storefront Registration page for more details).

(29)

Interworks Cloud Platform & CloudPortal Getting Started Guide Page 29 of 75 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

 Username: It will be Storefront’s username

(30)

Interworks Cloud Platform & CloudPortal Getting Started Guide Page 30 of 75 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 Home Page. You have to click on the magnifier, which will display a list of the products that you have categorized as

“New” 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.

(31)

(32)

Interworks Cloud Platform & CloudPortal Getting Started Guide Page 32 of 75 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)

 Inactive Tab Color. You define the color of the inactive tabs (the blue tabs in the picture below).

(33)

 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.

 Background Color. The Color of the Header of your Storefront.

 Font Color. The Font Color on the Header of your Storefront.

 Cart Indicator Color. The Color of the Cart

(34)

Interworks Cloud Platform & CloudPortal Getting Started Guide Page 34 of 75 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.

Horizontal Menu. Includes Settings for the main navigation menu.

(35)

 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.

 Promotional messaging color. The color in which the promotional messages will be displayed on your Storefront.

(36)

Interworks Cloud Platform & CloudPortal Getting Started Guide Page 36 of 75 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 displayed a “Terms of Use” link (as it is shown in the picture below) which opens a new window with the terms of use as you define them in the editor.

(37)

Interworks Cloud Platform & CloudPortal Getting Started Guide Page 37 of 75 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.

On the same page, you can enter a custom CSS, which you can use in “Storefront Rebranding” for your storefront configuration. Moreover, you can enable the “Contact us” link, which will be displayed on the Storefront footer and is a link to the “Contact us” page. You define the information displayed in the “Contact us” page in the editor of this section.

(38)

Interworks Cloud Platform & CloudPortal Getting Started Guide Page 38 of 75 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.

 Without following the two steps mentioned in this paragraph the visitor will not be able to register an Account and he will receive one of the following messages: “Invalid API options for Accounts” or “Invalid API options for Contacts”.

(39)

(40)

8. 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.

(41)

Interworks Cloud Platform & CloudPortal Getting Started Guide Page 41 of 75 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.

“View invoices list”

(42)

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.

(43)

 In BSS > Setup > Administration > Print-out Templates > Invoice Template, a correct invoice template should be set, containing a link for the selected payment method, in order when the Storefront’s customer receives 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.

(44)

Interworks Cloud Platform & CloudPortal Getting Started Guide Page 44 of 75 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.

By the end of the subscription period, the subscription will be renewed automatically. An invoice for the new period would be issued. It would be generated according to the billing option set in the subscription.

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.

In situations that the customer is not too much consistent on his/her payments, system provides the possibility to automatically suspend or even cancelling the subscription. This can be done if the proper notification plans are set in BSS

> Setup > Administration> Notifications > Notification Plans. In such cases the customer will receive the relevant notification, concerning the suspension or cancellation of the subscription after the number of days set according to the due dates of the invoices. A subscription can be unsuspended accordingly when the invoice is paid. For cancelled subscriptions there is no possibility for reactivation.

9.

(45)

PART 2 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 “Price List’ Home Page -Click “New Price List” from Quick Create menu

If you wish to attach your products into a price list you must do the following:

Go to Product’s tab Page and click “Quick Add” > “Product”. Search and display the products you want to be included in you Price List and click “Insert to Selected”.

Use the command “Same Pricing Rule” for setting the same price rule for all your products Use the command “Different Price Rule” in order to set different prices for each product.

To assign a Price List to any Account go to Account’s detailed page and click “Price List > Assign” from the shortcut menu.

(46)

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.

 A contract can be renewed either automatically or if you select it from the shortcuts menu.

(47)

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 pages.

Create an opportunity

Click “Add” on Opportunities’ Home Page or,

Click on New “Opportunity” on Quick create menu, or

Click on “New Opportunity” from the shortcut menu on Account’s or Contact Detailed page.

(48)

Interworks Cloud Platform & CloudPortal Getting Started Guide Page 48 of 75 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 Order and an Offer into and Order.

You can always create an offer from quick create menu or from Offer’s Home Page or through case detailed view page.

(49)

(50)

13. Support Management

What is a Case

 The Support Module organizes and coordinates your support department.

 It offers a complete solution for the efficient management of cases (trouble tickets and complaints) submitted by the customers through the customer support portal.

 Also, all the communication with the customer (send / receive emails and faxes, files exchange) is recorded and displayed in case view page.

Create a Case

 To create a Case you should have the appropriate privileges and the module “Support>Case” should be available according to your type of user license.

 From "Quick Create" menu select "New Case" or Click "New" from Cases home page.

 From a shortcut list click of any of the following object Account, Contact, Offer, Order, Contract, click “Cases” > “New Case”.

 From the case section of any detailed view page click “New”. This section is displayed when there is at least one case related with an object on a detailed view page under the basic information.

 The New Case screen will appear. Enter the details of the case.

(51)

 Many different fields are available, and help you describe in detail the case you are opening. For example you can assign the name of the technician who will be responsible for the case, the reason of the case, the priority etc. You may also declare your own fields, based on your business’ needs, simply by creating appropriate custom fields.

 The case can be related to an Account, Contact or Subscription

 Click "Save" when you are finished or "Save and New" to create a new case.

 Storefront users can create cases from Storefront pages and keep tracking on any changes.

(52)

14. Marketing Module

Manage Campaign and Leads

The Marketing Module empowers customer to centrally manage multichannel campaigns, maximize campaigns effectiveness and optimize lead management.

You can track leads through each stage of the lead management process – from lead qualification to closed revenue.

What is a Campaign and a Lead?

 You can add a list of companies as your potential customers for a specific Campaign

 You can copy an existing campaign or create a new one from scratch.

Define tasks and marketing material for the entire campaign life cycle and schedule campaign activities to be performed immediately or at specific times in the future.

Members of your new Campaigns can be existed Contacts or Leads. You can also keep track of their responses using Member Status option.

Convert a lead / customer / opportunity

 You can convert an initial lead into a new Account and create an opportunity for a potential sale using “Convert” from Shortcuts menu.

(53)

15. Promotions

With promotions you can apply discount rules for specific products. We support the following promotion types:

 One Time Discounts

 Recurring Discounts

 Limited Recurring Discounts (e.g. First two months free)

 Monetary Discounts (e.g. 5€ Off)

 Percentage Discounts (e.g. 20% Off) For each promotion you can define:

 Promotion Start and End Date. You set when the promotion stars and when it will end. During this period, the promotion is active and it will be applied to all orders placed in Cloud Platform.

 To which products it applies. Define the set of the products the promotion applies. You can define not only primary products but also add-on products

 To which billing cycles it applies. Because a product can have more than one available billing cycles (e.g.

monthly / quarterly etc.) you must define for which billing cycles the promotion is valid.

 Its discount type.We support the following types:

 Percentage. Discount by a percentage of the original price

 Fixed Amount. Discount a specific amount from the original price. If this type has been selected, then only one billing cycle can be selected

 Customers Restriction.Restrict promotion only to new customers or all customers.

 Promotion lifetime. For setting up promotion lifetime, there will be the following options:

 Apply only once for the first subscription billing period

 Apply for a limited number of billing periods (e.g. the first two months)

 Apply always. The promotion discount rule will apply during all subscription lifetime

 Pre-requisites products. You set pre-requisites products for a promotion when you want to offer “buy X get Y half price” promotions. By setting products as pre-requisites, it is possible to stipulate which products the customer must have before the discount will be applied.

Promotions Presentation in Storefront

When a customer logs in Storefront, the system will automatically enable the promotions that the customer can use.

Depending on promotion type, the following tags will be displayed.

 In products catalogue, for products under promotions, a tag “special promotion” will be added and the promotion marketing message will be displayed.

 For promos that change the original prices, the original price will be strikethrough and the new price will be displayed along with the applied discount.

(54)

Interworks Cloud Platform & CloudPortal Integration

Interworks S.A