In this guide, we'll walk you through the steps of setting up your Test Drive in Orbitera.
To get started, click Test Drives.
Adding Your Test Drive
To add a new Test Drive, click Add at the top right of the screen.
At the Test Drive configuration view, you'll enter the information specific to the Test Drive you're adding. Each of the fields is described below.
- Your customers will see the banner image when selecting a Test Drive to launch.
- Drag and drop the banner image or click Upload.
- Banner images should be 830x340 for best quality.
- Title: the name of your Test Drive.
- Description: a short description of your Test Drive.
- Embedded video (optional but recommended): customers will see the video panel and can watch the video while the Test Drive is launching. To add the video, copy the embedded video code from the video you want to include (for example, from MeTube) and paste it into the field.
Launching Text, In Progress Text, Completed Text, Failed Text
This is where you configure the text displayed to the customer when they launch and run your Test Drive.
- Launching Text: displayed when the Test Drive is being launched.
- In Progress Text: displayed after the script (described below) has launched and when the Test Drive is available for the customer to use.
- Completed Text: displayed when the Test Drive is finished. You should include a call-to-action in this text.
- Failed Text: displayed if the Test Drive fails to launch.
- Concurrent Instance Limit: displayed if Test Drive limits are hit (limits are configured in the section below).
- Contact email: provided to customers as a point of contact for questions regarding your Test Drive.
Manuals and Links
- Manuals: the user guide will walk the customer through your demo experience. Upload your user guide.
- Links: additional resources (for example, product pages or marketing collateral) that the customer can view while the Test Drive is launching or during the Test Drive experience. Copy and paste links to the appropriate resources here.
This is where you upload your GCP Template. Click Add to upload the template.
- Status: The status of your Test Drive (active or inactive). Inactive Test Drive are not accessible to users.
- Provider: The cloud provider for this Test Drive.
- Deployment template: Test Drive deployment template. Upload your deployment template as a single file, or as a zip file with multiple Python or Jinja scripts. In the case of multiple scripts, you must indicate which file is the main configuration file.
- When you're finished, click Save.
If you define some parameters in your template schema file, you'll be able to put custom values there in the template configuration screen.
The schema file
The configuration screen
If you mark the parameter Public it will be shown to the customer to fill in before each Test Drive launch. You can then use the parameters as variables in your custom deployment scripts.
In this section, you set the deployment restrictions for your Test Drive, such as the Test Drive duration and the number of times a customer can launch the Test Drive.
- Concurrent Instances Limit: The number of Test Drive across all customers that you will allow to run concurrently.
- Launch Limit per Customer: The number of times that a customer can launch the Test Drive for each registration. A value of "0" allows unlimited Test Drive runs per customer.
- Duration: The length of the Test Drive experience for customers. This is how long the Test Drive will run each time it's launched. Note that you will be responsible for charges in your GCP project while a Test Drive is running.
- Starts in: The number of minutes it will take the Test Drive to fully launch. The indicator on the Test Drive widget will count down from this value. Note that this is not dynamic, please time the launch time of your deployment scripts and fill in that value here.
- Status: This denotes whether the Test Drive is live or not. Set the test drive to Active so that it will be displayed in the menu of available test drives and ensure customers can launch it.
Shut Down Callback (optional)
This is an optional feature that is used if you have additional infrastructure that must be informed, deleted, or reconfigured after the Test Drive stops. If you choose to configure it, the Shut Down Callback will be made right after the customer clicks Stop or the Test Drive expires. You need to set the HTTP GET call that will be made to the defined URL to turn off the Test Drive upon the stop or Test Drive expiration.
- URL: the external service address or the server launched by the Test Drive.
- Timeout: the time in minutes between the callback and actual deletion of the infrastructure deployed by the Test Drive
- Your Test Drive deploys a server with a web application listening on
the http port. You want the Test Drive to make a call to the
stop.phpweb page after it stops.
- The server's IP is shown in the Test Drive output as
- The callback URL in this case would look like this:
In this section you define what information (or outputs) you want to share with the customer once the Test Drive is launched.
- Hidden: Any information that you want to hide from customers. For example,
in the Shut Down Callback example, if the
ApplicationIPparameter is internal and you don't want to show it to the customer, you can hide it from the output.
- Highlight: Deployment Manager script outputs that you want to highlight at the top of the Test Drive page for customers. This allows you to display any pertinent output variables at the top of the Test Drive for users to easily see after the Test Drive launches. For example, you will want to share the customer login credentials and URL to access the environment.
- Upload your GCP credentials in JSON format. (To access your GCP credentials, login into your GCP account, choose IAM, create a service account, grant appropriate privileges to this account, and download the credentials file.)
- Click Save.
Configuring Your Account
After you've created your Test Drive, there are several options and settings you can configure to create the best possible customer experience.
To access the account settings, click Settings. The following section walks you through the fields you should customize on each of the Settings tabs.
Complete the fields with your company information. We recommend that you use a group email for the contact email.
These fields are referenced in various parts of the Test Drive, such as email templates.
- Complete all fields.
- Upload a logo.
- Include an email address or group email that is monitored. This is the email that customers will use if they have any questions.
You can add as many users as you like. Click Add and complete the user fields
You can load a custom EULA for your Test Drive by editing the Customer Signup terms. These terms are presented to customers when they sign up, and customers must agree to these terms before they will be allowed to launch your Test Drive.
We recommend that you customize the email templates. There are several emails that are sent to customers, for example: when they register for your Test Drive, when the Test Drive is operational, when they complete the Test Drive, and more.
To modify the Test Drive email templates, click the Email templates tab.
Select Edit to customize an email template.
You should customize the email templates in the following ways:
- Change the From Email and From Name to a group email from your organization.
- Add a Reply-To Email and Reply-To-Name.
- Customize the content. Note that the variables differ by email template.
- (optional) Add a group email or distribution list to the BCC that you'd like to notify when a Test Drive is launched or completed. For example, sales distribution or the Test Drive project team.
Additional Email Customization
By default, email sent by Orbitera will appear in some email clients as being sent by "Orbitera on behalf of (your account)." This is an email security feature of many email clients.
To remove this message so that emails
are sent directly from your domain, you must make a change to your DNS settings.
To begin this process, please open a support ticket indicating you'd like help
configuring DNS settings for email delivery. Please include the domain you want
to use to send email (for example,
mydomain.com) and an Orbitera
representative will send you further instructions.
- Green list: Any email domains added to the green list will be automatically allowed to launch your Test Drive. We recommend adding your company domain to the green list.
- Red list: Any email domain added to the red list will be blocked from launching your Test Drive. You might want to block free webmail domains and competitors.
We recommend you check the boxes to automatically approve customers and require e-mail validation. Select the fourth box (shown above) if you would like to require address fields. These settings will require a user to validate they registered with an active email account they have access to and will not require an administrator to approve the customer to run Test Drive.
For the Customers Portal, the only field that applies to Test Drive is require EULA acceptance. Select this box if you would like to require EULA acceptance upon signup.
The sections below the Customers Portal do not apply to Test Drive and no configuration is needed.
The callback framework enables you to automatically register leads in your marketing automation system or CRM. Select Add to add a callback and following the instructions in the articles below to setup the callback framework with your marketing automation system or CRM:
If your marketing automation system is not listed above, please submit a support ticket (Click the ? in the top right corner of the application) and a representative will be in touch.
Next, prepare a step-by-step user guide for your customers to follow, and configure your GCP Marketplace Test Drive listing with marketing data and other Deployment Manager configurations, as needed.