Dropmyemail Documentation

Parallels APS

Dropmyemail provides a package to be installed on Parallels Automation. Currently we only support APS v2.0. We will show you the steps to install a white labelled package. For the purpose of this document, we will use a psuedo name called Critical Email for the white label partner. Do replace the name with your company's name when applicable.

Pre-requisites

Please obtain the package from us. We will also provide you with the authentication token for the package.

Installation of the package on PA

The following instructions assumes you are the admin on the PA. First log in as admin.

  • Click on Applications.
  • On the Applications page, click on Import Package. Select the local file option, and select the Dropmyemail APS package from your local drive.
  • Click Submit

install-aps-package from Wong Liang Zan on Vimeo.

Connecting Dropmyemail to PA

Now we need to hook up the Dropmyemail API server to the PA.

  • On the Applications page, click on the package Dropmyemail
  • On the Dropmyemail package page, click on the Instances tab
  • On the Instances tab, click on Install
  • For the Application API end-point URI field, enter https://api.staging.dropmyemail.com/v1/aps
  • For the next form, enter a name that identifies the partner for the Name field. Eg. Critical Email
  • For the Authentication Token field, enter the token provided by Dropmyemail.
  • Click Finish

install-application from Wong Liang Zan on Vimeo.

Defining the service

First we need to define the resources which we are selling. Then we need to define the service templates which sets the limit for the resources.

  • Click on Resources
  • Click on Add New Resource Type
  • Click on Application Service Reference.
  • Enter Dromyemail Archive for the Name field and click Next
  • Select Dropmyemail
  • You should see a series of screens with links. There should be only one link on each screen. Click on the links.

There are 3 resources. Repeat the same steps with the following input.

  • Dropmyemail Archiving: Application Service Reference
  • Dropmyemail Customers: Application Service, automatic provisioning
  • Dropmyemail Seats: Application Service, no automatic provisioning

Once done, we need to create the service template. The following is an example of an unlimited plan.

  • Click on Service Templates
  • Click on Add New Service Template
  • Enter Critical Email for the name field. This field will appear on the customer's subscription. It should be the name of your service. Also enable the Autoprovisioning checkbox. Use the default value Custom for the Type field. You may type anything for the Description field.
  • Find the earlier 3 resources we've defined, check them and click Next
  • Adjust the limit as you need and click Next
  • Click Finish

The service template is not active yet. You need to click on the template and click on Activate to enable it.

define-service from Wong Liang Zan on Vimeo.

Add service plan

Now we need to create the service plan.

  • Click on Billing on the top right corner. This should lead you to PBA.
  • Click on Service Plans under Products.
  • Click on Add New Service Plan
  • Select Generic Service Plan and click Next
  • Choose the service template defined earlier and click Next
  • Fill in the details for the service plans and click Next
  • Define your billing period for the plans. Change the fees accordingly and click Next.
  • Select all the resources and click Next
  • Set a number for Inc. Amount and Max Amount. There is no limit to the resources. So we use an arbitrarily large number. For Recurring Fee, set a fee only for the Seat resource. Click Next when done.
  • Select the sales categories and click Next
  • View throught the summary and click Finish

add-service-plan from Wong Liang Zan on Vimeo.

Provision Order

The following flow is not necessary. We show this to create a mock order from a customer.

  • Click on Orders
  • Click on Add New Order
  • Select a customer for Account
  • Select the previously created service plan for Service Plan
  • Select a subscription period for Subscription Period
  • Click Next
  • Enter the domain name and click Next
  • Go through the order summary and click Place Order
  • Select the order from the list and click Open Order to complete the order

Once done your customer would be subscribed to the service

provision-order from Wong Liang Zan on Vimeo.

Customer view

The following shows the customer control panel once it has been installed.

customer-control-panel from Wong Liang Zan on Vimeo.

Journal Set up view

Here is how it looks when trying to enable journaling for an email account.

pa-dme-journaling-setup from Wong Liang Zan on Vimeo.