Visitor Chatv1.2.2 User Manual
Contents
1. ClientEngage Visitor Chat User Manual Thank You Thank you for choosing ClientEngage Visitor Chat This guide will provide you with a one stop support document that helps you make your first steps with ClientEngage Visitor Chat This manual will guide you through the installation process and provide you with an overview of the core functionalities of ClientEngage Visitor Chat About ClientEngage Visitor Chat The ClientEngage Visitor Chat is a fully featured real time chat for your websites A clear and simple web based administration allows you to conveniently chat with your visitors And best of all Visitor Chat comes with a Windows based client out of the box Without having to visit the Visitor Chat s admin interface you will be notified from your Windows tray and can start chatting straight away By including one single snippet of JavaScript this interactive and engaging Chat can be used on any website whether you are using Wordpress Joomla or plain HTML The Visitor Chat will give put you at your clients and visitors fingertips at those times when they have burning questions turning your prospects into your future paying customers Not around for 16 hours of the day No problem Visitor Chat will go into enquiry mode and collect all enquiries in an easily navigable format where you can mark enquiries as read unread to stay on top of things Moreover the chat system presents you with up to date information on the2. Please note that currently ClientEngage Visitor Chat uses CakePHP 2 3 2 this is subject to change with future revisions and additions to Visitor Chat 8 When Encountering Problems If you encounter any problems whilst using ClientEngage Visitor Chat please first ensure the following Did you recursively set your write permissions for the respective folders that need it Does your system fulfil the minimum requirements If you receive upload errors what is your server settings max upload and post size Are you using GoDaddy as your webhost Then please follow these instructions If your system does fulfil the minimum requirements then please do get in touch through the CodeCanyon author profile i e the e mail form You will receive a response as soon as ye Ye possible to propose a solution 6 Furthermore please also keep an eye on Visitor Chat s FAQ section on CodeCanyon this is where common questions will be answered over time 9 Feedback is Welcome Do you have any feedback praise or a particular problem Do you have great ideas for future additions to ClientEngage Visitor Chat Then please do send these through ClientEngage s CodeCanyon profile or email these to contact clientengage com am always on the lookout for clients input to make future offerings even better After all I want all my clients to be delighted with their purchases ClientEngage Visitor Chat User Manual Visitor Chat 1
3. can easily translate ClientEngage Visitor Chat into your own language by performing the following steps 1 Create a folder with your language s code within app Locale yourcode you need to use the three letter locale code which you can find here the code on the left Next create the following subfolder app Locale yourcode LC_MESSAGES 3 Open Poedit www poedit net select File gt New catalog from POT file and select app Locale default pot 4 You can now translate all the strings used within the application and safe the file as app Locale yourcode LC_MESSAGES default po repeat the same process for cake po to translate time specific strings 5 Repeat the same process by opening cake pot and saving it next to your newly created default po you should have cake po and default po in your LC_MESSAGES directory 6 Now open app Lib GlobalClasses php and add your language around line 200 your language code is the index of the array item and the display name is the value 7 Finally please go to Administration gt Configuration and select your language am always looking for user contributed translations of ClientEngage Visitor Chat If you have translated the system into a language that is not yet part of the default languages please consider sharing your translation with me To reciprocate can offer you an attribution with backlink on the item page Please get in touch via em
4. people you talk to where have they come from What page are they on Which browser and OS are they using What time is it at their end Visitor Chat answers all of those questions for you www ClientEngage com wr Do you like ClientEngage Visitor Chat Then please rate this item on CodeCanyon Follow ClientEngage on CodeCanyon 3 www CodeCanyon net user ClientEngage Follow ClientEngage on Twitter wW www twitter com ClientEngage ClientEngage Visitor Chat User Manual Table of Contents 1 About ClientEngage Visitor Chat cccsccccscsssssscscscecsccscsceccccscsceccccscscsccccecscscescecscsceseecececes 3 11L FUNMCTIONAIITY Overview ccicsasitedeiccccecsestekvsesiewavccansuaceceianudea vai ndecpindedesuiedeseundewanscisanieeniadtedesusteeversauees 3 2 System Requirements ssssisssssscrisssissrssssesscsrssssssssavossecsssdosoncissesseiidsevossditocssdissvotssstisosositeiosovs 4 3 Updating from an Earlier Version scsccscscsssccscscecsccscscsccccscscsccecccscscescecscscescccecsceseececscesess 5 Bale Updaine POCO UE ere EE E N E 5 3 2 Keeping Your Custom Translation Files cccccssssecccccesseececceesecccsceeseeceeseaueccessaeeeceesseenseceesagaeess 5 S aaO s T E EE OE E EEES 6 A e a a E A E EE E E 6 4 2 Setting File Directory Permissions cccccccceeeeeeeeeeeeeeeceeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeees 6 4 3 Accessing the Automatic Installation TOO cc
5. 0 Third Party Components Credits This application was made possible with the help of various third party components For a list of attributions please see below CakePHP This application was built using the amazing CakePHP framework License MIT License Path lib Cake LICENSE txt Website hitp www cakephp org Twitter Bootstrap Many of this application s visual aspects were made possible by using the Twitter Bootstrap framework License Apache License v2 0 Path app webroot css bootstrap LICENSE Website htip twitter github com bootstrap jQuery Many aspects of the user interaction logic use jQuery License MIT License Path app webroot js jquery MIT LICENSE txt Website hiip query com famfamfam Icons A subset of the amazingly brilliant famfamfam icon set was included in this application License Creative Commons Attribution 2 5 License Path app webroot img icons readme txt Website hitp www famfamfam com jQuery blockUI plugin blockUI provides some great functionality to prevent form re submissions License MIT License Sunday 7 March 2013 g amp ClientEngage Visitor Chat Path app webroot js jquery plugins MIT LICENSE txt Website hitp malsup com jquery block CryptoJS 3 1 License New BSD License Path https code google com p crypto js wiki License Website hitps code google com p crypto js Codemirror License MIT Style License Path app webroot js codemirror
6. By clicking on View you can see all of the respective discussion s details 5 7 Enquiries If you are offline your chat will display an enquiry form for your visitors through which they can send you an Enquiry consisting of their name email address and a 750 character long message The Enquiries section contains a list of all enquiries that were sent by your visitors whilst you were offline Once you have viewed an enquiry it will be marked as read However you can easily change the status of an enquiry back to unread Moreover in the View dialog you can see a wide range of information about the visitor as well as the actual enquiry 5 8 General Information The minimised chat will check for new messages in a 10 second interval If you or your visitors are actively chatting then the interval is usually 2 seconds However if there have been extended periods of inactivity the interval slowly increases to 10 second intervals until there is new activity at which point the interval increases to 2 seconds again Rest assured that ClientEngage Visitor Chat will always make sure that the ideal update intervals are used If a visitor is not currently taking part in a chat session the system will ping your chat server every 15 seconds to check if any administrators are currently available ClientEngage Visitor Chat User Manual 6 Extending ClientEngage Visitor Chat 6 1 Translating ClientEngage Visitor Chat You
7. LICENSE Website http codemirror net php user agent License MIT License Path app Vendor php user agent LICENSE Website https github com ornicar php user agent jsmin php License MIT License Path app Vendor jsmin jsmin php Website https github com rgrove jsmin php Sunday 7 March 2013 Visitor Chat User Manual
8. TE on the server into the same directory where you have installed ClientEngage Visitor Chat do not use the ClientEngage System directory 3 Overwrite all files and folders when prompted You have to ensure that the following directories as well as subdirectories and all files and directories contained therein are writable o Temporary Directory app tmp O Coniguratiom Directory app Config 5 Point your browser to the URL of your ClientEngage Visitor Chat installation Finally follow the on screen instructions and perform the one click update directory In the unlikely case that the update progress was unsuccessful please replace the whole application directory and database with the backup you created Furthermore please note that you will need to merge any custom code back into the system since the ClientEngage Visitor Chat interface as well as codebase will be reset to the current development state If you wish to keep your own custom translations please refer to section 3 2 Important after installing the update navigate to Administration gt Settings and configure any new configuration settings Even if you do not change anything it is important that you click Save Finally uninstall amp reinstall the Windows based client when you update ClientEngage Visitor Chat Please first uninstall the old version here Control Panel gt Software then install the new version 3 2 Keeping Your Custom Translat
9. Visitor Chat will automatically include it 5 2 System Configuration The main system configuration contains three settings one for your default timezone and one for selecting the system s interface language If you wish to translate ClientEngage Visitor Chat into a different language then please refer to section 6 1 The next setting allows you to select your custom Chat style this will be used across all pages where you have included the Visitor Chat code Finally you can easily change all translations texts buttons error messages etc that are displayed to your visitors 5 3 Creating new Chat Styles Simply navigate to Administration gt Chat Styles and click New Style It is helpful if you simply copy one of the default styles and then change it to suit your needs You can use the variable placeholder BaseURL which points to the webroot of your Visitor Chat installation http chat example com you can use this placeholder to refer to any CSS background image properties 5 4 Going On Line In the main navigation menu simply click the Offline button You are now on line and your visitors will see that the chat is currently active All active chat sessions will be shown in the Discussions section of your website You can change between discussions simply by changing your current discussion tab On the right hand side you are shown a range of different information about your vis
10. ail contact clientengage com 6 2 Customising HTML Templates Are there certain areas of the system which you would like to change in terms of their layout You can easily adapt any visual aspect of the system by amending the template files You can find individual pages in app View AREANAME PAGENAME and the main layouts in app View Layouts However please be advised that any custom changes to the default layout will be lost if you decide to upgrade ClientEngage Visitor Chat in the future Therefore it is advisable that you keep a list of all your custom changes to enable you to merge them back into the system after updating Furthermore there are free merge utilities which may be able to help you in this respect ClientEngage Visitor Chat User Manual 7 Helpful Resources If your system fulfils the minimum requirements then you should have no problems in running ClientEngage Visitor Chat However some developers may wish to adapt ClientEngage Visitor Chat There are some helpful resources that may help you accomplish this First and foremost you should have good knowledge of general web development practices and in particular PHP 5 You may also wish to check out the documentation of the amazing PHP Framework on basis of which ClientEngage Visitor Chat is built CakePHP The best place to learn about CakePHP is to visit http www cakephp org and in particular the documentation under http book cakephp org
11. cccccsssccccesscccceeececeeecccseecesseueeeseusseessseessanseesees 6 A A Installation Procedure cccccsssssccsosssssecscsssssccscesessccscesessecsccssssecscessssecscesssssencesssseencesssscensesssseess 8 4 5 Changes to Database Credentials cccccccsssccccssscccesecccseecccceuscesseseecseuecessauecessaueeeseeeessaneeess 11 4 6 Windows based Client Installation ccccccccssssscccccesseccecceeseceeeeeesececeeeeeeceesseaeceeseeaeeeessugaeeeeees 11 5 Using ClientEngage Visitor Chat cscsccccscssscsccscscsccccccscsccccccscnceccccecscscescecscscescecscscesessecs 12 5 1 Including the Chat on your W COS ICC xg cecccessasacccxeensaechrsucsncvensseeatecencunesupeciaceeebaecantadsereuceadvarsaeecbeal 12 Sd System Conner aO oseon E a a aR E E ana 12 93s Creating NEW Chat Sy OS issiran nesia santana S DE A Ei i EEE 12 A Cone OMETE a E nase evan ecstnes 12 5 5 Using the Windows based Client w cc ssvsrccsceusswenssatscnesavtncenseseedecdussaessandusnnsandonsssthbbedsstedeesssaviaceetias 13 DOs REVIEWING Past DISCUSSIONS ws cccsscotssmuscceesedncataactietatdaineuateinaniaceaaudteatdnuendamsanuecendsdusaantannseatdeuetanedntant 13 ade MEIC LIN SS crs astatscuste eateaaicies tates eoseaa E nested anu otteirae eu eiad E ane meses 13 Os General NO Wiel aesae e a ea Ea 13 6 Extending ClientEngage Visitor Chat sccscscsecscscscsccccscsccccccscsceccccecscsccececscscescececscesescecs 14 6 1 Translating ClientEngage Vis
12. cessary configurations before you start using ClientEngage Visitor Chat 4 5 Changes to Database Credentials If you change your database login information then you have to reflect these changes in the following file app Config database php 4 6 Windows based Client Installation Simply double click the installer s EXE file ClientEngage Visitor Chat exe and follow the installation instructions If the correct NET Framework is not installed on your machine Visitor Chat will download and install it for you If you are updating from an earlier version uninstall the old one first After the installation you will be asked to provide your Envato purchase details After you have activated the Windows based client you simply need to enter your credentials Simply start the Windows based client and enter your credentials First you need to get the API Endpoint from your system s configuration section in Administration gt Configuration Simply paste the Endpoint URL and type your ClientEngage Visitor Chat email and password ClientEngage Visitor Chat User Manual 5 Using ClientEngage Visitor Chat 5 1 Including the Chat on your Website Simply navigate to Administration gt Configuration and copy the JavaScript snippet Now please insert it into the website where you wish to use the Visitor Chat If you are using jQuery please insert it after you include jQuery if jQuery is not available on your website
13. ers and can start chatting straight through the and more Windows based client e Unlimited number of administrators e The chat disappears to your system tray e Easy to translate until you have a visitor opening the chat Adaptable Templates amp Translations Easy Integration amp Use e Have a chat that fully blends with the e Simple copy amp paste integration of your look and feel of your website feedback survey into any website just copy e Comes with four pre defined colour a brief JavaScript code into the respective schemes site s HTML template e You can create an unlimited number of e Automated installation script no new chat styles and you have full extensive knowledge of PHP MySQL control over the CSS necessary e All visitor facing texts can be easily e Detailed handbook with installation amp use changed instructions e Extensible the system is developed with the CakePHP MVC framework and features a clean architecture This means that if you have web development experience the system is easily extensible ClientEngage Visitor Chat User Manual 2 System Requirements In order to be able to use ClientEngage Visitor Chat you must fulfil the following system requirements e Apache 2 HTTP Server e MySQL with a version of greater than MySQL 5 i e with InnoDB support e Preferably asubdomain domain for use with ClientEngage Visitor Chat e Safe mode off e Enough server resources for the number of concurren
14. ion Files Since you may have added your own custom translations of the ClientEngage Visitor Chat or you may have adapted the existing translation files you need to perform the following steps so as to be able to keep your changes 1 Do not overwrite the Locales directory in app Locale with the one in the ClientEngage UPDATE directory you can do this by deleting it from the update directory before moving ClientEngage UPDATE to your server 2 After finalising the update simply open each of the translation files such as app Locale deu LC_MESSAGES default po with Poedit and select Catalog gt Update from POT file 3 Next please select app Locale default pot you can now update any new translation strings that were added since the last version of ClientEngage Visitor Chat ClientEngage Visitor Chat User Manual 4 Installation 4 1 System Upload Upload the contents of the directory ClientEngage System to your webserver You should now have the following directory structure on your webserver app lib plugins EEE amp vendors _ htaccess index php __ README txt For best results you should run ClientEngage Visitor Chat under a domain or subdomain If you wish to do this then you should point not redirect your domain to the following directory If you are using an Apache server you can accomplish this by setting the DocumentRoot directive to the aforementioned d
15. irectory If you do not have access to your server s configuration your domain management interface should provide you with a setting that allows you to point your domain subdomain to this directory It is recommended to run ClientEngage Visitor Chat from a domain subdomain pointed to the webroot directory since this keeps all of the system s files outside of the document root 4 2 Setting File Directory Permissions You have to ensure that the following directories as well as subdirectories and all files and directories contained therein are writable e Temporary Directory app tmp e Configuration Directory app Config 4 3 Accessing the Automatic Installation Tool You can now access ClientEngage Visitor Chat by navigating your browser to your ClientEngage Visitor Chat installation such as http chat example com If you do not encounter any errors please carry on reading at 4 4 If you see an error and are using GoDaddy as your webhost please perform this change on your app webroot htaccess file If you do not use GoDaddy and you receive an Internal Server Error then it is likely that your webserver mod_rewrite is not correctly configured In this case please use a ClientEngage Visitor Chat User Manual Next ee line 16 from this ROOT app webroot htaccess Now please access the installation tool under the following address http chat example com index php If you use this method your C
16. itor Chat ccccsssccccssscccessecccsscceseusceceeuecesseeseesauecesseuseeseaesessaaees 14 6 2 Customising HIML Templates stip vac cucecdienrancoceeneacctersesncesusent seen EEEEA 14 7 Helpful ReSourceS sessssessssesessecsssessssscsssesessecesssossssossososessossosoesosossssossssossssoesssossssoesssseoe 15 8 When Encountering Problems occevccsvecenicovesevevensseunsenececesesesntceceseestevseves ceawaveecsnveentesueceuteresss 15 9 Feedbackis WEICOMIC s isscsisirrrasniiricr nes erren oinin n aare E E ENEAN N NESEN 15 10 Third Party Components Creits ccccccscsceccccscsceccccccsceccccecscsccccecscsceccecscscececcecsceseececces 16 O al a EA EEN aa EE E EAA AE E A EE T E ET A EEE EE AT 16 MU VO OES AO P PEAN A AE E Si E E O A E A E T E 16 jQuery 16 famtamfam ICONS psesscnntactinecasiasindedsantioedienantindan taatindea stavledutbenbinddensatlnduatiasindcastasadethacknesasaatndcatiaindaasasiedaeatnedeneat 16 TDCI OI OGh SI OMI OI vase e E a E TE EA AEA ENEE E A EENAA E E EE 16 CYD 0 0 fC Traa E E E AOO A E A A E O AE 17 Cod T aa E E EE E A E AEE AEA E E A E 17 php user aganla a a aa aa a e 17 TT ee E E E E A E eae aeedciaets 17 ClientEngage Visitor Chat User Manual 1 About ClientEngage Visitor Chat The ClientEngage Visitor Chat is a fully featured real time chat for your websites A clear and simple web based administration allows you to conveniently chat with your visitors And best of all Visitor Chat come
17. itors In case a visitor has manually exited the chat or timed out after 15 minutes of inactivity a small X icon will be shown this enables you to clear out finished discussions If you wish to go offline you simply need to click the Online button in your main menu If you are online your visitors will be shown the Enquiry form instead of the live Chat sign up form ClientEngage Visitor Chat User Manual 5 5 Using the Windows based Client Simply start the Windows based client and enter your credentials First you need to get the API Endpoint from your system s configuration section in Administration gt Configuration Simply paste the Endpoint URL and type your ClientEngage Visitor Chat email and password If you minimise the client it will be placed in your system tray You will be notified of any new chats through a Balloon Tooltip as well as a non intrusive notification sound When minimised the client will check for any new messages with a 10 second interval this will be increased to a 3 second interval whilst you are in an active chat session Similarly to the web based client you can rotate through all active discussions via a tab control 5 6 Reviewing Past Discussions Under Past Discussions you can find a paginated list of all your past discussions for future reference You can sort by a variety of fields to make it easier for you to find the right discussion you are looking for
18. lientEngage Visitor Chat installation will always be available under the aforementioned address ClientEngage Visitor Chat User Manual 4 4 Installation Procedure You can now access ClientEngage Visitor Chat by navigating your browser to your ClientEngage Visitor Chat installation such as http chat example com You should now see the following screen ClientEngage g iti 1 l l I i j Installation Steps Requirements Your temporary directory is writable C xampp htdocs wisitervoice_demo app tmp Your configuration directory is writable C xampp htdocs wisiterveice_demo app Confie Your security configuration is writable C xompp htdocs wisitervoice_demo app Confipsecurity core php The PHP version running on your server 5 3 5 fulfills the minimum requirement 5 2 8 The PDO extensions are loaded This is the end user license agreement for ClientEngage Visitor Voice hereafter referred to as SOFTWARE PRODUCT Please read the terms and conditions of this license agreement carefully before continuing with this installation ChentEngage s End User License Agreement EULA is a legal agreement between you either an individual or a single entity and ChentEngage for this software product s L agree to the above terms Begin Installation If your system fulfils the requirements you can commence the installation process after reading and accepting the end user license agree
19. ment In the next screen please enter your database details the port is optional It is important that you create the database before entering your details Collation utf8_ unicode_ci Database Host localhost TCP Port UNIX Socket Database Username Password Database Name clientengage Table Prefix ce ClientEngage Visitor Chat User Manual Visitor Chat Click Continue If the details you entered are correct you will see the following screen 3 ClientEngage Installation Steps Requirements Database Setup Database initialisation System Settings Administrator Finalisation Completed You have successfully configured the database connection Please click Initialise Database to create all necessary database tables Initialise Database Click Initialise Database and wait for the process to finish Now select your language setting and click Continue The database has been successfully initialised ClientEngage Installation Steps Requirements Database Setup Database initialisation System Settings Administrator Finalisation Completed system Settings System Language English British Sunday 7 March 2013 ClientEngage Visitor Chat User Manual You can now create your administrative user in the following form Installation Steps Requirements Database Setup Database initialisation System Settings Administrator Finalisation Completed Admini
20. s with a Windows based client out of the box Without having to visit the Visitor Chat s admin interface you will be notified from your Windows tray and can start chatting straight away By including one single snippet of JavaScript this interactive and engaging Chat can be used on any website whether you are using Wordpress Joomla or plain HTML The Visitor Chat will give put you at your clients and visitors fingertips at those times when they have burning questions turning your prospects into your future paying customers Not around for 16 hours of the day No problem Visitor Chat will go into enquiry mode and collect all enquiries in an easily navigable format where you can mark enquiries as read unread to stay on top of things Moreover the chat system presents you with up to date information on the people you talk to where have they come from What page are they on Which browser and OS are they using What time is it at their end Visitor Chat answers all of those questions for you With ClientEngage Visitor Chat you will get to the heart of what your visitors clients think 1 1 Functionality Overview Fully Featured Chat for your Website Windows based client included e Non intrusive chat for your websites e Don t want to keep a browser window open e Clear administrator chat interface all day long e View additional metadata of your e You are notified of new visitors in real time visitors pages they are on referr
21. strator Settings Username John Doe Email johngclentengage com Password Confirm Password Finalise Installation Please ensure that you remember the email address and password you choose you will need these to log into the system Click Finalise Installation when you are done You have now reached the final step of the installation process The administrator has been created ClientEngage installation Steps Requirements Database Setup Database Initialisation System Settings Administrator Finalisation Completed Perform Final Configurations Sunday 7 March 2013 ClientEngage Visitor Chat User Manual Click Perform Final Configurations and wait for the process to finish If the installation process was successful you will be automatically redirected to your log in screen The login will always be accessible at http chat example com login Please type in the email address and password of the administrator you created during the installation process ei ClientEngage Login Email Password After logging in successfully you will see the administration panel and you can begin using ClientEngage Visitor Chat to gather invaluable feedback from your visitors ClientEngage Discussions Past Discussions WEnquiries gf Administration Offine John Doe The first thing you should do is to navigate to Administration gt Configuration in order to perform any ne
22. t chatters you expect e Finally the PHP PDO extensions have to be installed PDO amp PDO MySQL Furthermore you have to ensure that the following directories as well as their subdirectories and the files contained therein are writable Pepe raly Inecroly app tmp ROME ANOA app Config e Upload Directory app uploads A note on server performance This chat system employs AJAX technologies and does not rely on WebSockets for its communication This means that anyone can run Visitor Chat as long as your server fulfils the requirements outlined below However this also means that this system is not intended for heavy duty use so don t build the next Facebook and try to have 10m people use this at once That being said on average server specifications there is nothing stopping you from having 10 15 concurrent conversations System requirements of the Windows based client e NET4 Framework will be installed if not already available e Windows XP Windows Vista Windows 7 Windows 8 ClientEngage Visitor Chat User Manual 3 Updating from an Earlier Version 3 1 Updating Procedure If this is your first time installing ClientEngage Visitor Chat please continue reading on page 6 lf you are updating from an earlier version of ClientEngage Visitor Chat then please follow the following steps 1 Important Create a full backup of your system files and database Upload the contents of the directory ClientEngage UPDA
Download Pdf Manuals
Related Search