Add AtomChat to your Woltlab Suite website

Modified on Fri, 28 Oct 2022 at 12:51 PM

Before you begin


1. Signup for a free trial (if you haven't already)

First select a plan from the AtomChat Free Trial page, enter your email address and start your free trial.

2. Note your API keys


Sign in to your AtomChat Client Area and click on the Manage button and then note down the keys present in API Keys (top right button) section - API Key, Auth Key, License Key and App ID. You may need these during installation.

3. Secure your environment 

For successful integration, please ensure your domain or local environment is SSL certified and secure.

AtomChat Admin Panel
AtomChat Admin Panel



Choose a Layout

AtomChat offers 2 Layouts
1. Docked Layout creates a floating chat widget at the bottom right/left corner of your website.
2. Embedded Layout embeds a chat interface inside any page of your website

And please remember!
AtomChat layouts are not designed to be used together on the same page. If you add both layouts on the same page, please expect erratic behavior from the software. 




Setting up Docked Layout 


                   Docked Layout
                   Docked Layout

Please copy the code given below and replace APP_ID and AUTH_KEY with your unique keys.

Then follow the instructions given in the section - "Where to add this code?"

<script>
var chat_appid = 'APP_ID';
var chat_auth = 'AUTH_KEY';
</script>
<script type="text/javascript">
 var chat_id = "{@$__wcf->user->userID}";
 var chat_name = "{$__wcf->user->username|encodeJS}";
 var chat_link = "{@$__wcf->user->getLink()}";
 var chat_avatar ="{@$__wcf->getUserProfileHandler()->getAvatar()->getURL(128)}";
</script>
<script>
(function() {
    var chat_css = document.createElement('link'); chat_css.rel = 'stylesheet'; chat_css.type = 'text/css'; chat_css.href = 'https://fast.cometondemand.net/'+chat_appid+'x_xchat.css';
    document.getElementsByTagName("head")[0].appendChild(chat_css);
    var chat_js = document.createElement('script'); chat_js.type = 'text/javascript'; chat_js.src = 'https://fast.cometondemand.net/'+chat_appid+'x_xchat.js'; var chat_script = document.getElementsByTagName('script')[0]; chat_script.parentNode.insertBefore(chat_js, chat_script);
})();
</script>
NOTE:
Please replace the "APP_ID" and "AUTH_KEY" values in the code with your own Keys from your AtomChat Admin Panel -> API Keys

Where to add this code?

Goto your Woltlab Suite project and edit your templates/footer.tpl file.


Setting up Embedded Layout 


               Embedded Layout
               Embedded Layout

Please copy the code given below and replace APP_ID and AUTH_KEY with your unique keys.

Then follow the instructions given in the section - "Where to add this code?"

<script>
var chat_appid = 'APP_ID';
var chat_auth = 'AUTH_KEY';
</script>
<script type="text/javascript">
 var chat_id = "{@$__wcf->user->userID}";
 var chat_name = "{$__wcf->user->username|encodeJS}";
 var chat_link = "{@$__wcf->user->getLink()}";
 var chat_avatar ="{@$__wcf->getUserProfileHandler()->getAvatar()->getURL(128)}";
</script>
<script>
var chat_height = '600px';
var chat_width = '990px';

document.write('<div id="cometchat_embed_synergy_container" style="width:'+chat_width+';height:'+chat_height+';max-width:100%;border:1px solid #CCCCCC;border-radius:5px;overflow:hidden;"></div>');

var chat_js = document.createElement('script'); chat_js.type = 'text/javascript'; chat_js.src = 'https://fast.cometondemand.net/'+chat_appid+'x_xchatx_xcorex_xembedcode.js';
chat_js.onload = function() {
    var chat_iframe = {};chat_iframe.module="synergy";chat_iframe.style="min-height:"+chat_height+";min-width:"+chat_width+";";chat_iframe.width=chat_width.replace('px','');chat_iframe.height=chat_height.replace('px','');chat_iframe.src='https://'+chat_appid+'.cometondemand.net/cometchat_embedded.php'; if(typeof(addEmbedIframe)=="function"){addEmbedIframe(chat_iframe);}
}
var chat_script = document.getElementsByTagName('script')[0];chat_script.parentNode.insertBefore(chat_js, chat_script);
</script>
NOTE:
Please replace the "APP_ID" and "AUTH_KEY" values in the code with your own Keys from your AtomChat Admin Panel -> API Keys

Where to add this code?

Goto your Woltlab Suite project and edit your templates/footer.tpl file.

Contact Sync

Your users will be visible on the contact list once they login using their credentials again to the site after installation.


Security 


IMPORTANT

Before you go live, follow our our security guide to ensure your integration is secure.



Congrats!! You are all set to start using AtomChat!

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article