Voci con l'etichetta :
Chiudi
Changelog
Chiudi
Centro assistenza
Hosting Solutions

How to integrate Hosting Edition with the ISP BillManager billing module

Introduction

An absolute advantage of Hosting Edition is the possibility to integrate it into the hosting provider workflow at minimum costs.

We have prepared a solution for our partners that allows to deploy the product in your infrastructure in a few simple steps.

System requirements

For the full deployment of the system, the following requirements must be fulfilled:

  1. Server workload
    • Server with at least 6-core CPU and 8 GB RAM with Windows Server 2012 OS installed for Hosting Edition installation
    • Server with 4-core CPU and 6 GB RAM with Ubuntu LTS 14.04 or CentOS 7 installed for standalone Document Server installation
    • Server with 2-core CPU and 4 GB RAM with CentOS 7 (recommended) or Ubuntu LTS 14.04 installed for the ISP BillManager billing system installation

    All the servers must have network access, dedicated external IP addresses and the following open ports:

    • 80
    • 443
    • Windows - 3389 (for RDP access)
    • Unix - 22 (for SSH access)

    Internet channel bandwidth - 500-750 Mb/s

  2. Configuration requirements
    • Wildcard A record of the following form: Windows Server 2012 IP <> *.domainname.com

      domainname.com - the second-level domain intended for all portals.

      • portal1.domainname.com - the name of the first portal
      • portal2.domainname.com - the name of the second portal

      A portal name (instead of portal1 and portal2) is specified by an end user during the portal creation process within the ISP BillManager interface.

  3. Security requirements
    • Wildcard SSL certificate issued for the domain name that will be used.
      The certificate presence is not obligatory if you install the solution on the test stand, but it is required when you start the product sales.
  4. Access
    • The access to servers is performed based on pre-agreed conditions using RDP for Windows Server 2012 and using SSH for Ubuntu/CentOS servers.
    • All the servers with the product components that reside on a local network must have access to each other.
  5. Hosting Edition setup and configuration

    Setup and configuration of all the Hosting Edition components are performed by ONLYOFFICE technical support specialists if all the requirement (items 1-4 above) are fulfilled.

  6. Integration with ISP BillManager billing system

    The integration process is described in the next section.

Integration Instructions

To integrate ISP BillManager payment system and Hosting Edition you will need to have:

  1. An already installed ISP BillManager version. You can install it following this instruction.

    To log in to the ISP BillManager web interface as an administrator, use the CentOS server credentials for the root account.

  2. Access to the server where ISP BillManager is installed.
    You might also need to install curl and libxml2 (the xmllint utility) if these packages are not installed on this server. If you are using Debian jessie, the curl and libxml2-utils packages are required.
  3. The ONLYOFFICE Hosting Edition for ISP handler file (which is sent upon request).

Perform the following steps:

  1. Extract the following files and put them into the specified folders:
    • put the billmgr_mod_pmonlyoffice.xml file into the /usr/local/mgr5/etc/xml folder
    • put the pmonlyoffice.sh file into the /usr/local/mgr5/processing folder
    • put the addononlyoffice.sh file into the /usr/local/mgr5/addon folder
    • put the onlyoffice_48x48.png image into the /usr/local/mgr5/skins/common/img/ folder
      The files must be extracted on the server where ISP BillManager is installed, otherwise (if the archive have been unpacked in the Windows environment) you need to run the following scripts after copying the .sh files:
      sed -i 's/\r$//' /usr/local/mgr5/processing/pmonlyoffice.sh
      sed -i 's/\r$//' /usr/local/mgr5/addon/addononlyoffice.sh

      Set '777' permissions to the pmonlyoffice.sh and addononlyoffice.sh files.

  2. Restart the service:
    /usr/local/mgr5/sbin/mgrctl -m billmgr exit
  3. Create a new product in the ISP BillManager. The details on how to create and configure a new product are described in the next section.

Product Creation

To create a product:

  1. Go to the Products >> Product types. Click Add Icon Add. A new product type creation form will open.
    • Specify ONLYOFFICE in the Name field.
    • Specify oo in the Internal name field.
      Please do not change the internal name. Set it exactly as it is specified here.
    • Add at least one payment period in the Available payment methods section checking the necessary options. For example, check the Month and Year options.
    • Click Ok. The created product will be added into the Product types list.
      Creating product Creating product
  2. Specify the product properties. You will need to add the following five obligatory properties:
    • First name with the firstname internal name
    • Second name with the lastname internal name
    • Portal name with the alias internal name
    • Email with the email internal name
    • Password with the password internal name
      Please do not change internal names. Set them exactly as they are specified here.

    To create a property:

    • Select the ONLYOFFICE product in the Product types list, click the Properties Icon Properties icon above, then click Add Icon Add.
    • Specify the property name and internal name as described above.
    • For all the properties, check the Show in the order form and Required parameter options as well as select the Staff member option in the Edit list.
    • When creating the Portal name property you will also need to select the check.alias option from the Check function list.
    • When creating the Password property you will also need to select the check.password_length option from the Check function list.
    • Click Ok to save the parameter.
      Adding properties Adding properties

      These properties will be used during the portal creation process.

  3. Add contents of the product type. You will need to add the following three obligatory add-ons:
    • Active users with the activeusers internal name
    • Max total size with the maxtotalsize internal name
    • Max file size with the maxfilesize internal name
      Please do not change internal names. Set them exactly as they are specified here.

    To create an add-on:

    • Select the ONLYOFFICE product in the Product types list, click the Details Icon Details icon above, then click Add Icon Add.
    • Specify the add-on name and internal name as described above.
    • Click Ok to save the parameter.
      Adding add-ons Adding add-ons

      These add-ons will be used to specify parameters of tariff plans.

  4. Create the processing module.
    • Go to Integration >> Processing modules and click Add Icon Add.
    • Click the Select button next to the ONLYOFFICE product type.
    • Сlick the Add button next to the ONLYOFFICE Integration option.
    • Specify the Apisystem Url of the following form: http://apisystem.domainname.com.
    • Insert the Machine Key (it can be found in the web.appsettings.config file) and click Next.
      The Apisystem Url and Machine Key parameters are specified to enable access to the API of the server where Hosting Edition is installed.
    • Specify the processing module name and click Finish.
      Creating processing module Creating processing module
  5. Create a tariff plan.
    • Go to Products >> Tariff plans and click Add Icon Add.
    • Click the Select button next to the ONLYOFFICE product type. A new tariff creation form will open.
    • Specify any desired name (for example, ONLYOFFICE 1-5 users) and internal name and select the Processing module you have created at the previous step.
    • Specify prices per month and per year in the Prices section. The prices must coincide with the ones published on the pricing page of our official website.
    • Click Finish to save the created tariff.
      Creating tariff plan Creating tariff plan
  6. Set the tariff plan parameters. To do that, you will need to add three tariff plan add-ons on the base of the product type add-ons created at step 3: Active users, Max total size, Max file size.

    To create an add-on:

    • Select the tariff plan you have created at the previous step in the Tariff plans list, click the Options Icon Options icon above, then click Add Icon Add.
    • Leave the Do not bill option selected by default in the Billing type list.
    • Select the necessary add-on type in the Type list.
      • Active users - to set the maximum number of users allowed for this tariff plan
      • Max total size - to set available disk storage space for this tariff plan
      • Max file size - to set the maximum size of a file that can be uploaded to the portal
    • Choose the Integer option in the Value type list.
    • Select corresponding Units of measure (pcs, GiB or MiB) for the selected add-on type and specify the necessary value in the Tariff plan includes field.
    • Click Ok to save the parameter.
      Adding add-ons Adding add-ons
  7. After all the necessary tariff plans are created, set the tariff change rules for each of them.
    • Select the necessary tariff plan in the Tariff plans list and click the Change tariff icon Change tariff icon above.
    • To allow your users to change the selected tariff to another one, select one of the existing tariff plans and click the On icon On icon above to enable switching to this tariff.
    • To disable the possibility to change the selected tariff to another one, select one of the existing tariff plans and click the Off icon Off icon above to disable switching to this tariff.
      Tariff change rules Tariff change rules

      You can allow those users who have the ONLYOFFICE 6-10 users tariff to upgrade it (selecting ONLYOFFICE 11-20 users) and disable the possibility to downgrade it (selecting ONLYOFFICE 1-5 users).

  8. So that users can pay for the product, add at least one payment method, if this has not yet been done.
    • Go to Provider >> Payment methods.
    • Click the Add icon Add button on the top.
    • Click the Add button next to the necessary payment method (e.g., Wire transfer).
    • Fill in the Integration settings form and click the Next button.
    • Specify required Payment method settings and click Finish.
  9. That's all. The links to order the one-year or one-month tariff plan can be found in the tariff properties: select the tariff plan in the Tariff plans list, click the Edit Icon Edit option and go to the URLs section. Copy a link and paste it into the address bar of your web browser to verify if the added tariff is displayed correctly in a shopping cart.
    Ordering tariff Ordering tariff

    To add screen tips to the alias and password fields, do the following:

    • Open the billmgr_mod_pmonlyoffice.xml file.
    • Find the <lang name="en"> or <lang name="ru"> section depending on the necessary localization.
    • Add the following contents to this section:
      
      <messages name="oo.order.param">
      <msg name="hint_alias">Name of your portal will be portalname.mycloudoffice.ru</msg>
      </messages>
                                    

    Users must fill in all the fields for the portal creation during the ordering process. After a user pays for the selected tariff, he/she will be able to change the tariff using the Change tariff icon Change tariff icon according to the specified tariff change rules.

Learn more Enhance your hosting Host ONLYOFFICE now and
boost your sales getting even more clients
Ti potrebbe essere d'aiuto anche...
Chiudi