GlobalSign OneClickSSL - Revision history

SarahK: /* Configuring a Product */

2022-12-28T17:14:13Z

‎Configuring a Product

SarahK: /* Configuring a Product */

2022-12-28T17:13:55Z

‎Configuring a Product

SarahK at 17:13, 28 December 2022

2022-12-28T17:13:30Z

SarahK: /* Troubleshooting */

2022-05-13T18:07:18Z

‎Troubleshooting

SarahK at 17:59, 13 May 2022

2022-05-13T17:59:01Z

SarahK at 17:55, 13 May 2022

2022-05-13T17:55:03Z

SarahK: /* Setting Up Voucher Products */

2022-04-22T19:49:00Z

‎Setting Up Voucher Products

SarahK: /* Setting Up Voucher Products */

2020-08-27T20:46:50Z

‎Setting Up Voucher Products

SarahK at 13:28, 5 August 2020

2020-08-05T13:28:50Z

Lawrence at 19:56, 4 July 2018

2018-07-04T19:56:24Z

@@ Line 47: / Line 47: @@
 #**'''Order Kind''' — Set the type of order this product is for (''New'' or ''Transfer''). Usually, you will select ''New''.
 #**'''Coupon & Campaign''' — Only use these fields if GlobalSign support instructs you to.
-# Optionally, go to '''Setup > [[Custom Fields|Client Custom Fields]]''' and customize the display name following '''Domain|''' on the system-created custom field for this module.
+# Optionally, go to '''Setup > [[Custom Fields|Custom Client Fields]]''' and customize the display name following '''Domain|''' on the system-created custom field for this module.
 [[File:GSOneClickSSLModuleSettings.png]]

@@ Line 47: / Line 47: @@
 #**'''Order Kind''' — Set the type of order this product is for (''New'' or ''Transfer''). Usually, you will select ''New''.
 #**'''Coupon & Campaign''' — Only use these fields if GlobalSign support instructs you to.
-# Optionally, go to '''Setup > [[Custom Fields|Custom Client Fields]]''' and customize the display name following '''Domain|''' on the system-created custom field for this module.
+# Optionally, go to '''Setup > [[Custom Fields|Client Custom Fields]]''' and customize the display name following '''Domain|''' on the system-created custom field for this module.
 [[File:GSOneClickSSLModuleSettings.png]]

@@ Line 47: / Line 47: @@
 #**'''Order Kind''' — Set the type of order this product is for (''New'' or ''Transfer''). Usually, you will select ''New''.
 #**'''Coupon & Campaign''' — Only use these fields if GlobalSign support instructs you to.
-# Optionally, go to '''Setup > [[Custom Client Fields]]''' and customize the display name following '''Domain|''' on the system-created custom field for this module.
+# Optionally, go to '''Setup > [[Custom Fields|Custom Client Fields]]''' and customize the display name following '''Domain|''' on the system-created custom field for this module.
 [[File:GSOneClickSSLModuleSettings.png]]

← Older revision		Revision as of 18:07, 13 May 2022
Line 74:		Line 74:

	''N/A''		''N/A''
		+
		+	{{modules}}

← Older revision		Revision as of 17:59, 13 May 2022
Line 70:		Line 70:
	# Upload the module folder to the <tt>/modules/servers/</tt> directory in your WHMCS installation.		# Upload the module folder to the <tt>/modules/servers/</tt> directory in your WHMCS installation.
	# Contact GlobalSign support and request that they whitelist your IP address for access to their API. If you do not do this, you will see a ''This IP Address is not registered'' error.		# Contact GlobalSign support and request that they whitelist your IP address for access to their API. If you do not do this, you will see a ''This IP Address is not registered'' error.
		+
		+	== Troubleshooting ==
		+
		+	''N/A''

@@ Line 1: / Line 1: @@
 <div class="docs-alert-danger">
-<span class="title">Discontinued</span><br />
+GlobalSign discontinued OneClick SSL on Tuesday, February 6th, 2018. We no longer distribute this module and it will no longer function.
-Effective Tuesday February 6th 2018, the OneClick SSL product has been discontinued by GlobalSign. As a result this module will no longer be distributed with the WHMCS software. More information on the discontinuation of this service can be found at https://support.globalsign.com/customer/portal/articles/2428257
+* For more information, see [https://support.globalsign.com/customer/portal/articles/2428257 GlobalSign's website].
+* We recommend using the [[GlobalSign SSL]] module instead.
 </div>
-Welcome to OneClickSSL, GlobalSign's revolutionary new SSL technology for automating the SSL reselling & installation process.
+This module automates the SSL reselling & installation process. Users simply activate SSL for their website by redeeming Secure Site vouchers via any of the OneClickSSL plug-ins, available via platforms such as cPanel, Parallels, IIS, and Apache.
-==What is it?==
+Redemption of the voucher using the plug-in transparently creates the cryptographic keys, the Certificate Signing Request (CSR), validates the control of the domain, installs the issued certificate, and binds it to the appropriate website. This eliminates the need to provide your customer with a CSR and have them go through a lengthy and often confusing SSL configuration process.
-With OneClickSSL, users simply activate SSL for their website by redeeming Secure Site vouchers via any of the OneClickSSL plug-ins, available via platforms such as cPanel, Parallels, IIS, and Apache.
+WHMCS lets you take full advantage of the OneClickSSL automation by allowing your customers to purchase and receive their OneClickSSL Vouchers automatically from your WHMCS installation. This includes:
-Redemption of the voucher using the plug-in transparently creates the cryptographic keys, the Certificate Signing Request (CSR), validates the control of the domain, installs the issued certificate and binds it to the appropriate website, all within just a few seconds, thus eliminating the need to provide your customer with a CSR, and have them go through a lengthy and often confusing SSL configuration process.
+* Fully-automated voucher provisioning.
-But where does the user get the OneClickSSL Voucher you're wondering? Well that's where WHMCS comes in.  WHMCS lets you take full advantage of the OneClickSSL automation by allowing your customers to purchase and receive their OneClickSSL Vouchers automatically from your very own WHMCS ordering system.
+=== Display ===
-Here's an example of how a voucher purchase is shown to the customer via your client area:
+Customers will see the option to purchase vouchers in your Client Area:
 [[File:GSOneClickSSLClientArea.png]]
-And for admin users:
+Admins can also view the option in your Admin Area:
 [[File:GSOneClickSSLAdminArea.png]]
-==Features==
+== Configuring a Product ==
-Finally your server IP address will need to be whitelisted by Globalsign support for access to their API. Failure to do so will result in a "This IP Address is not registered" error message.
+To set up a OneClickSSL Voucher product:
-==Setting Up Voucher Products==
+# Go to '''Setup > [[Products and Services|Products/Services]]'''.
 # Create a new group for your GlobalSign SSL offerings.
 # Create a new product:
@@ Line 58: / Line 45: @@
 #**'''SSL Certificate Type''' — Set the type of SSL product this voucher grants access to (''DomainSSL'' or ''AlphaSSL'').
 #**'''Validity Period''' — Set the period for which the SSL certificate should be valid (for example 1 year, 2 year, or 3 year).
-#**'''Order Kind''' — Set the type of order this product is for (''New'' or ''Transfer''). In most cases, select ''New''.
+#**'''Order Kind''' — Set the type of order this product is for (''New'' or ''Transfer''). Usually, you will select ''New''.
 #**'''Coupon & Campaign''' — Only use these fields if GlobalSign support instructs you to.
-One final requirement for the Voucher products is that a custom field must be created for the customer to enter the domain they are purchasing the voucher for. This will be created automatically for you but you can customise the display name which is the part after the '''Domain|''' via the custom fields tab should you wish.
+=== Configurable Options ===
-[[File:GSOneClickSSLModuleSettings.png]]
+You can offer voucher products in many combinations. To do this, you can create [[Configurable Options|configurable options]] to override the default module settings based on customer selections.
-==Additional Options==
+We started shipping this module by default in WHMCS 5.0.2. For WHMCS 4.5 or earlier, you will need to download and install the module before you can use it.
-Voucher products can be offered in many different ways and combinations. And so in the module for WHMCS we've tried it make it as flexible as possible. And so to that end, there are a number of optional configurable options you can create to override the default module settings based on customers selections if you wish:
+To download this module:
-*'''NumYears''' - A configurable option with this keyword name will override the Validity Period set for a product thus allowing you to offer the 1-5 registration periods via a single product
+# [http://www.whmcs.com/members/dl.php?type=d&id=90 Download the module.]
-*'''Transfer''' - If you setup a configurable option with this name, set to field type Yes/No, then this allows the customer to specify if the SSL they are ordering is a transfer of an existing SSL simply by checking a box in the order process
+# Unzip the file.

@@ Line 46: / Line 46: @@
 # Begin by navigating to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products and Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services'''.
-# Create a new group for your GlobalSign SSL offerings
+# Create a new group for your GlobalSign SSL offerings.
-# Next proceed to create a new product, selecting the group you just created above, setting the product type to "Other" and giving the new product a name
+# Create a new product:
-# You can then configure the description and other settings as you would for any product
+#* Select the newly-created group.
-# '''Require Domain''' should be unticked. And '''Welcome Email''' should be left at None.
+#* Set the product type to '''Other'''.
-# When it comes to pricing, you can offer the voucher for a one time item, so select the '''One-Time''' Payment Type option.
+#* Disable '''Require Domain'''.
-# Now it's time to configure the GlobalSign related settings via the '''Module Settings''' tab
+#* Select ''None'' for '''Welcome Email'''.
-# Begin by choosing '''Globalsignvouchers''' from the module dropdown menu
+#* Select '''One-Time''' for '''Payment Type'''.
-# You'll then be presented with a screen like the one below which has the following fields:
+#* Select ''Globalsignvouchers'' as the module.
+#* Configure the following additional module settings:
-*'''Username & Password''' - this is where you need to enter your GlobalSign API Username & Password
+#**'''Username & Password''' — Enter your GlobalSign API credentials.
-*'''SSL Certificate Type''' - in this dropdown menu you can set the type of SSL product this voucher grants access to. The choices are DomainSSL or AlphaSSL.
+#**'''SSL Certificate Type''' — Set the type of SSL product this voucher grants access to (''DomainSSL'' or ''AlphaSSL'').
-*'''Validity Period''' - this is where you set the period for which the SSL Certificate should be valid (for example 1 year, 2 year, 3 year).
+#**'''Validity Period''' — Set the period for which the SSL certificate should be valid (for example 1 year, 2 year, or 3 year).
-*'''Order Kind''' - this is where you set the type of order this product is for. The choices are New or Transfer. Normally you should choose New here.
+#**'''Order Kind''' — Set the type of order this product is for (''New'' or ''Transfer''). In most cases, select ''New''.
-*'''Coupon & Campaign''' - these are optional fields which are only to be used if specifically instructed to by GlobalSign support
+#**'''Coupon & Campaign''' — Only use these fields if GlobalSign support instructs you to.
 One final requirement for the Voucher products is that a custom field must be created for the customer to enter the domain they are purchasing the voucher for. This will be created automatically for you but you can customise the display name which is the part after the '''Domain|''' via the custom fields tab should you wish.

@@ Line 45: / Line 45: @@
 To configure a OneClickSSL Voucher product in WHMCS, simply follow the steps below:
-# Begin by navigating to '''Setup > Products/Services''' and create a new group for your GlobalSign SSL offerings
+# Begin by navigating to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services'''.
 # Next proceed to create a new product, selecting the group you just created above, setting the product type to "Other" and giving the new product a name
 # You can then configure the description and other settings as you would for any product