mimecast service provider deployment guide
TRANSCRIPT
Mimecast Service Provider Deployment Guide For Odin Service Automation
Revision 10 (March 2016)
Contents Preface 4
Documentation Conventions 4
Typographical Conventions 4
General Conventions 5
Feedback 6 Introduction 7
About This Guide 7
Audience 7
Terms and Abbreviations 7 Business Model Overview 8 Mimecast Services Provided 8
Service Hierarchy Exposed by Mimecast 9 Customerrsquos Workflow 10
The integration workflow looks as follows 10 Localization List 11 Revision History 11 Contractual contact information for Mimecast 12 Support Expectations 12 Technical Integration Overview 13
General Architecture 13
Mimecast Services Provided 14
Prerequisites for Mimecast Application 14 Deploying Mimecast APS Package 15
Preparing Provisioning Host 15
Importing Mimecast Application 17 Configuring Services for Selling - OSA 18
Instance Creation 19
Production Grid Management 20
Products and Add-ons Management 21
Resource Creation 25
Service Template Creation 29
Configuring Services for Selling - OBA 30
Service Plans 30
Resource Rates 32
Service Plan Upgrading 34
Order Creation 36
Delete Subscription 38 Index 39
C H A P T E R 1
Preface
In This Chapter
Documentation Conventions 4 Feedback 6
Documentation Conventions
Before you start using this guide it is important to understand the documentation conventions used in it
Typographical Conventions
The following kinds of formatting in the text identify special information Formatting convention
Special Bold
Type of Information Example Items you must select such as Navigate to the QoS tab menu options command buttons or items in a list
Italics
Titles of modules sections and subsections Used to emphasize the importance of a point to introduce a term or to designate a command line placeholder which is to be replaced with a real name or value
Read the Basic Administration module These are the so-called shared VEs To destroy a VE type vzctl destroy VEid
Important
An important note provides information that is essential to the completion of a task Users can disregard information in a note and still complete a task but they should not disregard an important note
Important The device drivers installed automatically during Setup are required by your system If you remove one of these drivers your system may not work properly
Preface
Note
A note with the heading ldquoNoterdquo indicates neutral or positive information that emphasizes or supplements important points of the main text A note supplies information that may apply only in special casesmdashfor example memory limitations equipment configurations or details that apply to specific versions of a program
Note If Windows prompts you for a network password at startup your network is already set up and you can skip this section
Monospace Preformatted Preformatted Bold CAPITALS
The names of commands files and directories On-screen computer output in your command-line sessions source code in XML C++ or other programming languages What you type contrasted with on-screen computer output Names of keys on the keyboard
Use vzctl start to start a VE Saved parameters for VE 101 rpm ndashV virtuozzo-release SHIFT CTRL ALT
KEY+KEY
Key combinations for which the CTRL+P ALT+F4 user must press and hold down one key and then press another
General Conventions Be aware of the following conventions used in this book bull Modules in this guide are divided into sections which in turn are subdivided into
subsections For example Documentation Conventions is a section and General Conventions is a subsection
bull When following steps or using examples be sure to type double-quotes () left single-quotes (`) and right single-quotes () exactly as shown
bull The key referred to as RETURN is labeled ENTER on some keyboards Commands in the directories included into the PATH variable are used without absolute path names Steps that use commands in other less common directories show the absolute paths in the examples
5
Preface
Feedback If you have found a mistake in this guide or if you have suggestions or ideas on how to improve this guide please send your feedback using supportdevtechgroupcom Please include in your report the guides title chapter and section titles and the fragment of text in which you have found an error 6
C H A P T E R 2
Introduction
In This Chapter
About This Guide 7 Audience 7 Terms and Abbreviations 7
About This Guide
This guide describes the integration of Odin Service Automation with Mimecast
This document was developed by DevTech For additional information please contact supportdevtechgroupcom
Audience
This guide is intended for
bull Providers that use Odin Service Automation and want to sell Mimecast services to customers
bull Technical support engineers that configure Mimecast services
Terms and Abbreviations
bull APS ‒ Application Packaging Standard an open standard that was designed to simplify the delivery of SaaS applications in the cloud-computing industry
bull OSA ‒ Odin Service Automation which includes OBA bull OBA ‒ Odin Business Automation bull PCP ‒ Provider Control Panel bull CCP ndash Customer Control Panel
C H A P T E R 3
Business Model Overview
Mimecast is an international company specializing in cloud-based email management for Microsoft Exchange and Microsoft Office 365 including security archiving and continuity services to protect business mail
Mimecast reduces the risk complexity and cost traditionally associated with protecting email You no longer have to manage an array of disjointed point solutions from multiple vendors And you mitigate single vendor exposure if you have moved your primary email server to the cloud with services like Microsoft Office 365
Mimecast Services Provided
By purchasing a Mimecast APS package an SMB gets a Mimecast account and some of the provided Mimecast services that he decides to buy The package provides basic Mimecast account management (contact information update) update billing information (buy additional Users seats) and upgrade purchased Mimecast services Any other service management is performed from the Mimecast Admin control panel on the Mimecast platform
Table of billable offerings of Mimecast
Attribute Type Period
User Seats Counter (unit) mqy
Mimecast Services Provided
Service Hierarchy Exposed by Mimecast
Global Setting
Production Grid
Product
Add-on
Customer
o User Seats
o Maximum Retention
9
Customerrsquos Workflow
Customerrsquos Workflow
The integration workflow looks as follows
1 Customer goes to OSA Providerrsquos Online Store Front and locates the Mimecast service offering
2 Customer adds the appropriate plan to his cart 3 On the checkout page customer will review his order accept license agreement if any
create a new customer account or log in to an existing account to place his order 4 Order should be accepted and processed Auto-provision starts 5 Customer now logs into his CCP using the login credentials created during the initial
purchase 6 Customer selects the appropriate Mimecast subscription from the Subscription List
on the Top of the Control Panel
10
Localization List C H A P T E R 4
Localization List
Mimecast has been localized in the following languages for each category
1 Customer Interface
a EN
2 OSA task manager error logging
a EN
3 Mimecast API error messaging
a EN
4 Mimecast external communication to customer
a EN
Revision History
10 Build 1
- Initial APS package
11
Contractual contact information for Mimecast
Service Providers using Odin Service Automation should contact the following to initiate the reseller account creation process by executing the required contracts before Mimecast can be resold globalchannelmimecastcom To choose right regional sales channel Service provider should visit httpswwwmimecastcomcompanycontact
Support Expectations
When Customers using Mimecast services from Odin Service Automation require support they can create a support ticket on httpswwwmimecastcomcustomer-successtechnical-support page or contact Mimecast via email supportmimecastcom
Technical Integration Overview
Technical Integration Overview
General Architecture
The following scheme represents the architecture of OSA and Mimecast integration
13
Technical Integration Overview
Mimecast Services Provided Mimecast APS package enables Odin Service Automation service provider to sell Mimecast services to their customers per number of user basis Examples of some Mimecast services
Secure Email Gateway user optimized spam protection malware DoS and DHA protection Real-time diagnostic and reporting data loss prevention secure message delivery email branding and disclaimer management document conversion and metadata management real-time online queue management large attachment management advanced routing and spooling
Targeted Threat Protection URL rewriting at the gateway with time-of-click scanning for malicious content before being opened
Once the subscription has been provisioned the Customer Admin has the ability to login to the CCP and do basic management of the Mimecast account
Prerequisites for Mimecast Application Service Provider is required to have Mimecast deployment ready and working in order to be able to integrate it in OSA Mimecast APS Package requires APS Billing Application installed on OSA platform The Instructions for Deployment process of the APS Billing Application could be found on official APS Standard page httpdocapsstandardorg21paupselldeploydeployment-of-aps-billing-application 14
C H A P T E R 5
Deploying Mimecast APS Package
To deploy the Mimecast APS package on the Provisioning Host you need to prepare the host and then import your Mimecast APS package in OSA
In This Chapter
Preparing Provisioning Host 16 Importing Mimecast Application 17
Preparing Provisioning Host
Mimecast APS Package requires an application host server to be setup before it can be successfully imported and used in OSA
The following components are required to be installed on the application endpoint server
o Apache HTTP Server 22 o PHP 53 or later o APS PHP Runtime library
instructions for APS PHP Runtime library could be found on httpdocapsstandardorg21toolsphp-libtools-php-runtime
For automatic application host setup endpointsh script is used You can download it from httpsdocapsstandardorg21_downloadsendpointsh
Steps for automatic setup
copy endpointsh to the root folder on the endpoint
Deploying Mimecast APS Package
execute this command to set rights to
readwriteexecute chmod ndashR 755 endpointsh
copy the Mimecast package to the root folder and execute this command
endpointsh FolderName NameOfThePackageappzip where FolderName is the name of the folder where the package will be unpacked and NameOfThePackage is for example Mimecast-10appzipp After successful execution Message ldquoCONGRATULATIONS Endpoint configured SUCCESSFULLYrdquo should be displayed and package should be automatically unpacked to the varwwwhtmlFolderName folder 16
Deploying Mimecast APS Package
Importing Mimecast Application To import the Mimecast application to OSA 1 In the control panel go to Top gt Services gt Applications The list of the applications
appears 2 Click the Import Package button 3 Import the application from the local workstation select the local file option and specify
the path to the application file using the Chose File button 4 Click the Submit button
17
C H A P T E R 6
Configuring Services for Selling - OSA
Learn about how to configure the service templates that are necessary to form Mimecast APS subscriptions for sale
In This Chapter
Instance Creation 19 Production Grid Management 20 Products and Add-ons Management 21 Resource Creation 26 Service Template Creation 29
Configuring Services for Selling - OBA
Instance Creation In order to create Global Settings and other resource types we are required to create an instance of this package Please follow the steps
Log in to OSA as service provider administrator
Go to Services -gt Applications and select Mimecast APS package
Switch to Instances tab and click the Install button
Provide the endpoint URL in the field ldquoApplication API end-point URIrdquo which takes a form of http[application-endpoint-server-ip][package-location] where
o [application-endpoint-server-ip] is the IP address of your application
server
o [package-location] is the name of the folder on endpoint where the package was unpacked
Click the Next button
On the next screen check both Enable debug logging and Enable API logging checkboxes
Important note We highly recommend to set both logging options Log files will be placed in varwwwhtmlFolderNamelogs folder where FolderName is the name of the folder where the package is unpacked There you can find cloglog file with debug logs and APICallslog with logs of all API calls that package makes toward Mimecast platform
19
Configuring Services for Selling ndash OBA
Production Grid Management Now that the instance of the application is created we can go to the Production Grid tab to create a new Production grid delete a Production Grid or edit a Production Grid settings To create a new Production grid
Click the Create button
Fill the necessary fields and click Create
Important note Service Provider gets API credentials listed above from Mimecast 20
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Contents Preface 4
Documentation Conventions 4
Typographical Conventions 4
General Conventions 5
Feedback 6 Introduction 7
About This Guide 7
Audience 7
Terms and Abbreviations 7 Business Model Overview 8 Mimecast Services Provided 8
Service Hierarchy Exposed by Mimecast 9 Customerrsquos Workflow 10
The integration workflow looks as follows 10 Localization List 11 Revision History 11 Contractual contact information for Mimecast 12 Support Expectations 12 Technical Integration Overview 13
General Architecture 13
Mimecast Services Provided 14
Prerequisites for Mimecast Application 14 Deploying Mimecast APS Package 15
Preparing Provisioning Host 15
Importing Mimecast Application 17 Configuring Services for Selling - OSA 18
Instance Creation 19
Production Grid Management 20
Products and Add-ons Management 21
Resource Creation 25
Service Template Creation 29
Configuring Services for Selling - OBA 30
Service Plans 30
Resource Rates 32
Service Plan Upgrading 34
Order Creation 36
Delete Subscription 38 Index 39
C H A P T E R 1
Preface
In This Chapter
Documentation Conventions 4 Feedback 6
Documentation Conventions
Before you start using this guide it is important to understand the documentation conventions used in it
Typographical Conventions
The following kinds of formatting in the text identify special information Formatting convention
Special Bold
Type of Information Example Items you must select such as Navigate to the QoS tab menu options command buttons or items in a list
Italics
Titles of modules sections and subsections Used to emphasize the importance of a point to introduce a term or to designate a command line placeholder which is to be replaced with a real name or value
Read the Basic Administration module These are the so-called shared VEs To destroy a VE type vzctl destroy VEid
Important
An important note provides information that is essential to the completion of a task Users can disregard information in a note and still complete a task but they should not disregard an important note
Important The device drivers installed automatically during Setup are required by your system If you remove one of these drivers your system may not work properly
Preface
Note
A note with the heading ldquoNoterdquo indicates neutral or positive information that emphasizes or supplements important points of the main text A note supplies information that may apply only in special casesmdashfor example memory limitations equipment configurations or details that apply to specific versions of a program
Note If Windows prompts you for a network password at startup your network is already set up and you can skip this section
Monospace Preformatted Preformatted Bold CAPITALS
The names of commands files and directories On-screen computer output in your command-line sessions source code in XML C++ or other programming languages What you type contrasted with on-screen computer output Names of keys on the keyboard
Use vzctl start to start a VE Saved parameters for VE 101 rpm ndashV virtuozzo-release SHIFT CTRL ALT
KEY+KEY
Key combinations for which the CTRL+P ALT+F4 user must press and hold down one key and then press another
General Conventions Be aware of the following conventions used in this book bull Modules in this guide are divided into sections which in turn are subdivided into
subsections For example Documentation Conventions is a section and General Conventions is a subsection
bull When following steps or using examples be sure to type double-quotes () left single-quotes (`) and right single-quotes () exactly as shown
bull The key referred to as RETURN is labeled ENTER on some keyboards Commands in the directories included into the PATH variable are used without absolute path names Steps that use commands in other less common directories show the absolute paths in the examples
5
Preface
Feedback If you have found a mistake in this guide or if you have suggestions or ideas on how to improve this guide please send your feedback using supportdevtechgroupcom Please include in your report the guides title chapter and section titles and the fragment of text in which you have found an error 6
C H A P T E R 2
Introduction
In This Chapter
About This Guide 7 Audience 7 Terms and Abbreviations 7
About This Guide
This guide describes the integration of Odin Service Automation with Mimecast
This document was developed by DevTech For additional information please contact supportdevtechgroupcom
Audience
This guide is intended for
bull Providers that use Odin Service Automation and want to sell Mimecast services to customers
bull Technical support engineers that configure Mimecast services
Terms and Abbreviations
bull APS ‒ Application Packaging Standard an open standard that was designed to simplify the delivery of SaaS applications in the cloud-computing industry
bull OSA ‒ Odin Service Automation which includes OBA bull OBA ‒ Odin Business Automation bull PCP ‒ Provider Control Panel bull CCP ndash Customer Control Panel
C H A P T E R 3
Business Model Overview
Mimecast is an international company specializing in cloud-based email management for Microsoft Exchange and Microsoft Office 365 including security archiving and continuity services to protect business mail
Mimecast reduces the risk complexity and cost traditionally associated with protecting email You no longer have to manage an array of disjointed point solutions from multiple vendors And you mitigate single vendor exposure if you have moved your primary email server to the cloud with services like Microsoft Office 365
Mimecast Services Provided
By purchasing a Mimecast APS package an SMB gets a Mimecast account and some of the provided Mimecast services that he decides to buy The package provides basic Mimecast account management (contact information update) update billing information (buy additional Users seats) and upgrade purchased Mimecast services Any other service management is performed from the Mimecast Admin control panel on the Mimecast platform
Table of billable offerings of Mimecast
Attribute Type Period
User Seats Counter (unit) mqy
Mimecast Services Provided
Service Hierarchy Exposed by Mimecast
Global Setting
Production Grid
Product
Add-on
Customer
o User Seats
o Maximum Retention
9
Customerrsquos Workflow
Customerrsquos Workflow
The integration workflow looks as follows
1 Customer goes to OSA Providerrsquos Online Store Front and locates the Mimecast service offering
2 Customer adds the appropriate plan to his cart 3 On the checkout page customer will review his order accept license agreement if any
create a new customer account or log in to an existing account to place his order 4 Order should be accepted and processed Auto-provision starts 5 Customer now logs into his CCP using the login credentials created during the initial
purchase 6 Customer selects the appropriate Mimecast subscription from the Subscription List
on the Top of the Control Panel
10
Localization List C H A P T E R 4
Localization List
Mimecast has been localized in the following languages for each category
1 Customer Interface
a EN
2 OSA task manager error logging
a EN
3 Mimecast API error messaging
a EN
4 Mimecast external communication to customer
a EN
Revision History
10 Build 1
- Initial APS package
11
Contractual contact information for Mimecast
Service Providers using Odin Service Automation should contact the following to initiate the reseller account creation process by executing the required contracts before Mimecast can be resold globalchannelmimecastcom To choose right regional sales channel Service provider should visit httpswwwmimecastcomcompanycontact
Support Expectations
When Customers using Mimecast services from Odin Service Automation require support they can create a support ticket on httpswwwmimecastcomcustomer-successtechnical-support page or contact Mimecast via email supportmimecastcom
Technical Integration Overview
Technical Integration Overview
General Architecture
The following scheme represents the architecture of OSA and Mimecast integration
13
Technical Integration Overview
Mimecast Services Provided Mimecast APS package enables Odin Service Automation service provider to sell Mimecast services to their customers per number of user basis Examples of some Mimecast services
Secure Email Gateway user optimized spam protection malware DoS and DHA protection Real-time diagnostic and reporting data loss prevention secure message delivery email branding and disclaimer management document conversion and metadata management real-time online queue management large attachment management advanced routing and spooling
Targeted Threat Protection URL rewriting at the gateway with time-of-click scanning for malicious content before being opened
Once the subscription has been provisioned the Customer Admin has the ability to login to the CCP and do basic management of the Mimecast account
Prerequisites for Mimecast Application Service Provider is required to have Mimecast deployment ready and working in order to be able to integrate it in OSA Mimecast APS Package requires APS Billing Application installed on OSA platform The Instructions for Deployment process of the APS Billing Application could be found on official APS Standard page httpdocapsstandardorg21paupselldeploydeployment-of-aps-billing-application 14
C H A P T E R 5
Deploying Mimecast APS Package
To deploy the Mimecast APS package on the Provisioning Host you need to prepare the host and then import your Mimecast APS package in OSA
In This Chapter
Preparing Provisioning Host 16 Importing Mimecast Application 17
Preparing Provisioning Host
Mimecast APS Package requires an application host server to be setup before it can be successfully imported and used in OSA
The following components are required to be installed on the application endpoint server
o Apache HTTP Server 22 o PHP 53 or later o APS PHP Runtime library
instructions for APS PHP Runtime library could be found on httpdocapsstandardorg21toolsphp-libtools-php-runtime
For automatic application host setup endpointsh script is used You can download it from httpsdocapsstandardorg21_downloadsendpointsh
Steps for automatic setup
copy endpointsh to the root folder on the endpoint
Deploying Mimecast APS Package
execute this command to set rights to
readwriteexecute chmod ndashR 755 endpointsh
copy the Mimecast package to the root folder and execute this command
endpointsh FolderName NameOfThePackageappzip where FolderName is the name of the folder where the package will be unpacked and NameOfThePackage is for example Mimecast-10appzipp After successful execution Message ldquoCONGRATULATIONS Endpoint configured SUCCESSFULLYrdquo should be displayed and package should be automatically unpacked to the varwwwhtmlFolderName folder 16
Deploying Mimecast APS Package
Importing Mimecast Application To import the Mimecast application to OSA 1 In the control panel go to Top gt Services gt Applications The list of the applications
appears 2 Click the Import Package button 3 Import the application from the local workstation select the local file option and specify
the path to the application file using the Chose File button 4 Click the Submit button
17
C H A P T E R 6
Configuring Services for Selling - OSA
Learn about how to configure the service templates that are necessary to form Mimecast APS subscriptions for sale
In This Chapter
Instance Creation 19 Production Grid Management 20 Products and Add-ons Management 21 Resource Creation 26 Service Template Creation 29
Configuring Services for Selling - OBA
Instance Creation In order to create Global Settings and other resource types we are required to create an instance of this package Please follow the steps
Log in to OSA as service provider administrator
Go to Services -gt Applications and select Mimecast APS package
Switch to Instances tab and click the Install button
Provide the endpoint URL in the field ldquoApplication API end-point URIrdquo which takes a form of http[application-endpoint-server-ip][package-location] where
o [application-endpoint-server-ip] is the IP address of your application
server
o [package-location] is the name of the folder on endpoint where the package was unpacked
Click the Next button
On the next screen check both Enable debug logging and Enable API logging checkboxes
Important note We highly recommend to set both logging options Log files will be placed in varwwwhtmlFolderNamelogs folder where FolderName is the name of the folder where the package is unpacked There you can find cloglog file with debug logs and APICallslog with logs of all API calls that package makes toward Mimecast platform
19
Configuring Services for Selling ndash OBA
Production Grid Management Now that the instance of the application is created we can go to the Production Grid tab to create a new Production grid delete a Production Grid or edit a Production Grid settings To create a new Production grid
Click the Create button
Fill the necessary fields and click Create
Important note Service Provider gets API credentials listed above from Mimecast 20
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Service Template Creation 29
Configuring Services for Selling - OBA 30
Service Plans 30
Resource Rates 32
Service Plan Upgrading 34
Order Creation 36
Delete Subscription 38 Index 39
C H A P T E R 1
Preface
In This Chapter
Documentation Conventions 4 Feedback 6
Documentation Conventions
Before you start using this guide it is important to understand the documentation conventions used in it
Typographical Conventions
The following kinds of formatting in the text identify special information Formatting convention
Special Bold
Type of Information Example Items you must select such as Navigate to the QoS tab menu options command buttons or items in a list
Italics
Titles of modules sections and subsections Used to emphasize the importance of a point to introduce a term or to designate a command line placeholder which is to be replaced with a real name or value
Read the Basic Administration module These are the so-called shared VEs To destroy a VE type vzctl destroy VEid
Important
An important note provides information that is essential to the completion of a task Users can disregard information in a note and still complete a task but they should not disregard an important note
Important The device drivers installed automatically during Setup are required by your system If you remove one of these drivers your system may not work properly
Preface
Note
A note with the heading ldquoNoterdquo indicates neutral or positive information that emphasizes or supplements important points of the main text A note supplies information that may apply only in special casesmdashfor example memory limitations equipment configurations or details that apply to specific versions of a program
Note If Windows prompts you for a network password at startup your network is already set up and you can skip this section
Monospace Preformatted Preformatted Bold CAPITALS
The names of commands files and directories On-screen computer output in your command-line sessions source code in XML C++ or other programming languages What you type contrasted with on-screen computer output Names of keys on the keyboard
Use vzctl start to start a VE Saved parameters for VE 101 rpm ndashV virtuozzo-release SHIFT CTRL ALT
KEY+KEY
Key combinations for which the CTRL+P ALT+F4 user must press and hold down one key and then press another
General Conventions Be aware of the following conventions used in this book bull Modules in this guide are divided into sections which in turn are subdivided into
subsections For example Documentation Conventions is a section and General Conventions is a subsection
bull When following steps or using examples be sure to type double-quotes () left single-quotes (`) and right single-quotes () exactly as shown
bull The key referred to as RETURN is labeled ENTER on some keyboards Commands in the directories included into the PATH variable are used without absolute path names Steps that use commands in other less common directories show the absolute paths in the examples
5
Preface
Feedback If you have found a mistake in this guide or if you have suggestions or ideas on how to improve this guide please send your feedback using supportdevtechgroupcom Please include in your report the guides title chapter and section titles and the fragment of text in which you have found an error 6
C H A P T E R 2
Introduction
In This Chapter
About This Guide 7 Audience 7 Terms and Abbreviations 7
About This Guide
This guide describes the integration of Odin Service Automation with Mimecast
This document was developed by DevTech For additional information please contact supportdevtechgroupcom
Audience
This guide is intended for
bull Providers that use Odin Service Automation and want to sell Mimecast services to customers
bull Technical support engineers that configure Mimecast services
Terms and Abbreviations
bull APS ‒ Application Packaging Standard an open standard that was designed to simplify the delivery of SaaS applications in the cloud-computing industry
bull OSA ‒ Odin Service Automation which includes OBA bull OBA ‒ Odin Business Automation bull PCP ‒ Provider Control Panel bull CCP ndash Customer Control Panel
C H A P T E R 3
Business Model Overview
Mimecast is an international company specializing in cloud-based email management for Microsoft Exchange and Microsoft Office 365 including security archiving and continuity services to protect business mail
Mimecast reduces the risk complexity and cost traditionally associated with protecting email You no longer have to manage an array of disjointed point solutions from multiple vendors And you mitigate single vendor exposure if you have moved your primary email server to the cloud with services like Microsoft Office 365
Mimecast Services Provided
By purchasing a Mimecast APS package an SMB gets a Mimecast account and some of the provided Mimecast services that he decides to buy The package provides basic Mimecast account management (contact information update) update billing information (buy additional Users seats) and upgrade purchased Mimecast services Any other service management is performed from the Mimecast Admin control panel on the Mimecast platform
Table of billable offerings of Mimecast
Attribute Type Period
User Seats Counter (unit) mqy
Mimecast Services Provided
Service Hierarchy Exposed by Mimecast
Global Setting
Production Grid
Product
Add-on
Customer
o User Seats
o Maximum Retention
9
Customerrsquos Workflow
Customerrsquos Workflow
The integration workflow looks as follows
1 Customer goes to OSA Providerrsquos Online Store Front and locates the Mimecast service offering
2 Customer adds the appropriate plan to his cart 3 On the checkout page customer will review his order accept license agreement if any
create a new customer account or log in to an existing account to place his order 4 Order should be accepted and processed Auto-provision starts 5 Customer now logs into his CCP using the login credentials created during the initial
purchase 6 Customer selects the appropriate Mimecast subscription from the Subscription List
on the Top of the Control Panel
10
Localization List C H A P T E R 4
Localization List
Mimecast has been localized in the following languages for each category
1 Customer Interface
a EN
2 OSA task manager error logging
a EN
3 Mimecast API error messaging
a EN
4 Mimecast external communication to customer
a EN
Revision History
10 Build 1
- Initial APS package
11
Contractual contact information for Mimecast
Service Providers using Odin Service Automation should contact the following to initiate the reseller account creation process by executing the required contracts before Mimecast can be resold globalchannelmimecastcom To choose right regional sales channel Service provider should visit httpswwwmimecastcomcompanycontact
Support Expectations
When Customers using Mimecast services from Odin Service Automation require support they can create a support ticket on httpswwwmimecastcomcustomer-successtechnical-support page or contact Mimecast via email supportmimecastcom
Technical Integration Overview
Technical Integration Overview
General Architecture
The following scheme represents the architecture of OSA and Mimecast integration
13
Technical Integration Overview
Mimecast Services Provided Mimecast APS package enables Odin Service Automation service provider to sell Mimecast services to their customers per number of user basis Examples of some Mimecast services
Secure Email Gateway user optimized spam protection malware DoS and DHA protection Real-time diagnostic and reporting data loss prevention secure message delivery email branding and disclaimer management document conversion and metadata management real-time online queue management large attachment management advanced routing and spooling
Targeted Threat Protection URL rewriting at the gateway with time-of-click scanning for malicious content before being opened
Once the subscription has been provisioned the Customer Admin has the ability to login to the CCP and do basic management of the Mimecast account
Prerequisites for Mimecast Application Service Provider is required to have Mimecast deployment ready and working in order to be able to integrate it in OSA Mimecast APS Package requires APS Billing Application installed on OSA platform The Instructions for Deployment process of the APS Billing Application could be found on official APS Standard page httpdocapsstandardorg21paupselldeploydeployment-of-aps-billing-application 14
C H A P T E R 5
Deploying Mimecast APS Package
To deploy the Mimecast APS package on the Provisioning Host you need to prepare the host and then import your Mimecast APS package in OSA
In This Chapter
Preparing Provisioning Host 16 Importing Mimecast Application 17
Preparing Provisioning Host
Mimecast APS Package requires an application host server to be setup before it can be successfully imported and used in OSA
The following components are required to be installed on the application endpoint server
o Apache HTTP Server 22 o PHP 53 or later o APS PHP Runtime library
instructions for APS PHP Runtime library could be found on httpdocapsstandardorg21toolsphp-libtools-php-runtime
For automatic application host setup endpointsh script is used You can download it from httpsdocapsstandardorg21_downloadsendpointsh
Steps for automatic setup
copy endpointsh to the root folder on the endpoint
Deploying Mimecast APS Package
execute this command to set rights to
readwriteexecute chmod ndashR 755 endpointsh
copy the Mimecast package to the root folder and execute this command
endpointsh FolderName NameOfThePackageappzip where FolderName is the name of the folder where the package will be unpacked and NameOfThePackage is for example Mimecast-10appzipp After successful execution Message ldquoCONGRATULATIONS Endpoint configured SUCCESSFULLYrdquo should be displayed and package should be automatically unpacked to the varwwwhtmlFolderName folder 16
Deploying Mimecast APS Package
Importing Mimecast Application To import the Mimecast application to OSA 1 In the control panel go to Top gt Services gt Applications The list of the applications
appears 2 Click the Import Package button 3 Import the application from the local workstation select the local file option and specify
the path to the application file using the Chose File button 4 Click the Submit button
17
C H A P T E R 6
Configuring Services for Selling - OSA
Learn about how to configure the service templates that are necessary to form Mimecast APS subscriptions for sale
In This Chapter
Instance Creation 19 Production Grid Management 20 Products and Add-ons Management 21 Resource Creation 26 Service Template Creation 29
Configuring Services for Selling - OBA
Instance Creation In order to create Global Settings and other resource types we are required to create an instance of this package Please follow the steps
Log in to OSA as service provider administrator
Go to Services -gt Applications and select Mimecast APS package
Switch to Instances tab and click the Install button
Provide the endpoint URL in the field ldquoApplication API end-point URIrdquo which takes a form of http[application-endpoint-server-ip][package-location] where
o [application-endpoint-server-ip] is the IP address of your application
server
o [package-location] is the name of the folder on endpoint where the package was unpacked
Click the Next button
On the next screen check both Enable debug logging and Enable API logging checkboxes
Important note We highly recommend to set both logging options Log files will be placed in varwwwhtmlFolderNamelogs folder where FolderName is the name of the folder where the package is unpacked There you can find cloglog file with debug logs and APICallslog with logs of all API calls that package makes toward Mimecast platform
19
Configuring Services for Selling ndash OBA
Production Grid Management Now that the instance of the application is created we can go to the Production Grid tab to create a new Production grid delete a Production Grid or edit a Production Grid settings To create a new Production grid
Click the Create button
Fill the necessary fields and click Create
Important note Service Provider gets API credentials listed above from Mimecast 20
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
C H A P T E R 1
Preface
In This Chapter
Documentation Conventions 4 Feedback 6
Documentation Conventions
Before you start using this guide it is important to understand the documentation conventions used in it
Typographical Conventions
The following kinds of formatting in the text identify special information Formatting convention
Special Bold
Type of Information Example Items you must select such as Navigate to the QoS tab menu options command buttons or items in a list
Italics
Titles of modules sections and subsections Used to emphasize the importance of a point to introduce a term or to designate a command line placeholder which is to be replaced with a real name or value
Read the Basic Administration module These are the so-called shared VEs To destroy a VE type vzctl destroy VEid
Important
An important note provides information that is essential to the completion of a task Users can disregard information in a note and still complete a task but they should not disregard an important note
Important The device drivers installed automatically during Setup are required by your system If you remove one of these drivers your system may not work properly
Preface
Note
A note with the heading ldquoNoterdquo indicates neutral or positive information that emphasizes or supplements important points of the main text A note supplies information that may apply only in special casesmdashfor example memory limitations equipment configurations or details that apply to specific versions of a program
Note If Windows prompts you for a network password at startup your network is already set up and you can skip this section
Monospace Preformatted Preformatted Bold CAPITALS
The names of commands files and directories On-screen computer output in your command-line sessions source code in XML C++ or other programming languages What you type contrasted with on-screen computer output Names of keys on the keyboard
Use vzctl start to start a VE Saved parameters for VE 101 rpm ndashV virtuozzo-release SHIFT CTRL ALT
KEY+KEY
Key combinations for which the CTRL+P ALT+F4 user must press and hold down one key and then press another
General Conventions Be aware of the following conventions used in this book bull Modules in this guide are divided into sections which in turn are subdivided into
subsections For example Documentation Conventions is a section and General Conventions is a subsection
bull When following steps or using examples be sure to type double-quotes () left single-quotes (`) and right single-quotes () exactly as shown
bull The key referred to as RETURN is labeled ENTER on some keyboards Commands in the directories included into the PATH variable are used without absolute path names Steps that use commands in other less common directories show the absolute paths in the examples
5
Preface
Feedback If you have found a mistake in this guide or if you have suggestions or ideas on how to improve this guide please send your feedback using supportdevtechgroupcom Please include in your report the guides title chapter and section titles and the fragment of text in which you have found an error 6
C H A P T E R 2
Introduction
In This Chapter
About This Guide 7 Audience 7 Terms and Abbreviations 7
About This Guide
This guide describes the integration of Odin Service Automation with Mimecast
This document was developed by DevTech For additional information please contact supportdevtechgroupcom
Audience
This guide is intended for
bull Providers that use Odin Service Automation and want to sell Mimecast services to customers
bull Technical support engineers that configure Mimecast services
Terms and Abbreviations
bull APS ‒ Application Packaging Standard an open standard that was designed to simplify the delivery of SaaS applications in the cloud-computing industry
bull OSA ‒ Odin Service Automation which includes OBA bull OBA ‒ Odin Business Automation bull PCP ‒ Provider Control Panel bull CCP ndash Customer Control Panel
C H A P T E R 3
Business Model Overview
Mimecast is an international company specializing in cloud-based email management for Microsoft Exchange and Microsoft Office 365 including security archiving and continuity services to protect business mail
Mimecast reduces the risk complexity and cost traditionally associated with protecting email You no longer have to manage an array of disjointed point solutions from multiple vendors And you mitigate single vendor exposure if you have moved your primary email server to the cloud with services like Microsoft Office 365
Mimecast Services Provided
By purchasing a Mimecast APS package an SMB gets a Mimecast account and some of the provided Mimecast services that he decides to buy The package provides basic Mimecast account management (contact information update) update billing information (buy additional Users seats) and upgrade purchased Mimecast services Any other service management is performed from the Mimecast Admin control panel on the Mimecast platform
Table of billable offerings of Mimecast
Attribute Type Period
User Seats Counter (unit) mqy
Mimecast Services Provided
Service Hierarchy Exposed by Mimecast
Global Setting
Production Grid
Product
Add-on
Customer
o User Seats
o Maximum Retention
9
Customerrsquos Workflow
Customerrsquos Workflow
The integration workflow looks as follows
1 Customer goes to OSA Providerrsquos Online Store Front and locates the Mimecast service offering
2 Customer adds the appropriate plan to his cart 3 On the checkout page customer will review his order accept license agreement if any
create a new customer account or log in to an existing account to place his order 4 Order should be accepted and processed Auto-provision starts 5 Customer now logs into his CCP using the login credentials created during the initial
purchase 6 Customer selects the appropriate Mimecast subscription from the Subscription List
on the Top of the Control Panel
10
Localization List C H A P T E R 4
Localization List
Mimecast has been localized in the following languages for each category
1 Customer Interface
a EN
2 OSA task manager error logging
a EN
3 Mimecast API error messaging
a EN
4 Mimecast external communication to customer
a EN
Revision History
10 Build 1
- Initial APS package
11
Contractual contact information for Mimecast
Service Providers using Odin Service Automation should contact the following to initiate the reseller account creation process by executing the required contracts before Mimecast can be resold globalchannelmimecastcom To choose right regional sales channel Service provider should visit httpswwwmimecastcomcompanycontact
Support Expectations
When Customers using Mimecast services from Odin Service Automation require support they can create a support ticket on httpswwwmimecastcomcustomer-successtechnical-support page or contact Mimecast via email supportmimecastcom
Technical Integration Overview
Technical Integration Overview
General Architecture
The following scheme represents the architecture of OSA and Mimecast integration
13
Technical Integration Overview
Mimecast Services Provided Mimecast APS package enables Odin Service Automation service provider to sell Mimecast services to their customers per number of user basis Examples of some Mimecast services
Secure Email Gateway user optimized spam protection malware DoS and DHA protection Real-time diagnostic and reporting data loss prevention secure message delivery email branding and disclaimer management document conversion and metadata management real-time online queue management large attachment management advanced routing and spooling
Targeted Threat Protection URL rewriting at the gateway with time-of-click scanning for malicious content before being opened
Once the subscription has been provisioned the Customer Admin has the ability to login to the CCP and do basic management of the Mimecast account
Prerequisites for Mimecast Application Service Provider is required to have Mimecast deployment ready and working in order to be able to integrate it in OSA Mimecast APS Package requires APS Billing Application installed on OSA platform The Instructions for Deployment process of the APS Billing Application could be found on official APS Standard page httpdocapsstandardorg21paupselldeploydeployment-of-aps-billing-application 14
C H A P T E R 5
Deploying Mimecast APS Package
To deploy the Mimecast APS package on the Provisioning Host you need to prepare the host and then import your Mimecast APS package in OSA
In This Chapter
Preparing Provisioning Host 16 Importing Mimecast Application 17
Preparing Provisioning Host
Mimecast APS Package requires an application host server to be setup before it can be successfully imported and used in OSA
The following components are required to be installed on the application endpoint server
o Apache HTTP Server 22 o PHP 53 or later o APS PHP Runtime library
instructions for APS PHP Runtime library could be found on httpdocapsstandardorg21toolsphp-libtools-php-runtime
For automatic application host setup endpointsh script is used You can download it from httpsdocapsstandardorg21_downloadsendpointsh
Steps for automatic setup
copy endpointsh to the root folder on the endpoint
Deploying Mimecast APS Package
execute this command to set rights to
readwriteexecute chmod ndashR 755 endpointsh
copy the Mimecast package to the root folder and execute this command
endpointsh FolderName NameOfThePackageappzip where FolderName is the name of the folder where the package will be unpacked and NameOfThePackage is for example Mimecast-10appzipp After successful execution Message ldquoCONGRATULATIONS Endpoint configured SUCCESSFULLYrdquo should be displayed and package should be automatically unpacked to the varwwwhtmlFolderName folder 16
Deploying Mimecast APS Package
Importing Mimecast Application To import the Mimecast application to OSA 1 In the control panel go to Top gt Services gt Applications The list of the applications
appears 2 Click the Import Package button 3 Import the application from the local workstation select the local file option and specify
the path to the application file using the Chose File button 4 Click the Submit button
17
C H A P T E R 6
Configuring Services for Selling - OSA
Learn about how to configure the service templates that are necessary to form Mimecast APS subscriptions for sale
In This Chapter
Instance Creation 19 Production Grid Management 20 Products and Add-ons Management 21 Resource Creation 26 Service Template Creation 29
Configuring Services for Selling - OBA
Instance Creation In order to create Global Settings and other resource types we are required to create an instance of this package Please follow the steps
Log in to OSA as service provider administrator
Go to Services -gt Applications and select Mimecast APS package
Switch to Instances tab and click the Install button
Provide the endpoint URL in the field ldquoApplication API end-point URIrdquo which takes a form of http[application-endpoint-server-ip][package-location] where
o [application-endpoint-server-ip] is the IP address of your application
server
o [package-location] is the name of the folder on endpoint where the package was unpacked
Click the Next button
On the next screen check both Enable debug logging and Enable API logging checkboxes
Important note We highly recommend to set both logging options Log files will be placed in varwwwhtmlFolderNamelogs folder where FolderName is the name of the folder where the package is unpacked There you can find cloglog file with debug logs and APICallslog with logs of all API calls that package makes toward Mimecast platform
19
Configuring Services for Selling ndash OBA
Production Grid Management Now that the instance of the application is created we can go to the Production Grid tab to create a new Production grid delete a Production Grid or edit a Production Grid settings To create a new Production grid
Click the Create button
Fill the necessary fields and click Create
Important note Service Provider gets API credentials listed above from Mimecast 20
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Preface
Note
A note with the heading ldquoNoterdquo indicates neutral or positive information that emphasizes or supplements important points of the main text A note supplies information that may apply only in special casesmdashfor example memory limitations equipment configurations or details that apply to specific versions of a program
Note If Windows prompts you for a network password at startup your network is already set up and you can skip this section
Monospace Preformatted Preformatted Bold CAPITALS
The names of commands files and directories On-screen computer output in your command-line sessions source code in XML C++ or other programming languages What you type contrasted with on-screen computer output Names of keys on the keyboard
Use vzctl start to start a VE Saved parameters for VE 101 rpm ndashV virtuozzo-release SHIFT CTRL ALT
KEY+KEY
Key combinations for which the CTRL+P ALT+F4 user must press and hold down one key and then press another
General Conventions Be aware of the following conventions used in this book bull Modules in this guide are divided into sections which in turn are subdivided into
subsections For example Documentation Conventions is a section and General Conventions is a subsection
bull When following steps or using examples be sure to type double-quotes () left single-quotes (`) and right single-quotes () exactly as shown
bull The key referred to as RETURN is labeled ENTER on some keyboards Commands in the directories included into the PATH variable are used without absolute path names Steps that use commands in other less common directories show the absolute paths in the examples
5
Preface
Feedback If you have found a mistake in this guide or if you have suggestions or ideas on how to improve this guide please send your feedback using supportdevtechgroupcom Please include in your report the guides title chapter and section titles and the fragment of text in which you have found an error 6
C H A P T E R 2
Introduction
In This Chapter
About This Guide 7 Audience 7 Terms and Abbreviations 7
About This Guide
This guide describes the integration of Odin Service Automation with Mimecast
This document was developed by DevTech For additional information please contact supportdevtechgroupcom
Audience
This guide is intended for
bull Providers that use Odin Service Automation and want to sell Mimecast services to customers
bull Technical support engineers that configure Mimecast services
Terms and Abbreviations
bull APS ‒ Application Packaging Standard an open standard that was designed to simplify the delivery of SaaS applications in the cloud-computing industry
bull OSA ‒ Odin Service Automation which includes OBA bull OBA ‒ Odin Business Automation bull PCP ‒ Provider Control Panel bull CCP ndash Customer Control Panel
C H A P T E R 3
Business Model Overview
Mimecast is an international company specializing in cloud-based email management for Microsoft Exchange and Microsoft Office 365 including security archiving and continuity services to protect business mail
Mimecast reduces the risk complexity and cost traditionally associated with protecting email You no longer have to manage an array of disjointed point solutions from multiple vendors And you mitigate single vendor exposure if you have moved your primary email server to the cloud with services like Microsoft Office 365
Mimecast Services Provided
By purchasing a Mimecast APS package an SMB gets a Mimecast account and some of the provided Mimecast services that he decides to buy The package provides basic Mimecast account management (contact information update) update billing information (buy additional Users seats) and upgrade purchased Mimecast services Any other service management is performed from the Mimecast Admin control panel on the Mimecast platform
Table of billable offerings of Mimecast
Attribute Type Period
User Seats Counter (unit) mqy
Mimecast Services Provided
Service Hierarchy Exposed by Mimecast
Global Setting
Production Grid
Product
Add-on
Customer
o User Seats
o Maximum Retention
9
Customerrsquos Workflow
Customerrsquos Workflow
The integration workflow looks as follows
1 Customer goes to OSA Providerrsquos Online Store Front and locates the Mimecast service offering
2 Customer adds the appropriate plan to his cart 3 On the checkout page customer will review his order accept license agreement if any
create a new customer account or log in to an existing account to place his order 4 Order should be accepted and processed Auto-provision starts 5 Customer now logs into his CCP using the login credentials created during the initial
purchase 6 Customer selects the appropriate Mimecast subscription from the Subscription List
on the Top of the Control Panel
10
Localization List C H A P T E R 4
Localization List
Mimecast has been localized in the following languages for each category
1 Customer Interface
a EN
2 OSA task manager error logging
a EN
3 Mimecast API error messaging
a EN
4 Mimecast external communication to customer
a EN
Revision History
10 Build 1
- Initial APS package
11
Contractual contact information for Mimecast
Service Providers using Odin Service Automation should contact the following to initiate the reseller account creation process by executing the required contracts before Mimecast can be resold globalchannelmimecastcom To choose right regional sales channel Service provider should visit httpswwwmimecastcomcompanycontact
Support Expectations
When Customers using Mimecast services from Odin Service Automation require support they can create a support ticket on httpswwwmimecastcomcustomer-successtechnical-support page or contact Mimecast via email supportmimecastcom
Technical Integration Overview
Technical Integration Overview
General Architecture
The following scheme represents the architecture of OSA and Mimecast integration
13
Technical Integration Overview
Mimecast Services Provided Mimecast APS package enables Odin Service Automation service provider to sell Mimecast services to their customers per number of user basis Examples of some Mimecast services
Secure Email Gateway user optimized spam protection malware DoS and DHA protection Real-time diagnostic and reporting data loss prevention secure message delivery email branding and disclaimer management document conversion and metadata management real-time online queue management large attachment management advanced routing and spooling
Targeted Threat Protection URL rewriting at the gateway with time-of-click scanning for malicious content before being opened
Once the subscription has been provisioned the Customer Admin has the ability to login to the CCP and do basic management of the Mimecast account
Prerequisites for Mimecast Application Service Provider is required to have Mimecast deployment ready and working in order to be able to integrate it in OSA Mimecast APS Package requires APS Billing Application installed on OSA platform The Instructions for Deployment process of the APS Billing Application could be found on official APS Standard page httpdocapsstandardorg21paupselldeploydeployment-of-aps-billing-application 14
C H A P T E R 5
Deploying Mimecast APS Package
To deploy the Mimecast APS package on the Provisioning Host you need to prepare the host and then import your Mimecast APS package in OSA
In This Chapter
Preparing Provisioning Host 16 Importing Mimecast Application 17
Preparing Provisioning Host
Mimecast APS Package requires an application host server to be setup before it can be successfully imported and used in OSA
The following components are required to be installed on the application endpoint server
o Apache HTTP Server 22 o PHP 53 or later o APS PHP Runtime library
instructions for APS PHP Runtime library could be found on httpdocapsstandardorg21toolsphp-libtools-php-runtime
For automatic application host setup endpointsh script is used You can download it from httpsdocapsstandardorg21_downloadsendpointsh
Steps for automatic setup
copy endpointsh to the root folder on the endpoint
Deploying Mimecast APS Package
execute this command to set rights to
readwriteexecute chmod ndashR 755 endpointsh
copy the Mimecast package to the root folder and execute this command
endpointsh FolderName NameOfThePackageappzip where FolderName is the name of the folder where the package will be unpacked and NameOfThePackage is for example Mimecast-10appzipp After successful execution Message ldquoCONGRATULATIONS Endpoint configured SUCCESSFULLYrdquo should be displayed and package should be automatically unpacked to the varwwwhtmlFolderName folder 16
Deploying Mimecast APS Package
Importing Mimecast Application To import the Mimecast application to OSA 1 In the control panel go to Top gt Services gt Applications The list of the applications
appears 2 Click the Import Package button 3 Import the application from the local workstation select the local file option and specify
the path to the application file using the Chose File button 4 Click the Submit button
17
C H A P T E R 6
Configuring Services for Selling - OSA
Learn about how to configure the service templates that are necessary to form Mimecast APS subscriptions for sale
In This Chapter
Instance Creation 19 Production Grid Management 20 Products and Add-ons Management 21 Resource Creation 26 Service Template Creation 29
Configuring Services for Selling - OBA
Instance Creation In order to create Global Settings and other resource types we are required to create an instance of this package Please follow the steps
Log in to OSA as service provider administrator
Go to Services -gt Applications and select Mimecast APS package
Switch to Instances tab and click the Install button
Provide the endpoint URL in the field ldquoApplication API end-point URIrdquo which takes a form of http[application-endpoint-server-ip][package-location] where
o [application-endpoint-server-ip] is the IP address of your application
server
o [package-location] is the name of the folder on endpoint where the package was unpacked
Click the Next button
On the next screen check both Enable debug logging and Enable API logging checkboxes
Important note We highly recommend to set both logging options Log files will be placed in varwwwhtmlFolderNamelogs folder where FolderName is the name of the folder where the package is unpacked There you can find cloglog file with debug logs and APICallslog with logs of all API calls that package makes toward Mimecast platform
19
Configuring Services for Selling ndash OBA
Production Grid Management Now that the instance of the application is created we can go to the Production Grid tab to create a new Production grid delete a Production Grid or edit a Production Grid settings To create a new Production grid
Click the Create button
Fill the necessary fields and click Create
Important note Service Provider gets API credentials listed above from Mimecast 20
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Preface
Feedback If you have found a mistake in this guide or if you have suggestions or ideas on how to improve this guide please send your feedback using supportdevtechgroupcom Please include in your report the guides title chapter and section titles and the fragment of text in which you have found an error 6
C H A P T E R 2
Introduction
In This Chapter
About This Guide 7 Audience 7 Terms and Abbreviations 7
About This Guide
This guide describes the integration of Odin Service Automation with Mimecast
This document was developed by DevTech For additional information please contact supportdevtechgroupcom
Audience
This guide is intended for
bull Providers that use Odin Service Automation and want to sell Mimecast services to customers
bull Technical support engineers that configure Mimecast services
Terms and Abbreviations
bull APS ‒ Application Packaging Standard an open standard that was designed to simplify the delivery of SaaS applications in the cloud-computing industry
bull OSA ‒ Odin Service Automation which includes OBA bull OBA ‒ Odin Business Automation bull PCP ‒ Provider Control Panel bull CCP ndash Customer Control Panel
C H A P T E R 3
Business Model Overview
Mimecast is an international company specializing in cloud-based email management for Microsoft Exchange and Microsoft Office 365 including security archiving and continuity services to protect business mail
Mimecast reduces the risk complexity and cost traditionally associated with protecting email You no longer have to manage an array of disjointed point solutions from multiple vendors And you mitigate single vendor exposure if you have moved your primary email server to the cloud with services like Microsoft Office 365
Mimecast Services Provided
By purchasing a Mimecast APS package an SMB gets a Mimecast account and some of the provided Mimecast services that he decides to buy The package provides basic Mimecast account management (contact information update) update billing information (buy additional Users seats) and upgrade purchased Mimecast services Any other service management is performed from the Mimecast Admin control panel on the Mimecast platform
Table of billable offerings of Mimecast
Attribute Type Period
User Seats Counter (unit) mqy
Mimecast Services Provided
Service Hierarchy Exposed by Mimecast
Global Setting
Production Grid
Product
Add-on
Customer
o User Seats
o Maximum Retention
9
Customerrsquos Workflow
Customerrsquos Workflow
The integration workflow looks as follows
1 Customer goes to OSA Providerrsquos Online Store Front and locates the Mimecast service offering
2 Customer adds the appropriate plan to his cart 3 On the checkout page customer will review his order accept license agreement if any
create a new customer account or log in to an existing account to place his order 4 Order should be accepted and processed Auto-provision starts 5 Customer now logs into his CCP using the login credentials created during the initial
purchase 6 Customer selects the appropriate Mimecast subscription from the Subscription List
on the Top of the Control Panel
10
Localization List C H A P T E R 4
Localization List
Mimecast has been localized in the following languages for each category
1 Customer Interface
a EN
2 OSA task manager error logging
a EN
3 Mimecast API error messaging
a EN
4 Mimecast external communication to customer
a EN
Revision History
10 Build 1
- Initial APS package
11
Contractual contact information for Mimecast
Service Providers using Odin Service Automation should contact the following to initiate the reseller account creation process by executing the required contracts before Mimecast can be resold globalchannelmimecastcom To choose right regional sales channel Service provider should visit httpswwwmimecastcomcompanycontact
Support Expectations
When Customers using Mimecast services from Odin Service Automation require support they can create a support ticket on httpswwwmimecastcomcustomer-successtechnical-support page or contact Mimecast via email supportmimecastcom
Technical Integration Overview
Technical Integration Overview
General Architecture
The following scheme represents the architecture of OSA and Mimecast integration
13
Technical Integration Overview
Mimecast Services Provided Mimecast APS package enables Odin Service Automation service provider to sell Mimecast services to their customers per number of user basis Examples of some Mimecast services
Secure Email Gateway user optimized spam protection malware DoS and DHA protection Real-time diagnostic and reporting data loss prevention secure message delivery email branding and disclaimer management document conversion and metadata management real-time online queue management large attachment management advanced routing and spooling
Targeted Threat Protection URL rewriting at the gateway with time-of-click scanning for malicious content before being opened
Once the subscription has been provisioned the Customer Admin has the ability to login to the CCP and do basic management of the Mimecast account
Prerequisites for Mimecast Application Service Provider is required to have Mimecast deployment ready and working in order to be able to integrate it in OSA Mimecast APS Package requires APS Billing Application installed on OSA platform The Instructions for Deployment process of the APS Billing Application could be found on official APS Standard page httpdocapsstandardorg21paupselldeploydeployment-of-aps-billing-application 14
C H A P T E R 5
Deploying Mimecast APS Package
To deploy the Mimecast APS package on the Provisioning Host you need to prepare the host and then import your Mimecast APS package in OSA
In This Chapter
Preparing Provisioning Host 16 Importing Mimecast Application 17
Preparing Provisioning Host
Mimecast APS Package requires an application host server to be setup before it can be successfully imported and used in OSA
The following components are required to be installed on the application endpoint server
o Apache HTTP Server 22 o PHP 53 or later o APS PHP Runtime library
instructions for APS PHP Runtime library could be found on httpdocapsstandardorg21toolsphp-libtools-php-runtime
For automatic application host setup endpointsh script is used You can download it from httpsdocapsstandardorg21_downloadsendpointsh
Steps for automatic setup
copy endpointsh to the root folder on the endpoint
Deploying Mimecast APS Package
execute this command to set rights to
readwriteexecute chmod ndashR 755 endpointsh
copy the Mimecast package to the root folder and execute this command
endpointsh FolderName NameOfThePackageappzip where FolderName is the name of the folder where the package will be unpacked and NameOfThePackage is for example Mimecast-10appzipp After successful execution Message ldquoCONGRATULATIONS Endpoint configured SUCCESSFULLYrdquo should be displayed and package should be automatically unpacked to the varwwwhtmlFolderName folder 16
Deploying Mimecast APS Package
Importing Mimecast Application To import the Mimecast application to OSA 1 In the control panel go to Top gt Services gt Applications The list of the applications
appears 2 Click the Import Package button 3 Import the application from the local workstation select the local file option and specify
the path to the application file using the Chose File button 4 Click the Submit button
17
C H A P T E R 6
Configuring Services for Selling - OSA
Learn about how to configure the service templates that are necessary to form Mimecast APS subscriptions for sale
In This Chapter
Instance Creation 19 Production Grid Management 20 Products and Add-ons Management 21 Resource Creation 26 Service Template Creation 29
Configuring Services for Selling - OBA
Instance Creation In order to create Global Settings and other resource types we are required to create an instance of this package Please follow the steps
Log in to OSA as service provider administrator
Go to Services -gt Applications and select Mimecast APS package
Switch to Instances tab and click the Install button
Provide the endpoint URL in the field ldquoApplication API end-point URIrdquo which takes a form of http[application-endpoint-server-ip][package-location] where
o [application-endpoint-server-ip] is the IP address of your application
server
o [package-location] is the name of the folder on endpoint where the package was unpacked
Click the Next button
On the next screen check both Enable debug logging and Enable API logging checkboxes
Important note We highly recommend to set both logging options Log files will be placed in varwwwhtmlFolderNamelogs folder where FolderName is the name of the folder where the package is unpacked There you can find cloglog file with debug logs and APICallslog with logs of all API calls that package makes toward Mimecast platform
19
Configuring Services for Selling ndash OBA
Production Grid Management Now that the instance of the application is created we can go to the Production Grid tab to create a new Production grid delete a Production Grid or edit a Production Grid settings To create a new Production grid
Click the Create button
Fill the necessary fields and click Create
Important note Service Provider gets API credentials listed above from Mimecast 20
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
C H A P T E R 2
Introduction
In This Chapter
About This Guide 7 Audience 7 Terms and Abbreviations 7
About This Guide
This guide describes the integration of Odin Service Automation with Mimecast
This document was developed by DevTech For additional information please contact supportdevtechgroupcom
Audience
This guide is intended for
bull Providers that use Odin Service Automation and want to sell Mimecast services to customers
bull Technical support engineers that configure Mimecast services
Terms and Abbreviations
bull APS ‒ Application Packaging Standard an open standard that was designed to simplify the delivery of SaaS applications in the cloud-computing industry
bull OSA ‒ Odin Service Automation which includes OBA bull OBA ‒ Odin Business Automation bull PCP ‒ Provider Control Panel bull CCP ndash Customer Control Panel
C H A P T E R 3
Business Model Overview
Mimecast is an international company specializing in cloud-based email management for Microsoft Exchange and Microsoft Office 365 including security archiving and continuity services to protect business mail
Mimecast reduces the risk complexity and cost traditionally associated with protecting email You no longer have to manage an array of disjointed point solutions from multiple vendors And you mitigate single vendor exposure if you have moved your primary email server to the cloud with services like Microsoft Office 365
Mimecast Services Provided
By purchasing a Mimecast APS package an SMB gets a Mimecast account and some of the provided Mimecast services that he decides to buy The package provides basic Mimecast account management (contact information update) update billing information (buy additional Users seats) and upgrade purchased Mimecast services Any other service management is performed from the Mimecast Admin control panel on the Mimecast platform
Table of billable offerings of Mimecast
Attribute Type Period
User Seats Counter (unit) mqy
Mimecast Services Provided
Service Hierarchy Exposed by Mimecast
Global Setting
Production Grid
Product
Add-on
Customer
o User Seats
o Maximum Retention
9
Customerrsquos Workflow
Customerrsquos Workflow
The integration workflow looks as follows
1 Customer goes to OSA Providerrsquos Online Store Front and locates the Mimecast service offering
2 Customer adds the appropriate plan to his cart 3 On the checkout page customer will review his order accept license agreement if any
create a new customer account or log in to an existing account to place his order 4 Order should be accepted and processed Auto-provision starts 5 Customer now logs into his CCP using the login credentials created during the initial
purchase 6 Customer selects the appropriate Mimecast subscription from the Subscription List
on the Top of the Control Panel
10
Localization List C H A P T E R 4
Localization List
Mimecast has been localized in the following languages for each category
1 Customer Interface
a EN
2 OSA task manager error logging
a EN
3 Mimecast API error messaging
a EN
4 Mimecast external communication to customer
a EN
Revision History
10 Build 1
- Initial APS package
11
Contractual contact information for Mimecast
Service Providers using Odin Service Automation should contact the following to initiate the reseller account creation process by executing the required contracts before Mimecast can be resold globalchannelmimecastcom To choose right regional sales channel Service provider should visit httpswwwmimecastcomcompanycontact
Support Expectations
When Customers using Mimecast services from Odin Service Automation require support they can create a support ticket on httpswwwmimecastcomcustomer-successtechnical-support page or contact Mimecast via email supportmimecastcom
Technical Integration Overview
Technical Integration Overview
General Architecture
The following scheme represents the architecture of OSA and Mimecast integration
13
Technical Integration Overview
Mimecast Services Provided Mimecast APS package enables Odin Service Automation service provider to sell Mimecast services to their customers per number of user basis Examples of some Mimecast services
Secure Email Gateway user optimized spam protection malware DoS and DHA protection Real-time diagnostic and reporting data loss prevention secure message delivery email branding and disclaimer management document conversion and metadata management real-time online queue management large attachment management advanced routing and spooling
Targeted Threat Protection URL rewriting at the gateway with time-of-click scanning for malicious content before being opened
Once the subscription has been provisioned the Customer Admin has the ability to login to the CCP and do basic management of the Mimecast account
Prerequisites for Mimecast Application Service Provider is required to have Mimecast deployment ready and working in order to be able to integrate it in OSA Mimecast APS Package requires APS Billing Application installed on OSA platform The Instructions for Deployment process of the APS Billing Application could be found on official APS Standard page httpdocapsstandardorg21paupselldeploydeployment-of-aps-billing-application 14
C H A P T E R 5
Deploying Mimecast APS Package
To deploy the Mimecast APS package on the Provisioning Host you need to prepare the host and then import your Mimecast APS package in OSA
In This Chapter
Preparing Provisioning Host 16 Importing Mimecast Application 17
Preparing Provisioning Host
Mimecast APS Package requires an application host server to be setup before it can be successfully imported and used in OSA
The following components are required to be installed on the application endpoint server
o Apache HTTP Server 22 o PHP 53 or later o APS PHP Runtime library
instructions for APS PHP Runtime library could be found on httpdocapsstandardorg21toolsphp-libtools-php-runtime
For automatic application host setup endpointsh script is used You can download it from httpsdocapsstandardorg21_downloadsendpointsh
Steps for automatic setup
copy endpointsh to the root folder on the endpoint
Deploying Mimecast APS Package
execute this command to set rights to
readwriteexecute chmod ndashR 755 endpointsh
copy the Mimecast package to the root folder and execute this command
endpointsh FolderName NameOfThePackageappzip where FolderName is the name of the folder where the package will be unpacked and NameOfThePackage is for example Mimecast-10appzipp After successful execution Message ldquoCONGRATULATIONS Endpoint configured SUCCESSFULLYrdquo should be displayed and package should be automatically unpacked to the varwwwhtmlFolderName folder 16
Deploying Mimecast APS Package
Importing Mimecast Application To import the Mimecast application to OSA 1 In the control panel go to Top gt Services gt Applications The list of the applications
appears 2 Click the Import Package button 3 Import the application from the local workstation select the local file option and specify
the path to the application file using the Chose File button 4 Click the Submit button
17
C H A P T E R 6
Configuring Services for Selling - OSA
Learn about how to configure the service templates that are necessary to form Mimecast APS subscriptions for sale
In This Chapter
Instance Creation 19 Production Grid Management 20 Products and Add-ons Management 21 Resource Creation 26 Service Template Creation 29
Configuring Services for Selling - OBA
Instance Creation In order to create Global Settings and other resource types we are required to create an instance of this package Please follow the steps
Log in to OSA as service provider administrator
Go to Services -gt Applications and select Mimecast APS package
Switch to Instances tab and click the Install button
Provide the endpoint URL in the field ldquoApplication API end-point URIrdquo which takes a form of http[application-endpoint-server-ip][package-location] where
o [application-endpoint-server-ip] is the IP address of your application
server
o [package-location] is the name of the folder on endpoint where the package was unpacked
Click the Next button
On the next screen check both Enable debug logging and Enable API logging checkboxes
Important note We highly recommend to set both logging options Log files will be placed in varwwwhtmlFolderNamelogs folder where FolderName is the name of the folder where the package is unpacked There you can find cloglog file with debug logs and APICallslog with logs of all API calls that package makes toward Mimecast platform
19
Configuring Services for Selling ndash OBA
Production Grid Management Now that the instance of the application is created we can go to the Production Grid tab to create a new Production grid delete a Production Grid or edit a Production Grid settings To create a new Production grid
Click the Create button
Fill the necessary fields and click Create
Important note Service Provider gets API credentials listed above from Mimecast 20
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
C H A P T E R 3
Business Model Overview
Mimecast is an international company specializing in cloud-based email management for Microsoft Exchange and Microsoft Office 365 including security archiving and continuity services to protect business mail
Mimecast reduces the risk complexity and cost traditionally associated with protecting email You no longer have to manage an array of disjointed point solutions from multiple vendors And you mitigate single vendor exposure if you have moved your primary email server to the cloud with services like Microsoft Office 365
Mimecast Services Provided
By purchasing a Mimecast APS package an SMB gets a Mimecast account and some of the provided Mimecast services that he decides to buy The package provides basic Mimecast account management (contact information update) update billing information (buy additional Users seats) and upgrade purchased Mimecast services Any other service management is performed from the Mimecast Admin control panel on the Mimecast platform
Table of billable offerings of Mimecast
Attribute Type Period
User Seats Counter (unit) mqy
Mimecast Services Provided
Service Hierarchy Exposed by Mimecast
Global Setting
Production Grid
Product
Add-on
Customer
o User Seats
o Maximum Retention
9
Customerrsquos Workflow
Customerrsquos Workflow
The integration workflow looks as follows
1 Customer goes to OSA Providerrsquos Online Store Front and locates the Mimecast service offering
2 Customer adds the appropriate plan to his cart 3 On the checkout page customer will review his order accept license agreement if any
create a new customer account or log in to an existing account to place his order 4 Order should be accepted and processed Auto-provision starts 5 Customer now logs into his CCP using the login credentials created during the initial
purchase 6 Customer selects the appropriate Mimecast subscription from the Subscription List
on the Top of the Control Panel
10
Localization List C H A P T E R 4
Localization List
Mimecast has been localized in the following languages for each category
1 Customer Interface
a EN
2 OSA task manager error logging
a EN
3 Mimecast API error messaging
a EN
4 Mimecast external communication to customer
a EN
Revision History
10 Build 1
- Initial APS package
11
Contractual contact information for Mimecast
Service Providers using Odin Service Automation should contact the following to initiate the reseller account creation process by executing the required contracts before Mimecast can be resold globalchannelmimecastcom To choose right regional sales channel Service provider should visit httpswwwmimecastcomcompanycontact
Support Expectations
When Customers using Mimecast services from Odin Service Automation require support they can create a support ticket on httpswwwmimecastcomcustomer-successtechnical-support page or contact Mimecast via email supportmimecastcom
Technical Integration Overview
Technical Integration Overview
General Architecture
The following scheme represents the architecture of OSA and Mimecast integration
13
Technical Integration Overview
Mimecast Services Provided Mimecast APS package enables Odin Service Automation service provider to sell Mimecast services to their customers per number of user basis Examples of some Mimecast services
Secure Email Gateway user optimized spam protection malware DoS and DHA protection Real-time diagnostic and reporting data loss prevention secure message delivery email branding and disclaimer management document conversion and metadata management real-time online queue management large attachment management advanced routing and spooling
Targeted Threat Protection URL rewriting at the gateway with time-of-click scanning for malicious content before being opened
Once the subscription has been provisioned the Customer Admin has the ability to login to the CCP and do basic management of the Mimecast account
Prerequisites for Mimecast Application Service Provider is required to have Mimecast deployment ready and working in order to be able to integrate it in OSA Mimecast APS Package requires APS Billing Application installed on OSA platform The Instructions for Deployment process of the APS Billing Application could be found on official APS Standard page httpdocapsstandardorg21paupselldeploydeployment-of-aps-billing-application 14
C H A P T E R 5
Deploying Mimecast APS Package
To deploy the Mimecast APS package on the Provisioning Host you need to prepare the host and then import your Mimecast APS package in OSA
In This Chapter
Preparing Provisioning Host 16 Importing Mimecast Application 17
Preparing Provisioning Host
Mimecast APS Package requires an application host server to be setup before it can be successfully imported and used in OSA
The following components are required to be installed on the application endpoint server
o Apache HTTP Server 22 o PHP 53 or later o APS PHP Runtime library
instructions for APS PHP Runtime library could be found on httpdocapsstandardorg21toolsphp-libtools-php-runtime
For automatic application host setup endpointsh script is used You can download it from httpsdocapsstandardorg21_downloadsendpointsh
Steps for automatic setup
copy endpointsh to the root folder on the endpoint
Deploying Mimecast APS Package
execute this command to set rights to
readwriteexecute chmod ndashR 755 endpointsh
copy the Mimecast package to the root folder and execute this command
endpointsh FolderName NameOfThePackageappzip where FolderName is the name of the folder where the package will be unpacked and NameOfThePackage is for example Mimecast-10appzipp After successful execution Message ldquoCONGRATULATIONS Endpoint configured SUCCESSFULLYrdquo should be displayed and package should be automatically unpacked to the varwwwhtmlFolderName folder 16
Deploying Mimecast APS Package
Importing Mimecast Application To import the Mimecast application to OSA 1 In the control panel go to Top gt Services gt Applications The list of the applications
appears 2 Click the Import Package button 3 Import the application from the local workstation select the local file option and specify
the path to the application file using the Chose File button 4 Click the Submit button
17
C H A P T E R 6
Configuring Services for Selling - OSA
Learn about how to configure the service templates that are necessary to form Mimecast APS subscriptions for sale
In This Chapter
Instance Creation 19 Production Grid Management 20 Products and Add-ons Management 21 Resource Creation 26 Service Template Creation 29
Configuring Services for Selling - OBA
Instance Creation In order to create Global Settings and other resource types we are required to create an instance of this package Please follow the steps
Log in to OSA as service provider administrator
Go to Services -gt Applications and select Mimecast APS package
Switch to Instances tab and click the Install button
Provide the endpoint URL in the field ldquoApplication API end-point URIrdquo which takes a form of http[application-endpoint-server-ip][package-location] where
o [application-endpoint-server-ip] is the IP address of your application
server
o [package-location] is the name of the folder on endpoint where the package was unpacked
Click the Next button
On the next screen check both Enable debug logging and Enable API logging checkboxes
Important note We highly recommend to set both logging options Log files will be placed in varwwwhtmlFolderNamelogs folder where FolderName is the name of the folder where the package is unpacked There you can find cloglog file with debug logs and APICallslog with logs of all API calls that package makes toward Mimecast platform
19
Configuring Services for Selling ndash OBA
Production Grid Management Now that the instance of the application is created we can go to the Production Grid tab to create a new Production grid delete a Production Grid or edit a Production Grid settings To create a new Production grid
Click the Create button
Fill the necessary fields and click Create
Important note Service Provider gets API credentials listed above from Mimecast 20
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Mimecast Services Provided
Service Hierarchy Exposed by Mimecast
Global Setting
Production Grid
Product
Add-on
Customer
o User Seats
o Maximum Retention
9
Customerrsquos Workflow
Customerrsquos Workflow
The integration workflow looks as follows
1 Customer goes to OSA Providerrsquos Online Store Front and locates the Mimecast service offering
2 Customer adds the appropriate plan to his cart 3 On the checkout page customer will review his order accept license agreement if any
create a new customer account or log in to an existing account to place his order 4 Order should be accepted and processed Auto-provision starts 5 Customer now logs into his CCP using the login credentials created during the initial
purchase 6 Customer selects the appropriate Mimecast subscription from the Subscription List
on the Top of the Control Panel
10
Localization List C H A P T E R 4
Localization List
Mimecast has been localized in the following languages for each category
1 Customer Interface
a EN
2 OSA task manager error logging
a EN
3 Mimecast API error messaging
a EN
4 Mimecast external communication to customer
a EN
Revision History
10 Build 1
- Initial APS package
11
Contractual contact information for Mimecast
Service Providers using Odin Service Automation should contact the following to initiate the reseller account creation process by executing the required contracts before Mimecast can be resold globalchannelmimecastcom To choose right regional sales channel Service provider should visit httpswwwmimecastcomcompanycontact
Support Expectations
When Customers using Mimecast services from Odin Service Automation require support they can create a support ticket on httpswwwmimecastcomcustomer-successtechnical-support page or contact Mimecast via email supportmimecastcom
Technical Integration Overview
Technical Integration Overview
General Architecture
The following scheme represents the architecture of OSA and Mimecast integration
13
Technical Integration Overview
Mimecast Services Provided Mimecast APS package enables Odin Service Automation service provider to sell Mimecast services to their customers per number of user basis Examples of some Mimecast services
Secure Email Gateway user optimized spam protection malware DoS and DHA protection Real-time diagnostic and reporting data loss prevention secure message delivery email branding and disclaimer management document conversion and metadata management real-time online queue management large attachment management advanced routing and spooling
Targeted Threat Protection URL rewriting at the gateway with time-of-click scanning for malicious content before being opened
Once the subscription has been provisioned the Customer Admin has the ability to login to the CCP and do basic management of the Mimecast account
Prerequisites for Mimecast Application Service Provider is required to have Mimecast deployment ready and working in order to be able to integrate it in OSA Mimecast APS Package requires APS Billing Application installed on OSA platform The Instructions for Deployment process of the APS Billing Application could be found on official APS Standard page httpdocapsstandardorg21paupselldeploydeployment-of-aps-billing-application 14
C H A P T E R 5
Deploying Mimecast APS Package
To deploy the Mimecast APS package on the Provisioning Host you need to prepare the host and then import your Mimecast APS package in OSA
In This Chapter
Preparing Provisioning Host 16 Importing Mimecast Application 17
Preparing Provisioning Host
Mimecast APS Package requires an application host server to be setup before it can be successfully imported and used in OSA
The following components are required to be installed on the application endpoint server
o Apache HTTP Server 22 o PHP 53 or later o APS PHP Runtime library
instructions for APS PHP Runtime library could be found on httpdocapsstandardorg21toolsphp-libtools-php-runtime
For automatic application host setup endpointsh script is used You can download it from httpsdocapsstandardorg21_downloadsendpointsh
Steps for automatic setup
copy endpointsh to the root folder on the endpoint
Deploying Mimecast APS Package
execute this command to set rights to
readwriteexecute chmod ndashR 755 endpointsh
copy the Mimecast package to the root folder and execute this command
endpointsh FolderName NameOfThePackageappzip where FolderName is the name of the folder where the package will be unpacked and NameOfThePackage is for example Mimecast-10appzipp After successful execution Message ldquoCONGRATULATIONS Endpoint configured SUCCESSFULLYrdquo should be displayed and package should be automatically unpacked to the varwwwhtmlFolderName folder 16
Deploying Mimecast APS Package
Importing Mimecast Application To import the Mimecast application to OSA 1 In the control panel go to Top gt Services gt Applications The list of the applications
appears 2 Click the Import Package button 3 Import the application from the local workstation select the local file option and specify
the path to the application file using the Chose File button 4 Click the Submit button
17
C H A P T E R 6
Configuring Services for Selling - OSA
Learn about how to configure the service templates that are necessary to form Mimecast APS subscriptions for sale
In This Chapter
Instance Creation 19 Production Grid Management 20 Products and Add-ons Management 21 Resource Creation 26 Service Template Creation 29
Configuring Services for Selling - OBA
Instance Creation In order to create Global Settings and other resource types we are required to create an instance of this package Please follow the steps
Log in to OSA as service provider administrator
Go to Services -gt Applications and select Mimecast APS package
Switch to Instances tab and click the Install button
Provide the endpoint URL in the field ldquoApplication API end-point URIrdquo which takes a form of http[application-endpoint-server-ip][package-location] where
o [application-endpoint-server-ip] is the IP address of your application
server
o [package-location] is the name of the folder on endpoint where the package was unpacked
Click the Next button
On the next screen check both Enable debug logging and Enable API logging checkboxes
Important note We highly recommend to set both logging options Log files will be placed in varwwwhtmlFolderNamelogs folder where FolderName is the name of the folder where the package is unpacked There you can find cloglog file with debug logs and APICallslog with logs of all API calls that package makes toward Mimecast platform
19
Configuring Services for Selling ndash OBA
Production Grid Management Now that the instance of the application is created we can go to the Production Grid tab to create a new Production grid delete a Production Grid or edit a Production Grid settings To create a new Production grid
Click the Create button
Fill the necessary fields and click Create
Important note Service Provider gets API credentials listed above from Mimecast 20
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Customerrsquos Workflow
Customerrsquos Workflow
The integration workflow looks as follows
1 Customer goes to OSA Providerrsquos Online Store Front and locates the Mimecast service offering
2 Customer adds the appropriate plan to his cart 3 On the checkout page customer will review his order accept license agreement if any
create a new customer account or log in to an existing account to place his order 4 Order should be accepted and processed Auto-provision starts 5 Customer now logs into his CCP using the login credentials created during the initial
purchase 6 Customer selects the appropriate Mimecast subscription from the Subscription List
on the Top of the Control Panel
10
Localization List C H A P T E R 4
Localization List
Mimecast has been localized in the following languages for each category
1 Customer Interface
a EN
2 OSA task manager error logging
a EN
3 Mimecast API error messaging
a EN
4 Mimecast external communication to customer
a EN
Revision History
10 Build 1
- Initial APS package
11
Contractual contact information for Mimecast
Service Providers using Odin Service Automation should contact the following to initiate the reseller account creation process by executing the required contracts before Mimecast can be resold globalchannelmimecastcom To choose right regional sales channel Service provider should visit httpswwwmimecastcomcompanycontact
Support Expectations
When Customers using Mimecast services from Odin Service Automation require support they can create a support ticket on httpswwwmimecastcomcustomer-successtechnical-support page or contact Mimecast via email supportmimecastcom
Technical Integration Overview
Technical Integration Overview
General Architecture
The following scheme represents the architecture of OSA and Mimecast integration
13
Technical Integration Overview
Mimecast Services Provided Mimecast APS package enables Odin Service Automation service provider to sell Mimecast services to their customers per number of user basis Examples of some Mimecast services
Secure Email Gateway user optimized spam protection malware DoS and DHA protection Real-time diagnostic and reporting data loss prevention secure message delivery email branding and disclaimer management document conversion and metadata management real-time online queue management large attachment management advanced routing and spooling
Targeted Threat Protection URL rewriting at the gateway with time-of-click scanning for malicious content before being opened
Once the subscription has been provisioned the Customer Admin has the ability to login to the CCP and do basic management of the Mimecast account
Prerequisites for Mimecast Application Service Provider is required to have Mimecast deployment ready and working in order to be able to integrate it in OSA Mimecast APS Package requires APS Billing Application installed on OSA platform The Instructions for Deployment process of the APS Billing Application could be found on official APS Standard page httpdocapsstandardorg21paupselldeploydeployment-of-aps-billing-application 14
C H A P T E R 5
Deploying Mimecast APS Package
To deploy the Mimecast APS package on the Provisioning Host you need to prepare the host and then import your Mimecast APS package in OSA
In This Chapter
Preparing Provisioning Host 16 Importing Mimecast Application 17
Preparing Provisioning Host
Mimecast APS Package requires an application host server to be setup before it can be successfully imported and used in OSA
The following components are required to be installed on the application endpoint server
o Apache HTTP Server 22 o PHP 53 or later o APS PHP Runtime library
instructions for APS PHP Runtime library could be found on httpdocapsstandardorg21toolsphp-libtools-php-runtime
For automatic application host setup endpointsh script is used You can download it from httpsdocapsstandardorg21_downloadsendpointsh
Steps for automatic setup
copy endpointsh to the root folder on the endpoint
Deploying Mimecast APS Package
execute this command to set rights to
readwriteexecute chmod ndashR 755 endpointsh
copy the Mimecast package to the root folder and execute this command
endpointsh FolderName NameOfThePackageappzip where FolderName is the name of the folder where the package will be unpacked and NameOfThePackage is for example Mimecast-10appzipp After successful execution Message ldquoCONGRATULATIONS Endpoint configured SUCCESSFULLYrdquo should be displayed and package should be automatically unpacked to the varwwwhtmlFolderName folder 16
Deploying Mimecast APS Package
Importing Mimecast Application To import the Mimecast application to OSA 1 In the control panel go to Top gt Services gt Applications The list of the applications
appears 2 Click the Import Package button 3 Import the application from the local workstation select the local file option and specify
the path to the application file using the Chose File button 4 Click the Submit button
17
C H A P T E R 6
Configuring Services for Selling - OSA
Learn about how to configure the service templates that are necessary to form Mimecast APS subscriptions for sale
In This Chapter
Instance Creation 19 Production Grid Management 20 Products and Add-ons Management 21 Resource Creation 26 Service Template Creation 29
Configuring Services for Selling - OBA
Instance Creation In order to create Global Settings and other resource types we are required to create an instance of this package Please follow the steps
Log in to OSA as service provider administrator
Go to Services -gt Applications and select Mimecast APS package
Switch to Instances tab and click the Install button
Provide the endpoint URL in the field ldquoApplication API end-point URIrdquo which takes a form of http[application-endpoint-server-ip][package-location] where
o [application-endpoint-server-ip] is the IP address of your application
server
o [package-location] is the name of the folder on endpoint where the package was unpacked
Click the Next button
On the next screen check both Enable debug logging and Enable API logging checkboxes
Important note We highly recommend to set both logging options Log files will be placed in varwwwhtmlFolderNamelogs folder where FolderName is the name of the folder where the package is unpacked There you can find cloglog file with debug logs and APICallslog with logs of all API calls that package makes toward Mimecast platform
19
Configuring Services for Selling ndash OBA
Production Grid Management Now that the instance of the application is created we can go to the Production Grid tab to create a new Production grid delete a Production Grid or edit a Production Grid settings To create a new Production grid
Click the Create button
Fill the necessary fields and click Create
Important note Service Provider gets API credentials listed above from Mimecast 20
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Localization List C H A P T E R 4
Localization List
Mimecast has been localized in the following languages for each category
1 Customer Interface
a EN
2 OSA task manager error logging
a EN
3 Mimecast API error messaging
a EN
4 Mimecast external communication to customer
a EN
Revision History
10 Build 1
- Initial APS package
11
Contractual contact information for Mimecast
Service Providers using Odin Service Automation should contact the following to initiate the reseller account creation process by executing the required contracts before Mimecast can be resold globalchannelmimecastcom To choose right regional sales channel Service provider should visit httpswwwmimecastcomcompanycontact
Support Expectations
When Customers using Mimecast services from Odin Service Automation require support they can create a support ticket on httpswwwmimecastcomcustomer-successtechnical-support page or contact Mimecast via email supportmimecastcom
Technical Integration Overview
Technical Integration Overview
General Architecture
The following scheme represents the architecture of OSA and Mimecast integration
13
Technical Integration Overview
Mimecast Services Provided Mimecast APS package enables Odin Service Automation service provider to sell Mimecast services to their customers per number of user basis Examples of some Mimecast services
Secure Email Gateway user optimized spam protection malware DoS and DHA protection Real-time diagnostic and reporting data loss prevention secure message delivery email branding and disclaimer management document conversion and metadata management real-time online queue management large attachment management advanced routing and spooling
Targeted Threat Protection URL rewriting at the gateway with time-of-click scanning for malicious content before being opened
Once the subscription has been provisioned the Customer Admin has the ability to login to the CCP and do basic management of the Mimecast account
Prerequisites for Mimecast Application Service Provider is required to have Mimecast deployment ready and working in order to be able to integrate it in OSA Mimecast APS Package requires APS Billing Application installed on OSA platform The Instructions for Deployment process of the APS Billing Application could be found on official APS Standard page httpdocapsstandardorg21paupselldeploydeployment-of-aps-billing-application 14
C H A P T E R 5
Deploying Mimecast APS Package
To deploy the Mimecast APS package on the Provisioning Host you need to prepare the host and then import your Mimecast APS package in OSA
In This Chapter
Preparing Provisioning Host 16 Importing Mimecast Application 17
Preparing Provisioning Host
Mimecast APS Package requires an application host server to be setup before it can be successfully imported and used in OSA
The following components are required to be installed on the application endpoint server
o Apache HTTP Server 22 o PHP 53 or later o APS PHP Runtime library
instructions for APS PHP Runtime library could be found on httpdocapsstandardorg21toolsphp-libtools-php-runtime
For automatic application host setup endpointsh script is used You can download it from httpsdocapsstandardorg21_downloadsendpointsh
Steps for automatic setup
copy endpointsh to the root folder on the endpoint
Deploying Mimecast APS Package
execute this command to set rights to
readwriteexecute chmod ndashR 755 endpointsh
copy the Mimecast package to the root folder and execute this command
endpointsh FolderName NameOfThePackageappzip where FolderName is the name of the folder where the package will be unpacked and NameOfThePackage is for example Mimecast-10appzipp After successful execution Message ldquoCONGRATULATIONS Endpoint configured SUCCESSFULLYrdquo should be displayed and package should be automatically unpacked to the varwwwhtmlFolderName folder 16
Deploying Mimecast APS Package
Importing Mimecast Application To import the Mimecast application to OSA 1 In the control panel go to Top gt Services gt Applications The list of the applications
appears 2 Click the Import Package button 3 Import the application from the local workstation select the local file option and specify
the path to the application file using the Chose File button 4 Click the Submit button
17
C H A P T E R 6
Configuring Services for Selling - OSA
Learn about how to configure the service templates that are necessary to form Mimecast APS subscriptions for sale
In This Chapter
Instance Creation 19 Production Grid Management 20 Products and Add-ons Management 21 Resource Creation 26 Service Template Creation 29
Configuring Services for Selling - OBA
Instance Creation In order to create Global Settings and other resource types we are required to create an instance of this package Please follow the steps
Log in to OSA as service provider administrator
Go to Services -gt Applications and select Mimecast APS package
Switch to Instances tab and click the Install button
Provide the endpoint URL in the field ldquoApplication API end-point URIrdquo which takes a form of http[application-endpoint-server-ip][package-location] where
o [application-endpoint-server-ip] is the IP address of your application
server
o [package-location] is the name of the folder on endpoint where the package was unpacked
Click the Next button
On the next screen check both Enable debug logging and Enable API logging checkboxes
Important note We highly recommend to set both logging options Log files will be placed in varwwwhtmlFolderNamelogs folder where FolderName is the name of the folder where the package is unpacked There you can find cloglog file with debug logs and APICallslog with logs of all API calls that package makes toward Mimecast platform
19
Configuring Services for Selling ndash OBA
Production Grid Management Now that the instance of the application is created we can go to the Production Grid tab to create a new Production grid delete a Production Grid or edit a Production Grid settings To create a new Production grid
Click the Create button
Fill the necessary fields and click Create
Important note Service Provider gets API credentials listed above from Mimecast 20
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Contractual contact information for Mimecast
Service Providers using Odin Service Automation should contact the following to initiate the reseller account creation process by executing the required contracts before Mimecast can be resold globalchannelmimecastcom To choose right regional sales channel Service provider should visit httpswwwmimecastcomcompanycontact
Support Expectations
When Customers using Mimecast services from Odin Service Automation require support they can create a support ticket on httpswwwmimecastcomcustomer-successtechnical-support page or contact Mimecast via email supportmimecastcom
Technical Integration Overview
Technical Integration Overview
General Architecture
The following scheme represents the architecture of OSA and Mimecast integration
13
Technical Integration Overview
Mimecast Services Provided Mimecast APS package enables Odin Service Automation service provider to sell Mimecast services to their customers per number of user basis Examples of some Mimecast services
Secure Email Gateway user optimized spam protection malware DoS and DHA protection Real-time diagnostic and reporting data loss prevention secure message delivery email branding and disclaimer management document conversion and metadata management real-time online queue management large attachment management advanced routing and spooling
Targeted Threat Protection URL rewriting at the gateway with time-of-click scanning for malicious content before being opened
Once the subscription has been provisioned the Customer Admin has the ability to login to the CCP and do basic management of the Mimecast account
Prerequisites for Mimecast Application Service Provider is required to have Mimecast deployment ready and working in order to be able to integrate it in OSA Mimecast APS Package requires APS Billing Application installed on OSA platform The Instructions for Deployment process of the APS Billing Application could be found on official APS Standard page httpdocapsstandardorg21paupselldeploydeployment-of-aps-billing-application 14
C H A P T E R 5
Deploying Mimecast APS Package
To deploy the Mimecast APS package on the Provisioning Host you need to prepare the host and then import your Mimecast APS package in OSA
In This Chapter
Preparing Provisioning Host 16 Importing Mimecast Application 17
Preparing Provisioning Host
Mimecast APS Package requires an application host server to be setup before it can be successfully imported and used in OSA
The following components are required to be installed on the application endpoint server
o Apache HTTP Server 22 o PHP 53 or later o APS PHP Runtime library
instructions for APS PHP Runtime library could be found on httpdocapsstandardorg21toolsphp-libtools-php-runtime
For automatic application host setup endpointsh script is used You can download it from httpsdocapsstandardorg21_downloadsendpointsh
Steps for automatic setup
copy endpointsh to the root folder on the endpoint
Deploying Mimecast APS Package
execute this command to set rights to
readwriteexecute chmod ndashR 755 endpointsh
copy the Mimecast package to the root folder and execute this command
endpointsh FolderName NameOfThePackageappzip where FolderName is the name of the folder where the package will be unpacked and NameOfThePackage is for example Mimecast-10appzipp After successful execution Message ldquoCONGRATULATIONS Endpoint configured SUCCESSFULLYrdquo should be displayed and package should be automatically unpacked to the varwwwhtmlFolderName folder 16
Deploying Mimecast APS Package
Importing Mimecast Application To import the Mimecast application to OSA 1 In the control panel go to Top gt Services gt Applications The list of the applications
appears 2 Click the Import Package button 3 Import the application from the local workstation select the local file option and specify
the path to the application file using the Chose File button 4 Click the Submit button
17
C H A P T E R 6
Configuring Services for Selling - OSA
Learn about how to configure the service templates that are necessary to form Mimecast APS subscriptions for sale
In This Chapter
Instance Creation 19 Production Grid Management 20 Products and Add-ons Management 21 Resource Creation 26 Service Template Creation 29
Configuring Services for Selling - OBA
Instance Creation In order to create Global Settings and other resource types we are required to create an instance of this package Please follow the steps
Log in to OSA as service provider administrator
Go to Services -gt Applications and select Mimecast APS package
Switch to Instances tab and click the Install button
Provide the endpoint URL in the field ldquoApplication API end-point URIrdquo which takes a form of http[application-endpoint-server-ip][package-location] where
o [application-endpoint-server-ip] is the IP address of your application
server
o [package-location] is the name of the folder on endpoint where the package was unpacked
Click the Next button
On the next screen check both Enable debug logging and Enable API logging checkboxes
Important note We highly recommend to set both logging options Log files will be placed in varwwwhtmlFolderNamelogs folder where FolderName is the name of the folder where the package is unpacked There you can find cloglog file with debug logs and APICallslog with logs of all API calls that package makes toward Mimecast platform
19
Configuring Services for Selling ndash OBA
Production Grid Management Now that the instance of the application is created we can go to the Production Grid tab to create a new Production grid delete a Production Grid or edit a Production Grid settings To create a new Production grid
Click the Create button
Fill the necessary fields and click Create
Important note Service Provider gets API credentials listed above from Mimecast 20
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Technical Integration Overview
Technical Integration Overview
General Architecture
The following scheme represents the architecture of OSA and Mimecast integration
13
Technical Integration Overview
Mimecast Services Provided Mimecast APS package enables Odin Service Automation service provider to sell Mimecast services to their customers per number of user basis Examples of some Mimecast services
Secure Email Gateway user optimized spam protection malware DoS and DHA protection Real-time diagnostic and reporting data loss prevention secure message delivery email branding and disclaimer management document conversion and metadata management real-time online queue management large attachment management advanced routing and spooling
Targeted Threat Protection URL rewriting at the gateway with time-of-click scanning for malicious content before being opened
Once the subscription has been provisioned the Customer Admin has the ability to login to the CCP and do basic management of the Mimecast account
Prerequisites for Mimecast Application Service Provider is required to have Mimecast deployment ready and working in order to be able to integrate it in OSA Mimecast APS Package requires APS Billing Application installed on OSA platform The Instructions for Deployment process of the APS Billing Application could be found on official APS Standard page httpdocapsstandardorg21paupselldeploydeployment-of-aps-billing-application 14
C H A P T E R 5
Deploying Mimecast APS Package
To deploy the Mimecast APS package on the Provisioning Host you need to prepare the host and then import your Mimecast APS package in OSA
In This Chapter
Preparing Provisioning Host 16 Importing Mimecast Application 17
Preparing Provisioning Host
Mimecast APS Package requires an application host server to be setup before it can be successfully imported and used in OSA
The following components are required to be installed on the application endpoint server
o Apache HTTP Server 22 o PHP 53 or later o APS PHP Runtime library
instructions for APS PHP Runtime library could be found on httpdocapsstandardorg21toolsphp-libtools-php-runtime
For automatic application host setup endpointsh script is used You can download it from httpsdocapsstandardorg21_downloadsendpointsh
Steps for automatic setup
copy endpointsh to the root folder on the endpoint
Deploying Mimecast APS Package
execute this command to set rights to
readwriteexecute chmod ndashR 755 endpointsh
copy the Mimecast package to the root folder and execute this command
endpointsh FolderName NameOfThePackageappzip where FolderName is the name of the folder where the package will be unpacked and NameOfThePackage is for example Mimecast-10appzipp After successful execution Message ldquoCONGRATULATIONS Endpoint configured SUCCESSFULLYrdquo should be displayed and package should be automatically unpacked to the varwwwhtmlFolderName folder 16
Deploying Mimecast APS Package
Importing Mimecast Application To import the Mimecast application to OSA 1 In the control panel go to Top gt Services gt Applications The list of the applications
appears 2 Click the Import Package button 3 Import the application from the local workstation select the local file option and specify
the path to the application file using the Chose File button 4 Click the Submit button
17
C H A P T E R 6
Configuring Services for Selling - OSA
Learn about how to configure the service templates that are necessary to form Mimecast APS subscriptions for sale
In This Chapter
Instance Creation 19 Production Grid Management 20 Products and Add-ons Management 21 Resource Creation 26 Service Template Creation 29
Configuring Services for Selling - OBA
Instance Creation In order to create Global Settings and other resource types we are required to create an instance of this package Please follow the steps
Log in to OSA as service provider administrator
Go to Services -gt Applications and select Mimecast APS package
Switch to Instances tab and click the Install button
Provide the endpoint URL in the field ldquoApplication API end-point URIrdquo which takes a form of http[application-endpoint-server-ip][package-location] where
o [application-endpoint-server-ip] is the IP address of your application
server
o [package-location] is the name of the folder on endpoint where the package was unpacked
Click the Next button
On the next screen check both Enable debug logging and Enable API logging checkboxes
Important note We highly recommend to set both logging options Log files will be placed in varwwwhtmlFolderNamelogs folder where FolderName is the name of the folder where the package is unpacked There you can find cloglog file with debug logs and APICallslog with logs of all API calls that package makes toward Mimecast platform
19
Configuring Services for Selling ndash OBA
Production Grid Management Now that the instance of the application is created we can go to the Production Grid tab to create a new Production grid delete a Production Grid or edit a Production Grid settings To create a new Production grid
Click the Create button
Fill the necessary fields and click Create
Important note Service Provider gets API credentials listed above from Mimecast 20
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Technical Integration Overview
Mimecast Services Provided Mimecast APS package enables Odin Service Automation service provider to sell Mimecast services to their customers per number of user basis Examples of some Mimecast services
Secure Email Gateway user optimized spam protection malware DoS and DHA protection Real-time diagnostic and reporting data loss prevention secure message delivery email branding and disclaimer management document conversion and metadata management real-time online queue management large attachment management advanced routing and spooling
Targeted Threat Protection URL rewriting at the gateway with time-of-click scanning for malicious content before being opened
Once the subscription has been provisioned the Customer Admin has the ability to login to the CCP and do basic management of the Mimecast account
Prerequisites for Mimecast Application Service Provider is required to have Mimecast deployment ready and working in order to be able to integrate it in OSA Mimecast APS Package requires APS Billing Application installed on OSA platform The Instructions for Deployment process of the APS Billing Application could be found on official APS Standard page httpdocapsstandardorg21paupselldeploydeployment-of-aps-billing-application 14
C H A P T E R 5
Deploying Mimecast APS Package
To deploy the Mimecast APS package on the Provisioning Host you need to prepare the host and then import your Mimecast APS package in OSA
In This Chapter
Preparing Provisioning Host 16 Importing Mimecast Application 17
Preparing Provisioning Host
Mimecast APS Package requires an application host server to be setup before it can be successfully imported and used in OSA
The following components are required to be installed on the application endpoint server
o Apache HTTP Server 22 o PHP 53 or later o APS PHP Runtime library
instructions for APS PHP Runtime library could be found on httpdocapsstandardorg21toolsphp-libtools-php-runtime
For automatic application host setup endpointsh script is used You can download it from httpsdocapsstandardorg21_downloadsendpointsh
Steps for automatic setup
copy endpointsh to the root folder on the endpoint
Deploying Mimecast APS Package
execute this command to set rights to
readwriteexecute chmod ndashR 755 endpointsh
copy the Mimecast package to the root folder and execute this command
endpointsh FolderName NameOfThePackageappzip where FolderName is the name of the folder where the package will be unpacked and NameOfThePackage is for example Mimecast-10appzipp After successful execution Message ldquoCONGRATULATIONS Endpoint configured SUCCESSFULLYrdquo should be displayed and package should be automatically unpacked to the varwwwhtmlFolderName folder 16
Deploying Mimecast APS Package
Importing Mimecast Application To import the Mimecast application to OSA 1 In the control panel go to Top gt Services gt Applications The list of the applications
appears 2 Click the Import Package button 3 Import the application from the local workstation select the local file option and specify
the path to the application file using the Chose File button 4 Click the Submit button
17
C H A P T E R 6
Configuring Services for Selling - OSA
Learn about how to configure the service templates that are necessary to form Mimecast APS subscriptions for sale
In This Chapter
Instance Creation 19 Production Grid Management 20 Products and Add-ons Management 21 Resource Creation 26 Service Template Creation 29
Configuring Services for Selling - OBA
Instance Creation In order to create Global Settings and other resource types we are required to create an instance of this package Please follow the steps
Log in to OSA as service provider administrator
Go to Services -gt Applications and select Mimecast APS package
Switch to Instances tab and click the Install button
Provide the endpoint URL in the field ldquoApplication API end-point URIrdquo which takes a form of http[application-endpoint-server-ip][package-location] where
o [application-endpoint-server-ip] is the IP address of your application
server
o [package-location] is the name of the folder on endpoint where the package was unpacked
Click the Next button
On the next screen check both Enable debug logging and Enable API logging checkboxes
Important note We highly recommend to set both logging options Log files will be placed in varwwwhtmlFolderNamelogs folder where FolderName is the name of the folder where the package is unpacked There you can find cloglog file with debug logs and APICallslog with logs of all API calls that package makes toward Mimecast platform
19
Configuring Services for Selling ndash OBA
Production Grid Management Now that the instance of the application is created we can go to the Production Grid tab to create a new Production grid delete a Production Grid or edit a Production Grid settings To create a new Production grid
Click the Create button
Fill the necessary fields and click Create
Important note Service Provider gets API credentials listed above from Mimecast 20
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
C H A P T E R 5
Deploying Mimecast APS Package
To deploy the Mimecast APS package on the Provisioning Host you need to prepare the host and then import your Mimecast APS package in OSA
In This Chapter
Preparing Provisioning Host 16 Importing Mimecast Application 17
Preparing Provisioning Host
Mimecast APS Package requires an application host server to be setup before it can be successfully imported and used in OSA
The following components are required to be installed on the application endpoint server
o Apache HTTP Server 22 o PHP 53 or later o APS PHP Runtime library
instructions for APS PHP Runtime library could be found on httpdocapsstandardorg21toolsphp-libtools-php-runtime
For automatic application host setup endpointsh script is used You can download it from httpsdocapsstandardorg21_downloadsendpointsh
Steps for automatic setup
copy endpointsh to the root folder on the endpoint
Deploying Mimecast APS Package
execute this command to set rights to
readwriteexecute chmod ndashR 755 endpointsh
copy the Mimecast package to the root folder and execute this command
endpointsh FolderName NameOfThePackageappzip where FolderName is the name of the folder where the package will be unpacked and NameOfThePackage is for example Mimecast-10appzipp After successful execution Message ldquoCONGRATULATIONS Endpoint configured SUCCESSFULLYrdquo should be displayed and package should be automatically unpacked to the varwwwhtmlFolderName folder 16
Deploying Mimecast APS Package
Importing Mimecast Application To import the Mimecast application to OSA 1 In the control panel go to Top gt Services gt Applications The list of the applications
appears 2 Click the Import Package button 3 Import the application from the local workstation select the local file option and specify
the path to the application file using the Chose File button 4 Click the Submit button
17
C H A P T E R 6
Configuring Services for Selling - OSA
Learn about how to configure the service templates that are necessary to form Mimecast APS subscriptions for sale
In This Chapter
Instance Creation 19 Production Grid Management 20 Products and Add-ons Management 21 Resource Creation 26 Service Template Creation 29
Configuring Services for Selling - OBA
Instance Creation In order to create Global Settings and other resource types we are required to create an instance of this package Please follow the steps
Log in to OSA as service provider administrator
Go to Services -gt Applications and select Mimecast APS package
Switch to Instances tab and click the Install button
Provide the endpoint URL in the field ldquoApplication API end-point URIrdquo which takes a form of http[application-endpoint-server-ip][package-location] where
o [application-endpoint-server-ip] is the IP address of your application
server
o [package-location] is the name of the folder on endpoint where the package was unpacked
Click the Next button
On the next screen check both Enable debug logging and Enable API logging checkboxes
Important note We highly recommend to set both logging options Log files will be placed in varwwwhtmlFolderNamelogs folder where FolderName is the name of the folder where the package is unpacked There you can find cloglog file with debug logs and APICallslog with logs of all API calls that package makes toward Mimecast platform
19
Configuring Services for Selling ndash OBA
Production Grid Management Now that the instance of the application is created we can go to the Production Grid tab to create a new Production grid delete a Production Grid or edit a Production Grid settings To create a new Production grid
Click the Create button
Fill the necessary fields and click Create
Important note Service Provider gets API credentials listed above from Mimecast 20
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Deploying Mimecast APS Package
execute this command to set rights to
readwriteexecute chmod ndashR 755 endpointsh
copy the Mimecast package to the root folder and execute this command
endpointsh FolderName NameOfThePackageappzip where FolderName is the name of the folder where the package will be unpacked and NameOfThePackage is for example Mimecast-10appzipp After successful execution Message ldquoCONGRATULATIONS Endpoint configured SUCCESSFULLYrdquo should be displayed and package should be automatically unpacked to the varwwwhtmlFolderName folder 16
Deploying Mimecast APS Package
Importing Mimecast Application To import the Mimecast application to OSA 1 In the control panel go to Top gt Services gt Applications The list of the applications
appears 2 Click the Import Package button 3 Import the application from the local workstation select the local file option and specify
the path to the application file using the Chose File button 4 Click the Submit button
17
C H A P T E R 6
Configuring Services for Selling - OSA
Learn about how to configure the service templates that are necessary to form Mimecast APS subscriptions for sale
In This Chapter
Instance Creation 19 Production Grid Management 20 Products and Add-ons Management 21 Resource Creation 26 Service Template Creation 29
Configuring Services for Selling - OBA
Instance Creation In order to create Global Settings and other resource types we are required to create an instance of this package Please follow the steps
Log in to OSA as service provider administrator
Go to Services -gt Applications and select Mimecast APS package
Switch to Instances tab and click the Install button
Provide the endpoint URL in the field ldquoApplication API end-point URIrdquo which takes a form of http[application-endpoint-server-ip][package-location] where
o [application-endpoint-server-ip] is the IP address of your application
server
o [package-location] is the name of the folder on endpoint where the package was unpacked
Click the Next button
On the next screen check both Enable debug logging and Enable API logging checkboxes
Important note We highly recommend to set both logging options Log files will be placed in varwwwhtmlFolderNamelogs folder where FolderName is the name of the folder where the package is unpacked There you can find cloglog file with debug logs and APICallslog with logs of all API calls that package makes toward Mimecast platform
19
Configuring Services for Selling ndash OBA
Production Grid Management Now that the instance of the application is created we can go to the Production Grid tab to create a new Production grid delete a Production Grid or edit a Production Grid settings To create a new Production grid
Click the Create button
Fill the necessary fields and click Create
Important note Service Provider gets API credentials listed above from Mimecast 20
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Deploying Mimecast APS Package
Importing Mimecast Application To import the Mimecast application to OSA 1 In the control panel go to Top gt Services gt Applications The list of the applications
appears 2 Click the Import Package button 3 Import the application from the local workstation select the local file option and specify
the path to the application file using the Chose File button 4 Click the Submit button
17
C H A P T E R 6
Configuring Services for Selling - OSA
Learn about how to configure the service templates that are necessary to form Mimecast APS subscriptions for sale
In This Chapter
Instance Creation 19 Production Grid Management 20 Products and Add-ons Management 21 Resource Creation 26 Service Template Creation 29
Configuring Services for Selling - OBA
Instance Creation In order to create Global Settings and other resource types we are required to create an instance of this package Please follow the steps
Log in to OSA as service provider administrator
Go to Services -gt Applications and select Mimecast APS package
Switch to Instances tab and click the Install button
Provide the endpoint URL in the field ldquoApplication API end-point URIrdquo which takes a form of http[application-endpoint-server-ip][package-location] where
o [application-endpoint-server-ip] is the IP address of your application
server
o [package-location] is the name of the folder on endpoint where the package was unpacked
Click the Next button
On the next screen check both Enable debug logging and Enable API logging checkboxes
Important note We highly recommend to set both logging options Log files will be placed in varwwwhtmlFolderNamelogs folder where FolderName is the name of the folder where the package is unpacked There you can find cloglog file with debug logs and APICallslog with logs of all API calls that package makes toward Mimecast platform
19
Configuring Services for Selling ndash OBA
Production Grid Management Now that the instance of the application is created we can go to the Production Grid tab to create a new Production grid delete a Production Grid or edit a Production Grid settings To create a new Production grid
Click the Create button
Fill the necessary fields and click Create
Important note Service Provider gets API credentials listed above from Mimecast 20
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
C H A P T E R 6
Configuring Services for Selling - OSA
Learn about how to configure the service templates that are necessary to form Mimecast APS subscriptions for sale
In This Chapter
Instance Creation 19 Production Grid Management 20 Products and Add-ons Management 21 Resource Creation 26 Service Template Creation 29
Configuring Services for Selling - OBA
Instance Creation In order to create Global Settings and other resource types we are required to create an instance of this package Please follow the steps
Log in to OSA as service provider administrator
Go to Services -gt Applications and select Mimecast APS package
Switch to Instances tab and click the Install button
Provide the endpoint URL in the field ldquoApplication API end-point URIrdquo which takes a form of http[application-endpoint-server-ip][package-location] where
o [application-endpoint-server-ip] is the IP address of your application
server
o [package-location] is the name of the folder on endpoint where the package was unpacked
Click the Next button
On the next screen check both Enable debug logging and Enable API logging checkboxes
Important note We highly recommend to set both logging options Log files will be placed in varwwwhtmlFolderNamelogs folder where FolderName is the name of the folder where the package is unpacked There you can find cloglog file with debug logs and APICallslog with logs of all API calls that package makes toward Mimecast platform
19
Configuring Services for Selling ndash OBA
Production Grid Management Now that the instance of the application is created we can go to the Production Grid tab to create a new Production grid delete a Production Grid or edit a Production Grid settings To create a new Production grid
Click the Create button
Fill the necessary fields and click Create
Important note Service Provider gets API credentials listed above from Mimecast 20
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Configuring Services for Selling - OBA
Instance Creation In order to create Global Settings and other resource types we are required to create an instance of this package Please follow the steps
Log in to OSA as service provider administrator
Go to Services -gt Applications and select Mimecast APS package
Switch to Instances tab and click the Install button
Provide the endpoint URL in the field ldquoApplication API end-point URIrdquo which takes a form of http[application-endpoint-server-ip][package-location] where
o [application-endpoint-server-ip] is the IP address of your application
server
o [package-location] is the name of the folder on endpoint where the package was unpacked
Click the Next button
On the next screen check both Enable debug logging and Enable API logging checkboxes
Important note We highly recommend to set both logging options Log files will be placed in varwwwhtmlFolderNamelogs folder where FolderName is the name of the folder where the package is unpacked There you can find cloglog file with debug logs and APICallslog with logs of all API calls that package makes toward Mimecast platform
19
Configuring Services for Selling ndash OBA
Production Grid Management Now that the instance of the application is created we can go to the Production Grid tab to create a new Production grid delete a Production Grid or edit a Production Grid settings To create a new Production grid
Click the Create button
Fill the necessary fields and click Create
Important note Service Provider gets API credentials listed above from Mimecast 20
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Configuring Services for Selling ndash OBA
Production Grid Management Now that the instance of the application is created we can go to the Production Grid tab to create a new Production grid delete a Production Grid or edit a Production Grid settings To create a new Production grid
Click the Create button
Fill the necessary fields and click Create
Important note Service Provider gets API credentials listed above from Mimecast 20
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Configuring Services for Selling - OBA To delete Production Grid
Check Production Grid that you wish to delete
Click Delete button To edit Production Grid
Select Production Grid that you wish to edit
At the bottom of newly opened page click Edit button
Fill the necessary fields and click Save changes button
To change password
Select Production Grid which password you wish to change
Enter and confirm new password
Click Save changes button
Products and Add-ons Management Now that a Production Grid is created we can go and import Products and Add-ons
Select the Production Grid from the grid available under Production Grid tab To import Products
Find the Product List below the Production Grid Details section
Click on the Import button
21
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Configuring Services for Selling ndash OBA
On the new screen available Products that are not already imported are displayed in a grid Select the ones you want to import and click the Add button
Imported Products should be displayed in a grid in the Product List section on Production Grid page
22
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Configuring Services for Selling - OBA To import Add-ons
Find the Addon List below the Product List section
Click on the Import button
On the new screen available Add-ons that are not already imported are displayed in a grid Select the ones you want and click the Add button
23
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Configuring Services for Selling ndash OBA
Imported Add-ons should be displayed in a grid in the Addon List section on Production Grid page
Note Imported Add-ons and Product will have a prefix of your current Production Grid To delete Product
Check Product that you wish to delete under Product List section
Click Delete Button To delete Add-on
Check Add-on that you wish to delete under Addon List section
Click Delete Button 24
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Configuring Services for Selling - OBA
Resource Creation In OSA Provider Control Panel navigate to Services gt Applications select the Mimecast application and switch to Resource Types tab Create Mimecast Global Settings resource
Click Create and select Application Service Reference
In the Name field enter Mimecast Global Settings and click Next Select globalSettings as the APS Type
In the Resource column click on the instance ID and on the next screen click Finish button
Create Mimecast Production Grid resource
Click Create and select Application Service Reference In the Name field enter Mimecast Production Grid and click Next Select productionGrid as the APS Type In the Resource column click on the instance ID and on the next screen click Finish button
25
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Configuring Services for Selling ndash OBA Create Mimecast Product resource
Click Create and select Application Service Reference In the Name field enter Mimecast Secure Email Gateway and click Next Select product as the APS Type
In the Resource column click on the instance ID of the resource with Secure Email Gateway Product Name and on the next screen click Finish button
Create Mimecast Addon resource
Click Create and select Application Service Reference In the Name field enter Mimecast Targeted Threat Protection ndash URL Protect and click Next
Select addon as the APS Type In the Resource column click on the instance ID of the resource with Targeted Threat Protection ndash URL Protect Addon Name and on the next screen click Finish button
Do the same for all of the imported Add-ons The key is to name the Resource type according to the names of the imported Add-ons and to associate the Resource type with the right Add-on in the step shown on the picture below 26
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Configuring Services for Selling - OBA Create Mimecast Customer Resource
Click Create and select Application Service In the Name field enter Mimecast Customer and click Next Select customer as the APS Type Check the Automatically provision service checkbox click Next and on the next screen click Finish
Create Mimecast User Seats counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast User Counter and click Next
In the Resource column select User Seats and on the next screen click Finish button
27
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Configuring Services for Selling ndash OBA Create Mimecast Maximum Retention counter
Click Create and select Application Counter (unit) In the Name field enter Mimecast Maximum Retention and click Next
In the Resource column select Maximum Retention and on the next screen click Finish button
Now when you navigate to switch to Resource Types
Services gt Applications select the Mimecast application and tab you should the list of all the Resource Types you created
28
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Configuring Services for Selling - OBA
Service Template Creation
In the OSA Provider Control Panel navigate to Products gt Service Templates Click Add New Service Template Configure the General Parameters
o In the Name field enter Mimecast Template for example o Leave the Autoprovisioning and Account-Wide Service checkboxes
checked o Leave the Type option as Custom o Click Next button
On the next screen check the checkboxes for the created resources and click Next
On the next screen also click Next and then the Finish button to create the Service Plan
The Service Plan is automatically Activated Note Resource limits can be set here in the Service Template but we will do that in the Service Plan instead in order to get more billing options Important note For allowed Product and Add-on combinations please contact Mimecast If you create combination that is not allowed Customers canrsquot successfully make order
29
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Configuring Services for Selling ndash OBA C H A P T E R 7
Configuring Services for Selling - OBA
Learn about how to configure the service templates that are necessary to form Mimecast
APS subscriptions for sale
In This Chapter
Service Plans 30 Resource Rates 32 Service Plan Upgrading 34 Order Creation 35 Delete Subscription 37
Service Plans
In order to start creating a Service Plan you must change OSA Control Panel from OSA to OBA Click Billing at the upper right corner on Providerrsquos Control Panel To create Service Plan follow these steps
Go to Products gt Service Plans Click Add New Service Plan button Select Generic Service Plan and click Next
In the Name field enter Mimecast Service Plan for example Select the Service Template you have previously created
Enter Short Summary and Detailed Description Check the Published checkbox
30
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Configuring Services for Selling - OBA
On the next screen select the subscription period to include it in the Service plan optionally set the fees and click the Next button
On the next screen click Finish button as we will add Resource Rates later in this chapter
31
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Configuring Services for Selling ndash OBA
Resource Rates Resource rates are a way for including billing options such as resource limits and fees inside service plan Follow these steps in order to add resource rates to the service plan
Click on the plan you created and go to the Resource Rates tab Click on Add New Resource Rate button
Check the checkboxes for User Seats and Maximum Retention Counters from the dropdown menus on the right select Additional Resources and click Next
For Maximum Retention Counter o Provide a value for the Included Amount (in our case 100)
Important Note If you leave -1 for Included amount it is interpreted as unlimited by OBA and package will send value 36160 to Mimecast platform when Customer makes an order
For User Seats Counter 32
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Configuring Services for Selling - OBA
o Set the Included Amount to 0 o Provide a value for the Maximum Amount (in our case 20)
Important Note 1 If you leave -1 for Included Amount it is interpreted as unlimited
by OBA and package will send value 1000 for numberOfUser seats to Mimecast platform when Customer makes order The same is for Maximum Amount if you leave -1 package will treat it as 1000
Important Note 2 We highly recommend to set Included Amount to 0 since package has initial upsell screen on Customer Control Panel on which Customer must set amount
33
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Configuring Services for Selling ndash OBA
of User Seats that he wish to purchase This amount could be less or more than Included Amount that you set in Service Plan but canrsquot be less than 1
Click Finish
Now that the resource rates are set and shown in the list click on the Mimecast Maximum Retention resource
Scroll down and click Edit Uncheck the Show in CP checkbox and click Save
Service Plan Upgrading If you want to enable Service Plan upgrading you must create at least one additional Service Plan and add it on the Upgrade tab of the Service Plan you wish to upgrade For example you have created an additional Service Plan called Mimecast Advanced Service Plan To 34
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Configuring Services for Selling - OBA enable upgrading the Mimecast Service Plan to Mimecast Advanced Service Plan follow these steps
Go to Products gt Service Plans and select the Mimecast Service Plan Switch to Upgrades tab Click on Add New Allowed UpgradeDowngrade button Check the checkbox besides the Mimecast Advanced Service Plan
Confirm the selection by clicking on the Add Selected Plan(s) button
Now the Mimecast Service Plan is upgradable to Mimecast Advanced Service Plan
35
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Configuring Services for Selling ndash OBA
Order Creation In order to create a subscription using a Service Plan we have already created we need to make an order of that Service Plan for the customer To create an order
On the OBA side go to Operations gt Orders Click the Add New Order button Select an account
Select the Service Plan you created and a subscription period
Click Next button on the next screen Click Next button and then click Place Order button
Order is now created and has to be opened
Go to Operations gt Orders Click on the created order
36
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Configuring Services for Selling - OBA
Presented with details click Open Order button and wait while the order is being provisioned
Click the Check Order Provisioning Status button to check if Order Status is set to Completed
Important note In order to successfully create an order Customer State field is required Please contact Mimecast for valid State code list
37
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Configuring Services for Selling ndash OBA
Delete Subscription If provider wishes to delete a Mimecast Subscription he will have to perform the following steps
On OBA navigate to Operations gt Customers and select the customer which uses the Mimecast APS application
Click on the Subscription tab and click on the subscription you wish to delete Click on Cancel Subscription button State a reason for deleting the Subscription in Comment text box Click Next and then Place Order
Go to Operations gt Orders and select the Cancellation order Click Open Order
Click Check Order Provisioning Status button to see if Order Status has changed to Completed Go back to the subscription (Operations gt Customers tab Subscriptions select the subscription) and click Destroy Following message will be shown ldquoService of Subscription has been destroyedrdquo
38
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4
Index
Index Mimecast Services Provided - 8 14 Mimecast Subscriptions Configuration
Overview - 25 30 A About This Guide - 7 Audience - 7 C Configuring Services for Selling - 18 30 Creating Mimecast Application Resource
Type - 29 32 Creating Mimecast Diskspace Resource
Type - 34 Creating Mimecast Service Resource Types
- 36 38 Customerrsquos Workflow - 10 D Deploying Mimecast Application - 11 Deploying Mimecast APS Package - 15 Documentation Conventions - 4 F Feedback - 6 G General Architecture - 10 13 General Conventions - 5 I Importing Mimecast Application - 17 Integration Overview - 8 13
Introduction - 7 P Preface - 4 Prepequisites for Mimecast Application - 14 T Terms and Abbreviations - 7 Typographical Conventions - 4