Orbitera makes it relatively easy to create your own branded marketplace. You can think of a white-label marketplace as an out-of-the-box sales channel for selling products, services, and applications to cloud consumers and customers.

White-label marketplaces can also be used for non-cloud products. Imagine, for example, a device ecosystem that incorporates cloud service and hardware into a sophisticated distribution network.

A marketplace serves as a storefront for products and services that customers can consume. You can have this with a lower operational burden of provisioning, launching, and maintaining your own storefront.

Orbitera-powered marketplaces are self service, meaning that you can define your products without going through Orbitera for an approval or integration process. Orbitera provides the toolset for you to build and interface with multiple potential cloud platforms through our RESTful API interface, but Orbitera doesn't dictate your inventory or your go-to-market strategy.

Thus, Orbitera allows you to retain customer touchpoints, keep the customer in your own domain, and retain control over the customer experience.

What you'll learn

How will you use this quickstart?

Only read through it Read it and complete the exercises

Account: Sometimes called "cloud account," but can be any customer account. A customer account defined in Orbitera is a bucket that contains all usage charges. In Google, an account is called a GCP project. In Microsoft Azure, it's an Azure subscription. In AWS, it's a linked account.

Admin: A user who can log in to the Orbitera admin console. Admins are configured in the admin console at Settings > Users. Admin roles are User or Owner. An Owner can modify all settings. A User has the same capability, but can't add new Users.

Channel partner: A generic term that can apply to a distributor, reseller, systems integrator, or vendor. A business that partners with a manufacturer to market and sell the manufacturer's products, services, or technologies.

Cloud provider: A business that offers cloud computing – typically, Infrastructure as a Service (IaaS), Software as a Service (SaaS) or Platform as a Service (PaaS) – to other businesses or individuals. Cloud providers are sometimes referred to as cloud service providers or CSPs. Examples of cloud providers are Amazon Web Services, Microsoft Azure, and Google Cloud Platform.

Customer: Individuals or businesses that purchase cloud products from resellers or sometimes directly from distributors. Customers can purchase or test drive products on an Orbitera-powered marketplace. A customer that is a business can include multiple end users (who are typically the customers' employees or contractors) who log in to a marketplace to make purchases.

Distributor: A business that helps channel partners find the right cloud offering for their customers and also provides deployment and support services. Compared to a reseller, a distributor implies a closer relationship with the manufacturer. Essentially, a distributor buys directly from a manufacturer and sells to either resellers or, sometimes, the end user directly.

End user: Someone who can log in to a white-label marketplace to make purchases or start test drives. End users can be configured by an Orbitera admin in the admin portal at Customers > {customer} > Users, or end users can sign up via a white-label marketplace's front end.

Individual software vendor: An individual or business that builds, develops, and sells consumer or enterprise software. Although ISV-provided software is consumed by end users, it remains the property of the vendor. An ISV is also known as a software publisher.

Partner: A distributor, vendor, or reseller.

Reseller: A business that typically buys from a distributor and sells directly to their customers, who are end users. Resellers often create white-label marketplaces.

Seller: An individual or business that adds products to a white-label marketplace, but doesn't necessarily create the marketplace.

Log in to the Orbitera admin console.

Log in

Design the words, images, and links that appear on your catalog home page.

Note that currently only the default color scheme is supported.

Settings > Customers Portal > Catalog look & feel

Example

Settings > Customers Portal > Portal functionality

Option

Meaning

Enable dashboard

Display a dashboard in the customer portal. By default, the dashboard is enabled.

Enable test drives

Enable end users to sign up for test drives in the customer portal. By default, test drives are enabled.

Enable credit card payments

Enable end users to make credit card payments in the customer portal. By default, credit card payments are disabled.

Require EULA acceptance when customers add new accounts

Require that end users accept a EULA for each new account. By default, the EULA requirement is disabled. You can add or edit terms at Settings > Account > Terms.

Settings > Customer Portal > Customer signup

Option

Meaning

Require email validation

Ensure end user email addresses are valid.

Require address fields

In the sign-up form, make address fields required. By default, they are optional.

Require EULA acceptance

In the sign-up form, require end users to accept an end-user license agreement (EULA). By default, this option is disabled.

Automatically approve new customers to initiate test drives

Approve new test drives immediately. When this option is disabled, new test drives require approval in Settings > Approval requests.

Automatically approve new customers to initiate subscriptions

Approve new subscriptions immediately. When this option is disabled, new subscriptions require approval in Settings > Approval requests.

Green list domains

List of approved email domains. End users with addresses at these domains can sign up for test drives and subscriptions. If you leave this field blank, all end users can sign up, unless they are listed in the red list.

Red list domains

List of forbidden email domains. End users with addresses at these domain cannot sign up for test drives and subscriptions.

Signup form

Use the default sign-up form text or specify custom text.

Sample custom text:
{linkStart}<license URL>{linkEnd} {linkStart}<login URL>{linkEnd}

Example

Select Launch Marketplace from the drop-down menu in the top-right corner.

Products > My products

  1. Click Add+.
  2. Enter the SKU label for internal tracking.
  3. Enter the product name.
  4. Mark the product status as Active or Inactive.
    If the status is active, the product appears in the marketplace catalog, and the user can purchase it.
    As a best practice, keep the status inactive until you're ready to publish the product.

Set the available actions

Action

Meaning

Try

Test drive the product. If you turn on this setting, you can set the maximum spend and select the test drive.

Buy

Purchase the product. Disable Buy for products that are informational only.

Info

Learn more about the product. Common use cases for Info are an email link or a referral program where the user is directed from the marketplace to a third-party domain. If you include Info, you must include an Info URL, such as:

  • mailto:info@example.com?body=cool%20mailto%20link
  • https://www.third-party.com/?source=YourMarketplace&Ref=1234

Require approval?

To require product-specific approval, click the Approval Required checkbox.
This puts the transaction into a "Pending" state and begins the approval workflow for the admin to approve the purchase. Then, when you're ready, you can complete the transaction.

Select an administrative user's (see Settings > Users) email address to approve the transaction. The administrator approves the transaction via email or in the admin portal at Settings > Approval requests.

Add descriptive content

  1. Enter a brief description of the product or service. This description appears in the marketplace catalog.
  2. Add one or more images of the product. The first picture is presented in the catalog view. Subsequent images appear in the product detail view.
    Supported formats include GIF, JPEG, SVG, and PNG. Width: 1720px. Height: 960px.
  3. Add a product logo.
  4. Add one or more keywords for search engine optimization (SEO).
  5. Associate the product with a category.
    Examples: Virtualization, Storage, or Managed Services.
    Categories that you create here are listed in the marketplace's left navigation panel.

When you're finished

Click Create.

Example product settings

This is where you can set the user-facing content for your product.

Products > My products

  1. Find your product and click Edit.
  2. Click Edit product details.
  3. In the Description field, enter a detailed product overview.
  4. Add features with titles and descriptions.
  5. Add reviews with titles and content.
    Orbitera currently does not support direct user feedback. Instead, you control what reviews and testimonials are shown for your product.
  6. Add FAQs with questions and answers.
  7. Add support information with titles and content.
  8. Add videos with titles and embedded links.
    For example:
<iframe width="560" height="315" src="https://www.youtube.com/embed/COhwhZjcjw0" frameborder="0" allowfullscreen=""></iframe>
  1. Click Update.
  2. Click Back to product.

Example

Deployments use API calls and scripts to take action automatically, triggered by user events.

Learn more

Multiple actions can be made in response to a single user event. For example, when a user creates a subscription, you can:

  1. Do an API call to your provisioning endpoint.
  2. Then do an API call to your SAP system to register the purchase.

API calls and scripts are executed in order, from top to bottom.

All actions for a given event must execute successfully for the deployment to be considered successful.

Suppose, for example, a deployment has three API calls. The first call succeeds, the second fails, and therefore the third is not executed. The effects of the first API call remain in place and are not "undone." There is no rollback of the first call. However, because all calls in the deployment are not executed successfully, the deployment status is marked as failed.

Action chains

The actions can be "chained." This means that response values can be captured and used as input to a subsequent action within the deployment.

Response values cannot currently be captured and used at a later time. They must be used within the working deployment.

Select a user event

Products > My products

  1. Find your product and click Edit.
  2. Under Deployment Actions, click Add+.

Under Event, select a user event:

Configure an API call

  1. Under Type, select API.
  2. Enter the endpoint URL.

Set the API request type

Under Request Type, select:

Add any input fields

1. Click Fields and Add+.

2. Enter a field name and a label name. Field and label are the same, by default.

3. Enter a type:

4. (Optional) Enter a default value.

5. (Optional) Enter a description.

Set the content type

Edit the API credentials

Currently, only basic authentication is supported.

Add any query parameter names and user-input fields

Add key-value pairs as request parameters sent with the API call. The values can contain placeholders that are replaced with values during deployment.

When deploying a product with an API callback, the customer completes a form built using input fields. To automatically generate the user-input fields, click Inp+.

Add output field names and mapping

Output fields allow you to take output from this call and use it as input to the next call.

Example API call: create entitlement

Example API call: create report key

Output from "Create entitlement" is used as input to this API call.

Notes on API calls

Example

{
  "first_name": "Jane", // <== OK to extract
  "last_name": "Doe", // <== OK to extract
  "addresses": [ // <== Can't extract from nested datatype
    { "address": "1234 main st", "city": "mycity", "state": "zip": "11111" },
    ...
  ]
  "is_customer": true
}

Test API calls

As a best practice, use cURL to test and verify API calls prior to entering the calls into Orbitera.

Example

curl -D --X POST -d '{"foo": "bar"}' http://register.example.com/api/newSignup/

Offer multiple plans to allow users to choose one that's right for them. The product tile provides the initial product discovery in the marketplace. When the user double-clicks the product tile, they can view one or more plans. Plans can be the same product configuration offered with different payment methods, or plans can offer different levels of features.

Products > My products

  1. Find your product and click Edit.
  2. Under Plans, click Add+.
  3. Enter a plan name.
  4. Enter a short description.
  5. To add additional plans, click Duplicate or Add+.
  6. Click Save.

Example

Add features to your plans

Typically, some features are common across all plans, while some vary among the plans.

1. Under Features, click Included.

2. Click Add+.

3. Enter a feature name.

4. For each plan, either:

5. Click Save.

Example

Configure prices for your plans

Typically, prices include a one-time setup fee and some recurring fees.

1. Under Price, click Edit.

2. Click to select time periods:

3. For each plan, enter a price for the associated time period.

4. Select when the billing cycle starts:

If you choose Beginning of the month or Specific date, the first bill is prorated. Suppose the customer signs up on the 12th and billing happens on the 15th. In this case, at the time of subscription an invoice is generated with two lines:

And then a second invoice is generated on the 15th, with the price for the full month.

Example

You might charge a standard setup fee of $100, and a monthly fee that varies by plan type.

Add optional features to your plans

Options are added features that end users can choose to purchase.

1. Under Features, click Optional.

2. Click Add+.

3. Enter a feature name.

4. For each plan, either:

Configure prices for your optional features

1. Under Features, click Optional.

2. Under Price, click Edit.

3. Click to select time periods:

4. For each plan, enter a price for the associated time period.

5. (For monthly only) Select when the billing cycle starts:

6. (Optional) Require the feature.
This is often used for regulatory fees or taxes that are not included in the base price, but need to be included on the invoice.

7. (Optional) Force fixed quantity.
This allows you to require that an option be purchased in groups, for example, seats must be bought in groups of five.

Example 1

Example 2

Log in

From the admin portal, select Launch Marketplace from the drop-down menu in the top-right corner.

The new product appears as a tile in the marketplace. To view the product details, double-click the tile.

Before you begin

If you haven't done so already, create a user.

From the admin portal, go to Customers > {customer} > Users and create a new user.

Alternatively, users can create a new user account themselves by signing up in the marketplace.

View the product as a user

  1. Launch the marketplace.
  2. Click Sign in and log in as the user.
    The catalog appears with the new product.
  3. Double-click the product.
  4. Click Subscribe and select a plan.

Reports

  1. Under Customer Reports, select the Customers Subscriptions Report.
    The report automatically populates with the most recent month's data and a default set of columns.
  2. (Optional) To modify the content and layout of the report, click the vertical ellipses in the upper-right corner.
  3. (Optional) Save the customized report.

Example

You've successfully created a marketplace.

In this quickstart you learned how to:

Was this quickstart helpful?

Yes Somewhat No

If you want to learn more, explore these resources: