Docs | Support Board

GETTING STARTED

Installing Support Board

In order to install Support Board on your server please follow the steps below:

Open the archive supportboard.zip and extract the folder in a server location of your choice.
Navigate to the link http://[your-site]/supportboard/admin.php and complete the installation. Replace [your-site] with the URL of your website's plug-in location.
Once the installation is complete, log in with the email and password you created in the previous step and you're done!
If you're updating the plugin from an older version, delete the old plugin before installing the new version. Also, keep in mind that the new version may not necessarily be compatible with old conversations.

Display the chat

In order to display the chat on your website, please include the following scripts into the <head><head> or <footer><footer> area of each page you would like for the chat to be visible.

                                        <script src="supportboard/js/min/jquery.min.js"></script> <!-- Not required if jQuery is already loaded -->
                                        <script src="supportboard/js/init.js"></script>

URL parameters

lang=LANGUAGE-CODE See the multilingual docs for more details.
url=PLUGIN-URL Use this parameter if your plugin directory URL / folder has been changed. Replace PLUGIN-URL with the URL of the plugin folder. You can also define the Javascript variable via SB_INIT_URL = "PLUGIN-URL".

In order to install Support Board on WordPress follow the steps below:

Your server must allow the access of the file supportboard/include/ajax.php
If you're updating the plugin from an older version delete the old plugin first. Mind that the new version will not be compatible with the old conversations.
Go to the Plugins page and click Add new then Upload plugin and upload the file supportboard.zip.
Once the installation is complete you should see a new left menu item named Support Board. You're done, the chat is automatically shown on all pages.

Requirements

The pages where you include the chat must be HTML or PHP pages and must be opened via a server.
You cannot display the chat on a HTML page opened directly on a local computer. Use a server instead.
The plugin folder name must be supportboard. Do not rename it.
Your server must allow the access of the following file: supportboard/include/ajax.php
If you're using the WordPress version of Support Board and you have any security plugins installed, please make sure that they don't block the supportboard/include/ajax.php file.
JQuery 1.1+
PHP 7+
In your server settings, PHP SESSIONS, CURL, ZIP ARCHIVE, must be enabled and working correctly.
Files and folders permissions must be granted for the Support Board uploads and apps folders. Support Board must be able to save and read the files in these folders.
MySQL

Once the installation is completed you can check the system requirements from Settings > Miscellaneous > System requirements.

Activation

To activate the plugin and enable all of the features (including automatic updates), you need to insert the Envato Purchase Code into the Settings > Miscellaneous area of the Support Board Admin page.

Find your Envato Purchase Code

Updates

To update Support Board manually, go to the Admin area and click the version number in the bottom left corner.
You can also activate automatic updates via Settings > Miscellaneous.
To enable plugin updates, you need to have a valid Envato Purchase Code. To update the Support Board Apps (Dialog Flow and Slack) you need to have a separate valid License Key for each specific App. In addition, the License Key must not be older than 1 year. If your License Key is expired, you will need to purchase a new license to enable App updates again.
The latest versions of the Apps will not work if Support Board has not been updated to the latest version.
If you're using the WordPress version of Support Board, keep in mind that you cannot update Support Board from the WordPress plugins page.

More Settings

Cross-domain installation

If you want to use the same chat installation on multiple domains, your server must allow cross-origin requests. To enable cross-origin requests on your server follow the steps below:

For Apache servers — Edit the .htaccess file of the domain where the plugin is installed and insert the code Header set Access-Control-Allow-Origin "*" at the very top of the file. You can insert this code too: <IfModule mod_deflate.c="">header('Access-Control-Allow-Origin: *');</IfModule>.
For nginx servers — Edit the file /etc/nginx/nginx.conf of the domain where the plugin is installed and insert the code add_header Access-Control-Allow-Origin "*"; at the very top of the file.
If any of solutions above do not work or you're unable to change the server configuration, edit the supportboard/include/ajax.php and supportboard/include/init.php files and insert the code header('Access-Control-Allow-Origin: *'); as the first line at the very top of the file.

If the chat works but icons and fonts are missing, you'll need to edit your server settings. Remove header('Access-Control-Allow-Origin: *') from the .htaccess file and edit the server settings directly as previously described above. You can view tutorials for the most common server administration software in the list below:

Blocking zoom on iOS devices

When using the chat on iPhones the textarea is automatically zoomed when the user's start typing a new message. To stop the zoom insert the code below into the <head> area of all the pages that include the chat.

                                <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1.0, user-scalable=no" />

Having Problems?

If you're having any issues at all, please contact our friendly support team at support@schiocco.com. Before contacting us, please make sure that your server has all the requirements listed above. On that same note, if you are using the WordPress version, please make sure that your WordPress installation has all the requirements listed above.

General issue

For any issue you can check the system requirements from Settings > Miscellaneous > System requirements. We can not provide support about solving the issues reported by the system requirement function, please contact your hosting or server support if you need help.

Chat widget not displaying

You cannot see and test the chat as a user if you're logged into the admin area. To test the chat as a user, please log out of your admin account. Alternatively, you can use another browser window in “private” or “incognito” mode. Additionally, you can force a logout by executing the SBF.reset() function in the browser console.

Forgot email or password of the admin account

If you can no longer log in to the admin area because you forgot the email or password of the admin account, you can resolve this issue by following the steps below:

Edit your MySQL Database. You can edit it from your hosting panel, usually with phpMyAdmin.
Edit the table sb_users.
Find your admin account and edit the password field. The value of the password column must be a hash. To generate a hash for your password, visit https://php-password-hash-online-tool.herokuapp.com/password_hash.

Admin account deleted

If you accidentally delete all of your admin and agent accounts and can no longer log in to the admin area, you can resolve this issue by following the steps below:

Edit your MySQL Database. You can edit it from your hosting panel, usually with phpMyAdmin.
Edit the table sb_users.
You can convert any existing user to an admin by editing the column user_type, and inserting the value admin.
You can also add a new user by assigning a value to the columns first_name, last_name, password, email, and user_type fields. The value of the password column must be a hash. To generate a hash for your password, visit https://php-password-hash-online-tool.herokuapp.com/password_hash. Also, the value of the column user_type must be admin.

Server down

If your server and/or website goes down or suddenly stops working after a few minutes of chat usage, the issue could be related to your server's Firewall. This usually happens as a result of an IP Address Banning (Fail2Ban) or Web Application Firewall (ModSecurity) settings. The multiple AJAX requests from the chat to the database are recognized as a "server attack" and so your server places a temporary block on your IP address. This issue should only affect you and/or your developers; visitors/users should not be affected. To confirm whether or not this is the issue, use a VPN service like Hotspot Shield. When the server goes down, activate the VPN to change your IP and try accessing your website again. If the website works normally, the issue is confirmed. To solve it temporarily disable fail2ban or contact your hosting support for additional support.

CONVERSATIONS

Manage Conversations

Conversations have a total of four different statuses: mark as read, archive, delete and restore. You can manage the status of a conversation by opening it in the conversations area and then clicking any of the corresponding icon buttons in the top right of the conversation window.

When you empty the trash, all the conversations in the trash are permanently deleted.
When a user sends a new message to an archived or trashed conversation, the conversation is automatically restored and will now be visible in the Inbox area.
When a user is deleted, all the conversations and messages will be permanently deleted too.
An agent can delete their own messages by opening the message menu and clicking Delete. The message menu becomes visible when you hover the mouse cursor over the message.

Text Editor Features

The text editor of the admin area can be used to create stylized messages:

Links formatting — All text links are automatically converted to clickable hyperlinks.
Text formatting — The editor also supports Slack's text formatting syntax:
- To make text bold, surround it with asterisks: *your text*.
- To make text italic, surround it with asterisks: _your text_.
- To make text strikethrough, surround it with asterisks: ~your text~.
- To insert a single-line code comment, surround it with asterisks: `your text`.
- To insert a code block, surround it with asterisks: ```your text```.
HTML and other code languages — For security reasons, no HTML, JavaScript (JS), or other code languages are permitted. However, you can use HTML snippets by utilizing custom Rich Messages (discussed below).
To insert a line break into a message, use the keyboard combination CTRL + ENTER.

Rich Messages

Rich messages are special messages with interactive features like buttons, dropdowns, or inputs. They allow an agent to request information from the user via a user input form. Rich messages can be inserted into a chat message using shortcodes. This allows you to create simple, yet complex, forms that can be easily inserted into a message by an agent without them having to know or type any HTML code. The shortcodes accept various parameters like title and description. The available Rich Messages are listed here below:

How it works:

Create and send

Create a Rich Message by inserting the shortcode into the text editor of the admin area. Customize all of the parameters with your information and send your message.

Message is displayed

When a shortcode is used, the user sees the Rich Message (not the shortcode) and can select or insert the required information to complete the form submission.

User's response is submitted

Once the Rich Message form has been filled out and sent by the user, a success message is shown and the form data is saved.

Rich Messages

Name	Shortcode	Description
Card	[card image="URL" header="TITLE" description="Lorem ipsum dolor sit amete" link="URL" link-text="Purchase" extra="$599"]	Display a call-to-action card with an image, title, description, link, and more.
Slider	[slider image-1="URL" header-1="TITLE" description-1="Lorem ipsum dolor sit amete" link-1="URL" link-text-1="Purchase" extra-1="$599" image-2="URL" header-2="TITLE" description-2="Lorem ipsum dolor sit amete" link-2="URL" link-text-2="Purchase" extra-2="$599"]	Display a slider of call-to-action cards with an image, title, description, link, and more. You can add up to 10 slides.
Chips	[chips options="A,B,C"]	Display a list of buttons.
Buttons	[buttons options="A,B,C"]	Display a list of buttons.
Select	[select options="A,B,C"]	Display a dropdown list of options.
Inputs	[inputs values="A,B,C" button="Send now"]	Display a list of text inputs.
Email	[email]	Display a form to collect the user's email.
Registration	[registration]	Display the registration form.
Timetable	[timetable]	Display the timetable.
Articles	[articles]	Display the articles.
Rating	[rating]	Display an agent rating form.
List	[list values="A,B,C"]	Display a static text list.
List double	[list values="A:X,B:Y,C:Z"]	Display a static text list with titles.
Table	[table header="A,B,C" values="A:B:C,A:B:C,A:B:C"]	Display a table.
Button	[button link="https://board.support" name="Click here" target="_blank"]	Display a link. The attribute target="_blank" is optional and open the link in a new window.
Video	[video type="youtube" id="0TImic4N1ko" height="350"]	Display a YouTube or Vimeo video. The value of the attribute type can be youtube or vimeo. The attribute id is the ID of the video, get it from the URL. The attribute height is optional and sets the video height in px.
Image	[image url="https://board.support/media/admin.png"]	Display an image.

Global parameters

All of the Rich Messages support the following parameters:

Parameters	Description
id="123"	The ID of the Rich Message (this will be used also to save the JSON data).
title="ABC"	The Rich Message title.
message="ABC"	The Rich Message description that appear underneath the title.
success="ABC"	The message that appear when the user complete and send the Rich Message. The user input will be appended to this message.

Rich message response

When a user completes a Rich Message form, a success message is shown. The message includes the user's input/selection. The user's response data is saved in JSON format in the database under table sb_messages and column payload. For example:

{"rich-messages":{"4Voyu":{"type":"email","result":{"email":["example@gmail.com","Your email ..."]}}}}

Custom Rich Messages

You can create custom Rich Messages with your own custom content by going to Settings > Miscellaneous. Currently, custom Rich Messages are completely static and there are no interactive options available as there are with shortcodes. However, you can insert custom HTML codes.

HTML codes

When creating a custom Rich Message, you can use the following codes:

Code	Description
<a href="https://www.google.com" target="_blank" class="sb-rich-btn sb-btn">Click here</a>	Display a button with a link.

Attachments

The allowed file extensions for the attachments are pre-set into the supportboard/include/upload.php file. The following image formats are displayed automatically: .jpg, .jpeg, .png

USERS

Manage Users

All users can be managed from the Users area in the left menu of the Admin area.

Search users

You can search users by name, surname, email, and custom fields.

Delete users

You can delete a user by opening the User edit box and then clicking Delete user. To delete multiple users at once, select the users you want to delete from the Users table and then click the top right Delete icon. When a user is deleted, all of their conversations and messages will be automatically deleted permanently. Note: Visitors are automatically deleted every 24 hours.

User types

Type	Description
user	A "user" is any user with an email.
lead	A "guest" is any user without an email address who is automatically registered without registration and has at least one conversation.
visitor	A "visitor" is any user who has not started a conversation. Note: Visitors are automatically deleted every 24 hours.

Manage Agents

Agents can be managed from the Users area. An agent is a special user that can log in to the admin area and reply to all of the conversations. There are two types of agents: agents and admins. Admins are the only ones that can create new agents and admins; they also have access to the settings area. Agents can only manage users and conversations.

If you are using the WordPress version of Support Board, an admin will be created on plugin activation with the same user and password of the logged in user.

Information

The log-in form is shown only if the registration password field is shown.
The password field is always shown when the user system is set to "WordPress".

SETTINGS

Email

Both agents and users can receive an email notification when a new message is received.

When and how often the emails are sent

When a user sends their first message, an email is sent to all of the agents; subsequent emails are sent only to the last agent of the conversation. At this point, email notifications will be sent only if the agent is offline. Subsequent messages will not trigger a new email alert unless the user reloads the page or navigates to another page.

When an agent sends a message to a user, an email is sent to the user only if the user is offline. Subsequent messages do not trigger a new email alert unless the admin reloads the Support Board admin area page.

Create the email

To manage the emails and create the body go to Settings > Notifications. You can use text and HTML. New lines are automatically converted to <br />. You can use the following code in the email. These codes will be automatically replaced with the updated information.

Code	Description
{recipient_name}	The name of the user or agent who is receiving the email.
{sender_name}	The name of the user or agent who was sending the message that triggered the email notification.
{sender_profile_image}	The profile image of the user or agent who was sending the message that triggered the email notification.
{message}	The links to any attachments that were part of the message that triggered the email notification.
{attachments}	Emails might not be delivered for a number of reasons; below are the most common ones:

Problems?

Emails might not be delivered for a number of reasons; below are the most common ones:

Reason	Description	Solution
Hosting problems	The email server of your web hosting provider is not able to send emails or the emails are sent but are automatically detected as spam and deleted by the email clients.	Please contact your web hosting provider regarding email support or use your SMTP server by activating it in the Notifications area.
SMTP problems	The email is not send also if you activated the SMTP option in the Notifications area.	We don't provide support for problems related to your SMTP. Send a test email to get details about the issue or use sendgrid.com, you can send 40000 emails for 30 days for free, then 100/day forever for free.

Office Hours

You can set your office hours timetable from Settings > Miscellaneous. Office hours are used for:

Automatically displaying the timetable when a user sends a message during out-of-office hours.
Disabling and hiding the chat during out-of-office hours.
Disabling the Dialogflow bot during regular office hours and enabling it during out-of-office hours.

The office hours are in UTC format. To get the UTC offset of your area, go to: https://browserspy.dk/ or wikipedia.org/wiki/List_of_UTC_time_offsets and copy the offset (e.g. for UTC −12:00, insert -12). Only integers are accepted. If your offset is not an integer (e.g. UTC -12:30 or UTC -12:45), try searching for alternative UTC offset. If you can't find an integer offset, you will need to manually adjust the times in the office hours table to fix the gap.

Knowledge Base Articles

Knowledge base articles provide instant answers to customers in order to help reduce customer support volume. To manage the articles, go to Settings > Articles. Articles support HTML code, which can be used to add images, videos, and other contents. Here are some HTML code examples that you can use:

Name	Code
Image	<img src="your-image-url" />
Video	<video controls><source src=" your-video-url.mp4" type="video/mp4"></video>
YouTube and Vimeo	Insert the embed code provided by YouTube or Vimeo

Where are the articles shown?

Knowledge base rticles can be shown in the chat dashboard by enabling them from the Settings > Chat area. Alternatively, articles can be shared via the Rich Message shortcode, [articles].

Language and Translations

Support Board is fully multilingual and provides powerful features to detect the user's language on the fly.

Edit translations

To edit the languages of both chat and admin, go to Settings > Translations. The front-end chat is already translated in 20+ languages.

Set chat and admin language

To set the language for front-end admin area, you have two options:

Go to Settings > Chat and check the Translate automatically option. This feature will automatically translate the chat language detected by the browser.
Add the url parameter lang=LANGUAGE-CODE to the script that loads the chat, replacing "LANGUAGE-CODE" with the actual language code you would like to display. For example, https://board.support/supportboard/js/init.js?lang=en. Go to wikipedia.org/wiki/List_of_ISO_639-1_codes for the complete languages code list (see column 639-1).
The WordPress version of Support Board uses the default language of the WordPress installation; or the language of the current page or post if the website is multilingual. This feature is compatible with WPML, Polylang, and the other multilingual plugins. Note: This feature is automatically disabled if the "Translate automatically" option has been enabled.

Translate custom contents

You can translate almost any content that you create, such as: Rich Messages, titles, descriptions, the chat header text, etc. To add translations, select the language you want and click the New translation button.

Add a new language

To add a new language, follow the steps below:

Via FTP or a File Manager, go to supportboard\resources\languages\front.
Duplicate (copy and paste it in the same directory) the supportboard\resources\languages\front\source.json file.
Rename the file with the language code you would like to add. Go to wikipedia.org/wiki/List_of_ISO_639-1_codes for the complete languages code list (see column 639-1).
Go to Settings > Translations and the new language should appear automatically.

To add a new language for the admin area, follow the exact same steps, but change the folder from front to admin. New languages will not be lost or deleted on plugin updates.

Edit translations

To edit the languages for both chat and admin, go to Settings > Translations. The front-end chat has already been translated in 20+ languages.

Information

The translations edits are not saved in the database but directly in the translation files. When a translation is edited, and saved, a backup is created into the uploads folder. The backup is restored automatically on plugin update and plugin activation.

Departments

Departments give you the power to distribute conversations and assign various agents to specific departments. For example, you can create a department entitled "Sales" and assign specific conversations to that department. To start using departments, follow the steps below:

Go to Settings > Miscellaneous and add your required departments. After saving, reload the page.
Go to Users > Agents & Admins and edit an agent, you will see a new field where you can set the department of the agent.
Reload the page and you're done! In the Conversations area, you will now see an option to set the conversations department in the Details area on the right side of the screen.

Settings

Display in dashboard Display the departments' list in the chat dashboard and force users to choose a department before starting a conversation.
Display images Display the department image instead of the department color.
Label Change the departments name (plural) to something else. The name is displayed in the admin and tickets area.
Label single Change the department name (singular) to something else. The name is displayed in the admin and tickets area.
Dashboard title Set the title of the chat dashboard list. Default: Departments.

How it works

An agent can only access conversations that have been assigned to their specific department.
When an agent is assigned to a new department, an email notification is sent to all of the agents assigned to the new department.
The General department is global and gives agents access to all of the conversations within all departments. In addition, all agents without a department are automatically assigned to the General department.
To automatically assign a department to the user conversations check the APIs, more details here.

Queue

When the chat queue setting has been enabled via Settings > Miscellaneous > Queue, users will automatically enter into a queue when an agent's chat limit has been reached. When a user enters the queue, a message with the current position in the queue and the estimated waiting time is displayed. Support Board automatically assigns the conversations to all available agents proportionately. When an agent marks a conversation as completed (by archiving it), the queue is updated and a new conversation is received.

Details

Only online agents are counted as "available" agents; only online agents will receive new conversations.
Admins are not included; admins will always see all the conversations.
Agents must archive a conversation to mark it as completed; this will automatically give them access to the next conversation in the queue.
Agents can switch their status between online and offline by hovering over their profile image and then clicking the label of the profile pop-up at the bottom-left of the admin area.
Agents can only view their own conversations; however, they can see all of the conversations of a single user.
Agents can only search and filter their own conversations.
The waiting time is displayed in minutes and is calculated as follows: queue position X response time = waiting time. For example, if a user is 5th in the queue, and the response time has been set to 4 minutes (via Settings > Miscellaneous > Queue), then the total wait time displayed to the user will be 20 minutes.
If a user is in the queue and leaves (e.g. by closing the browser) for more than 1 minute, the conversation will be saved; however, once the user comes back, the queue will be reset and the user will lose their previous position.
The queue is compatible with the departments.

How to test the queue

To simulate multiple users and agents, open the chat in multiple different browsers (e.g. Opera, Firefox, Brave, Chrome, etc.). Each browser can simulate two users/agents: one in normal mode and one in "private" or "incognito" mode.
To reset the chat and start a new user session, open the browser console, insert SBF.reset(), and press ENTER.

Routing

When the routing setting has been enabled via Settings > Miscellaneous > Routing, Support Board automatically assigns the users conversations to all available agents proportionately.

Details

Only online agents are counted as "available" agents; only online agents will receive new conversations.
Admins are not included; admins will always see all the conversations.
Agents can switch their status between online and offline by hovering over their profile image and then clicking the label of the profile pop-up at the bottom-left of the admin area.
Agents can only view their own conversations; however, they can see all of the conversations of a single user.
Agents can only search and filter their own conversations.
The routing is compatible with the departments.

Push notifications

Push notifications are like the Desktop notifications but with some key difference. Desktop notifications, also called Web notifications, are requested directly by the client while Push notifications come from a server. The main difference is that the Push notifications work always, also if your device is offline, or Support Board is not open. Also, they are persistent and always visible until closed. Push notifications require an external service to work. We use Pusher, it is free to use for the admin notifications sent to the agents, and it's free to use for up to 2000 users/devices when sending notifications to the users (this feature is not yet available). Currently, the Push notifications are supported only in the admin area, and only agents can receive them. Unfortunately, Apple has yet to provide iOS support, but we hope it will come soon. Currently, the Push notifications are supported only on Mac, Windows, and Android devices.

How to activate the push notifications

Go to https://dashboard.pusher.com/accounts/sign_up and create a new account.
From your dashboard at https://dashboard.pusher.com, choose the Beams product by clicking Get started.
Insert the Instance name and create the instance. You can insert any value you want.
From the left menu of the dashboard click Keys, copy the Instance ID and Primary key, go to Settings > Notifications > Push notifications, and paste them into the two dedicated fields.
You're done.

WORDPRESS

User Synchronization

WordPress users can be automatically synchronized with Support Board by selecting "WordPress" under the Users system in the Settings > WordPress area. When active, the front-end chat will automatically recognize all logged-in WordPress users and create a new Support Board user account with the same details (name, surname, email, and password). In addition, the log-in form will also recognize the email and password of each WordPress user.

More Settings

Direct access and PWA

You can access the admin area directly without going through WordPress by navigating to /wp-content/plugins/supportboard/supportboard/admin.php and logging in with your default WordPress user or agent email and password. Keep in mind that your wp-content folder might be different. By accessing the admin directly, you will also be able to use the admin area as a Progressive Web App. You can find more details on this by clicking here.

Login and logout

To logout from the admin area of Support Board, logout from WordPress from the admin area of Support Board, after that you will be able to login with another WordPress account.

Obtaining a page or Post Type ID

To obtain the ID of a specific page or Post Type, go to the admin area of WordPress and edit the page or post. The ID will be displayed in the address bar. For example, http://your-site.com/wp-admin/post.php?post=11&action=edit&lang=en. In this case, the page/post ID is equal to 11.

Obtaining a Post Type slug

The Post Type slug of the blog archive and posts is post. The Post Type of the pages is page. To obtain the slug of a custom Post Type, go to the admin area of WordPress and open the custom Post Type page from the left menu. The slug will be displayed in the address bar. For example, http://your-site.com/wp-admin/edit.php?post_type=food. In this case, the slug is food.

DIALOGFLOW

Synchronization

To add a bot to Support Board, you need to sync Dialogflow by clicking the button "Start synchronization" within the Settings > Dialogflow area and then follow the instructions. To get the Project ID follow these steps:

Log in to the Dialogflow console by going to dialogflow.cloud.google.com.
Click the gear icon at top left, near the bot name, and open the settings area. . If you didn't create a bot yet follow the instructions below to create your first bot.
Copy the Project ID .

Bot Creation

If you haven't created a bot as of yet, follow the instructions below to create your first bot. The creation and management of your Dialogflow bot is handled entirely by Dialogflow. There are a lot of tutorials online that can help you create and configure your Dialogflow bot. Here are a few great resources to help you get started:

Knowledge Base

Knowledge Base is a feature that gives your bot the ability to search within documents (such as a PDF) or web pages to find an answer. To create your first Knowledge Base, go to cloud.google.com/dialogflow/docs/knowledge-connectors

Get knowledge base document names

To get the knowledge base document names to be inserted into the Support Board settings area, follow these steps:

Log in to the Dialogflow console by going to dialogflow.cloud.google.com.
Click the left menu item, "Knowledge", then click the document you want to get the name of.
Copy the last part of the URL on your browser — that's the name of the document (e.g. NTY5Njg2MjIxMzYwMDQ0NDQxNg).

Information

Dialogflow response

The full Dialogflow JSON response is automatically saved in the database, sb_messages, column payload.

User attachments

User attachments are sent to Dialogflow by appending the attachments to the message details in the following format:

[name:file-name.ext,url:URL,extension:file-extension]

Example:

                                    [name:archive.zip,url:https://board.support/archive.zip,extension:zip]
                                    [name:license.pdf,url:https://board.support/license.pdf,extension:pdf]

Bot attachments

To allow the bot to send attachments, add a Payload response and insert this JSON code:

                                    { "attachments": [["name", "YOUR-LINK"], ["name", "YOUR-LINK"], ["name", "YOUR-LINK"]]}

Replace "name" with the actual name of the attachment to display and replace "YOUR-LINK" with the actual URL of the file. Images attachments are displayed automatically as images.

Rich messages

To allow Dialogflow to send Rich Messages, simply insert the Rich Message shortcode into the TEXT RESPONSE field. To obtain the shortcodes or to learn how to create a Rich Message, please click here.

Rich message response

When the user interacts with Rich Messages (e.g. by clicking a button), the Rich Message response is sent to Dialogflow in the following format: ID|type|response. ID is the Rich Message ID, which can be set by adding the attribute id="your-id" to the shortcode. If no ID has been set, a random ID will be used instead; type is the Rich Message type (input, select, buttons, etc.); response is the input or selection of the user. To block Dialogflow from replying to each Rich Message, go to the Dialogflow Console and add a new intent with only one user expression containing ID|type and no response.

Dialogflow bot optimization

If the bot is replying with the wrong intents, go to Dialogflow Console > Bot Settings > ML Settings, and set the ML CLASSIFICATION THRESHOLD to a larger number, such as 0.6.

Human takeover

When a human agent reply to a user, the bot is automatically disabled for 1 hour. You can manually disable the bot by creating a new Intent with the following Custom Payload response: { "human-takeover": true }. The manual takeover automatically notify agents via email and leave the conversation marked as unread.

Sequential survey

To create a sequential survey like the one of the demo you need to insert the Rich message ID in the Training phrases, check the example below.

Go to Dialogflow and create a new intent. In the Training phrases area insert the user expression survey example. In the Responses area insert the code [buttons id="test-survey-1" options="Software,Physical products,Services" title="What is your type of business?" message="Please choose the type that best suits your company." success="Your company type is "]
Create a new intent. Insert the user expression test-survey-1 and as response insert [select id="seq-survey-2" options="Priority post, Express courier, International courier" title="Shipping methods" message="Choose the preferred shipping method of your customers" success="Your customers preferred shipping method is"]
Create a new intent. Insert the user expression test-survey-2 and as response insert Thank you for completing our survey!.
You're done.

SLACK

Synchronization

To sync Slack click the button Start synchronization of the Settings > Slack area and follow the instructions.

Having Problems?

The synchronization of Slack may not be successful for a number of reasons; below are the most common ones:

Problem description	Solution
You can receive messages on Slack, but you cannot send messages from Slack to Support Board	Navigate to /supportboard/include/slack.php from your browser. If you receive a 403 - Forbidden error, you will need to contact your web hosting provider and ask them to set the correct file permissions for this file. It must be allowed to be executed freely without any restrictions.
Slack sync not working	Double check whether or not you chose a public Slack channel when you attempted to synchronize Slack. If you did not, try syncing Slack once again, this time choosing a public channel instead. The general channel is a good option.

Information

Manually archive channels

To archive a channel in Slack, follow these steps:

Open the Slack channel you want to archive.
On top right click the gear icon and select addition options.
Click the info icon in the top right area of the screen, then click the More icon, and then click Additional options.... Click Archive this channel.

TICKETS

Installation and usage

PHP installation

To display the chat on your website, please include the following script into the page where you want to display the tickets area.

                                <script src="supportboard/js/min/jquery.min.js"></script> <!-- Not required if jQuery is already loaded -->
                                <script src="supportboard/js/init.js?mode=tickets"></script>

You can not include both chat and tickets area on the same page. Make sure to remove the script that loads the chat. You can also use the variable SB_TICKETS = true; to prevent the chat to load.
To set the position of the tickets area insert the code <div id="sb-tickets"></div>. The tickets area will be placed inside this div element. By default, the tickets area is appended to the body.

WordPress installation

To display the tickets use the shortcode [sb-tickets]. Insert it in any page, post, or post type item.

Information

Most of the settings of the chat are compatible with the Tickets App but not all of them. The dashboard settings, the pop-up message, and more are not compatible.
Dedicated APIs for the Tickets App are available in the API section.

MORE SETTINGS

Progressive Web App

The Support Board admin area is a PWA, which means that you can install it on desktop, Mac, or mobile devices and use it like a fully-functional app. To install it, enter in your admin area (ex. https://www.your-site.com/supportboard/admin.php), and click the + icon on the top right of the URL bar of your Chrome browser. Note: This feature is optimized for Google Chrome.

To install the PWA on WordPress, you need to access the admin directly by going to:

https://www.your-site.com/wp-content/plugins/supportboard/supportboard/admin.php

Change "your-site" with the URL of your website and also keep in mind that the "wp-content" folder may be different with your installation.

Keyboard shortcuts

Admin area keyboard shortcuts are enabled on both PC and MAC and work as follows:

Shortcut	Description
ENTER	Confirm a dialog alert; the same as clicking OK.
ESC or CANCEL	Decline a dialog alert and close it.
CTRL + ENTER	Add a line break to a message. This only works for the admin editor.
ESC	Close a lightbox.
CANCEL	In the admin conversations area, archive a conversation, or delete it.
CTRL + UP/DOWN ARROW	In the admin conversations area, navigate between the conversations of the list.
CTRL + RIGHT/LEFT ARROW	In the admin users area, navigate between the users.

Config file

The config.php file is a special file that contains the MySQL database log-in details and other import settings. Most of the settings are generated automatically, but some are optional. You can add the following settings below:

Code	Description
define('SB_UPLOAD_URL', 'YOUR-URL')	Change the uploads directory (the default directory is: /supportboard/uploads/). Insert a URL: for example, https://your-site.com/myuplaods/. For this setting you need also to define the SB_UPLOAD_PATH.
define('SB_UPLOAD_PATH', 'YOUR-PATH')	Change the uploads directory path (the default path is: /supportboard/uploads/). Insert a PATH: for example, C:\xampp\htdocs\uploads. Finding the root path of your website can be a bit tricky. You can try copying the path displayed in your FTP client or simply contact your web hosting provider for additional support.

More Information

Welcome messages are not sent to slack and conversations containing only the welcome message (and no response) are automatically archived.
Follow-up messages are sent a maximum of once every 24 hours.
A popup message is always shown default, until the user manually closes it; then it stays closed.
The Users and Conversations sections in the Support Board admin area use auto-pagination on scroll, which is limited to 100 results per scroll.
The privacy message is not shown if the “Require registration” option has been enabled.