Difference between revisions of "Other Tab"

From WHMCS Documentation
 
(48 intermediate revisions by 7 users not shown)
Line 1: Line 1:
−
===Twitter Integration===
+
{{General Settings}}<br/>
−
Enter your Twitter username here and the three most recent tweets will appear at the bottom of the portal homepage in place of the "Latest Announcements" section. A "Follow us on Twitter" button will also appear, linking clients directly to your Twitter page.
 
  
−
===KB SEO Friendly URLs===
+
The '''Other''' tab allows you to configure additional WHMCS settings.
−
Enabling this requires mod_rewrite enabled on your server, it will rewrite ''/knowledgebase.php?action=view&id=1'' to "/knowledgebase/1/How_do_I_login.html" for example. Making your knowledgebase, announcements and downloads more friendly to search engines. For more information [[Support_Center#Search_Engine_Friendly_URLS|refer to this page]].
+
 
 +
You can access this tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[General Settings]]''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
 +
 
 +
===Marketing Emails===
 +
This setting controls the opt-in/opt-out functionality for Marketing e-mails, such as those sent by the mass mail tool. When enabled, a '''Newsletter Opt-In''' option displays to new customers during checkout or registration. This option is enabled by default.
 +
 
 +
===Require User Opt-In===
 +
Enable this to require clients to explicit opt-in before they will receive marketing labelled e-mails. By default, users are required to opt-in to marketing emails. If you wish, you can use this setting to default the opt-in box to a checked status, requiring users instead to opt-out of marketing emails.
 +
 
 +
===Marketing Email Opt-In Messaging===
 +
The message that will be displayed to clients on the client area if '''Marketing Emails''' is enabled and they are being asked to opt in. Allows you to customise the message displayed to users in the opt-in request. It is important that the opt-in message accurately reflects the type of marketing emails you will be sending for compliance reasons.
 +
 
 +
===Admin Client Display Format===
 +
Choose the format that your customer's names appear in throughout the admin. For example it may be desirable to display the company name instead of the contact's name.
  
 
===Client Dropdown Format===
 
===Client Dropdown Format===
−
Choose the format that your customer’s names appear in the client dropdown throughout the admin.
+
Choose the format that your customer’s names appear in the client menu throughout the admin.
  
 
===Disable Full Client Dropdown===
 
===Disable Full Client Dropdown===
−
Check this option to remove the aforementioned client dropdown. This is used on large databases where the number of clients slows down the loading of pages.
 
  
−
===Captcha Form Protection===
+
<div class="docs-alert-info">We removed this setting in WHMCS 6.2.</div>
−
Requires GD2 on your server. Also known as image verification; shows an image containing 5 characters that your clients will be required to enter to register or submit a support ticket when enabled. Helps prevents automated submissions and spam.
+
 
 +
Check this option to remove the client menu in order to speed up page loading.
 +
 
 +
===Default to Client Area===
 +
 
 +
Normally when clients and visitors visit your WHMCS installation they are presented with the homepage listing the various pages; client area, submit ticket, view tickets, place order etc. Ticking this option skips this page and takes visitors directly to the client area prompting them to login.
 +
 
 +
===Disable Client Area User Management===
 +
 +
<div class="docs-alert-warning">
 +
We added this setting in WHMCS 8.0.
 +
</div>
 +
 
 +
Check this option to prevent account owners from adding and managing other users. Admins can still invite and manage users at '''Clients > [[Manage Users]]''' and in the '''[[Clients:Users Tab|Users]]''' tab in the client's profile.
 +
 +
This setting does not prevent existing users from logging in to their associated accounts.
  
 
===Allow Client Registration===
 
===Allow Client Registration===
−
When enabled customers can sign up at /registration.php without ordering a product or service.
 
  
−
===Locked Client Profile Fields===
+
If you enable this, customers can sign up at <tt>/registration.php</tt> without ordering a product or service.
−
When ticked your clients will not be able to update this piece of their contact information via the client area, they will need to contact you to update it. They will be able to view the information, but it will appear as text and not an input field.
+
 
 +
===Client Email Preferences===
 +
 
 +
<div class="docs-alert-info">We added this setting in WHMCS 7.10.</div>
 +
 
 +
This setting allows clients to customize which emails they receive.
 +
 
 +
* If you enable this, clients will see checkboxes on the Client Area profile page to choose which emails they receive. This setting defaults to enabled.
 +
* If you disable this option, clients cannot change which emails they receive.
 +
 
 +
This setting will not change the opt-in and opt-out email notification preferences of clients. Regardless of their settings, clients will continue to receive any '''Email Verification''' and '''Password Reset''' emails.
 +
 
 +
By default, clients and users are configured to receive all email notification types. The groups of email notifications match the groups at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Email Templates]]''' or, prior to WHMCS 8.0, '''Setup > Email Templates'''.
 +
 
 +
===Optional Client Profile Fields===
 +
 
 +
The checkboxes ticked here will be optional on the registration and order forms. For example ticking the ''Phone Number'' field will mean clients can complete the order process without providing a phone number.
 +
Certain modules, particularly domain registrars, may require all the client profile information to function.
 +
 
 +
===Locked Client/User Profile Fields===
 +
 
 +
If you check this, clients and users will not be able to update this part of their contact information via the Client Area. They will need to contact you to update it.  
 +
 
 +
They will be able to view the information, but it will appear as text and not as an input field.
 +
 
 +
<div class="docs-alert-warning">
 +
Prior to WHMCS 8.0, this was the '''Locked Client Profile Fields''' setting.
 +
</div>
 +
 
 +
===Client Details Change Notify===
 +
 
 +
Enabling this option will send an email notification to all admins when a customer changes their contact details.
 +
 
 +
===Marketing Opt-out===
 +
 
 +
When this option is enabled, clients will see an option to opt-out of marketing emails on the '''Account Details''' page of the client area.
 +
 
 +
When using [[Mass_Mail#Composing_a_Mass_Mailing|Mass Mail]] or creating an [[Email_Marketer|email marketer]] rule you will see a '''Marketing Email?''' checkbox. Check this checkbox so users who have opted out do not receive this message.
  
 
===Show Cancellation Link===
 
===Show Cancellation Link===
−
Enabling will activate the cancellation system. Customers can request cancellation from the product details page, they then appear in Clients > Cancellation Requests along with an email notification and will be processed automatically when the cron runs. For more information [[Products_Management#Cancelling_a_Product.2FService|refer to this page]].
+
 
 +
Enabling will activate the cancellation system. Customers can request cancellation from the product details page, they then appear in '''Clients > [[Cancellation Requests]]''' along with an email notification and will be processed automatically when the cron runs. For more information, see [[Cancellation Requests]] and [[Products Management]].
  
 
===Monthly Affiliate Reports===
 
===Monthly Affiliate Reports===
 +
 
Sends a monthly report email containing the status of the customer’s affiliate account when active.
 
Sends a monthly report email containing the status of the customer’s affiliate account when active.
  
−
===Client Details Change Notify===
+
===Banned Subdomain Prefixes===
−
Enabling this option will send an email notification to all admins when a customer changes their contact details.
+
 
 +
This setting is used to prevent orders being placed using any of the subdomains listed within the field for products with the [[Products_and_Services#Other|free subdomain option]] enabled. Add new subdomains to block in a comma separated list.
 +
 
 +
For example, the default values will block users from placing orders using a subdomain like <tt>ftp.example.com</tt>.
 +
 
 +
===Encoded File Loading===
 +
 
 +
When loading custom PHP assets like hooks or widgets, WHMCS will perform static analysis on ionCube-encoded files. If the encoded file is either unknown or incompatible with the environment, the file will not load normally. You can disable this feature if you have custom files that you are certain are compatible with your environment but that the analysis considers incompatible.
 +
 
 +
When you enable this, any files that do not load will appear in either the activity log or the hook log.
 +
 
 +
You can override this in the <tt>configuration.php</tt> file by defining the <tt>$enable_safe_include</tt> variable with a value of either <tt>true</tt> (enabled) or <tt>false</tt> (disabled). 
 +
 
 +
For example:<div class="source-cli">$enable_safe_include = false;</div>
 +
 
 +
===Event Handling===
 +
 +
<div class="docs-alert-info">
 +
<span class="title">WHMCS 8.4</span><br />
 +
We added this setting in WHMCS 8.4.
 +
</div>
 +
 +
Events are actions that the system executes in order to complete a provisioning-related request. For example, provisioning a hosting product with WordPress® results in an event that installs WordPress on the server. 
 +
 
 +
Many events can relate to the fulfillment of a single order or automation routine. The '''Event Handling''' setting controls and optimizes how and when WHMCS prepares and executes these events.
 +
 
 +
You can choose from the following options:
 +
 +
* '''Concurrent (Launch an asynchronous request.)''' — Run events as asynchronous requests, concurrent with the process that caused them.
 +
** The setting defaults to this option and most admins should select this.
 +
** When you select this, WHMCS will present the optimal user experience with the lowest wait times for the client.
 +
* '''Inline (Handle events within the same request.)''' — Run all events within the same request as the process that caused them. Use this option for WHMCS installations that use uncommon or constrained CGI environments in which concurrency is not possible.
 +
** Prior to WHMCS 8.3, which introduced the '''Event Handling''' setting, WHMCS used this mode of event preparation and execution.
 +
** When you select Inline '''(Handle events within the same request.)''', clients will still have a positive experience but it may not be as fast as '''Concurrent (Launch an asynchronous request.)'''.
 +
* '''Cron (Defer events until the next cron run.)''' — Defer events to the next time that the cron runs. For more information, see [[Crons]].
 +
** We only recommend this option for specialized environments with unique runtime constraints or highly-customized provisioning and procurement systems.
 +
** When you select this option, clients will have a quick experience but it may delay changes to remote systems.
 +
 
 +
===Display Errors===
 +
If you encounter a blank page or '''Oops!''' error page in WHMCS, make certain that <tt>display_errors</tt> is enabled in the server's PHP configuration and then enable this setting.
 +
 
 +
Use the displayed error when you troubleshoot the problem.
 +
 
 +
For more information, see [[Troubleshooting Guide]] and [[Error Management]].
 +
 
 +
===Log Errors===
 +
When you enable it, this option logs PHP errors to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' ('''Utilities > Logs > Activity Log''' in WHMCS 7.x and earlier) with any errors that may occur in your WHMCS installation. This is a good feature if you do not want to show sensitive path information on public-facing pages.
 +
 
 +
For technical information, refer to [[Error Management]].
 +
 
 +
Enabling this option will result in a number of activity log entries, so should be used sparingly and only when debugging PHP errors. It should then be promptly switched off.
 +
 
 +
===SQL Debug Mode===
 +
 
 +
This option should remain unticked unless specifically instructed to change it by WHMCS support staff. When you enable it, any database-related errors will be recorded in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' ('''Utilities > Logs > Activity Log''' in WHMCS 7.x and earlier).
 +
 
 +
For technical information, refer to [[Error Management]].
 +
 
 +
===Hooks Debug Mode===
 +
 
 +
In order to troubleshoot problems with action hooks, it may be necessary to log action hook activity. Checking this option will do this to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' ('''Utilities > Logs > Activity Log''' in WHMCS 7.x and earlier).
  
−
===Credit on Downgrade===
+
Enabling this option will result in a large number of activity log entries, so should be used sparingly and only when debugging hook problems. It should then be promptly switched off.
−
Clients will receive a credit on their account pro-rated when downgrading their package using the automated downgrade feature, when enabled.
 

Latest revision as of 18:23, 25 October 2022


The Other tab allows you to configure additional WHMCS settings.

You can access this tab at Configuration () > System Settings > General Settings or, prior to WHMCS 8.0, Setup > General Settings.

Marketing Emails

This setting controls the opt-in/opt-out functionality for Marketing e-mails, such as those sent by the mass mail tool. When enabled, a Newsletter Opt-In option displays to new customers during checkout or registration. This option is enabled by default.

Require User Opt-In

Enable this to require clients to explicit opt-in before they will receive marketing labelled e-mails. By default, users are required to opt-in to marketing emails. If you wish, you can use this setting to default the opt-in box to a checked status, requiring users instead to opt-out of marketing emails.

Marketing Email Opt-In Messaging

The message that will be displayed to clients on the client area if Marketing Emails is enabled and they are being asked to opt in. Allows you to customise the message displayed to users in the opt-in request. It is important that the opt-in message accurately reflects the type of marketing emails you will be sending for compliance reasons.

Admin Client Display Format

Choose the format that your customer's names appear in throughout the admin. For example it may be desirable to display the company name instead of the contact's name.

Client Dropdown Format

Choose the format that your customer’s names appear in the client menu throughout the admin.

Disable Full Client Dropdown

We removed this setting in WHMCS 6.2.

Check this option to remove the client menu in order to speed up page loading.

Default to Client Area

Normally when clients and visitors visit your WHMCS installation they are presented with the homepage listing the various pages; client area, submit ticket, view tickets, place order etc. Ticking this option skips this page and takes visitors directly to the client area prompting them to login.

Disable Client Area User Management

We added this setting in WHMCS 8.0.

Check this option to prevent account owners from adding and managing other users. Admins can still invite and manage users at Clients > Manage Users and in the Users tab in the client's profile.

This setting does not prevent existing users from logging in to their associated accounts.

Allow Client Registration

If you enable this, customers can sign up at /registration.php without ordering a product or service.

Client Email Preferences

We added this setting in WHMCS 7.10.

This setting allows clients to customize which emails they receive.

  • If you enable this, clients will see checkboxes on the Client Area profile page to choose which emails they receive. This setting defaults to enabled.
  • If you disable this option, clients cannot change which emails they receive.

This setting will not change the opt-in and opt-out email notification preferences of clients. Regardless of their settings, clients will continue to receive any Email Verification and Password Reset emails.

By default, clients and users are configured to receive all email notification types. The groups of email notifications match the groups at Configuration () > System Settings > Email Templates or, prior to WHMCS 8.0, Setup > Email Templates.

Optional Client Profile Fields

The checkboxes ticked here will be optional on the registration and order forms. For example ticking the Phone Number field will mean clients can complete the order process without providing a phone number. Certain modules, particularly domain registrars, may require all the client profile information to function.

Locked Client/User Profile Fields

If you check this, clients and users will not be able to update this part of their contact information via the Client Area. They will need to contact you to update it.

They will be able to view the information, but it will appear as text and not as an input field.

Prior to WHMCS 8.0, this was the Locked Client Profile Fields setting.

Client Details Change Notify

Enabling this option will send an email notification to all admins when a customer changes their contact details.

Marketing Opt-out

When this option is enabled, clients will see an option to opt-out of marketing emails on the Account Details page of the client area.

When using Mass Mail or creating an email marketer rule you will see a Marketing Email? checkbox. Check this checkbox so users who have opted out do not receive this message.

Show Cancellation Link

Enabling will activate the cancellation system. Customers can request cancellation from the product details page, they then appear in Clients > Cancellation Requests along with an email notification and will be processed automatically when the cron runs. For more information, see Cancellation Requests and Products Management.

Monthly Affiliate Reports

Sends a monthly report email containing the status of the customer’s affiliate account when active.

Banned Subdomain Prefixes

This setting is used to prevent orders being placed using any of the subdomains listed within the field for products with the free subdomain option enabled. Add new subdomains to block in a comma separated list.

For example, the default values will block users from placing orders using a subdomain like ftp.example.com.

Encoded File Loading

When loading custom PHP assets like hooks or widgets, WHMCS will perform static analysis on ionCube-encoded files. If the encoded file is either unknown or incompatible with the environment, the file will not load normally. You can disable this feature if you have custom files that you are certain are compatible with your environment but that the analysis considers incompatible.

When you enable this, any files that do not load will appear in either the activity log or the hook log.

You can override this in the configuration.php file by defining the $enable_safe_include variable with a value of either true (enabled) or false (disabled).

For example:
$enable_safe_include = false;

Event Handling

WHMCS 8.4
We added this setting in WHMCS 8.4.

Events are actions that the system executes in order to complete a provisioning-related request. For example, provisioning a hosting product with WordPress® results in an event that installs WordPress on the server.

Many events can relate to the fulfillment of a single order or automation routine. The Event Handling setting controls and optimizes how and when WHMCS prepares and executes these events.

You can choose from the following options:

  • Concurrent (Launch an asynchronous request.) — Run events as asynchronous requests, concurrent with the process that caused them.
    • The setting defaults to this option and most admins should select this.
    • When you select this, WHMCS will present the optimal user experience with the lowest wait times for the client.
  • Inline (Handle events within the same request.) — Run all events within the same request as the process that caused them. Use this option for WHMCS installations that use uncommon or constrained CGI environments in which concurrency is not possible.
    • Prior to WHMCS 8.3, which introduced the Event Handling setting, WHMCS used this mode of event preparation and execution.
    • When you select Inline (Handle events within the same request.), clients will still have a positive experience but it may not be as fast as Concurrent (Launch an asynchronous request.).
  • Cron (Defer events until the next cron run.) — Defer events to the next time that the cron runs. For more information, see Crons.
    • We only recommend this option for specialized environments with unique runtime constraints or highly-customized provisioning and procurement systems.
    • When you select this option, clients will have a quick experience but it may delay changes to remote systems.

Display Errors

If you encounter a blank page or Oops! error page in WHMCS, make certain that display_errors is enabled in the server's PHP configuration and then enable this setting.

Use the displayed error when you troubleshoot the problem.

For more information, see Troubleshooting Guide and Error Management.

Log Errors

When you enable it, this option logs PHP errors to Configuration () > System Logs (Utilities > Logs > Activity Log in WHMCS 7.x and earlier) with any errors that may occur in your WHMCS installation. This is a good feature if you do not want to show sensitive path information on public-facing pages.

For technical information, refer to Error Management.

Enabling this option will result in a number of activity log entries, so should be used sparingly and only when debugging PHP errors. It should then be promptly switched off.

SQL Debug Mode

This option should remain unticked unless specifically instructed to change it by WHMCS support staff. When you enable it, any database-related errors will be recorded in Configuration () > System Logs (Utilities > Logs > Activity Log in WHMCS 7.x and earlier).

For technical information, refer to Error Management.

Hooks Debug Mode

In order to troubleshoot problems with action hooks, it may be necessary to log action hook activity. Checking this option will do this to Configuration () > System Logs (Utilities > Logs > Activity Log in WHMCS 7.x and earlier).

Enabling this option will result in a large number of activity log entries, so should be used sparingly and only when debugging hook problems. It should then be promptly switched off.

Retrieved from "http://3.17.75.209/index.php?title=Other_Tab&oldid=33604"