Difference between revisions of "WHMCS for Windows"

From WHMCS Documentation
Line 61: Line 61:
 
   
 
   
 
==Common Problems==
 
==Common Problems==
−
 
−
The common error responses from the API can be found at [[API:Responses|API Responses]]
 
 
   
 
   
 
===Can't gain access as I forgot the passcode===
 
===Can't gain access as I forgot the passcode===

Revision as of 21:00, 14 October 2021

Discontinued
Effective Tuesday January 10th, 2017 the WHMCS for Windows app has been removed form the Windows Marketplace. As a result the app can no longer be downloaded or purchased. This page remains for reference purposes.

Acceptable Password Characters
The following characters should not be used in an administrator password & " ' < > (ampersand, double quotes, single quotes, less than or greater than). Any other symbols such as # ! £ $ % ^ * ( ) . , / etc… are perfectly acceptable.

WHMCS for Windows is the official WHMCS App for Windows platforms. Available for $2.99 a month, a license will allow all your staff to use WHMCS for Windows in conjunction with your WHMCS installation on any of their compatible Windows devices (the same licensing scheme as with all our mobile editions). With the WHMCS for Windows app, admins can view and accept orders, reply to tickets, and keep a pulse on daily, monthly, and yearly sales to date.

Setup Instructions

  1. You need to ensure you have a valid WHMCS for Windows license for your WHMCS installation.
  2. Once you've ordered and paid, the addon will be instantly activated and you'll just need to perform a local key update by going to Help > License Information > Force License Update inside your WHMCS installation to have it take effect.
  3. Download WHMCS for Windows from the Windows Store
  4. Site Setup
    Locate and open WHMCS for Windows on your device.
  5. When launching the app for the first time, you will be prompted that no WHMCS installation has been added. Select the (+) at the bottom of the screen to add your WHMCS installation.
  6. Enter the desired site name. This is purely for your own reference within the app.
  7. Enter your admin login credentials. This is the same username and password you use to log in to the Admin panel.
  8. Enter the WHMCS installation URL. If installed @ "http://www.yourdomain.com/whmcs/" then the URL setting would be "http://www.yourdomain.com/whmcs/". Please note: Your Admin account role needs to have API Access permission.
  9. Site Confirmation
    Enter the API Access Key into the app that was configured in the WHMCS admin area configuration.
  10. Press save. If all the details entered are correct you will be prompted that your site has been saved. If any issues are found, you will be informed by an error popup and asked to fix them.
  11. You will be returned to the main menu with your new site name listed. Select the site name you wish to load and you will be taken to the main page for this site.

Setting up a Passcode

  1. Main Menu
    From the main menu of the app (the site list as soon as the app is opened), select the 3 dot icon on the bottom right of the screen to bring up the menu.
  2. Select "edit passcode".
  3. Set Passcode
    You will be prompted to "enter a new passcode to change it". This screen will be shown when either adding a new passcode or changing an existing passcode.
  4. Enter the desired 4 digit passcode by selecting the desired numbers on the pop up keyboard. Tip: Don't see the keyboard? Touch on the "1234" section to show the keyboard.
  5. You will be prompted to verify this passcode. Enter it a second time to ensure it was entered correctly.

Every time the app is now opened, you will be prompted to enter the passcode before you can continue.

Deleting a Passcode

  1. From the main menu of the app, enter the existing passcode to unlock the app if a passcode has been configured, then select the 3 dot icon on the bottom right of the screen to bring up the menu.
  2. Deactivate Passcode
    Click "edit passcode".
  3. You will be prompted to "enter a new passcode to change it". Don't enter a new passcode here, simply hit the trash can icon at the bottom of the screen to remove the existing passcode.

Navigating the App

The main hub for your site is split in to 3 sections. Site stats and functions and the bottom menu.

Site stats is primarily a snapshot of activity on your site. Any highlighted font (using your current device accent colour) is a clickable item and will take you directly to the appropriate section of the app. For example, selecting the number under Open Tickets will navigate to the Ticket Menu of the app, allowing you to look at tickets that are awaiting reply, other active tickets, and browse tickets by support department.

Sliding across to the Functions section, these are secondary areas of your app, including:

  • Online admins - displays which admins are online in your installation of WHMCS
  • Domain lookup - domain lookup tool
  • Announcements - Displays current announcements, allowing you to edit and publish new announcements, as well as delete them
  • Activity log - displays all admin activity within your installation of WHMCS
  • To-do items - allows you to view your configured to-do items. Please note that to-do items must be configured in the admin area of WHMCS.

The bottom menu gives you access to the major areas of the app. Clicking the 3 dots down the bottom right will give a text description for what each button does. The main areas are Clients, Support & Billing.

  • The icon with a person in it leads to the Clients menu. From the Clients menu, an admin can add a new client, search clients, and view the details of a specific client. These details include viewing the client's products, domains, invoices, and contacts, and creating invoices, tickets, and contacts on behalf of the client. Admins can also assign credits to the client or send an email to the client using this view.
  • The icon with the chat bubble leads to the Ticket menu, which allows admins to view, edit, and reply to tickets.
  • The icon with the gift box allows admins to view, accept, and edit orders, as well as view, edit, and add payments to invoices.

Common Problems

Can't gain access as I forgot the passcode

The passcode system is designed to lock you out of the application unless you enter the present passcode. If you have forgotten your passcode you must delete WHMCS for Windows from your device and reinstall from the Windows store. No data is stored locally on your device so removing the app from your device will not result in any data loss in your WHMCS installation.

Invalid credentials

This error will show when attempting to add your WHMCS installation to the app. Ensure you are using the correct username and password you use to log in to the Admin panel, the correct Installation URL as listed in the Setup Instructions and have followed the instructions to set up your API Access key. If you continue to get this error, please contact support.

License required

If you have purchased a license for the site and are still receiving a License Required error message when trying to access any of the major features of the app, you may need to refresh the license within the app or from within the admin area of WHMCS.

First, make sure your license to the Windows for WHMCS app is licensed in WHMCS by performing a local key update by going to Help > Licence Information inside your WHMCS installation and clicking Force Licence Update. Next, open the app, load the desired site and from the main menu of the site click the 3 dots down the bottom right to open the menu and click Refresh Admin Details/License. Once this has loaded, close the app and reopen in and then try to access your site again.

If the problem persists, please ensure you have an active WHMCS for Windows license for the specific site you are trying to access. If you are still unable to access your site, please contact support.

Retrieved from "http://3.17.75.209/index.php?title=WHMCS_for_Windows&oldid=30911"