Difference between revisions of "Clients:Profile Tab"

From WHMCS Documentation

(→‎Status Update)
Line 1: Line 1:
 
{{Client Management}}
 
{{Client Management}}
−
 
+
−
The Profile tab is accessed via the '''Clients > View/Search Clients''' page, select a client, then click the tab marked "Profile". It contains fields for changing the client's contact details (name, address, email address etc.) as well as a number of other options affecting the behaviour of their account in WHMCS.
+
The '''Profile''' tab contains fields for changing the account's contact details, like their name, address, and email address. It also contains other options that affect the behavior of the account in WHMCS.
−
 
+
−
==Core Options==
+
To access the '''Profile''' tab, go to '''Clients > View/Search Clients''', select a client, and click '''Profile'''.
−
===Name, Address, Email Address===
+
−
 
+
==View Marketing Opt-In Consent History==
−
A number of fields on this page should be self-explanatory, such as Name, Address, Email Address, Phone Number etc.... They display the client's current details. The values can be changed, and upon clicking Save Changes their record will be updated.
+
Click '''View Marketing Opt-In Consent History''' to view the account's consent history.
−
 
+
−
===Password===
+
==Account Information==
−
 
+
This tab includes these basic account information settings:
−
Clicking this link will instantly generate a new client area password for the client and email it to them.
+
−
 
+
===Name and Addresses===
−
Clients can also request a password reset themselves by clicking the the '''Forgotten Password''' link on the login form to begin the reset process:
+
Use these fields to enter basic information for the account:
−
 
+
* '''First Name'''
−
*After entering their email address, if a security question answer is specified they will be prompted to provide the answer, then an email is sent containing a confirmation link to ensure they are actually the one who requested the reset. The reset link is valid for 2 hours from the time of request
+
* '''Last Name'''
−
**If no security question answer is set, the email will be sent immediately upon entering a valid email address.
+
* '''Company Name'''
−
*When they click the link in the email, clients will be taken to the password reset validation page where a new password can be specified. They can then login immediately using the new password. If the client didn't request the reset they are advised to simply ignore the email and not click the link.
+
* '''Email Address'''
−
 
+
* '''Password''' (in WHMCS 7.10 and earlier)
−
==Billing Preferences==
+
* '''Address 1''' and '''Address 2'''
−
 
+
* '''City'''
−
There are a number of billing related settings that can be set on a per client basis. These are set from the Client Profile tab also. The options consist of the following:
+
* '''State/Region'''
−
 
+
* '''Postcode'''
 +
* '''Country'''
 +
* '''Phone Number'''
 +
* '''Language'''
 +
* '''Tax ID'''
 +
 +
===Payment Method===
 +
Select the payment method that the account will default to. This performs an update to all products, services, addons, domains, and unpaid invoices that used the default payment method.
 +
 +
===Billing Contact===
 +
Select the main contact for billing-related items. You can create billing contacts in the [[Clients:Contacts_Tab|Contacts]] tab.
 +
 +
===Currency===
 +
Select the account's default currency. This will change the currency symbol, but '''will not''' automatically convert any prices, invoices, or transactions into the appropriate amount in the new currency.
 +
 +
An account's currency is fixed when placing the first order, and all subsequent orders will use it. As a result, users won't see the currency selector on the order form. We recommend against changing an account's currency after an order has been placed and invoices, services, and transactions have been generated.
 +
 +
===Status===
 +
Instead of deleting a user, you can change the user's status for record-keeping purposes.
 +
 +
When you set an account's status, you can choose these options:
 +
 +
*'''Active''' — The account can log in and has active or suspended services.
 +
*'''Inactive''' — The account can log in but has no active services and is removed from client menus.
 +
*'''Closed''' — The account has no active services, cannot log in to the client area, and is removed from client menus.
 +
 +
<div class="docs-alert-warning">
 +
<span class="title">Invoicing and Status</span><br />
 +
The client's status does not stop invoicing if their package's status is still active, suspended, or pending.
 +
</div>
 +
 +
===Client Group===
 +
If [[Client_Groups|client groups]] have been configured in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Client Groups''' (or, prior to WHMCS 8.0, '''Setup > Client Groups'''), use this to assign a group or remove their group assignment.
 +
 +
===Email Notifications===
 +
{{:Client Email Notification Preferences}}
 +
 +
==Settings==
 +
You can set these billing-related settings up on a per-client basis:
 +
 
===Late Fees===
 
===Late Fees===
−
 
+
Use this to prevent overdue invoices from including late fees.
−
Ticking this box will prevent any late fees being applied to invoices that become overdue for this client
+
* In WHMCS 8.0 and later, toggle it to '''Off''' to prevent fees.
−
 
+
* In WHMCS 7.10 and earlier, check '''Late Fees''' to prevent fees.
 +
 
===Overdue Notices===
 
===Overdue Notices===
−
 
+
Use this to disable overdue email notices for certain clients.
−
There are situations where you may want to disable overdue email notices for certain clients. You can do this in WHMCS from the client profile tab by ticking the "Don't Send Overdue Emails" checkbox. The Invoice Payment Reminder prior to the due date will still send, but this will suppress the First, Second & Third Overdue Invoice Notice email messages.
+
* In WHMCS 8.0 and later, toggle this to '''Off''' to disable notices.
−
 
+
* In WHMCS 7.10 and earlier, check '''Overdue Notices''' to disable notices.
 +
 +
The Invoice Payment Reminder prior to the due date will still send, but this will suppress the First, Second, and Third Overdue Invoice Notice email messages.
 +
 
===Tax Exempt===
 
===Tax Exempt===
−
 
+
Toggle this to '''On''' to prevent tax rules from being applied to the account's invoices.
−
Ticking this box will stop any tax rules from being applied to invoices generated for this client
+
−
 
 
 
===Separate Invoices===
 
===Separate Invoices===
−
 
+
Toggle this to '''On''' to prevent items due on the same date and via the same payment method from being grouped together into a single invoice. Use this, for example, with resellers who don't always want to renew every product they have.
−
Enabling this option will mean that items due on the same date and via the same payment method will not be automatically grouped together into a single invoice as would normally happen. You might use this for example with resellers where they won't always want to renew every product they have.
+
−
 
 
 
===Disable CC Processing===
 
===Disable CC Processing===
−
 
+
Toggle this to '''On''' to prevent invoices that are due via a merchant gateway from being automatically attempted for capture. This effectively requires that the account logs in and makes payment manually for all invoices, even if there's a credit card on file.
−
Enabling this option will prevent invoices for this client due via a merchant gateway from being automatically attempted for capture - leaving the client to login and make payment manually for all invoices even with a credit card stored on file
 
−
 
 
−
===Payment Method===
 
−
 
 
−
This option can be used to perform a client wide update to all products/services, addons, domains & unpaid invoices of the default payment method that they are set to both now and in the future.
 
−
 
 
−
===Billing Contact===
 
−
 
 
−
A billing contact is used where the name/address an invoice should be sent to differs from the main account and/or the name/address of the card holder that will be paying the invoice is different (if using a merchant gateway). A billing contact is first created via the [[Clients:Contacts_Tab|Contacts tab]], then it can be selected from this dropdown menu.
 
−
 
 
−
===Client Currency===
 
−
A client's currency is fixed when they place their first order, all subsequent orders will use that same currency. As a result clients will not see the currency selector on their order form.
 
−
 
 
−
Once a client has placed an order - and therefore generated invoices, services and transactions - we recommend against changing their currency in the admin area. The currency dropdown on the client's Profile tab will change the currency symbol, it '''will not''' automatically convert any prices, invoices or transactions into the appropriate amount in the new currency.
 
−
 
 
−
===Client Group===
 
−
 
 
−
If [[Client_Groups|client groups]] have been configured on the Setup > Client Groups page, this dropdown menu can be used to assign this client to a group or change/remove their group assignment.
 
−
 
 
−
==Changing a Clients Status==
 
−
Rather than deleting a user you would normally just change the users status for record keeping purposes. To do this, go to the Profile tab of the client you wish to change and then select the status you want in the dropdown box. Then click the Save Changes button to save the new status.
 
−
 
 
−
*Active - Can login and has active or suspended services
 
−
*Inactive - Can login but has no active services currently, removed from client dropdown menus
 
−
*Closed - No active services and cannot login to the client area, removed from client dropdown menus
 
−
 
 
−
Please note: The clients status does not stop invoicing if their packages status is still active, suspended or pending.
 
−
 
 
−
===Status Update===
 
 
   
 
   
−
Any account with no active products, addons, or domains will have their account automatically set to Inactive by the cron job. An active product or addon is defined as being in Active or Suspended state. An active domain is Active or Pending-Transfer. This can also be extended to include clients who have not logged in to the client area for three months.
+
===Marketing Emails Opt-out===
 +
Toggle this to '''On''' to prevent emails sent via the [[Email Campaigns]]] (formerly [[Mass_Mail|mass mail]]) or [[Email Marketer]] tools. Clients can change the status of this field themselves via '''My Details''' in the client area (if it's enabled in [[Other_Tab#Marketing_Opt-out|General Settings]]).
 
   
 
   
−
The Inactive status does not stop the user from logging in, opening a ticket, or paying any due invoices.
+
===Status Update===
 +
Any client account with no active products, addons, or domains will have their account automatically set to '''Inactive''' by the cron job. This does not stop the user from logging in, opening a ticket, or paying any due invoices.
 +
* This can be further extended to include clients who have not logged in to the client area for three months. You can disable it entirely via '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.
 +
* An active product or addon is defined as being in the '''Active''' or '''Suspended''' state. An active domain is '''Active''' or '''Pending-Transfer'''.
 +
* If the client purchases a product domain or addon, their status will automatically be set to '''Active''' again.
 
   
 
   
−
If an account purchases a product domain or addon, their status is automatically set to Active again the next time the cron job runs. The '''Status Update''' toggle can prevent the account's status from being changed automatically, causing it to remain at the current value. Set the toggle to '''On''' to allow automatic updates to the account's status, or set it to '''Off''' to disable automatic status updates.
+
In WHMCS 8.0 and later, toggle this to '''Off''' to disable status updates. In WHMCS 7.10 and earlier, check '''Status Update''' to disable status updates.
 
   
 
   
−
You can disable this entirely via '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.
 
−
 
−
==Misc. Options==
 
−
 
−
===Marketing Emails Opt-out===
 
−
 
−
When ticked this means clients will not receive emails sent via the [[Mass_Mail|mass mail]] or [[Email_Marketer|email marketer]] tools. Clients can change the status of this field themselves via the My Details page of the client area (if enabled in [[Other_Tab#Marketing_Opt-out|general settings]]).
 
−
 
−
===Two-Factor Authentication===
 
−
If a client has configured two factor authentication for their account then the greyed-out checkbox on the Profile tab will become ticked. Thus indicating whether two factor is configured for that client's account. Should the client claim to have forgotten/lost their two factor device - then after verifying their identify - a member of staff can untick this checkbox, thereby allowing the client to login without completing two factor auth.
 
−
 
 
===Allow Single Sign-On===
 
===Allow Single Sign-On===
−
When ticked, this client will be able to authentication into WHMCS from an external resource perform Single Sign On into WHMCS. For example ticking this option will prevent a client from logging into WHMCS using the [[WHMCS_OpenID_and_cPanel_Setup_Guide|cPanel OpenID integration]].
+
Toggle this to '''On''' to allow authentication into WHMCS from an external resource (Single Sign On into WHMCS). For example, disabling this would prevent a client from logging in to WHMCS using the [[WHMCS_OpenID_and_cPanel_Setup_Guide|cPanel OpenID integration]].
−
 
+
−
===Email Notifications===
 
−
 
 
−
{{:Client Email Notification Preferences}}
 
−
 
 
 
===Custom Client Fields===
 
===Custom Client Fields===
−
 
 
If any [[Custom_Fields|custom client fields]] have been configured, they will appear towards the bottom of the client's Profile tab. This allows staff to see the values clients have entered or change them directly.
 
If any [[Custom_Fields|custom client fields]] have been configured, they will appear towards the bottom of the client's Profile tab. This allows staff to see the values clients have entered or change them directly.
−
 
+
 
===Admin Notes===
 
===Admin Notes===
−
 
+
Enter private notes about the client, which will display whenever someone views this Summary tab. Separate notes sections are available available under the '''Products/Services''', '''Domains''', and '''Notes''' tabs.
−
Here staff can enter private notes about the client to be displayed to whoever views this Summary tab. Separate notes sections are available available under the Products/Services , Domains and Notes tab.
 

Revision as of 18:08, 27 August 2020

Client Management
Summary Tab | Profile Tab | Users Tab | Contacts Tab | Products/Services Tab | Domains Tab
Billable Items Tab | Invoices Tab | Quotes Tab | Transactions Tab | Tickets Tab | Emails Tab | Notes Tab | Log Tab |


The Profile tab contains fields for changing the account's contact details, like their name, address, and email address. It also contains other options that affect the behavior of the account in WHMCS.

To access the Profile tab, go to Clients > View/Search Clients, select a client, and click Profile.

View Marketing Opt-In Consent History

Click View Marketing Opt-In Consent History to view the account's consent history.

Account Information

This tab includes these basic account information settings:

Name and Addresses

Use these fields to enter basic information for the account:

  • First Name
  • Last Name
  • Company Name
  • Email Address
  • Password (in WHMCS 7.10 and earlier)
  • Address 1 and Address 2
  • City
  • State/Region
  • Postcode
  • Country
  • Phone Number
  • Language
  • Tax ID

Payment Method

Select the payment method that the account will default to. This performs an update to all products, services, addons, domains, and unpaid invoices that used the default payment method.

Billing Contact

Select the main contact for billing-related items. You can create billing contacts in the Contacts tab.

Currency

Select the account's default currency. This will change the currency symbol, but will not automatically convert any prices, invoices, or transactions into the appropriate amount in the new currency.

An account's currency is fixed when placing the first order, and all subsequent orders will use it. As a result, users won't see the currency selector on the order form. We recommend against changing an account's currency after an order has been placed and invoices, services, and transactions have been generated.

Status

Instead of deleting a user, you can change the user's status for record-keeping purposes.

When you set an account's status, you can choose these options:

  • Active — The account can log in and has active or suspended services.
  • Inactive — The account can log in but has no active services and is removed from client menus.
  • Closed — The account has no active services, cannot log in to the client area, and is removed from client menus.

Invoicing and Status
The client's status does not stop invoicing if their package's status is still active, suspended, or pending.

Client Group

If client groups have been configured in Configuration () > System Settings > Client Groups (or, prior to WHMCS 8.0, Setup > Client Groups), use this to assign a group or remove their group assignment.

Email Notifications


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.

Settings

You can set these billing-related settings up on a per-client basis:

Late Fees

Use this to prevent overdue invoices from including late fees.

  • In WHMCS 8.0 and later, toggle it to Off to prevent fees.
  • In WHMCS 7.10 and earlier, check Late Fees to prevent fees.

Overdue Notices

Use this to disable overdue email notices for certain clients.

  • In WHMCS 8.0 and later, toggle this to Off to disable notices.
  • In WHMCS 7.10 and earlier, check Overdue Notices to disable notices.

The Invoice Payment Reminder prior to the due date will still send, but this will suppress the First, Second, and Third Overdue Invoice Notice email messages.

Tax Exempt

Toggle this to On to prevent tax rules from being applied to the account's invoices.

Separate Invoices

Toggle this to On to prevent items due on the same date and via the same payment method from being grouped together into a single invoice. Use this, for example, with resellers who don't always want to renew every product they have.

Disable CC Processing

Toggle this to On to prevent invoices that are due via a merchant gateway from being automatically attempted for capture. This effectively requires that the account logs in and makes payment manually for all invoices, even if there's a credit card on file.

Marketing Emails Opt-out

Toggle this to On to prevent emails sent via the Email Campaigns] (formerly mass mail) or Email Marketer tools. Clients can change the status of this field themselves via My Details in the client area (if it's enabled in General Settings).

Status Update

Any client account with no active products, addons, or domains will have their account automatically set to Inactive by the cron job. This does not stop the user from logging in, opening a ticket, or paying any due invoices.

  • This can be further extended to include clients who have not logged in to the client area for three months. You can disable it entirely via Configuration () > System Settings > Automation Settings or, prior to WHMCS 8.0, Setup > Automation Settings.
  • An active product or addon is defined as being in the Active or Suspended state. An active domain is Active or Pending-Transfer.
  • If the client purchases a product domain or addon, their status will automatically be set to Active again.

In WHMCS 8.0 and later, toggle this to Off to disable status updates. In WHMCS 7.10 and earlier, check Status Update to disable status updates.

Allow Single Sign-On

Toggle this to On to allow authentication into WHMCS from an external resource (Single Sign On into WHMCS). For example, disabling this would prevent a client from logging in to WHMCS using the cPanel OpenID integration.

Custom Client Fields

If any custom client fields have been configured, they will appear towards the bottom of the client's Profile tab. This allows staff to see the values clients have entered or change them directly.

Admin Notes

Enter private notes about the client, which will display whenever someone views this Summary tab. Separate notes sections are available available under the Products/Services, Domains, and Notes tabs.

Retrieved from "http://3.17.75.209/index.php?title=Clients:Profile_Tab&oldid=29256"