PROVISIONING/MODULES

Transcription

1 PROVISIONING/MODULES

2 Table of Contents Modules... 3 Setup Application Links with cpanel... 4 Resolving a failed hosting account creation... 6 Troubleshooting MarketConnect Automated SSL Installation... 9 Other...13 Handling Pending Orders...14 Troubleshooting...15 Product attribute Package Name XXX Not Found on Server...16 Troubleshooting An Unknown Error Occurred...18

3 Modules Page 3

4 Setup Application Links with cpanel Application Links allows customers to seamlessly transition from cpanel to WHMCS using Single Sign-On technology. To activate it, begin by navigating to Setup > Application Links. In the Application Links overview, click the toggle switch that should currently be in the Off position to turn the feature on. Enabling Application Links requires communicating with cpanel's API's and may take anywhere from 20 seconds to a couple of minutes. Upon completion, you should see the display update to reflect it is active as pictured below. Page 4

5 Once enabled, links will be visible as shown below for all existing cpanel accounts and will be provisioned automatically for any new accounts you create. Login to a cpanel account to verify. Page 5

6 Resolving a failed hosting account creation When an automated module action fails, it is added to the Module Queue. Events that can fail and go into the Module Queue include Hosting Account Creation, Suspension, Unsuspension as well as Domain Registrations, Renewals and more. The admin dashboard will indicate when an action has failed via the Pending Module Actions badge shown below. To resolve it, visit the Module Queue either by clicking on the badge (pictured above) or by navigating to Utilities > Module Queue. The list of automated actions that have failed and need attention will be displayed, along with the error code returned by the module (highlighted below). Page 6

7 In this case, the issue is the automatically generated username is a reserved username. To resolve it and allow the creation to be successful, we must change change the username to a valid value. To do that, click the Product Name which in our case is "Home", and that will take you to the Manage Product/Service screen. From here we can update the username and hit Save Changes. Now return to the Module Queue and hit the Retry button. Page 7

8 WHMCS will attempt to perform the account creation again and the outcome of the attempt will be displayed on screen. If you see a green success message like the one below, then the account has been successfully created. Page 8

9 Troubleshooting MarketConnect Automated SSL Installation With WHMCS MarketConnect, SSL certificates can be configured, approved and installed totally automatically without any intervention from you or the client. Should this not be occurring, please check the following points: Supported Modules The following official modules support SSL certificate auto-installation: cpanel Plesk DirectAdmin If the client's hosting product is assigned to any other module, including third-party cpanel, Plesk or DirectAdmin extended modules, the client will be required to manually configure, approve and install the certificate. To check you are using a supported module, follow these steps: 1. Navigate to Setup > Products/Services > Products/Services 2. Click the Edit link next to the product in question 3. Click the Module Settings tab Page 9

10 4. Confirm that the Module Name Settings is one of the following: cpanel Plesk DirectAdmin Supported Product Configuration In order for WHMCS to identify the account upon which the certificate should be auto-installed, it must be ordered as a Product Addon beneath the hosting service in question. If the SSL certificate is ordered as a standalone product, it will not be automatically installed and the client will be prompted to manually configure, approve and install the certificate. To check the correct configuration, follow these steps: 1. Navigate to Setup > MarketConnect 2. Click the Manage button under the SSL Certificates heading Page 10

11 3. Click the Other Settings tab 4. Ensure the Auto Assign to Addons option is set to On 5. The client can then place an order for this service in two ways: 1. From their client area, navigate to Services > View Available Addons 2. By visiting the MarketConnect SSL Certificates landing page (/store/order) and selecting the Choose Existing Domain or Subdomain of an Existing Domain options: Page 11

12 Further Troubleshooting If you have confirmed the above configuration steps and the problem persists, further troubleshooting steps are located in this article. Page 12

13 Other Page 13

14 Handling Pending Orders With WHMCS all orders are pending until accepted. Orders can reviewed by navigating to Orders > List All Orders. The items in that order - hosting accounts and domains - will be automatically activated based on the product auto setup options and domain auto registration options. So if you have hosting and domains configured to be provisioned and registered instantly upon payment, that will be done while the order remains pending. This allows the automation to take place whilst providing a method to manually review each order received, giving you an opportunity to keep track of new orders received and run any manual checks your business practices require. For more information please refer to our documentation on Order Management. Page 14

15 Troubleshooting Page 15

16 Product attribute Package Name XXX Not Found on Server This article explains how to troubleshoot the cpanel Product attribute Package Name XXX not found on server which you may have received via , seen listed in the Module Queue or the Activity Log. If you are experiencing this issue with the cpanel module, this message is being provided via the WHM/cPanel API and typically means that your WHM account is hitting resource limitations. To confirm this, we can follow the steps below: Login to your WHM Navigate to Account Functions > Create New Account Leaving all the fields blank, scroll down to the Package Area and select the drop down. When that expands, you will see a list of the packages available to provision. Those highlighted in green are able to be used, while those in red are not. This is due to resource limitations imposed by your hosting provider. The WHMCS cpanel module will only be able to provision accounts to packages that your WHM account is able to have the resources for. In this example, there are 3 Packages that my WHM user does not have enough resources to provision and only one that is allowed. Page 16

17 How to Resolve This Issue Change your package limitations to be within your Reseller Account resource limitations. If you are unsure of what these limitations are, please contact your Hosting Provider for full details. Page 17

18 Troubleshooting An Unknown Error Occurred Sometimes a third party system or module will provide a response that WHMCS is unable to recognise and interpret. This can result in the display of an "Unknown Error" message. In these cases the System Module Debug Log can be used to obtain the raw response being received which will help pinpoint the problem. 1. Navigate to Utilities > Logs > Module Log 2. Click Enable Debug Logging 3. Now reproduce the issue 4. Refresh the Module Log page The details of the interaction between WHMCS and the module will be displayed on-screen for your own analysis. These details can then be forwarded to the provider's technical support team if necessary. We have collected the explanation for most common module errors in the troubleshooting section of each module's documentation: Click Disable Debug Logging Page 18