# Office 365 1.0.0 For WHMCS
# (opens new window) About Office 365 For WHMCS (opens new window)
Office 365 For WHMCS has been designed to let you automatically provision Microsoft Office 365 plans and remotely manage their key features.
With this module, you will easily supervise all subscriptions, perform switches and suspensions as well as password changes right in your WHMCS.
Admin Area Features
- Create/Suspend/Unsuspend Office 365 Subscriptions
- Create/Suspend/Unsuspend Addon Services
- Change Package
- Change Password
Client Area Features
- Upgrade/Downgrade Office 365 Subscriptions
- Change Password
Supported Services
- Office 365 Education/Education E5
- Office 365 Business/Business Essentials/Business Premium
- Office 365 ProPlus/Enterprise E1/E3/E5/K1
- Standalone Services:
- Exchange Online
- SharePoint Online
- OneDrive For Business
- Skype For Business Online
- Office Applications
- Project Portfolio Management
- Yammer
- Business Intelligence Service
- Online Diagram Software
- Information Rights Management
General Info
- Requires Microsoft Partner Network
- Requires Microsoft Cloud Solution Provider - Tier 1
- Supports PHP 5.4 Up To PHP 7
- Supports WHMCS Templates Five and Six
- Supports WHMCS V6 and V7
# Installation
This tutorial will show you how to successfully install and authenticate Office 365 For WHMCS.
We will guide you step by step through the whole installation and configuration process.
Note: This module configuration requires a Microsoft Partner Network (opens new window) account.
- Log in to our client area and download the module.
- In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.
It does not apply to open source versions.
Note: You can check current PHP version in your WHMCS. To do so proceed to 'Utilities' → 'System' → 'PHP Info'.
- Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.
The content of PHP version files should look like this.
- When you install Office 365 For WHMCS for the first time you have to rename the 'license_RENAME.php' file.
File is located in 'modules/servers/office365/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.
- In order to configure your license key you have to edit the previously renamed 'license.php' file.
Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.
# Configuration of Server
- To begin, you must add a new server.
Go to 'Setup' → 'Products/Services' → 'Servers' and press 'Add New Server'.
- Enter your server name. Choose 'Office365' from the dropdown menu. Enter your Microsoft Partner username, password, API URL, Native APP ID, Domain And Microsoft ID. Then press 'Save Changes'.
In order to create full 'API URL' go to 'Microsoft Partner Center' panel → 'Account Settings' → 'Organization profile (opens new window)' and copy 'Default domain' from the section marked on the screen below:
To find your 'Native APP ID' and 'Domain' go to 'Microsoft Partner Center' panel → 'Account Settings' → 'App Management (opens new window)' and copy 'App ID' and 'Domain' from the 'Native App' section:
To obtain 'Microsoft ID' go to 'Microsoft Partner Center' panel → 'Dashboard' → 'Customers (opens new window)' and see more details of the account you want to be used to sell subscriptions:
- Once your server has been configured correctly, you will see the following screen.
Create a new group for your server. Press 'Create New Group' to follow.
- Enter a name, click on your previously created server, press 'Add' then 'Save Changes'.
# Configuration of Product
- In order to create a product, go to 'Setup' → 'Products/Services' → 'Products/Services'.
If you do not have a product group, click on 'Create a New Group'. If you do, simply move to the 12th step.
- Fill in a product group name and press 'Save Changes'.
- When you have a product group added, you can create your product and assign it to Office 365 module.
- Afterward, choose your product type and product group from dropdown menus, enter your product name and press 'Continue'.
- Now, go to 'Module Settings' section, choose both 'Office365' and the previously created server group from the dropdown menu and press 'Save Changes'.
# Configuration and Management
Configuration and management of Office 365 For WHMCS is very intuitive. Read the below sections to see how easy it is.
# Basic Configuration
Let's start the module configuration by choosing 'Office365' from 'Module Name' and previously created 'Server Group' .
Now, choose 'Country'. that you will offer your Office 365 services from.
Also, select the available 'Company Domain' ' and choose one of desired Office 365 plans. You may also assign additional services to the main plan as addons, they will be described in further parts.
Then, go to the 'Custom Fields' tab and add two new text box fields: userid|User ID and orderid|Order ID as shown on the following screen.
# Additional Services
In order to offer additional services for a product plan you need to create a new addon first.
In your WHMCS system press 'Setup' → 'Products/Services' → 'Product Addons' and select 'Add New Addon'.
Enter a name for the addon, choose the addon to be visible in order and configure the rest of the desired options.
Go to the 'Applicable Products' tab and select the product that you want to offer this addon for. Then press 'Save Changes'.
Go back to your product and connect the created addon with one of the available additional services in the 'Module Settings' tab.
'Save Changes'. Remember that you can add more addons for other services.
# Order
Once the product configuration is complete, clients will be able to order the selected subscription and addons.
# Client Area
Currently, the module does not support any additional features in the client area.
The customer can order additional services to their subscription, change their password to the Office 365 (opens new window) panel, upgrade a subscription plan or request a service cancelation.
# Admin Area
Let's check your new product in the admin area product page. After a successful creation it should look like on the screen below.
The 'Username' and 'Password' are used to sign up to Office 365 (opens new window) user panel.
The 'User ID', 'Order ID' and 'Subscription ID' are custom fields used to connect the product to the created subscription in your Microsoft Partner Center (opens new window).
If one customer buys more than one subscription then the common 'User ID' will be used for connection.
# Suspend/Terminate
Due to API limitations, ordered subscriptions can only be suspended or unsuspended. For this reason, the 'Terminate' command will work in the same way as the 'Suspend' one.
In case of product suspension, all addons that belong to the product will also be suspended.
If the product is unsuspended, its addons will remain suspended.
Information about product suspension will be shown in the 'Admin Notes' field.
# Change Password
'Change Password' will change the password for all services assigned to the user. To change it for a new one you need to:
- Provide a new password → Press 'Save Changes' → Press 'Change Password'.
Note that the password must also meet the following requirements:
- At least 8 characters in length
- At least 1 uppercase character
- At least 1 special character
- At least 1 numeric character
# Addons
Information about addons will depend on their status and will be shown in the 'Admin Notes' field. By default, the 'Subscription IDservice should be provided.
For example, if the addon is suspended the information will also appear in this field.
# Tips
- For more information on how the Microsoft Partner program works, see here (opens new window).
# Update Instructions
Essential guidance through the process of updating the module is offered here (opens new window).
Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
To take advantage of it, simply use the License Upgrade button located on the product's page and a discounted invoice will be generated automatically.
# Common Problems
- When you have problems with connection, make sure that SELinux or firewall does not block ports.