UCxChat

Chapter 1 - Introduction

UCxChat is a web-based chat service provided on the UCx Server that is ideal for companies wanting to privately host their own chat service.

To access UCxChat from a web broswer, enter the IP address or hostname of the UCx Server followed by ' :4020 '.

For example: http://192.168.1.200:4020

Chapter 2 - Rooms

Conversations in UCxChat are organized into chat rooms, there are 3 different types of rooms:

  1. Channels
  2. Direct Messages
  3. Private Groups

Channels

Channels are public, used for conversations that are open to all users to join. New users joining the channel can read all information previously published on the channel.

Channels are useful for sharing information with your users, for example, you can create a "Help" channel to share tips on using UCxChat.

To create a channel, type the following command in the message text box:

/create #channel_name

Direct Messages

Direct messages are private one-to-one conversations between two users. When you send a chat message to another user, it is automatically a direct message.

To start a direct message with another user, go to DIRECT MESSAGES on the left-hand panel, click on "More Users..." link to see all users, then select the user.

Private Groups

Private groups are private, not open to the public. It is visible only to their members. Private groups can be joined by invitation only.

The administrator sets the permissions that determine who can invite others to a private group. By default, only administrators, room owners, and moderators can invite others to join a private group.

To create a private group:

  1. First create a public channel
  2. Click on   located on the Right Icon Menu.
  3. Enable the Private settting.

To invite users to the group, enter the following command:

/invite @username

Chapter 3 - Room Operations

The various rooms are listed on the left-hand navigation panel and organized according to their types.

Favorites

To favorite a channel, click on the star icon in the upper left corner of the message area (next to the room name).
 
The star is then highlighted. To unfavorite a channel, just click on the star icon again.
 
Highlighted channels are listed under Favorites on the left-hand panel. 

Joining channels

Your channels are listed on the left-hand pane under CHANNELS(X), where X represents the number of channels you have joined.
To view all available channels, click on the "More channels..." link.
Click on a channel to preview its contents. If you want to join it, click on the JOIN button.

Hiding and leaving channels

When you hover your mouse over a channel listed on the left-hand pane, you will see two icons appear to the right of the channel name: JOIN Hide_room and Leave_room.
To hide a room is to remain a member of the channel but to remove it from your list of channels on the left-hand pane.
To leave a room is to no longer be a member of the channel.
Click on the corresponding icon to "hide" or "leave" a room.

Chapter 4 - Messaging

Sending

Sending chat messages is simple:

  • First select the channel, user or private group from the left-hand panel
  • Then type your message in the message box and press the Enter key or the Send  button.

If you want to insert a new line without sending the message, press Shift+Enter.
Emojis can be added to your message by clicking on the emoji icon located on the left of the message box.

Mentions

You can "mention" someone by typing @ followed by their username, for example @john. Enter @ and start typing the username, a drop-down list will appear where you can select the desired user.

A user can be selected from the list by clicking on the username or using the keyboard arrow keys to scroll up and down then select by pressing the tab key.

When someone is mentioned in a room, they will get a desktop notification and also a badge count beside the room name if they are not already in the room.

Each of your mentions are also listed in the Mentions list when you click on    located on the Right Icon Menu.

Attachments

To upload a file, there are 2 options:

  • Click on the paperclip icon and select the file, enter a description and click OK to upload.
  • Drag and drop the file onto the message box.

For each uploaded file, you can edit the file name and add a description. A number of file types are supported including images, videos, audio files, pdfs, and office documents.
 

Other Functions

You can access other messaging functions by hovering over the message, then click on the Gear  icon that appears, an expanded list of functions is then displayed: 

The messaging functions supported by UCxChat include:
 Delete - you will be prompted to confirm deletion of the message
 Star - message will appear in the Starred Messages list that only you can see
 Pin - message will appear in the Pinned Messages list for everyone in the room to see
 Emoji reaction - you will be prompted to select an emoji and the selected emoji will appear beneath the message

Chapter 5 - Right Icon Menu

Located on the right side of the screen, there is an icon menu that provides quick access to the following functions:
  • IM Mode / Rooms Mode toggle
  • Info
  • Search
  • Members List or User Info
  • Notifications
  • Files List
  • Mentions
  • Starred Messages
  • Pinned Messages

IM/Room Mode toggle  

When in Room mode, the functions and icons related to rooms are visible and this is the default mode. When you toggle to IM mode, only direct messaging is available.

Info 

Displays information and settings for the Room. You can change the room settings here and also delete the room.

Search 

The Search function is currently not supported.

Members List or User Info  

Displays the list of members who have joined the Channel or Private Group. For Direct Messages, it displays the User information.

Notifications 

Displays the notification settings for the room.

Files List 

Displays the list of attachments that have been uploaded for the room.

Mentions 

Displays the list of messages where you have been mentioned.

Starred Messages 

Displays the list of starred messages. Starred messages are personal, only you can see them.

Pinned Messages 

Displays the list of pinned messages. Pinned messages are public, can be viewed by all members of the room.

Chapter 6 - Slash Commands

Some of the functions are accessed by typing '/ ' followed by the command in the message text box. To view a list of available commands, simply type `/ `and you can select from the list displayed.
Here is a list of the more commonly used commands:

Command Description
/create #channel To create the specified channel.
/join #channel To join the specified channel.
/leave To leave this channel.
/invite @username To invite a user to join this room.
/invite-all-to #room To invite all from this room to join the specified room.
/invite-all-from #room To invite all from the specified room to join this room.
/kick @username To remove a user from this room.

Chapter 7 - FAQ

Can we send SMS text messages from this tool?

No, not yet. This is a future enhancement.

Can you control the audio notification?

You can control the audio notification under your account preferences or via the notification settings for a specific room. There is no volume control.

How is the hashtag used here compared to the twitter/instagram/snapchat world?

The hash is a prefix to a room. When used in a message it is prepended to a valid room name, this allows a single click to get to the room. For example, you can write "... check out #general
for general discussions...".

Page Tags: 
ucc
ucxchat
chat. user guide