Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

CreateCancelSuspendUnsuspendManagementConfig Options
Status
colourGreen
titleYes
Status
colourGreen
titleYes
Status
colourGreen
titleYes
Status
colourGreen
titleYes
Status
colourGreen
titleYes

Status
colour

Red

Green
title

No

Yes

Management Features

This module supports the following management features within the client area:

...

Select servers under "Available Servers" and click to move them to the left column to add them to the group
OptionDetails
Group Name

Enter the name for this server group.

Add OrderChoose how servers in this group will be selected for provisioning. Currently, first non-full server is the only add order.Assigned Serversprovisioning. Currently, first non-full server is the only add order.
Assigned ServersSelect servers under "Available Servers" and click to move them to the left column to add them to the group.

Configurable Options Overview

This module supports configurable options which may server settings in cPanel.

Option Name

Possible Values

Recommended Field Type

Description

dedicated_ip[0, 1]CheckboxWhether to assign a dedicated IP to the server.

Creating Configurable Options

The following steps describe how to create configurable options. This section describes the following:

  1. Creating a Configurable Option Group
  2. Creating Configurable Options, and assigning them to the Group (repeat this step as necessary to create all Configurable Options required)

Creating an Option Group

To create a Configurable Option Group, visit [Packages] > Options, and click the "Create Group" button.

Field Name

Description

NameEnter a name for this group.
DescriptionEnter a description for this group (optional).
Package MembershipLeave this section blank, we will add the options to the group when creating the options instead. If you have already created the options, you may add them to the group on this step.

After filling out these options, click the "Create Group" button to create the Option Group.

Creating a Configurable Option

To create a Configurable Option, visit [Packages] > Options, and click the "Create Option" button.


Field Name

Description

LabelEnter a label, which will appear above or next to this form field.
NameEnter a name, which is the form field name. (Important! This should match an Option Name described above. The module requires specific naming.)
TypeSelect the field type from "Checkbox", "Radio", "Drop-down", and "Quantity".
Options SectionSet pricing information within the Options section. The fields required here may vary depending on the "Type" selected above.
Group Membership SectionAdd this Configurable Option to the previously created Option Group by moving the Group from the right to the left in the multi-select box.

After filling out these options, click the "Create Package Option" button to create the Option. Repeat as necessary to create all of the configurable options you wish to make available to the client during checkout.

Creating Packages

Packages define the pricing, welcome email, module and more. Packages can be assigned to Package Groups, and added to Order Forms. To create a Package, visit [Packages] > Browse, and click the "Create Package" button.

...

  1. Go to the profile for the client you want to add the cPanel account to [Clients] > [Browse] and click on the client ID, or perform a search.
  2. Click Add Service under Account Actions on the left, or click the [+] button in the Services widget.
  3. Select the correct Package for the plan you are adding, and Continue.
  4. Select the Term, and uncheck the "Send order confirmation" and "Provision using the cPanel module" boxes. You may also wish to select "Do not Invoice" for Invoice method, but this will depend on whether you'd like to create an invoice now or not.
  5. Enter the domain name and click "Continue".
  6. The service should be added, now click the Manage icon next to the service on the client's profile page.
  7. Enter the correct username under the "Username" field, uncheck the "Use moduleProvision using the cPanel module when activated" option, and save.
  8. If you need to sync the renew date to a specific day, click on the Manage link for the service again, and select "Change Renew Date" under the Actions drop down. Set the nex renew date, uncheck the "Prorate" option, and Save.
  9. Repeat for each account.

...