Official Documentation Wiki

Everything you need to know about installing and using The Appointment Machine SaaS

How The Appointment Machine SaaS Works

You, the administrator

You are the license holder of The Appointment Machine SaaS, which runs in a web server environment. You provide an “Appointment Manager” service to your clients. You are thus the administrator and will access the administration panel of the system. You can set up more than one administrator user account and assign access roles for each administrator user. The administrator panel (based on the access roles created) has full access to each profile (client) account and can action each feature on behalf of the profile account.

Your Client, the service provider

Your client is the service provider to their customers. They log into their control and manage their appointments from the client control panel. Each client holds one profile account. Each profile account can have multiple users. Each profile account can have multiple calendars. Each calendar can have multiple appointments, its own calendar configuration and its own notification message configurations. Each profile account can have multiple SMS gateway provider configurations.

To sum it up

So - you provide an appointment manager service to your clients. Your clients use this appointment manager service to serve their customers.


Credits

The Appointment Machine SaaS makes partially or in a whole, use of:


Post Installation - Take Note Of:

  • Both control panels can be accessed at [yourdomain.com]
  • Setting up your CRON jobs on your hosting / server side is crucial in successfully utilizing The Appointment Machine SaaS - including getting status updates for SMS messages sent
  • In order to receive inbound SMS messages, you have to set the inbound sms hook URL at your SMS gateway provider's section (Such as Twilio or Nexmo) to [your-domain.com]/inboundsms using the GET method
  • If it seems that your CSS assets / UI design is missing, your ASSETS_URL set in the .env file might be incorrect. If you are sure that the correct value is present, the issue might be with whether you have a www. is present or perhaps absent from the URL entered in your browser's address bar.

    Remember that each of the following domains are "different" when it comes to displaying your assets files correctly:
    http://yourdomain.com/
    https://yourdomain.com/
    http://www.yourdomain.com/
    https://www.yourdomain.com/

Installation

Overview

The easiest and recommended way of installing The Appointment Machine SaaS, is to launch it on Amazon AWS Beanstalk. However - the choice of server environment is yours. The installation method described below would stay the same. I'm first covering the straight-forward installation method, assuming that your server environment is configured, up and running. However, for a step-by-step tutorial on launching The Appointment Machine SaaS on Amazon AWS Beanstalk - scroll down. At the time of writing this article - Amazon AWS provides a "AWS Free Tier" which allows you to run The Appointment Machine SaaS free of charge* for X amount of time, within limitations set by Amazon AWS.


Server Requirements

Below is a list of server requirements - however, if you are hosting The Appointment Machine SaaS in the cloud on an instance such as Amazon AWS Beanstalk or in a server environment such as Homestead, then there is no need to manually install any software package on your server.

Server Requirements

  • PHP >= 5.6.4
  • OpenSSL PHP Extension
  • PDO PHP Extension
  • Mbstring PHP Extension
  • Tokenizer PHP Extension
  • XML PHP Extension
  • Composer

Installation: Summarised

If you're not into lenghy documentation and you want to get straight to the point; Then this is what you need to do to set up The Appointment Machine on your own server. If you are making use of Amazon AWS Beanstalk, then you can skip this section.

  1. Copy the CONTENTS of the source files to your web server's root directory
  2. Update the .env file with your own settings
  3. Ensure that your hosting / web server settings points to public the directory inside the copied source files
  4. Fire up your favorite command console, cd to the source root, and run the comment composer install
  5. Run the command php artisan migrate - this will create the application's database table. If you receive an error here, then it most likely says that your database connection settings set inside the .env file is wrong
  6. Run the command php artisan db:seed - this will add the default database data to the database
  7. Set your one cronjob * * * * * root /usr/bin/php /var/www/html/artisan schedule:run >> /dev/null 2>&1
    The exact path depends on your server setup
  8. Set your SMS Gateway Provider's web hook for inbound SMS messages to send data to [yourdomain.com]/inboundsms using the GET method
  9. Fire up your favorite web browser, and access The Appointment Machine SaaS from your application's domain name
  10. Log in with the username admin@localhost.com and the password admin
  11. Navigate to System Settings, replace the default values - and you are done. Oh - don't forget to change the administrator username and password from the My Account panel

a Bit of Random Advice

This advice has got nothing to do with The Appointment Machine SaaS; Configuring your server is out of the scope of this article and instructions on setting up a local or development environment - as well - but here are some tips which may save you some sleepless nights configuring your server (in general).

Laragon

  • Laragon is similar to WAMP or XAMPP and eliminates the need waste countless of precious hours, days or weeks (or job) to configure Homestart / Vagrant on Windows 8 or 10. It ships with PHPMyAdmin and it works with Reddis.
  • No more need to update your hosts file and Apache configuration when creating a new project. Simply create a directory within the Laragon web directory (default it is www - restart the services from the Laragon control panel, and walla! Open your favorite web browser, enter the name of the newly created directory, add .dev as TLD, and you're all set. Magic.

Windows 8/10 with Homestead for local environments

  • First of all - good luck. (Mac runs Homestead with a breeze) But just a word of advice, when editing any *.yaml file - the intending "spaces" result your application(s) to crash - or work. So be sure to maintain the PSR standard.
  • Touch base and get to know Vagrant commands
  • In the homestead.yaml file you will notice folders: map: C:/Users/[user]/[Code] - this is the directory on your local machine where your project files will be located at. What you do here, is exactly what will be in the vagrant box (see below)
  • In the homestead.yaml file you will notice folders: to: /home/vagrant/[Code] - this is the directory on the Vagrant box. Don't try to find this directory structure on your Windows or Mac - because you wont. You will die trying.
  • Make sure that keys: maps to the absolute path/[your_file] on your local machine. On Windows you first have to generate a key if it does not exist - I'm not getting into that here, but generating a key with PuttyGen would be a good start.

Setting up a Linux Server

  • Here is a nice tutorial for setting up a linux web server

The Configuration File

The .env file, located in the root of the source, is the file that contains almost all the custom configurable settings for running The Appointment Machine SaaS. This is where you will set your application domain, email server settings and so forth. Replace the configuration settings in the .env file with your own settings. For your convenience, we're working on a .env settings generator which will be available soon.

a Couple of things you should take note of:

  • All of the configuration files are stored in the /config directory.
  • It is recommended that you do not change any of the settings in the config files, but rather add your own configuration settings in the .env file
  • It is not necessary to run any command from a terminal, but if you would want to do so, open up your favorite terminal and change the directory to the source's root. As an example, if you are running the application on a linux box and having direct access to the linux box, you can simply open the terminal window to run commands from the terminal. If you are making use of Amazon AWS or a dedicated or shared hosting environment, you would probably want to SSH into your server and run commands via SSH.

APP_ENV=production
APP_KEY=base64:yronJEmGBUV4/1V0T5BDRum60mTX0rc6ymFDrlXkZJw=   #IF you want to change this, you can issue the command php artisan key:gen
APP_DEBUG=true
APP_LOG_LEVEL=debug
APP_URL=http://your-domain.com #replace this with your domain name or IP address
ASSETS_URL=http://your-domain.com #replace this with your domain name or IP address unless you are hosting your asset files in the cloud - then enter hte cloud address here
APPLICATION_NAME="The Appointment Machine SaaS" # change this to the name of your application
TIMEZONE=Africa/Johannesburg #find your correct timezone at http://php.net/manual/en/timezones.php
FILESYSTEM=local # change this to s3 IF you are making use of Amazon AWS as a cloud storage provider
COOKIE=tam_session
SESSION_DOMAIN=null

SHOULDQUEUE=0 #set this value to 1 if you DO want to make use of a queue system

DB_CONNECTION=mysql
DB_HOST=your-database-host
DB_PORT=3306
DB_DATABASE=your-database-name
DB_USERNAME=your-database-username
DB_PASSWORD=your-database-password

BROADCAST_DRIVER=log
CACHE_DRIVER=file
SESSION_DRIVER=file
QUEUE_DRIVER=database

# uncomment this section if you are making use of an email service such as mailgun
#MAIL_DRIVER=mailgun
#MAILGUN_DOMAIN=null
#MAILGUN_API_KEY=null

#comment this section IF you are making use of an email service such as mailgun
MAIL_DRIVER=smtp
MAIL_HOST=your-smtp-host
MAIL_PORT=587 #your smtp port
MAIL_USERNAME=your-smtp-email-username
MAIL_PASSWORD=your-smtp-email-password
MAIL_ENCRYPTION=null #set this value to TLS if you are sending email via SSL

MAIL_FROM_ADDRESS=null #set this value to the address from where you are sending the mail, This must usually be the same as the MAIL_USERNAME
MAIL_FROM_NAME="The Appointment Machine"

PUSHER_APP_ID=
PUSHER_KEY=
PUSHER_SECRET=

#IF you want to make use of AWS S3 - complete this section with your own credentials and set the FILESYSTEM value above to s3
AWS_KEY=null
AWS_SECRET=null
AWS_REGION=us-east-1
AWS_BUCKET=null

SQS_PREFIX=null
SQS_QUEUE_NAME=null


Installation In Your Own Server Environment

Skip this section if you're installing The Appointment Machine SaaS on Amazon AWS Beanstalk

This is *all* that you need to do:

  1. Extract the contents of the zip folder to your server's document root. The exact directory depends on your server environment and is out of the scope of this article. However, in a Linux based server environment, the document root to the world wide web is usually the /var/www or /var/www/htmldirectory.
  2. Configure your application's document / web root to the /public directory of The Appointment Machine SaaS. (If you're running Apache as web server, you should set this in the apache configuration)
  3. Open up your favorite command prompt / terminal and change the directory to the root of the source
  4. Run the command composer install and have a cup of coffee while The Appointment Machine SaaS completes the installation. Perhaps even just a half a cup of coffee. Maybe just a sip.
  5. Run the command php artisan migrate - this will create the application's database table. If you receive an error here, then it most likely says that your database connection settings set inside the .env file is wrong
  6. Once the installation is complete, run the command php artisan db:seed - if you get any errors here, it probably means that your database information in the .env is wrong
  7. Schedule a single cron job (help: contab -e) for the application to run every minute
    * * * * * php /path/to/the/application/root/directory/artisan schedule:run >> /dev/null 2>&1
    As an example:
    * * * * * root /usr/bin/php /var/www/html/artisan schedule:run >> /dev/null 2>&1
  8. Set your SMS Gateway Provider's web hook for inbound SMS messages to send data to [yourdomain.com]/inboundsms using the GET method
  9. Open up your favorite web browser and point it to the The Appointment Machine SaaS application server`s IP or hostname. If you get an error similar to No supported encrypter found. The cipher and / or key length are invalid., simply issue the command (in your command terminal) php artisan key:generate - however, you should not receive any such error since composer automatically generates your application key when installing the application.
  10. Log in with the username admin@localhost.com and the password admin
  11. Navigate to System Settings, replace the default values - and you are done. Oh - don't forget to change the administrator username and password from the My Account panel

Installation in Amazon AWS Beanstalk

Hosting The Appointment Machine SaaS in the cloud on Amazon Beanstalk is straight forward. Amazon AWS takes care of the server configurations, web security and loads of other things to ensure that your application runs smooth, reliably and fast.

What is Amazon Beanstalk?

If you Google Beanstalk - you will probably get combined results about Beanstalkd. Beanstalkd is a queue handler, and can be installed in the The Appointment Machine SaaS application - which there is no reason for to do so. So just know there is a world's difference between AWS Beanstalk and Beanstalkd. In the scope of this application, Beanstalk has got nothing to do with noun: the stem of a bean plant, proverbially fast-growing and tall either.

Amazon describes their Beanstalk service as such:

"Amazon Web Services (AWS) comprises dozens of services, each of which exposes an area of functionality. While the variety of services offers flexibility for how you want to manage your AWS infrastructure, it can be challenging to figure out which services to use and how to provision them. With Elastic Beanstalk, you can quickly deploy and manage applications in the AWS Cloud without worrying about the infrastructure that runs those applications. AWS Elastic Beanstalk reduces management complexity without restricting choice or control. You simply upload your application, and Elastic Beanstalk automatically handles the details of capacity provisioning, load balancing, scaling, and application health monitoring."

What you need to know:

We are going to set up two environments - which basically translates to two EC2 server instances. One is a server environment and the other one is a worker environment. Now, there are much to say about this - but for the scope of this project, all you need to know is that the server environment is the server which your users access to use The Appointment Machine SaaS. The worker environment is, for the scope of this project, basically the same source as the server environment - except that your worker is doing some back-end computing. As an example; If you send an email from the application, the server environment push the mail to the que. Because the server environment is "concentrating" on serving pages and computing for your users, the worker then comes, takes the job in the queue, and email it. Which is also why it is referred to, as the worker. Regards the worker environment as a headless version of the server environment.

Another major reason why we are making use of a worker - is because of cron jobs. The thing that makes sure that notification emails and sms messages wll be sent when they are supposed to send. If your application gets very busy - you might be making use of auto scaling. Basically, as an example, if 500 users are accessing and using your The Appointment Machine SaaS application at once, the server might get very busy computing and run out of resources. Now to ensure that we can cater for busy times, and if you are using auto scaling, then your cloud platform provider such as AWS, will duplicate (or more) server instances, to cater for the computing load. And when less computing is required, it will remove the extra instances.

Now since "a" server check every minute (as an example) for notification messages to send - when the computing load required, increases and your auto-scaling server instance duplicates (or more), the problem though, is that for every server instance created, each of them will look for messages to send, at the same time. So if for example the The Appointment Machine SaaS application scales up 6 times, all notifications will be sent 6 times.

Which is the reason why we do not tell the server instance(s) to check for notifications to send, but rather the worker. So when the The Appointment Machine SaaS scales up, they wont be checking for messages - instead, the single worker server instance will do just that, and send the messages to be sent - just once, as required.

What YOU have to do

The nice thing about Amazon AWS Beanstalk, is that you don't have to configure your server, at all. You simply create your server and worker environments once, upload the source code, deploy - and everything is just working. I have included easy-to-follow step-by-step screenshots of how to set up an application on Amazon AWS Beanstalk, create the server and worker environments, upload the source code, and deploy. It is very easy - just follow the instructions. Amazon AWS Beanstalk can be configured on many levels, but this is out of the scope of this article. I'm showing you exactly what to do and how easy it is, to launch The Appointment Machine SaaS on Amazon AWS Beanstalk.

Remember:

Remember to set your SMS Gateway Provider's web hook for inbound SMS messages to send data to [yourdomain.com]/inboundsms using the GET method


Amazon AWS: Creating an Account / Signing In
Setting up your application and server environment
Setting up your worker environment
Granting RDS database access to your worker environment
Getting your IP address (for in case you've missed it)
Getting your database details (in case you've forgotten)
Preparing the source files
Uploading and Deploying the The Appointment Machine SaaS source

Running The Appointment Machine SaaS

Admin Control Panel VS Client Control Panel

The admin control panel has the same layout and look as the client control panel - and it has all the functions and features of the client control panel, plust some extra administrator-only features.


System Queues

All emails and all automated SMS messages are all sent to a built-in Queue, before processing. There is nothing to really understand about it, but a short basic English explanation is that a Queue is exactly what it says it is - a queue. It is like ordering a burger at McDonnalds - you would stand in a queue and the first customer in front of the queue - gets served first. The reason why we we make use of queue's is simple; When sending an email or SMS (in the scope of this project), it takes time to connect to the email server or SMS gateway provider, take what is posted, and process the action requested. Sometimes the provider's server may not respond as expected, and your user will receive a timeout message or sometimes it just takes long. So instead of having your user to wait until all the processes are completed - we are rather adding the process to a queue, and the user receives an immediate page load response, while the queue is processed in the back end. There are several queue service providers and we have successfully used the Amazon AWS SQS service with project testing, but for the scope of an "out-of-the-box" working and easy to set-up product, we make use of the built-in database queue service. You have nothing to configure - everything is ready.


Sending System Emails

As you would know at this time - you have to set your own SMTP email gateway service provider in the .env file, located in the root directory of The Appointment Machine SaaS source. Many hosting providers have limitations on how many emails a single account or domain-level account may send. If you're business is expanding, we'd recommend making use of a email sending service such as Amazon SES or similar. This is just to prevent emails bottle-necking or failing.


Inbound SMS

In order to receive and have The Appointment Machine process incoming SMS text messages, you have to set the inbound SMS web hook in your SMS gateway provider's control panel. The web hook URL would be your installation URL /inboundsms using the GET method.

The Admin Control Panel

Logging In

Fire up your favorite internet browser and enter the domain name or IP address of your newly installed The Appointment Machine SaaS. The default interface of non-authenticated users is the log-in panel. The default administration log-in username is admin@localhost.com with the password as admin. You should change this right after your first successful login.

Resetting Your Password

If you or a user has forgotten his or her password, a simple password reset request can be initiated by clicking on the "Did you forget your password" link from the login panel and then following the on-screen directions which will request the user to enter his or her email account, and then upon successful account authentication, email a Password Reset link the email address of the user.

The Dashboard

The Dashboard is the default panel which is presented after a successful user login. The dashboard features real-time graphical and statistical data to give the administrator user a complete summarised insight of system accounts - as well as of end-user profile account data. All charts presents data accumulated during the past 12 months.

If you require more information or data presented in a different way or method, please send a feature request here. Note that not all feature requests can be accumulated - however the promise is that each feature request will be evaluated and essentially we are striving to accommodate all customers and to keep extending and improving the The Appointment Machine SaaS application.


Profile Management: General

The Profile Management section is from where you can simulate each profile account feature and action, such as manage the profile account's users, configure calendars, configure SMS gateways for individual profile accounts, manage profile account customers and schedule appointments - all behalf of the profile account selected.

Viewing Profile Accounts

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile accounts will load

Deleted Profile Accounts

When restoring profile accounts - all users associated to the profile account restored - will be restored as well - thus allowing them to log into the application again. All profile account data prior to the deletion, will be restored as well.

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile accounts will load
  3. Click on the Show deleted profiles button above the profile accounts table
  4. a Tabular list featuring all deleted profile accounts - if any - will load
  5. If you would like to restore a deleted profile account, click on the Restore button in the same row as the name of the deleted profile account.
  6. a Confirmation box will appear - requesting to confirm the selected restore action
  7. Click on the Yes button to restore the deleted profile account

Registering Profile Accounts

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile accounts will load
  3. Click on the Register a new profile button above the profile accounts table
  4. a Modal page will load
  5. Complete the online profile account registration form
  6. Click on the Save button
  7. The newly registered profile user will receive his / her account login details via email

Updating Profile Account Information

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile accounts will load
  3. Click on the Edit button in the same row as the profile account you wish to update
  4. a Modal page will load
  5. Apply the profile account information changes
  6. Click on the Save button

Deleting Profile Accounts

When deleting profile accounts - all users associated with the deleted profile account, will be deleted as well. However, profiles as well as profile users can be restored.

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile accounts will load
  3. Click on the Delete button in the same row as the profile account you wish to delete
  4. a Confirmation box will appear - requesting to confirm the selected delete action
  5. Click on the Yes button to delete the selected profile account

Profile Management: User Management

Viewing Profile User Accounts

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which user accounts you want to access
  4. Scroll down to the Profile Users section
  5. a Tabular list of all profile user accounts is located right below the User Management heading

Deleted Profile User Accounts

When restoring profile user accounts - all data associated to the profile user account will be restored as well - thus allowing the restored profile users to log into the application again and having access to data accumulated prior to the account deletion.

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which user accounts you want to access
  4. Scroll down to the Profile Users section
  5. a Tabular list of all profile user accounts is located right below the User Management heading
  6. Click on the Show deleted user accounts button above the profile user accounts table
  7. a Tabular list featuring all deleted profile user accounts - if any - will load
  8. If you would like to restore a deleted profile user account, click on the Restore button in the same row as the name of the deleted profile user account.
  9. a Confirmation box will appear - requesting to confirm the selected restore action
  10. Click on the Yes button to restore the deleted profile user account

Registering Profile User Accounts

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which user accounts you want to access
  4. Scroll down to the Profile Users section
  5. a Tabular list of all profile user accounts is located right below the User Management heading
  6. Click on the Register a new profile user button above the profile user accounts table
  7. a Modal page will load
  8. Complete the online profile user account registration form
  9. Click on the Save button
  10. The newly registered profile user will receive his / her account login details via email

Updating Profile User Account Information

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which user accounts you want to access
  4. Scroll down to the Profile Users section
  5. a Tabular list of all profile user accounts is located right below the User Management heading
  6. Click on the Edit button in the same row as the name of the profile user account you wish to update
  7. a Modal page will load
  8. Apply the profile user account changes
  9. Click on the Save button

Deleting Profile User Accounts

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which user accounts you want to access
  4. Scroll down to the Profile Users section
  5. a Tabular list of all profile user accounts is located right below the User Management heading
  6. Click on the Delete button in the same row as the name of the profile user account you wish to delete
  7. a Confirmation box will appear - requesting to confirm the selected delete action
  8. Click on the Yes button to delete the selected profile user account

Sending an email message to a profile user

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which user accounts you want to access
  4. Scroll down to the Profile Users section
  5. a Tabular list of all profile user accounts is located right below the User Management heading
  6. Click on the More Options dropdown menu in the same row as the name of the profile user account
  7. Select the Email User option from the dropdown menu
  8. a Page will load from where the email message can be composed
  9. Enter your email subject in the Email Subject field
  10. Type your email message in the Email Message field
  11. Click on the Send button

Sending a SMS text message to a profile user

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which user accounts you want to access
  4. Scroll down to the Profile Users section
  5. a Tabular list of all profile user accounts is located right below the User Management heading
  6. Click on the More Options dropdown menu in the same row as the name of the profile user account
  7. Select the SMS User option from the dropdown menu
  8. a Modal page will load
  9. Select a pre-configured SMS gateway in the Select a SMS gateway to send this text message field to send this text message. The option to choose between pre-configured SMS gateway providers comes in handy when having multiple SMS gateways configured, and you want to send a text message from a specific "from" number, related to the country of the user you are about to text.
  10. Type your text message in the SMS Message field
  11. Click on the Send button
  12. All text messages, except for SMS messages sent when scheduling appointments, re-scheduling appointments and post-dated automated reminder SMS messages - will be sent in real-time.

Profile Management: Customer Management

Viewing Profile Customer Accounts

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which customer accounts you want to access
  4. Scroll down to the Customers section
  5. a Tabular list of all profile customer accounts is located right below the Customer Management heading

Deleted Profile Customer Accounts

When restoring profile customer accounts - all data associated to the profile customer account will be restored as well - thus allowing the restored profile customer to log into the application again and having access to data accumulated prior to the account deletion.

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which customer accounts you want to access
  4. Scroll down to the Customers section
  5. a Tabular list of all profile customer accounts is located right below the Customer Management heading
  6. Click on the Show deleted customer accounts button above the profile customer accounts table
  7. a Tabular list featuring all deleted profile customer accounts - if any - will load
  8. If you would like to restore a deleted profile customer account, click on the Restore button in the same row as the name of the deleted profile customer account.
  9. a Confirmation box will appear - requesting to confirm the selected restore action
  10. Click on the Yes button to restore the deleted profile customer account

Registering Profile Customer Accounts

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which customer accounts you want to access
  4. Scroll down to the Customers section
  5. a Tabular list of all profile customer accounts is located right below the Customer Management heading
  6. Click on the Register a new profile customer button above the profile customer accounts table
  7. a Modal page will load
  8. Complete the online profile customer account registration form
  9. Click on the Save button

Updating Profile Customer Account Information

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which customer accounts you want to access
  4. Scroll down to the Customers section
  5. a Tabular list of all profile customer accounts is located right below the Customer Management heading
  6. Click on the Edit button in the same row as the name of the profile customer account you wish to update
  7. a Modal page will load
  8. Apply the profile customer account changes
  9. Click on the Save button

Deleting Profile Customer Accounts

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which customer accounts you want to access
  4. Scroll down to the Customers section
  5. a Tabular list of all profile customer accounts is located right below the Customer Management heading
  6. Click on the Delete button in the same row as the name of the profile customer account you wish to delete
  7. a Confirmation box will appear - requesting to confirm the selected delete action
  8. Click on the Yes button to delete the selected profile customer account

Sending an email message to a profile customer

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which customer accounts you want to access
  4. Scroll down to the Customers section
  5. a Tabular list of all profile customer accounts is located right below the Customer Management heading
  6. Click on the More Options dropdown menu in the same row as the name of the profile customer account
  7. Select the Email Customer option from the dropdown menu
  8. a Page will load from where the email message can be composed
  9. Enter your email subject in the Email Subject field
  10. Type your email message in the Email Message field
  11. Click on the Send button

Sending a SMS text message to a profile customer

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which customer accounts you want to access
  4. Scroll down to the Customers section
  5. a Tabular list of all profile customer accounts is located right below the Customer Management heading
  6. Click on the More Options dropdown menu in the same row as the name of the profile user account
  7. Select the SMS Customer option from the dropdown menu
  8. a Modal page will load
  9. Select a pre-configured SMS gateway in the Select a SMS gateway to send this text message field to send this text message. The option to choose between pre-configured SMS gateway providers comes in handy when having multiple SMS gateways configured, and you want to send a text message from a specific "from" number, related to the country of the user you are about to text.
  10. Type your text message in the SMS Message field
  11. Click on the Send button
  12. All text messages, except for SMS messages sent when scheduling appointments, re-scheduling appointments and post-dated automated reminder SMS messages - will be sent in real-time.

Profile Management: Calendar / Appointment Management

Viewing Profile Calendars

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which calendars / appointments you want to access
  4. Scroll down to the Calendars section
  5. a List of all profile calendars is located right below the Calendars heading

Registering New Profile Calendars

Note: The Custom Provider Name field is used to send notification messages. As an example, the profile account may be owned by a body corporate, such as The Nail House - yet you can set a Custom Provider Name - so if, for example, "Lisa" works at The Nail House and so does Benna - and each of them have their own calendars set up - the Custom Provider Name for "Lisa" can be Lisa@TheNailHouse and for "Benna" it could perhaps be Benna@TheNailHouse. So - depending on your text message templates set - the notification could be something like Dear Ann! This is a confirmation of your appointment at Benna@TheNailHouse on ....

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which calendars / appointments you want to access
  4. Scroll down to the Calendars section
  5. a List of all profile calendars is located right below the Calendars heading
  6. Click on the Register a New Calendar button
  7. a Modal page will load
  8. Complete the online Calendar Registration form
  9. Click on the Save button

Updating Profile Calendar Information

Note: The Custom Provider Name field is used to send notification messages. As an example, the profile account may be owned by a body corporate, such as The Nail House - yet you can set a Custom Provider Name - so if, for example, "Lisa" works at The Nail House and so does Benna - and each of them have their own calendars set up - the Custom Provider Name for "Lisa" can be Lisa@TheNailHouse and for "Benna" it could perhaps be Benna@TheNailHouse. So - depending on your text message templates set - the notification could be something like Dear Ann! This is a confirmation of your appointment at Benna@TheNailHouse on ....

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which calendars / appointments you want to access
  4. Scroll down to the Calendars section
  5. a List of all profile calendars is located right below the Calendars heading
  6. Click on the Edit button right below the calendar of which information / configuration you want to update
  7. a Modal page will load
  8. Apply the required changes
  9. Click on the Save button

Deleting Profile Calendars

Note: When deleting a profile calendar, ALL data associated with the deleted calendar, such as calendar configuration, calendar appointments, calendar notification instance configurations and calendar snippet configurations will be lost forever.

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which calendars / appointments you want to access
  4. Scroll down to the Calendars section
  5. a List of all profile calendars is located right below the Calendars heading
  6. Click on the Delete button right below the calendar which you want to delete
  7. a Confirmation box will appear - requesting to confirm the selected delete action
  8. Click on the Yes button to delete the selected profile calendar and all calendar data

Viewing Appointments

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which calendars / appointments you want to access
  4. Scroll down to the Calendars section
  5. a List of all profile calendars is located right below the Calendars heading
  6. Click on the View button right below the calendar of which you want to access
  7. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display

Scheduling Appointments

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which calendars / appointments you want to access
  4. Scroll down to the Calendars section
  5. a List of all profile calendars is located right below the Calendars heading
  6. Click on the View button right below the calendar of which you want to access
  7. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  8. Click on the Schedule button in the same row as the available time slot where you want to schedule an appointment
  9. a Modal page will load
  10. Complete the online schedule appointment form as follow:
    • Select a customer from the Customers dropdown menu
    • Select the radiobutton next to the appropriate timeslot:duration
    • Uncheck the checkboxes of the notification methods not to use - and vice versa. Both the email as well as the SMS notification methods are selected by default
    • Check the checkboxes next to the Confirmation message to be sent now options. The first highlighted option is the default confirmation message to send. Any other messages (referred to as Snippets) selected in this section, will be added to the default confirmation message as well as to the selected post-dated reminder notifications (referred to as notification instances).
    • Check the checkboxes next to the Post-dated Notification Messages options. If any snippets other than the default confirmation message (as described in the previous step) were selected - they will be added to each of the Post-dated Notification Messages selected
  11. Click on the Save button
  12. Depending if any notification messages selected and depending on which notification methods selected, the customer will receive an appointment confirmation message shortly after the appointment was scheduled. If any post-dated reminder messages were selected, they will be sent on the date and time scheduled - in the same timezone of your server environment.

Rescheduling Appointments

Appointments can be rescheduled accross different calendars

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which calendars / appointments you want to access
  4. Scroll down to the Calendars section
  5. a List of all profile calendars is located right below the Calendars heading
  6. Click on the View button right below the calendar of which you want to access
  7. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  8. Click on the Reschedule button in the same row as the available time slot where you want to reschedule an appointment
  9. a Modal page will load
  10. Complete the online schedule appointment form as follow:
    • Enter the reference code of the appointment you want to reschedule, in the Appointment Reference field. Retrieving an appointment reference is discussed in detail further down in this document, however as a quick reference, prior to clicking on the Reschedule button - click on the dropdown arrow of the appointment you want to reschedule, and select Appointment Information option from the dropdown menu. All appointment information will display in a modal page - including the Appointment Reference which you can copy from here.
    • Select the radiobutton next to the appropriate timeslot:duration
    • Uncheck the checkboxes of the notification methods not to use - and vice versa. Both the email as well as the SMS notification methods are selected by default
    • Check the checkboxes next to the Confirmation message to be sent now options. The first highlighted option is the default reschedule confirmation message to send. Any other messages (referred to as Snippets) selected in this section, will be added to the default reschedule confirmation message as well as to the selected post-dated reminder notifications (referred to as notification instances).
    • Check the checkboxes next to the Post-dated Notification Messages options. If any snippets other than the default reschedule confirmation message (as described in the previous step) were selected - they will be added to each of the Post-dated Notification Messages selected
  11. Click on the Save button
  12. Depending if any notification messages selected and depending on which notification methods selected, the customer will receive an appointment reschedule confirmation message shortly after the appointment was rescheduled. If any post-dated reminder messages were selected, they will be sent on the date and time scheduled - in the same timezone of your server environment.

The Appointment Options Menu

To make accessing extended appointment information / features easy and on-the-fly, each appointment features a dropdown menu, presenting options associated to the selected appointment. As an example, instead of searching for a customer in the Customer Management section just to get the customer's contact number, you can instead just click on the dropdown menu of an appointment and select the Customer Information option, to access the customer information of the customer associated with the selected appointment.

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which calendars / appointments you want to access
  4. Scroll down to the Calendars section
  5. a List of all profile calendars is located right below the Calendars heading
  6. Click on the View button right below the calendar of which you want to access
  7. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  8. Click on the arrow facing down, located right at the end of the full names of the customer, associated with the appointment of which you want to retrieve extended information and/or features, from.
  9. a Dropdown menu will appear, featuring the following options:
    • Update Appointment Status

      To make managing appointments easy, the status of each appointment can be changed. Several appointment status options are available - such as Billed, Confirmed or Cancelled. a Unique easy-readable color is assigned to each appointment status - so when changing an appointment status, the background color of the appointment slot, when viewing appointments, will change too. This will help to easily distinc appointments from each other - based on the appointment status.

      Note: When updating an appointment's status to Cancelled - the appointment will be removed from the Calendar > Appointments view so that the same timeslot can be used again. Also, when an appointment is cancelled, all post dated notification reminder messages scheduled - will be removed as well - thus ensuring that a customer will receive no further notification messages associated the this cancelled appointment.

    • Appointment Information

      When selecting the Appointment Information option - a modal page will load, presenting you with all the appointment information fields. When rescheduling an appointment and you need to find the appointment reference - then this is the best place to easily retrieve the appointment reference code, as explained before.

    • Customer Information

      When selecting the Customer Information option - a modal page will load, presenting you with all the customer information such as full names, contract numbers and email address. Note that if the mobile contact number of the customer associated to the selected appointment, is wrong - (though unlikely) - an error will be produced here.

    • Notification History

      When selecting the Notification History option - a modal page will load, presenting you with all the notification messages sent, associated with the selected appointment. This also includes notification messages if the appointment was rescheduled before - including rescheduling accross multiple calendars.

    • Email Customer
      • Select the Email Customer option from the dropdown menu
      • a Page will load from where the email message can be composed
      • Enter your email subject in the Email Subject field
      • Type your email message in the Email Message field
      • Click on the Send button
    • SMS Customer
      • Select the SMS Customer option from the dropdown menu
      • a Modal page will load
      • Type your text message in the SMS Message field
      • Click on the Send button
      • The message will be sent via the default profile SMS Gateway configuration. All text messages, except for SMS messages sent when scheduling appointments, re-scheduling appointments and post-dated automated reminder SMS messages - will be sent in real-time.

What are Notification Instances

Notification instances are pre-defined post-dated reminder message templates, which you can select individually, at the time of scheduling or rescheduling an appointment. With each notification instance, you can specify when the message should be sent. As an example, if you want The Appointment Machine SaaS to send a notification reminder to a customer one day prior to the appointment date at 7:15am, you would create a once-off notification instance template, setting the day to send, one day before the appointment date and setting the time to send the notification message, to 7:15am. You can also set the instance to send on the day of the appointment, as well to send after the date of the appointment. The latter option comes in handy for if you want to perform a service satisfaction survey after the service has been rendered. Take note that post-dated messages are sent in the same timezone of your server environment.

Viewing Notification Instances

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which calendars / appointments you want to access
  4. Scroll down to the Calendars section
  5. a List of all profile calendars is located right below the Calendars heading
  6. Click on the View button right below the calendar of which you want to access
  7. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  8. Click on the Notification Instances button at the top of the page
  9. a Tabular list of all existing notification instances will display

Creating Notification Instances

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which calendars / appointments you want to access
  4. Scroll down to the Calendars section
  5. a List of all profile calendars is located right below the Calendars heading
  6. Click on the View button right below the calendar of which you want to access
  7. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  8. Click on the Notification Instances button at the top of the page
  9. a Tabular list of all existing notification instances will display
  10. Click on the Create a new notification instance button
  11. a Modal page will load
  12. Complete the online form
  13. Click on the Save button

Updating Notification Instances

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which calendars / appointments you want to access
  4. Scroll down to the Calendars section
  5. a List of all profile calendars is located right below the Calendars heading
  6. Click on the View button right below the calendar of which you want to access
  7. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  8. Click on the Notification Instances button at the top of the page
  9. a Tabular list of all existing notification instances will display
  10. Click on the Edit button in the same row as the notification instance you wish to edit
  11. a Modal page will load
  12. Apply the required changes
  13. Click on the Save button

Deleting Notification Instances

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which calendars / appointments you want to access
  4. Scroll down to the Calendars section
  5. a List of all profile calendars is located right below the Calendars heading
  6. Click on the View button right below the calendar of which you want to access
  7. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  8. Click on the Notification Instances button at the top of the page
  9. a Tabular list of all existing notification instances will display
  10. Click on the Delete button in the same row as the notification instance you wish to delete
  11. a Confirmation box will appear - requesting to confirm the selected delete action
  12. Click on the Yes button to delete the selected notification instance

What are Notification Snippets

a Notification snippet is a phrase which you can add to reminder or confirmation notifications. As an example, if certain customers has to pay an administration fee, you can say something like, "Remember to bring with $5.00 for administration fees." If selected, this message will then be added to the default notification message as well as to selected post-dated notification messages. Notification phrases can be selected individually at the time of scheduling or re-scheduling an appointment.

Viewing Notification Snippets

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which calendars / appointments you want to access
  4. Scroll down to the Calendars section
  5. a List of all profile calendars is located right below the Calendars heading
  6. Click on the View button right below the calendar of which you want to access
  7. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  8. Click on the Notification Snippets button at the top of the page
  9. a Tabular list of all existing notification snippets will display

Creating Notification Snippets

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which calendars / appointments you want to access
  4. Scroll down to the Calendars section
  5. a List of all profile calendars is located right below the Calendars heading
  6. Click on the View button right below the calendar of which you want to access
  7. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  8. Click on the Notification Snippets button at the top of the page
  9. a Tabular list of all existing notification snippets will display
  10. Click on the Create a new notification snippet button
  11. a Modal page will load
  12. Complete the online form
  13. Click on the Save button

Updating Notification Snippets

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which calendars / appointments you want to access
  4. Scroll down to the Calendars section
  5. a List of all profile calendars is located right below the Calendars heading
  6. Click on the View button right below the calendar of which you want to access
  7. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  8. Click on the Notification Snippets button at the top of the page
  9. a Tabular list of all existing notification snippets will display
  10. Click on the Edit button in the same row as the notification snippet you wish to edit
  11. a Modal page will load
  12. Apply the required changes
  13. Click on the Save button

Deleting Notification Snippets

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which calendars / appointments you want to access
  4. Scroll down to the Calendars section
  5. a List of all profile calendars is located right below the Calendars heading
  6. Click on the View button right below the calendar of which you want to access
  7. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  8. Click on the Notification Snippets button at the top of the page
  9. a Tabular list of all existing notification snippets will display
  10. Click on the Delete button in the same row as the notification snippet you wish to delete
  11. a Confirmation box will appear - requesting to confirm the selected delete action
  12. Click on the Yes button to delete the selected notification snippet

Profile SMS Gateways

Viewing Gateways Configured

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which SMS gateway cnfigurations you want to access
  4. Scroll down to the SMS Gateway Configurations section
  5. a Tabular list featuring all SMS gateway configurations will load

Configuring new SMS gateways

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which SMS gateway cnfigurations you want to access
  4. Scroll down to the SMS Gateway Configurations section
  5. a Tabular list featuring all SMS gateway configurations will load
  6. Click on the Configure a New SMS Gateway button above the SMS gateway configurations table
  7. a Modal page will load
  8. Complete the online SMS gateway configuration form
  9. Click on the Save button

Updating SMS Gateway Configurations

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which SMS gateway cnfigurations you want to access
  4. Scroll down to the SMS Gateway Configurations section
  5. a Tabular list featuring all SMS gateway configurations will load
  6. Click on the Edit button in the same row as the configuration nickname
  7. a Modal page will load
  8. Apply the required changes
  9. Click on the Save button

Deleting SMS Gateway Configurations

  1. Click on the Profile Management link from the main navigation menu
  2. a Tabular list of all profile user accounts will load
  3. Click on the name of the profile of which SMS gateway cnfigurations you want to access
  4. Scroll down to the SMS Gateway Configurations section
  5. a Tabular list featuring all SMS gateway configurations will load
  6. Click on the Delete button in the same row as the SMS gateway configuration you wish to delete
  7. a Confirmation box will appear - requesting to confirm the selected delete action
  8. Click on the Yes button to delete the selected SMS gateway configuration

Emailing Multiple Users

The Email Users feature allow administrator users to email more than one profile user at once. This feature comes in handy when you want to send a single email message to multiple profile users, at once.

  1. Click on the Email Users link from the main navigation menu
  2. Click in the Email To field.
  3. a Dropdown list of all profile users will load
  4. Click on the name of one profile user to add to the recipient list of users to send this email to
  5. Repeat the steps above to add more profile users to the email recipient list
  6. Enter an appropriate email subject in the Email Subject field
  7. Type your email message in the Email Message text area
  8. Click on the Send button

Number Lookup

The Number Lookup feature allows administrator users to perform in-depth contact number information retrieval / validation. This feature can be used not only to validate if a contact number is valid, but, depending on the SMS Gateway Provider configuration which is set as the default gateway, it even shows the network carrier as well as if the number is connected, reachable and more. Some providers return more information, compared to others. As an example, the NEXMO gateway provider returns quite more information in a number validation request, compared to Twilio - though they are both very innovative and reliable gatway providers. The Number Lookup feature is a chargeable service (usually just a few cents) and will be billed to the account of the default SMS gateway provider set. In order to use the Number Lookup feature, at least one valid system SMS Gateway Configuration should be set.

  1. Click on the Number Lookup link from the main navigation menu
  2. Enter a E.164 contact number in the Contact Number field.
  3. Click on the Submit button

Admin User Management

Viewing Administrator User Accounts

  1. Click on the Admin User Management link from the main navigation menu
  2. a Tabular list featuring all administrator user accounts will load

Deleted Administrator User Accounts

When restoring administrator user accounts - all administrator user data prior to the deletion, will be restored as well.

  1. Click on the Admin User Management link from the main navigation menu
  2. a Tabular list featuring all administrator user accounts will load
  3. Click on the Show deleted admin accounts button above the user table
  4. a Tabular list featuring all deleted administrator user accounts - if any - will load
  5. If you would like to restore a deleted administrator account, click on the Restore button in the same row as the name of the deleted administrator user
  6. a Confirmation box will appear - requesting to confirm the selected restore action
  7. Click on the Yes button to restore the deleted administrator user account
  8. Once you have restored the selected administrator user account, the user will be able to log into the administrators panel again

Registering Administrator User Accounts

  1. Click on the Admin User Management link from the main navigation menu
  2. a Tabular list featuring all administrator user accounts will load
  3. Click on the Register a new admin user button above the user table
  4. a Modal page will load
  5. Complete the online administrator user registration form
  6. Click on the Save button
  7. The newly registered administrator user will receive his / her account login details via email

Updating Administrator User Account Information

  1. Click on the Admin User Management link from the main navigation menu
  2. a Tabular list featuring all administrator user accounts will load
  3. Click on the More Options dropdown menu in the same row as the name of the administrator user account you wish to update
  4. Select the Edit User option from the dropdown menu
  5. a Modal page will load
  6. Apply the account information changes
  7. Click on the Save button

Deleting Administrator Users

  1. Click on the Admin User Management link from the main navigation menu
  2. a Tabular list featuring all administrator user accounts will load
  3. Click on the Delete button in the same row as the name of the administrator user account you wish to delete
  4. a Confirmation box will appear - requesting to confirm the selected delete action
  5. Click on the Yes button to delete the selected administrator user account
  6. Once deleted, this administrator user will not be able to log in again, unless the account is restored

Sending an email message to an administrator user

  1. Click on the Admin User Management link from the main navigation menu
  2. a Tabular list featuring all administrator user accounts will load
  3. Click on the More Options dropdown menu in the same row as the name of the administrator user account
  4. Select the Email User option from the dropdown menu
  5. a Page will load from where the email message can be composed
  6. Enter your email subject in the Email Subject field
  7. Type your email message in the Email Message field
  8. Click on the Send button

Sending a SMS text message to an administrator user

  1. Click on the Admin User Management link from the main navigation menu
  2. a Tabular list featuring all administrator user accounts will load
  3. Click on the More Options dropdown menu in the same row as the name of the administrator user account
  4. Select the SMS User option from the dropdown menu
  5. a Modal page will load
  6. Select a pre-configured SMS gateway in the Select a SMS gateway to send this text message field to send this text message. The option to choose between pre-configured SMS gateway providers comes in handy when having multiple SMS gateways configured, and you want to send a text message from a specific "from" number, related to the country of the user you are about to text.
  7. Type your text message in the SMS Message field
  8. Click on the Send button
  9. All text messages, except for SMS messages sent when scheduling appointments, re-scheduling appointments and post-dated automated reminder SMS messages - will be sent in real-time.

Admin Access Roles

Administrator access roles can be configured to allow access to certain areas of the administrator control panel to certain users only. Access privileges can not be assigned per user account, but rather per access role. Administrator users each belong to one access role. By default, the existing Admin access role provides access to all areas of the administrator control panel. Administrator roles can only be deleted if there are no users linked the that administrator role. At least one administrator role is required by the application.

Viewing Administrator Access Roles

  1. Click on the Admin Access Roles link from the main navigation menu
  2. a Tabular list featuring all administrator access roles will load

Registering Administrator Access Roles

  1. Click on the Admin Access Roles link from the main navigation menu
  2. a Tabular list featuring all administrator access roles will load
  3. Click on the Register a new access role button above the access role table
  4. a Modal page will load
  5. Complete the online access role registration form
  6. Click on the Save button
  7. Any administrator access roles with special characters, capital letters and spaces, will be automatically removed to suit the required system standard

Updating Administrator Access Role Titles

  1. Click on the Admin Access Roles link from the main navigation menu
  2. a Tabular list featuring all administrator access roles will load
  3. Click on the Edit button in the same row as the access role title you wish to change
  4. a Modal page will load
  5. Apply the required changes
  6. Click on the Save button
  7. Any administrator access roles with special characters, capital letters and spaces, will be automatically removed to suit the required system standard

Deleting Administrator Access Roles

  1. Click on the Admin Access Roles link from the main navigation menu
  2. a Tabular list featuring all administrator access roles will load
  3. Click on the Delete button in the same row as the access role you wish to delete
  4. a Confirmation box will appear - requesting to confirm the selected delete action
  5. Click on the Yes button to delete the selected administrator access role

Assigning Access Privileges to Administrator User Accounts

  1. Click on the Admin Access Roles link from the main navigation menu
  2. a Tabular list featuring all administrator access roles will load
  3. Click on the Assign Privileges button in the same row as the access role title
  4. a Modal page will load
  5. Select all the checkboxes relative to the sections users related to this role, should have access to, and vice versa
  6. Click on the Save button

System Configuration

You can configure all system settings / information from the System Settings section. Take note that in order to combat spam, most hosting providers have spam policies in place, thus validating that the account email address sending the email, matches the email address in the from context. Thus - it is in your best interest to enter the same email address in the Company Email Address field - of the email address you have used to configure your .env configuration file(s).

Updating The System Settings

  1. Click on the System Settings link from the main navigation menu
  2. Apply the required changes
  3. Click on the Save button

System SMS Gateways

Viewing Gateways Configured

  1. Click on the System SMS Gateways link from the main navigation menu
  2. a Tabular list featuring all SMS gateway configurations will load

Configuring new SMS gateways

  1. Click on the System SMS Gateways link from the main navigation menu
  2. a Tabular list featuring all SMS gateway configurations will load
  3. Click on the Configure a New SMS Gateway button above the SMS gateway configurations table
  4. a Modal page will load
  5. Complete the online SMS gateway configuration form
  6. Click on the Save button

Updating SMS Gateway Configurations

  1. Click on the System SMS Gateways link from the main navigation menu
  2. a Tabular list featuring all SMS gateway configurations will load
  3. Click on the Edit button in the same row as the configuration nickname
  4. a Modal page will load
  5. Apply the required changes
  6. Click on the Save button

Deleting SMS Gateway Configurations

  1. Click on the System SMS Gateways link from the main navigation menu
  2. a Tabular list featuring all SMS gateway configurations will load
  3. Click on the Delete button in the same row as the SMS gateway configuration you wish to delete
  4. a Confirmation box will appear - requesting to confirm the selected delete action
  5. Click on the Yes button to delete the selected SMS gateway configuration

The Client Control Panel

Logging In

Fire up your favorite internet browser, and enter the domain name or IP address of your newly installed The Appointment Machine SaaS. The default interface of non-authenticated users is the log-in panel.

Resetting Your Password

If you or a user has forgotten his or her password, a simple password reset request can be initiated by clicking on the "Did you forget your password" link from the login panel and then following the on-screen directions which will request the user to enter his or her email account, and then upon successful account validation, email a Password Reset link the email address of the user.

The Dashboard

The Dashboard is the default panel which is presented after a successful user login. The dashboard features real-time graphical and statistical data to give the user a complete summarised insight of the associated profile account. All charts presents data accumulated during the past 12 months.


Customer Management

Viewing Customer Accounts

  1. Click on the Customer Management link from the main navigation menu
  2. a Tabular list of all customer accounts is located right below the Customers heading

Deleted Customer Accounts

When restoring customer accounts - all data associated to the customer account will be restored as well - thus allowing the restored customer to log into the application again and having access to data accumulated prior to the account deletion.

  1. Click on the Customer Management link from the main navigation menu
  2. a Tabular list of all customer accounts is located right below the Customers heading
  3. Click on the Show deleted customer accounts button above the customer accounts table
  4. a Tabular list featuring all deleted customer accounts - if any - will load
  5. If you would like to restore a deleted customer account, click on the Restore button in the same row as the name of the deleted customer account.
  6. a Confirmation box will appear - requesting to confirm the selected restore action
  7. Click on the Yes button to restore the deleted customer account

Registering Customer Accounts

  1. Click on the Customer Management link from the main navigation menu
  2. a Tabular list of all customer accounts is located right below the Customers heading
  3. Click on the Register a new customer button above the customer accounts table
  4. a Modal page will load
  5. Complete the online customer account registration form
  6. Click on the Save button

Updating Customer Account Information

  1. Click on the Customer Management link from the main navigation menu
  2. a Tabular list of all customer accounts is located right below the Customers heading
  3. Click on the Edit button in the same row as the name of the customer account you wish to update
  4. a Modal page will load
  5. Apply the customer account changes
  6. Click on the Save button

Deleting Customer Accounts

  1. Click on the Customer Management link from the main navigation menu
  2. a Tabular list of all customer accounts is located right below the Customers heading
  3. Click on the Delete button in the same row as the name of the customer account you wish to delete
  4. a Confirmation box will appear - requesting to confirm the selected delete action
  5. Click on the Yes button to delete the selected customer account

Sending an email message to a customer

  1. Click on the Customer Management link from the main navigation menu
  2. a Tabular list of all customer accounts is located right below the Customers heading
  3. Click on the More Options dropdown menu in the same row as the name of the customer account
  4. Select the Email Customer option from the dropdown menu
  5. a Page will load from where the email message can be composed
  6. Enter your email subject in the Email Subject field
  7. Type your email message in the Email Message field
  8. Click on the Send button

Sending a SMS text message to a customer

  1. Click on the Customer Management link from the main navigation menu
  2. a Tabular list of all customer accounts is located right below the Customers heading
  3. Click on the More Options dropdown menu in the same row as the name of the user account
  4. Select the SMS Customer option from the dropdown menu
  5. a Modal page will load
  6. Select a pre-configured SMS gateway in the Select a SMS gateway to send this text message field to send this text message. The option to choose between pre-configured SMS gateway providers comes in handy when having multiple SMS gateways configured, and you want to send a text message from a specific "from" number, related to the country of the user you are about to text.
  7. Type your text message in the SMS Message field
  8. Click on the Send button
  9. All text messages, except for SMS messages sent when scheduling appointments, re-scheduling appointments and post-dated automated reminder SMS messages - will be sent in real-time.

Calendar / Appointment Management

Viewing Calendars

  1. Click on the Appointment Manager link from the main navigation menu
  2. a List of all calendars is located right below the Appointment Manager: Calendar Management heading

Registering New Calendars

Note: The Custom Provider Name field is used to send notification messages. As an example, the profile account may be owned by a body corporate, such as The Nail House - yet you can set a Custom Provider Name - so if, for example, "Lisa" works at The Nail House and so does Benna - and each of them have their own calendars set up - the Custom Provider Name for "Lisa" can be Lisa@TheNailHouse and for "Benna" it could perhaps be Benna@TheNailHouse. So - depending on your text message templates set - the notification could be something like Dear Ann! This is a confirmation of your appointment at Benna@TheNailHouse on ....

  1. Click on the Appointment Manager link from the main navigation menu
  2. a List of all calendars is located right below the Appointment Manager: Calendar Management heading
  3. Click on the Register a New Calendar button
  4. a Modal page will load
  5. Complete the online Calendar Registration form
  6. Click on the Save button

Updating Calendar Information

Note: The Custom Provider Name field is used to send notification messages. As an example, the profile account may be owned by a body corporate, such as The Nail House - yet you can set a Custom Provider Name - so if, for example, "Lisa" works at The Nail House and so does Benna - and each of them have their own calendars set up - the Custom Provider Name for "Lisa" can be Lisa@TheNailHouse and for "Benna" it could perhaps be Benna@TheNailHouse. So - depending on your text message templates set - the notification could be something like Dear Ann! This is a confirmation of your appointment at Benna@TheNailHouse on ....

  1. Click on the Appointment Manager link from the main navigation menu
  2. a List of all calendars is located right below the Appointment Manager: Calendar Management heading
  3. Click on the Edit button right below the calendar of which information / configuration you want to update
  4. a Modal page will load
  5. Apply the required changes
  6. Click on the Save button

Deleting Calendars

Note: When deleting a calendar, ALL data associated with the deleted calendar, such as calendar configuration, calendar appointments, calendar notification instance configurations and calendar snippet configurations will be lost forever.

  1. Click on the Appointment Manager link from the main navigation menu
  2. a List of all calendars is located right below the Appointment Manager: Calendar Management heading
  3. Click on the Delete button right below the calendar which you want to delete
  4. a Confirmation box will appear - requesting to confirm the selected delete action
  5. Click on the Yes button to delete the selected calendar and all calendar data

Viewing Appointments

  1. Click on the Appointment Manager link from the main navigation menu
  2. a List of all calendars is located right below the Appointment Manager: Calendar Management heading
  3. Click on the View button right below the calendar of which you want to access
  4. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display

Scheduling Appointments

  1. Click on the Appointment Manager link from the main navigation menu
  2. a List of all calendars is located right below the Appointment Manager: Calendar Management heading
  3. Click on the View button right below the calendar of which you want to access
  4. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  5. Click on the Schedule button in the same row as the available time slot where you want to schedule an appointment
  6. a Modal page will load
  7. Complete the online schedule appointment form as follow:
    • Select a customer from the Customers dropdown menu
    • Select the radiobutton next to the appropriate timeslot:duration
    • Uncheck the checkboxes of the notification methods not to use - and vice versa. Both the email as well as the SMS notification methods are selected by default
    • Check the checkboxes next to the Confirmation message to be sent now options. The first highlighted option is the default confirmation message to send. Any other messages (referred to as Snippets) selected in this section, will be added to the default confirmation message as well as to the selected post-dated reminder notifications (referred to as notification instances).
    • Check the checkboxes next to the Post-dated Notification Messages options. If any snippets other than the default confirmation message (as described in the previous step) were selected - they will be added to each of the Post-dated Notification Messages selected
  8. Click on the Save button
  9. Depending if any notification messages selected and depending on which notification methods selected, the customer will receive an appointment confirmation message shortly after the appointment was scheduled. If any post-dated reminder messages were selected, they will be sent on the date and time scheduled - in the same timezone of your server environment.

Rescheduling Appointments

Appointments can be rescheduled accross different calendars

  1. Click on the Appointment Manager link from the main navigation menu
  2. a List of all calendars is located right below the Appointment Manager: Calendar Management heading
  3. Click on the View button right below the calendar of which you want to access
  4. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  5. Click on the Reschedule button in the same row as the available time slot where you want to reschedule an appointment
  6. a Modal page will load
  7. Complete the online schedule appointment form as follow:
    • Enter the reference code of the appointment you want to reschedule, in the Appointment Reference field. Retrieving an appointment reference is discussed in detail further down in this document, however as a quick reference, prior to clicking on the Reschedule button - click on the dropdown arrow of the appointment you want to reschedule, and select Appointment Information option from the dropdown menu. All appointment information will display in a modal page - including the Appointment Reference which you can copy from here.
    • Select the radiobutton next to the appropriate timeslot:duration
    • Uncheck the checkboxes of the notification methods not to use - and vice versa. Both the email as well as the SMS notification methods are selected by default
    • Check the checkboxes next to the Confirmation message to be sent now options. The first highlighted option is the default reschedule confirmation message to send. Any other messages (referred to as Snippets) selected in this section, will be added to the default reschedule confirmation message as well as to the selected post-dated reminder notifications (referred to as notification instances).
    • Check the checkboxes next to the Post-dated Notification Messages options. If any snippets other than the default reschedule confirmation message (as described in the previous step) were selected - they will be added to each of the Post-dated Notification Messages selected
  8. Click on the Save button
  9. Depending if any notification messages selected and depending on which notification methods selected, the customer will receive an appointment reschedule confirmation message shortly after the appointment was rescheduled. If any post-dated reminder messages were selected, they will be sent on the date and time scheduled - in the same timezone of your server environment.

The Appointment Options Menu

To make accessing extended appointment information / features easy and on-the-fly, each appointment features a dropdown menu, presenting options associated to the selected appointment. As an example, instead of searching for a customer in the Customer Management section just to get the customer's contact number, you can instead just click on the dropdown menu of an appointment and select the Customer Information option, to access the customer information of the customer associated with the selected appointment.

  1. Click on the Appointment Manager link from the main navigation menu
  2. a List of all calendars is located right below the Appointment Manager: Calendar Management heading
  3. Click on the View button right below the calendar of which you want to access
  4. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  5. Click on the arrow facing down, located right at the end of the full names of the customer, associated with the appointment of which you want to retrieve extended information and/or features, from.
  6. a Dropdown menu will appear, featuring the following options:
    • Update Appointment Status

      To make managing appointments easy, the status of each appointment can be changed. Several appointment status options are available - such as Billed, Confirmed or Cancelled. a Unique easy-readable color is assigned to each appointment status - so when changing an appointment status, the background color of the appointment slot, when viewing appointments, will change too. This will help to easily distinc appointments from each other - based on the appointment status.

      Note: When updating an appointment's status to Cancelled - the appointment will be removed from the Calendar > Appointments view so that the same timeslot can be used again. Also, when an appointment is cancelled, all post dated notification reminder messages scheduled - will be removed as well - thus ensuring that a customer will receive no further notification messages associated the this cancelled appointment.

    • Appointment Information

      When selecting the Appointment Information option - a modal page will load, presenting you with all the appointment information fields. When rescheduling an appointment and you need to find the appointment reference - then this is the best place to easily retrieve the appointment reference code, as explained before.

    • Customer Information

      When selecting the Customer Information option - a modal page will load, presenting you with all the customer information such as full names, contract numbers and email address. Note that if the mobile contact number of the customer associated to the selected appointment, is wrong - (though unlikely) - an error will be produced here.

    • Notification History

      When selecting the Notification History option - a modal page will load, presenting you with all the notification messages sent, associated with the selected appointment. This also includes notification messages if the appointment was rescheduled before - including rescheduling accross multiple calendars.

    • Email Customer
      • Select the Email Customer option from the dropdown menu
      • a Page will load from where the email message can be composed
      • Enter your email subject in the Email Subject field
      • Type your email message in the Email Message field
      • Click on the Send button
    • SMS Customer
      • Select the SMS Customer option from the dropdown menu
      • a Modal page will load
      • Type your text message in the SMS Message field
      • Click on the Send button
      • The message will be sent via the default SMS Gateway configuration. All text messages, except for SMS messages sent when scheduling appointments, re-scheduling appointments and post-dated automated reminder SMS messages - will be sent in real-time.

What are Notification Instances

Notification instances are pre-defined post-dated reminder message templates, which you can select individually, at the time of scheduling or rescheduling an appointment. With each notification instance, you can specify when the message should be sent. As an example, if you want The Appointment Machine SaaS to send a notification reminder to a customer one day prior to the appointment date at 7:15am, you would create a once-off notification instance template, setting the day to send, one day before the appointment date and setting the time to send the notification message, to 7:15am. You can also set the instance to send on the day of the appointment, as well to send after the date of the appointment. The latter option comes in handy for if you want to perform a service satisfaction survey after the service has been rendered. Take note that post-dated messages are sent in the same timezone of your server environment.

Viewing Notification Instances

  1. Click on the Appointment Manager link from the main navigation menu
  2. a List of all calendars is located right below the Appointment Manager: Calendar Management heading
  3. Click on the View button right below the calendar of which you want to access
  4. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  5. Click on the Notification Instances button at the top of the page
  6. a Tabular list of all existing notification instances will display

Creating Notification Instances

  1. Click on the Appointment Manager link from the main navigation menu
  2. a List of all calendars is located right below the Appointment Manager: Calendar Management heading
  3. Click on the View button right below the calendar of which you want to access
  4. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  5. Click on the Notification Instances button at the top of the page
  6. a Tabular list of all existing notification instances will display
  7. Click on the Create a new notification instance button
  8. a Modal page will load
  9. Complete the online form
  10. Click on the Save button

Updating Notification Instances

  1. Click on the Appointment Manager link from the main navigation menu
  2. a List of all calendars is located right below the Appointment Manager: Calendar Management heading
  3. Click on the View button right below the calendar of which you want to access
  4. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  5. Click on the Notification Instances button at the top of the page
  6. a Tabular list of all existing notification instances will display
  7. Click on the Edit button in the same row as the notification instance you wish to edit
  8. a Modal page will load
  9. Apply the required changes
  10. Click on the Save button

Deleting Notification Instances

  1. Click on the Appointment Manager link from the main navigation menu
  2. a List of all calendars is located right below the Appointment Manager: Calendar Management heading
  3. Click on the View button right below the calendar of which you want to access
  4. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  5. Click on the Notification Instances button at the top of the page
  6. a Tabular list of all existing notification instances will display
  7. Click on the Delete button in the same row as the notification instance you wish to delete
  8. a Confirmation box will appear - requesting to confirm the selected delete action
  9. Click on the Yes button to delete the selected notification instance

What are Notification Snippets

a Notification snippet is a phrase which you can add to reminder or confirmation notifications. As an example, if certain customers has to pay an administration fee, you can say something like, "Remember to bring with $5.00 for administration fees." If selected, this message will then be added to the default notification message as well as to selected post-dated notification messages. Notification phrases can be selected individually at the time of scheduling or re-scheduling an appointment.

Viewing Notification Snippets

  1. Click on the Appointment Manager link from the main navigation menu
  2. a List of all calendars is located right below the Appointment Manager: Calendar Management heading
  3. Click on the View button right below the calendar of which you want to access
  4. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  5. Click on the Notification Snippets button at the top of the page
  6. a Tabular list of all existing notification snippets will display

Creating Notification Snippets

  1. Click on the Appointment Manager link from the main navigation menu
  2. a List of all calendars is located right below the Appointment Manager: Calendar Management heading
  3. Click on the View button right below the calendar of which you want to access
  4. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  5. Click on the Notification Snippets button at the top of the page
  6. a Tabular list of all existing notification snippets will display
  7. Click on the Create a new notification snippet button
  8. a Modal page will load
  9. Complete the online form
  10. Click on the Save button

Updating Notification Snippets

  1. Click on the Appointment Manager link from the main navigation menu
  2. a List of all calendars is located right below the Appointment Manager: Calendar Management heading
  3. Click on the View button right below the calendar of which you want to access
  4. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  5. Click on the Notification Snippets button at the top of the page
  6. a Tabular list of all existing notification snippets will display
  7. Click on the Edit button in the same row as the notification snippet you wish to edit
  8. a Modal page will load
  9. Apply the required changes
  10. Click on the Save button

Deleting Notification Snippets

  1. Click on the Appointment Manager link from the main navigation menu
  2. a List of all calendars is located right below the Appointment Manager: Calendar Management heading
  3. Click on the View button right below the calendar of which you want to access
  4. a Detailed list of all available appointment slots together with appointments scheduled within the default or selected date range, will display
  5. Click on the Notification Snippets button at the top of the page
  6. a Tabular list of all existing notification snippets will display
  7. Click on the Delete button in the same row as the notification snippet you wish to delete
  8. a Confirmation box will appear - requesting to confirm the selected delete action
  9. Click on the Yes button to delete the selected notification snippet

User Management

Viewing User Accounts

  1. Click on the User Management link from the main navigation menu
  2. a Tabular list of all user accounts is located right below the User Accounts heading

Deleted User Accounts

When restoring user accounts - all data associated to the user account will be restored as well - thus allowing the restored user to log into the application again and having access to data accumulated prior to the account deletion.

  1. Click on the User Management link from the main navigation menu
  2. a Tabular list of all user accounts is located right below the User Accounts heading
  3. Click on the Show deleted user accounts button above the user accounts table
  4. a Tabular list featuring all deleted user accounts - if any - will load
  5. If you would like to restore a deleted user account, click on the Restore button in the same row as the name of the deleted user account.
  6. a Confirmation box will appear - requesting to confirm the selected restore action
  7. Click on the Yes button to restore the deleted user account

Registering User Accounts

  1. Click on the User Management link from the main navigation menu
  2. a Tabular list of all user accounts is located right below the User Accounts heading
  3. Click on the Register a new user button above the user accounts table
  4. a Modal page will load
  5. Complete the online user account registration form
  6. Click on the Save button
  7. The newly registered user will receive his / her account login details via email

Updating User Account Information

  1. Click on the User Management link from the main navigation menu
  2. a Tabular list of all user accounts is located right below the User Accounts heading
  3. Click on the Edit button in the same row as the name of the user account you wish to update
  4. a Modal page will load
  5. Apply the user account changes
  6. Click on the Save button

Deleting User Accounts

  1. Click on the User Management link from the main navigation menu
  2. a Tabular list of all user accounts is located right below the User Accounts heading
  3. Click on the Delete button in the same row as the name of the user account you wish to delete
  4. a Confirmation box will appear - requesting to confirm the selected delete action
  5. Click on the Yes button to delete the selected user account

Sending an email message to a user

  1. Click on the User Management link from the main navigation menu
  2. a Tabular list of all user accounts is located right below the User Accounts heading
  3. Click on the More Options dropdown menu in the same row as the name of the user account
  4. Select the Email User option from the dropdown menu
  5. a Page will load from where the email message can be composed
  6. Enter your email subject in the Email Subject field
  7. Type your email message in the Email Message field
  8. Click on the Send button

Sending a SMS text message to a user

  1. Click on the User Management link from the main navigation menu
  2. a Tabular list of all user accounts is located right below the User Accounts heading
  3. Click on the More Options dropdown menu in the same row as the name of the user account
  4. Select the SMS User option from the dropdown menu
  5. a Modal page will load
  6. Select a pre-configured SMS gateway in the Select a SMS gateway to send this text message field to send this text message. The option to choose between pre-configured SMS gateway providers comes in handy when having multiple SMS gateways configured, and you want to send a text message from a specific "from" number, related to the country of the user you are about to text.
  7. Type your text message in the SMS Message field
  8. Click on the Send button
  9. All text messages, except for SMS messages sent when scheduling appointments, re-scheduling appointments and post-dated automated reminder SMS messages - will be sent in real-time.

SMS Gateways

Viewing Gateways Configured

  1. Click on the User Management link from the main navigation menu
  2. a Tabular list of all SMS gateway configurations is located right below the SMS Gateway Configurations heading

Configuring new SMS gateways

  1. Click on the User Management link from the main navigation menu
  2. a Tabular list of all SMS gateway configurations is located right below the SMS Gateway Configurations heading
  3. Click on the Configure a New SMS Gateway button above the SMS gateway configurations table
  4. a Modal page will load
  5. Complete the online SMS gateway configuration form
  6. Click on the Save button

Updating SMS Gateway Configurations

  1. Click on the User Management link from the main navigation menu
  2. a Tabular list of all SMS gateway configurations is located right below the SMS Gateway Configurations heading
  3. Click on the Edit button in the same row as the configuration nickname
  4. a Modal page will load
  5. Apply the required changes
  6. Click on the Save button

Deleting SMS Gateway Configurations

  1. Click on the User Management link from the main navigation menu
  2. a Tabular list of all SMS gateway configurations is located right below the SMS Gateway Configurations heading
  3. Click on the Delete button in the same row as the SMS gateway configuration you wish to delete
  4. a Confirmation box will appear - requesting to confirm the selected delete action
  5. Click on the Yes button to delete the selected SMS gateway configuration

Number Lookup

The Number Lookup feature allows users to perform in-depth contact number information retrieval / validation. This feature can be used not only to validate if a contact number is valid, but, depending on the SMS Gateway Provider configuration which is set as the default gateway, it even shows the network carrier as well as if the number is connected, reachable and more. Some providers return more information, compared to others. As an example, the NEXMO gateway provider returns quite more information in a number validation request, compared to Twilio - though they are both very innovative and reliable gatway providers. The Number Lookup feature is a chargeable service (usually just a few cents) and will be billed to the account of the default SMS gateway provider set. In order to use the Number Lookup feature, at least one valid system SMS Gateway Configuration should be set.

  1. Click on the Number Lookup link from the main navigation menu
  2. Enter a E.164 contact number in the Contact Number field.
  3. Click on the Submit button