AirSembly Distributor Portal Guide Version 2.0 (December 2015)
Table of Contents Table of Contents 2 1. Distributor Portal Overview 4 1.1 Distributor Dashboard 4 2. Resources Menu 6 2.1 Template Management 6 3. Reports Menu 8 3.1 Revenue Breakdown 8 3.2 Revenue Summary 9 Actual Revenue Tab 9 Projected Revenue Tab 9 3.3 Sales Agent Report 9 3.4 Usage 10 Details 11 Download 12 Email 12 PO Number 12 4. Admin Menu 13 4.1 Branding 13 Managing Your Brand 14 4.2 Datacenters 15 Datacenter Details 15 4.3 Default Products 16 4.4 Notifications 18 Recent Notifications 18 Send Notification 18 4.5 Product Blueprints 19 Product Blueprint Modify 19 Product Blueprint Configure Tab 20 Associated Partners Tab 21 4.6 Resource Pricing 23 4.7 Settings 23 Distributor Details 23 Language Settings 24 Email Notification Details 24 Points of Contact 25 Invoice Settings 26 Billing Options 26 Distributor Portal Guide 2
Authentication Settings 27 Signup Settings 27 Platform URL 28 4.8 Taxes 28 4.9 User Management 29 Add User 29 User Details 30 5. Partner Management 31 5.1 Adding a Partner 31 Partner Details 31 Billing Options 32 User Details 32 5.2 Viewing Partner Details 33 Account Settings Tab 33 Products 34 Users 35 Billing 36 Transactions 36 Usage 37 Details 38 Download 38 Email 38 PO Number 38 Distributor Portal Guide 3
1. Distributor Portal Overview The Distributor Portal allows you to create and manage your partners, product profiles, templates and staff, and it also gives you access to a variety of reports. 1.1 Distributor Dashboard The Distributor Dashboard is the main window that appears after you log into a Distributor from the Provider portal. Figure 1-1: Distributor Portal Dashboard The dashboard contains the following fields: Resources: View vcenter resources. Reports: Templates: The OS Templates you have access to. You may choose which of your partners can access them. Revenue Breakdown: View revenue in more detail. Customize the time range and break revenue down by Distributor, Partner and Client. Revenue Summary: An overview of revenue broken down by month. View actual revenue or projected revenue. Sales Agent Report: The activity report for your Sales Agents. Usage: Monthly usage information for all VM, vdc resources and XaaS products consumed. Admin: Contains links to account settings, client accounts, reporting and other account functions. Branding: Opens the Brand Management window to allow control of your branding look for Partner sites. Datacenters: View the datacenters you have access to and adjust the pricing for resources. Default Products: View the default products for newly created Partner accounts. Notifications: Send notifications to your clients, or review past notifications. Product Blueprints: The list of the Product Blueprints that the Service Provider has provided for you. You can choose who has access to each product profile and adjust the pricing for items. Distributor Portal Guide 4
Resource Pricing: View the resource pricing of your VMs, vdc, XaaS products and datacenters. Settings: Distributor account settings. Taxes: Set up any taxes you are required to collect from your Partners. Users: Create, manage and delete users on the Distributor account. Customers: Displays the Partner menu. Add, view or remove partner accounts. Distributor Portal Guide 5
2. Resources Menu You can manage and view VM templates through the Resources Menu -> vcenter -> Templates. Figure 2-1: vcenter Resources Menu Window 2.1 Template Management Templates are used with Virtual Machine (VM) Product Blueprints for partners to create products. When a partner cre ates a VM product they choose a VM blueprint that has their desired resource pricing. Then they choose which Oper ating Systems are available when a client orders that product. A template is a basic virtual machine with the listed operating system and an enforced set of minimum requirements that the partner must configure. Templates offer limited ability to make changes. Only the template privacy can be edited. Distributor Portal Guide 6
Figure 2-2: Template Management Window The VM template shows the minimum requirements of the Operating System used for that template, as well as its loc ation and privacy information. Figure 2-3: Template Settings Window - Modify Tab The Access Tab shows information about whether access to the template is public or private. Figure 2-4: Template Settings Window - Access Tab Distributor Portal Guide 7
3. Reports Menu The Reports menu allows you to view your revenue daily, weekly, monthly, or yearly. It also allows you to view rev enue breakdown, suspended VMs and payment information. Figure 3-1: Reports Menu 3.1 Revenue Breakdown This report allows you to break down your partner s revenue in greater detail. Figure 3-2: Revenue Breakdown Window This window contains the following fields: Date Range: The date range for the information listed in the graph. You can choose either daily, weekly, monthly or yearly. You can also use the slider to change the date range. Date: This is the date of a data point. Distributor Revenue: The amount of partner revenue. Distributor Cost: The partner's cost. Distributor Margin: The partner's margin. View Button: Click this button to see a breakdown of the partner revenue details. Distributor Portal Guide 8
3.2 Revenue Summary View monthly revenue by actual revenue and projected revenue. Actual Revenue Tab Figure 3-3: Revenue Summary Window - Actual Revenue Tab This window contains the following fields: Year Selection: Choose the year for your report. Revenue Selection: Choose actual or projected revenue. Months: Identifies each month of the year's breakdown. Total Charges: The total net charges for the month. Net Adjustments: Any adjustments to the net value. Net Revenue: The amount of net revenue. Projected Revenue Tab This shows projected revenue based on your current growth. Figure 3-4: Revenue Summary Window - Projected Revenue Tab 3.3 Sales Agent Report View reports about your sales agent activity. You can expand any sales agent's information for more details. Distributor Portal Guide 9
Figure 3-5: Sales Agents Window This window contains the following fields: Name: The name of the Sales Agent. Listed as last name, first name. Status: The status of the Sales Agent (Active or Inactive). Default Commission Rate: This is the default commission rate used when the Sales Agent is added to a Partner account. The commission rate can be adjusted within the Partner settings. Total Commission: The total commission generated by the Sales Agent across all Partners. Total Revenue: The total revenue managed by the Sales Agent. 3.4 Usage You can view usage by month. Figure 3-6: Usage History Window Clicking on a month shows the number of units consumed during the period. Each service is listed separately. Distributor Portal Guide 10
Figure 3-7: Usage History Details Window Details View a summary of the services throughout the month. The breakdown shows hourly, monthly, one time and manual changes. Click through the menu to view various charges. Each entry can be expanded to view the details. Distributor Portal Guide 11
Figure 3-8: Monthly Usage Details Window Download Click here to download the invoice for the month, if available. Email Email the invoice to the billing contact on the account. If there is no billing contact an email is sent to all user accounts. PO Number Add a PO number to the invoice. Distributor Portal Guide 12
4. Admin Menu You can manage a variety of settings from the Admin menu. Figure 4-1: Admin Menu 4.1 Branding You can use the Branding window to configure the branding for your partners. Distributor Portal Guide 13
Figure 4-2: Branding Window Managing Your Brand When you first access your Distributor account you will likely not have any branding configured yet. You should dis cuss the URL to be used for your Partner Portal, and your reseller branding domain with your Service Provider. After your portal is set up and running you can change the look of the site through the Branding window. You can choose a logo, and change colors, fonts and other elements. Set a customer header and footer, either by using a screen shot of a logo or a fully integrated header from another website. Follow these steps to set up your branding quickly: 1. Upload a logo. You can upload a file of any size or proportion you choose, but the optimal logo is a "horizontal" version of at least 160px by 40px, or a 4 to 1 ratio. This logo will appear in the footer of the management tiers and the header of the marketplace storefront. Distributor Portal Guide 14
2. Enter a slogan. You can choose up to 64 characters to display next to your custom logo. Your logo could be an identifier (for example "Management Portal") or a slogan for your company. 3. Select the font stack. A web-safe font stack is a set of fonts that will display on almost any device, regardless of browser or operating system. Select the set that best matches your standard corporate font, or match the one you are currently using on your website. 4. Select the color scheme for your brand. The majority of the platform can be recolored quickly and easily by selecting the three main colors of your brand from the Colors section. Note: We suggest that you do not choose the color white for your primary, secondary, or tertiary color. 5. Edit the custom header and footer. You can paste any HTML into the appropriate text box to have it displayed on every page. For example, you can copy the exact HTML header into your corporate website and place it on top of your marketplace storefront. You could also use the custom footer area to place links to social media or additional corporate information. 6. You can use the Custom CSS field to override the CSS of the default storefront, if you would like to do so. You can add the CSS code to this area that will apply to any element you would like to change or re-size. This text box allows you to completely change the look and feel of the entire platform. 4.2 Datacenters Displays the datacenters you have access to and provides the ability to change the resource costs. Figure 4-3: Datacenter Management Window This window contains the following fields: Name: The name of the datacenter. Description: The datacenter description. Privacy: Set the datacenter to public (available to all partners), or private (available to selected partners). Currency: The currency used by the datacenter. Status: If the datacenter is active or inactive. Actions: Click on the Edit button to view datacenter details. Datacenter Details View the details of a datacenter and change the resource pricing by clicking on Edit. Distributor Portal Guide 15
Figure 4-4: Datacenter Settings Window This window contains the following fields: Modify Tab: Modify the datacenter's properties. This is the default tab that appears when the Datacenter Set tings window opens. Access Tab: If the datacenter is set to private this tab lets you choose which of your partners have access. Name: The name of the datacenter. Description: The datacenter description. Currency: The currency that you want to use for the resources. Recursive DNS1/2: The DNS servers that the virtual machines created in this datacenter are configured with. Private: If the datacenter's visibility is private you must to go to the Access tab and choose the Partners that should have access. IPV4/6 Cost Per Address ($): Hourly costs per IPV4 or IPV6 addresses used by virtual machines. Firewall Cost ($): Hourly cost for firewalls. Bandwidth In/Out: Hourly cost for bandwidth in or out. 4.3 Default Products When creating a new Partner account you are asked if you want to include the default products. Default products are generally items that are commonly offered by your resellers and offering default products allows a new partner to be up and running faster. Distributor Portal Guide 16
All of the products listed under the Product Management menu are default products. Not all products listed will show up in the new Partner account if the account does not have access to all of the listed datacenters. Figure 4-5: Product Management Window This window contains the following fields: Name: The name of the product. Datacenter: The datacenter the product is located in. Status: Whether the product is Active or Passive. Action: The actions that can be taken with the product. View: View the product options (see Figure 4-6). The information shown is read only. To make changes to the product options you must remove the product listing, edit the original product and set the updated product as a new default product. Remove Default: Remove the product from the list of default products. This does not delete the product itself. When you click on the View button beside the default product name, detailed information about the product appears. Figure 4-6: Product Management View Window Distributor Portal Guide 17
4.4 Notifications The notifications menu shows a history of all notifications sent out by the system. It also allows you to send out noti fications to your partners. Recent Notifications Figure 4-7: Recent Notifications Window This window contains the following fields: Send Notification: Send a custom notification to your partners. Date time sent: The data and time that the notification was sent out. The time displayed is based on the time zone setting you have chosen in your account settings. Subject: The subject of the message. Source: The sender of the email. View: View more details about the notification. Send Notification Figure 4-8: Send Notification Window This window contains the following fields: Subject: The subject of the message. Body: The message to be sent. Distributor Portal Guide 18
Send this notification to: Choose the recipients of the notification. All Partners: Send to all partners. Specific Partners: Select one or more partners from the list of partners. Hold down the CTRL key to select multiple partners. Message Controls:Click Send to send out the notification or Cancel to remove it. 4.5 Product Blueprints Product Blueprints are created by your Service Provider and are used by your Partners to create products. Product Blueprints can contain various items such as software licenses, managed services, physical goods, and virtual machine resources. Figure 4-9: Product Blueprint Management Window This window contains the following fields: Name: The name of the product blueprint. Status: Whether the product blueprint is active or inactive. Privacy: Whether the product profile is public or private. If it is private you must choose which partners have access. Type: The type of product blueprint: Virtual Datacenter (vdc) or XaaS. Actions: Actions that can be taken with the product blueprint. Click Edit to make changes to the product blue print. Product Blueprint Modify When a product blueprint is added to your list it is set to private. You can decide if you want to offer that product blue print to all partners or only a select few. You can also adjust the pricing on some or all of the items in the product blue print. To edit a product blueprint select Edit. The Product Blueprint Modify window opens. Note: Changes cannot be made to a product blueprint when a Partner has already created a product. If you want to make changes, your Partner must set the current product to inactive and create a new product using the updated profile. Changes will not affect any products that a client has already ordered. Distributor Portal Guide 19
Figure 4-10: Product Blueprint Modify Window You can add a base fee charged to Partners when using this blueprint. You can also change the currency for the blue print, set the blueprint to active or inactive, and decide if it is public or private. Product Blueprint Configure Tab To view or make changes to the pricing for items under the profile, click on the Product Blueprint Configure Items tab. You can view the items offered and the price your Service Provider is charging. You can adjust the price up or down. Distributor Portal Guide 20
Figure 4-11: Product Blueprint Configure Tab Associated Partners Tab Click the Associated Partners tab to view a list of Partners who have access to this product blueprint. If the product blueprint is set to public it is available to all Partners. Distributor Portal Guide 21
Figure 4-12: Associated Partners Tab Distributor Portal Guide 22
4.6 Resource Pricing You can view your VM, virtual datacenter, XaaS and datacenter pricing. These reports are view only. To adjust the actual pricing, go to the appropriate menu for each resource. Figure 4-13: Resource Pricing Window This window contains the following fields: Resource Pricing Type: Select the resource pricing to view: VM/vDC, Products or Datacenter. Name: The name of the product. Description: The product description (if any). Type: The product type. Cost Type: The cost type: Resource Cost: This is the cost of your resources. The costs shown may be the default costs that your distributor has set, or they may reflect changes you have made. MSRP: The costs you pay to your distributor. Product Details: Clicking the Details button next to a item displays more details. Cost: The cost of resources. VMs display licenses used and unlicensed resource costs. 4.7 Settings You can update the platform settings for the Distributor. Make sure that you go through these to enable all func tionality on the platform. After making any changes click Update at the bottom of the window to save them. Distributor Details The address information for the Distributor. This information is displayed on invoices sent to Partners. Distributor Portal Guide 23
Figure 4-14: Distributor Details Section Language Settings Select the default language for the portal, and what languages are supported. Figure 4-15: Language Settings Section Email Notification Details Set the email address used by the system for sending notifications or for system related tasks. Distributor Portal Guide 24
Notification Email: The "from" address for all notifications sent out by the platform. Provider Email: The email address or addresses used for provider notifications. Provider Emergency Email: The email address or addresses used in case of platform emergencies. Notification Email Footer: Define a footer to be attached to outgoing notifications. Figure 4-16: Email Notification Details Section Points of Contact Enter specific points of contact for the provider portal. Primary Administrator: The primary administrator for the system. Primary Billing: Entering a contact here makes this contact the only recipient of invoices. Primary Technical: The primary technical contact. Primary Order Manage: The primacy contact to process XaaS orders through the Order Management page. Figure 4-17: Points of Contact Section Distributor Portal Guide 25
Invoice Settings Partner Invoice settings: Allow Invoice Downloads: [Yes/No] This decides if Partners can view and download invoices. If using a sep arate billing system set this to No. Default Invoice Notification Settings: [Never/Monthly] If the above option is set to Yes, this determines if noti fications are sent at the end of a monthly billing cycle. Send Copy to (Email Address): This sends a copy of the invoice to the email address or addresses listed. Figure 4-18: Invoice Settings Section Billing Options Set the default currency for the Provider. You can also include tax numbers here. Distributor Portal Guide 26
Figure 4-19: Billing Options Section Authentication Settings Enable Two Factor Authentication on the provider portal, requiring anyone logging in to enter a code that has been emailed to them. Figure 4-20: Authentication Settings Section Signup Settings Choose Yes or No to allow request access. Figure 4-21: Signup Settings Section Distributor Portal Guide 27
Platform URL Shows the Partner URL and domain. Figure 4-22: Platform URL Section 4.8 Taxes Configure taxes to be collected on invoices from regions where you are collecting taxes. Figure 4-23: Tax Management Window When you first open this window, there are no taxes selected. Click Add to open the list of supported taxes. If the region for which you need to collect taxes is not present contact your distributor. Figure 4-24: Tax Add Window Click on the drop down menu to select the country that you are going to charge taxes for. If the country has different tax rates for any states or provinces a new list will open. Distributor Portal Guide 28
Figure 4-25: State/Province Select Section You can select multiple states by pressing the Control key when clicking on your choices. Click Create when you are finished. After you are finished you will be returned to the Tax Management screen. You should now see any tax choices you have made. Anyone that orders products from the selected regions is now charged the appropriate taxes. 4.9 User Management You can view information about existing users or add you can add new users. Figure 4-26: Distributor User Management Window Add User Click Add User to add a new user to the system. Enter their contact details. Email, password, first and last name are required fields. Distributor Portal Guide 29
Figure 4-27: User Add Window After you have filled out the contact details you must assign a role to the user: Admin: Has full and complete access to the account. Financial: Has access to billing information only. Sales Agent: You can add sales commission information. Technician: Has access to manage the services only. Click Create User to add a new user to the system. User Details Send out a new password and change a user's role. Distributor Portal Guide 30
5. Partner Management You can create new partners and manage your existing ones. The Partner Overview window contains a list of active partners. You can add a new partner by clicking Add Partner. If you have partners that have been removed they will be found under the "View Removed Partners" button, located next to the Add Partners button. Figure 5-1: Partner Overview Window From the list of clients shown you can take the following actions: Add Partner: Add a new partner. Name: The name of the partner. Balance: The partner's account balance. Cloud platform: The partner's storefront URL. Actions: You can: View: Click this button to view the partner's administrative interface. You can view their assets, process their billing and view their account history. Login: Log into the partner's account as a user. 5.1 Adding a Partner Click the Add button at the top of the Partner Overview window to add a partner. The Partner Add window appears. Partner Details Enter the information for your new partner. Distributor Portal Guide 31
Figure 5-2: Partner Details Section Billing Options Enter the following information: Discount (%): The partner's discount on resource costs. Currency: The currency the partner is using for services. Default Client Payment Terms: PrePay or PostPay. Default Suspend Threshold: If you are using PrePay set the monetary amount that causes the service to be sus pended. Figure 5-3: Billing Options Section User Details Enter the information for the user of the partner account. Distributor Portal Guide 32
Figure 5-4: User Details Section 5.2 Viewing Partner Details To view a client's details click on the View button beside the client's name. Figure 5-5: Partner Settings Window Account Settings Tab The account tab contains general information for the partner's account. These are settings that the partner would have entered for their own account. Distributor Portal Guide 33
Field Partner Details Minimum Charges Billing Options Invoice Settings Language Settings Notification Details Fraud Screening Web Signups Authentication Settings Signup Settings Points of Contact Notes Branding Area Client quote Details Store Name: The prefix used with the branding domain to create the partner's storefront URL. This can be edited here but not at the partner level. Discount: Adjust the discount percentage. The minimum charge for hourly products. Change or view the billing options for the partner. The partner's invoice settings. The language settings for the partner portal. The partner's notification settings. The Max/Min settings used if the partner has chosen to use fraud screening with credit card payments. If enabled the partner allows clients to sign up directly at the storefront to begin pur chasing services. The partner's authentication settings. Used if the partner has enabled signup requests from their storefront. The partner's points of contact. Here you can leave notes about the partner. This is not shown in their settings screen. The partner's branding information. You can enter text for a greeting, note, terms and conditions, and a footer. Products View products the partner has created. You can view more details about a specific product, set the product as a default, and see the storefront URL for the product. Figure 5-6: Product Management Window When you click on the View button beside the product name, the expanded view of the Product Management window appears. Distributor Portal Guide 34
Figure 5-7: Expanded Product Management Window Users View the users in the partner account. You can send out a new password, view user details and change their role. Distributor Portal Guide 35
Figure 5-8: Partner User List Billing Add service credits, adjust balances and view usage data. Transactions Add transactions to the partner s account. Changes here reflect on the account balance and in invoices, if available. Figure 5-9: Transaction Details Window Type: The type of transaction: Service credit increase Payment Charge Refund Balance increase sales adjustment Balance increase write off Balance increase billing error Balance reduction billing error For Invoice Period: The invoice any changes should be reflected on. Distributor Portal Guide 36
In the Amount of: The amount of the transaction. Description: The description of the transaction. Click Process to run the transaction. Usage View usage by month. Figure 5-10: Usage History Window Clicking on the Full Details button shows the number of units consumed during the period. Each service is listed sep arately. Figure 5-11: Monthly Usage Window Distributor Portal Guide 37
Details Open a summary of the services consumed throughout the month. The breakdown shows hourly, monthly, one time and manual changes. Click through the menu to view various charges. Expand each entry to view the details. Figure 5-12: Usage History Details Download Click here to download the invoice for the month, if available. Email Emails the invoice to the billing contact on the account. If there is no billing contact, an email is sent to all user accounts. PO Number Click here to add a PO number to the invoice. Distributor Portal Guide 38