Managing service processing modules

A processing module is a tool for integrating the platform with external services, allowing you to automate service provisioning. For example, you can set up the VMmanager 6 handler and sell virtual machines to your customers. This article provides general instructions on managing processing modules.

Creating module

To create module, in the main menu go to  Integration → Processing modules → Add button:

1. Select a Product type, for example, "Shared hosting". 
2. Select a Processing module. For example, "cPanel".
3. Click Add.
4. Specify the required integration data in the Integration settings and Processing module parameters sections. The data depends on the processing module type. For more information, see the documentation section Products/Services Sales Settings.
5. Click Finish.

Viewing processing module settings

To view processing module settings, in the main menu go to  Integration → Processing modules → select a processing module → View button.

Overview

The block contains basic information about the processing module:

• Processing module — the name of the system integrated with;
• Data center — the name of the data center in the platform associated with the processing module. Not displayed if the processing module does not support data center selection;
• Responsible department — the name of the department assigned tasks from the processing module;
• Status — the processing module status. Possible values:
  • Enabled;
  • Disabled.

The block may contain additional fields supported by the processing module. For example, for some processing modules there is an additional field Processing module balance.

Settings

The Settings block displays processing module settings grouped into logical categories. If certain settings are not supported by the processing module, the corresponding settings group is not displayed. Possible categories:

• Connection parameters — parameters for connecting to the external system. Field composition depends on the processing module type: for example, Address, Login, Password;
• Processing module settings — configuration parameters affecting service processing within the platform. Includes flags, switches, drop-down lists, and text fields. For more information, see the article section Changing processing module settings;
• License server — parameters related to license server usage. 

Related entities

This block displays data related to the processing module. Data can only be viewed. Depending on the processing module, the following entities may be available:

• Tariffs  — a list of tariffs connected to the processing module, including deleted and archived ones:
  • Name — tariff name. Click the name to open a list with an automatic filter applied for this tariff. To go to the general tariffs list filtered by the selected processing module, click the link at the bottom of the section;
  • Number of active services — number of active services linked to the tariff and this processing module;

• Background tasks — a list of background tasks launched for the processing module:
  • Name — task name;
  • Schedule — schedule description in cron format. For example, */15 * * * *;
  • Last run time — date and time of the last execution;
  • Last run result — status. Possible values:
    • Successful;
    • Unsuccessful;
    • In progress;
  • Duration — task execution time. For example, 5 s or 4.45 m;

• Notifications — a list of unread notifications related to the processing module. Read notifications are automatically removed from the list. Columns displayed:
  • Description — notification type. Click the name to open the notifications list filtered by this processing module. To go to the general tariffs list filtered by the selected processing module, click the link at the bottom of the section;
  • Date added — date when the notification was registered in the system.  

Changing processing module settings

To change processing module settings, in the main menu go to Integration → Processing modules → select a processing module → View button:

1. In the top right corner, click Edit.
2. Make changes. Available fields depend on the selected processing module.
   Example

   For example, you need to change the settings of the VMmanager 6 processing module. You will be able to modify the following parameters:

   1. In the Processing module settings block:

      • Data center — the name of the data center to which the processing module is connected;

        The data center must not have an External data center ID.
      • Name — processing module name displayed in the platform interface;
      • Department — department assigned tasks from the processing module;
      • Sort — processing module priority. If multiple processing modules are connected to a tariff plan, the processing module with the lowest priority is selected first when creating a service;
      • Default cluster — VMmanager cluster where virtual machines (VMs) will be created;
      • Use recipes — enable the option if you need to install additional software or run a script on the VM;
      • Additional network interface — enable the option if you need to use a second network interface on the VM. For this, both primary and additional network interfaces must be configured on the VMmanager cluster;
      • Do not use new templates/recipes — enable the option to prohibit using templates or recipes;
      • Allowed IP pools — specify a list of IP address pools from those allowed for the cluster. An IP address will be allocated from the specified pool if no specific IP address pool is selected for the virtual server.
   2. In the Integration settings block:
      
      • URL — domain or public address of the server with VMmanager 6;
      • Username — email of the VMmanager 6 administrator. Use the account of the first user created after installing VMmanager 6;
      • Password.
   3. In the License server block:
      • enable the Provider's server option if you want to use the license server specified in the provider settings;
      • select one of the existing servers.
3. Click Ok.
4. The card will be updated with current parameters. To synchronize the configuration with the external system, click Update configuration.

Enabling and disabling a processing module

To enable a processing module, in the main menu go to Integration → Processing modules → select a processing module → Enable button.

To disable a processing module, in the main menu go to Integration → Processing modules → select a processing module → Disable button.

Deleting a processing module

Before deletion, perform the following steps:

1. Transfer all associated tariffs to another processing module or disable them:
   1. Go to Products → Tariff plans.
   2. Filter tariffs by the processing module being deleted: Filter button → in the Processing module field enter the processing module name → Search button.
   3. For each tariff, perform one of the following actions:
      • change the linked processing module: select the tariff → Modules button → select the module to be used for the tariff and deselect the processing module being deleted;
      • set the tariff status to "Disabled": select the tariff → Disabled button.
2. Ensure there are no active services on the processing module:
   1. In the main menu go to Integration → Processing modules → select a processing module → View button.
   2. Ensure that in the Related entities section, under "Number of active services", the value 0 is shown for all tariffs.
   3. If active services remain, delete them or manually transfer them to another processing module.
3. Check background tasks and notifications:
   1. In the main menu go to Integration → Processing modules → select a processing module → View button.
   2. Ensure that in the Related entities section, under "Background tasks", all tasks are completed.

To delete a processing module:

1. In the main menu go to Integration → Processing modules.
2. Select the processing module → Delete button.
3. Click Ok to confirm the action.