Office 365 1.0.0 For WHMCS - Revision history

Gregor: Created page with "
2018-03-05T08:35:17Z

Created page with "<meta name="keywords" content="office 365 for whmcs, office 365 configuration, office 365 management, office 365 installation, office 365 guide, modulesgarden office 365, offi..."

New page
<meta name="keywords" content="office 365 for whmcs, office 365 configuration, office 365 management, office 365 installation, office 365 guide, modulesgarden office 365, office 365 wiki, office 365 tutorial, office 365 tips, whmcs office 365 module wiki, office 365 common problems, about office 365 for whmcs, office 365 documentation, office 365 faq, office 365 help"></meta>
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Office 365 For WHMCS Module."></meta>

=About [https://www.modulesgarden.com/products/whmcs/office-365 Office 365 For WHMCS]=
{|
|style="padding: 10px 0px 10px 0px;"|'''Office 365 For WHMCS''' has been designed to let you automatically provision Microsoft Office 365 plans and remotely manage their key features.<br />
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:'''
{|
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend Office 365 Subscriptions
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend Addon Services
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Change Package
|}
{|
|style="padding: 0px 0px 10px 30px;"|✔ Change Password
|}
'''Client Area Features:'''
{|
|style="padding: 10px 0px 0px 30px;"|✔ Upgrade/Downgrade Office 365 Subscriptions
|}
{|
|style="padding: 0px 0px 10px 30px;"|✔ Change Password
|}
'''Supported Services:'''
{|
|style="padding: 10px 0px 0px 30px;"|✔ Office 365 Education/Education E5
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Office 365 Business/Business Essentials/Business Premium
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Office 365 ProPlus/Enterprise E1/E3/E5/K1
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Standalone Services:
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ Exchange Online
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ SharePoint Online
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ OneDrive For Business
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ Skype For Business Online
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ Office Applications
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ Project Portfolio Management
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ Yammer
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ Business Intelligence Service
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ Online Diagram Software
|}
{|
|style="padding: 0px 0px 10px 45px;"|✔ Information Rights Management
|}
'''General Info:'''
{|
|style="padding: 10px 0px 0px 30px;"|✔ Requires Microsoft Partner Network
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Requires Microsoft Cloud Solution Provider - Tier 1
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.4 Up To PHP 7
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
|}
{|
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7
|}

=Installation=
{|
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and authenticate Office 365 For WHMCS.'''<br />
We will guide you step by step through the whole installation and configuration process.<br />
''Note: This module configuration requires a [http://partner.microsoft.com/ Microsoft Partner Network] account.''
|}
{|
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_1.png]]
|}
{|
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>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.<br/>It does not apply to open source versions.<br/>
'' '''Note''': You can check current PHP version in your WHMCS. To do so proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_2.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.'''<br />
The content of PHP version files should look like this.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_2_2.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Office 365 For WHMCS for the first time you have to rename the '' 'license_RENAME.php' '' file.'''<br />
File is located in '' 'modules/servers/office365/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_3.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key you have to edit the previously renamed '' 'license.php' '' file.'''<br />
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'. ''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_4.png]]
|}
==Configuration of Server==
{|
|style="padding: 10px 0px 15px 15px;"|'''6. To begin, you must add a new server.'''<br />
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and press '' 'Add New Server'. ''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_8.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''7. 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'. '''''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_9.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|In order to create full ''' 'API URL' ''' go to '' 'Microsoft Partner Center' '' panel → '' 'Account Settings' '' → '' '[https://partnercenter.microsoft.com/en-us/pcv/accountsettings/organizationprofile Organization profile]' '' and copy '' 'Default domain' '' from the section marked on the screen below:
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_9_01.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|To find your ''' 'Native APP ID' ''' and ''' 'Domain' ''' go to '' 'Microsoft Partner Center' '' panel → '' 'Account Settings' '' → '' '[http://partnercenter.microsoft.com/en-us/pcv/apiintegration/appmanagement App Management]' '' and copy '' 'App ID' '' and '' 'Domain' '' from the '' 'Native App' '' section:
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_9_1.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|To obtain ''' 'Microsoft ID' ''' go to '' 'Microsoft Partner Center' '' panel → '' 'Dashboard' '' → '' '[http://partnercenter.microsoft.com/en-us/pcv/customers/list Customers]' '' and see more details of the account you want to be used to sell subscriptions:
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_9_2.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''8. Once your server has been configured correctly, you will see the following screen.'''<br />
Create a new group for your server. Press '' 'Create New Group' '' to follow.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_10.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|'''9. Enter a name, click on your previously created server, press '' 'Add' '' then '' 'Save Changes'.'' '''
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:O_11.png]]
|}

==Configuration of Product==
{|
|style="padding: 10px 0px 15px 15px;"|'''10. In order to create a product, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
If you do not have a product group, click on '' 'Create a New Group' ''. If you do, simply move to the 12th step.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_12.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|'''11. Fill in a product group name and press '' 'Save Changes'. '' '''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_13.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|'''12. When you have a product group added, you can create your product and assign it to Office 365 module.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_14.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|'''13. Afterward, choose your product type and product group from dropdown menus, enter your product name and press '' 'Continue' ''.'''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_15.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|'''14. Now, go to '' 'Module Settings' '' section, choose both '' 'Office365' '' and the previously created server group from the dropdown menu and press'' 'Save Changes' ''.'''
|}
{|
|style="padding: 0px 0px 30px 30px;"|[[File:O_16.png]]
|}

=Configuration and Management=
{|
|style="padding: 10px 0px 30px 0px;"|Configuration and management of Office 365 For WHMCS is very intuitive. Read the below sections to see how easy it is.
|}
==Basic Configuration==
{|
|style="padding: 10px 0px 15px 15px;"|Let's start the module configuration by choosing '' 'Office365' from '' 'Module Name' and previously created 'Server Group' ''.
|}
{|
|style="padding: 0px 0px 15px 25px;"|[[File:O_16.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|
Now, choose '' 'Country'. '' that you will offer your Office 365 services from.<br />
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.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_17.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"| 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.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:O_18.png]]
|}

==Additional Services==
{|
|style="padding: 10px 0px 15px 15px;"|
In order to offer additional services for a product plan you need to create a new addon first. <br/>
In your WHMCS system press '' 'Setup' '' → '' 'Products/Services' '' → '' 'Product Addons' '' and select '' 'Add New Addon' ''.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_22.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|Enter a name for the addon, choose the addon to be visible in order and configure the rest of the desired options.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_23.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|Go to the '' 'Applicable Products' '' tab and select the product that you want to offer this addon for. Then press '' 'Save Changes' ''.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_24.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|Go back to your product and connect the created addon with one of the available additional services in the '' 'Module Settings' '' tab.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_25.png]]
|}
{|
|style="padding: 0px 0px 30px 15px;"|'' 'Save Changes' ''. Remember that you can add more addons for other services.
|}

==Order==
{|
|style="padding: 10px 0px 20px 15px;"|Once the product configuration is complete, clients will be able to order the selected subscription and addons.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:O_20_2.png]]
|}

==Client Area==
{|
|style="padding: 10px 0px 15px 15px;"|
Currently, the module does not support any additional features in the client area.<br />
The customer can order additional services to their subscription, change their password to the [http://www.office.com Office 365] panel, upgrade a subscription plan or request a service cancelation.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:O_20.png]]
|}

==Admin Area==
{|
|style="padding: 10px 0px 20px 15px;"|Let's check your new product in the admin area product page. After a successful creation it should look like on the screen below.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_19.1.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|The '' 'Username' '' and '' 'Password' '' are used to sign up to [http://www.office.com Office 365] user panel.
|}
{|
|style="padding: 0px 0px 15px 25px;"|[[File:O_26.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|
The '' 'User ID' '', '' 'Order ID' '' and '' 'Subscription ID' '' are custom fields used to connect the product to the created subscription in your [http://partnercenter.microsoft.com Microsoft Partner Center].<br />
If one customer buys more than one subscription then the common '' 'User ID' '' will be used for connection.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_27.png]]
|}
====Suspend/Terminate====
{|
|style="padding: 10px 0px 15px 15px;"|
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.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_30.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|
In case of product suspension, all addons that belong to the product will also be suspended.<br />
If the product is unsuspended, its addons will remain suspended.<br />
Information about product suspension will be shown in the '' 'Admin Notes' '' field.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:O_31.png]]
|}

====Change Password====
{|
|style="padding: 10px 0px 15px 15px;"|
'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' ''.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_34.png]]
|}
{|
|style="padding: 0px 0px 30px 15px;"|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====
{|
|style="padding: 10px 0px 20px 15px;"|Information about addons will depend on their status and will be shown in the '' 'Admin Notes' '' field. By default, the '' 'Subscription ID''' service should be provided.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:O_28.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|For example, if the addon is suspended the information will also appear in this field.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:O_29.png]]
|}

=Tips=
{|
|style="padding: 10px 0px 30px 15px;"|'''1. For more information on how the Microsoft Partner program works, see [http://partner.microsoft.com/en-us/membership/how-it-works here].'''
|}

=Update Instructions=
{|
|style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
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!<br/>
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.<br/>
|}
=Common Problems=
{|
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, make sure that SELinux or firewall does not block ports.'''
|}