Setup guide for Salesforce admins

Post Installation Guide

After installing the ChatTime package, six steps make chat available to your users: access, the utility bar, mobile, the license, settings, and a quick test.

Before you start

You need to be a Salesforce administrator in the org where ChatTime is installed.

  • Lightning Experience with at least one Lightning app. ChatTime does not work in Salesforce Classic.
  • Users on a Salesforce or Salesforce Platform license. External (community) users are not supported.
  • The package installed. Under Setup → Installed Packages you should see ChatTime with the namespace sftime.
  • For phones: the Salesforce mobile app.

In a sandbox or Developer Edition org ChatTime is free and needs no license key, so you can skip Step 4 there.

Step 1

Give people access

ChatTime comes with two permission sets. Nobody can use chat until they have the first one.

Permission setWho gets itWhat it allows
ChatTime UserEveryone who should chatUsing chat on desktop and mobile
ChatTime AdminYou, and anyone else who administers ChatTimeThe ChatTime License tab, entering a license key, and license notices. It gives no extra rights inside chats

An admin who also wants to chat needs both.

To assign to one user: Setup → Users → open the user → Permission Set Assignments → Edit Assignments → add the permission set → Save.

To assign to many users: Setup → Permission Sets → ChatTime User → Manage Assignments → Add Assignment → select the users → Assign.

Chats are private to their members. Being an admin, or having ChatTime Admin, does not let anyone read other people's conversations through the chat.

Step 2

Add Chat to the utility bar

On desktop, chat lives in the utility bar at the bottom of a Lightning app. Add it to every app your users work in.

  1. Setup → App Manager.
  2. Find the app, click the arrow at the right of its row, and choose Edit.
  3. Open Utility Items (Desktop Only) and click Add Utility Item.
  4. Choose Chat from the list.
  5. Enter the settings below and click Save.
SettingValueWhy
LabelChatIt changes to "Chat (3)" by itself when there are unread messages
Iconchat
Panel Width360
Panel Height480
Start automaticallyCheckedWithout it, unread counts, live messages and the sound only start after the user first opens the panel

Users see the new item after they refresh the page.

Console apps: a console app (such as Service Console) can only be opened by users whose Salesforce license allows console apps. Users on a Salesforce Platform license usually cannot. Give those users Chat in a standard app, or the Chat tab from Step 3.

Step 3

Set up mobile

The Salesforce mobile app has no utility bar, so on phones chat is a tab. Skip this step if nobody uses the mobile app.

Add the Chat tab

  1. Setup → App Manager → the app your mobile users use → Edit. It must not be a console app; console apps do not run on phones.
  2. Open Navigation Items.
  3. Move Chat from Available Items to Selected Items and click Save.

Users then find Chat in the menu of the Salesforce mobile app. The same tab also works on desktop, as a full-page chat.

Push notifications

When a message arrives, the other members of the chat get "New message from [name]" on their phone, and tapping it opens that conversation. For this to work, the Chat Message notification has to be made available to the Salesforce mobile app:

  1. Setup → Quick Find → Notification Delivery Settings.
  2. Under Custom Notification Types, find Chat Message, click the arrow at the right of its row, and choose Edit.
  3. Make sure the Mobile channel is selected, and select the Salesforce mobile apps (Salesforce for iOS and Salesforce for Android) under the supported applications.
  4. Click Save.

Good to know:

  • A person gets at most one push per chat every 2 minutes, so a burst of messages does not buzz repeatedly.
  • A person who muted a chat gets no push for it.
  • Each user must allow notifications for the Salesforce app in their phone's settings.
Step 4

Activate the license

ChatTime is licensed per user. In a production org a 30-day free trial starts the first time anyone opens Chat, with no limit on users. Enter a license key before it ends.

ChatTime is free for up to 10 users. A free team also needs a license key, which costs nothing: follow the steps below and ask for a key for up to 10 users. For more than 10 users the price is $2 per user per month for all users, billed annually.

  1. Make sure you have the ChatTime Admin permission set (Step 1).
  2. Open the App Launcher and search for ChatTime License.
  3. Copy Your org ID from that page and send it to [email protected], with the number of users you need.
  4. When you receive the license key, paste the whole key into License key and click Save license key.

The page then shows the status Licensed, the valid-until date, the number of licensed users, and how many users currently have Chat access. A key works only in the org it was made for.

SituationWhat happens
Sandbox or Developer Edition orgFree. No key, no user limit
Trial, 30 days from first useEverything works. ChatTime admins see the days left
Licensed, within the number of usersNothing visible
More users have Chat access than licensedThe users who were given access first keep working. The most recently added ones see "No ChatTime seat is available for you". You see both numbers
License expired, first 14 daysChat keeps working. ChatTime admins see a warning
License expired more than 14 days, or trial over with no keyChat is read-only for everyone: messages can be read, nothing can be sent

To free a seat, remove ChatTime User from someone, or deactivate the user. The next person in line gets the seat within a few minutes.

To add users or renew, email [email protected] for a new key and enter it the same way. It replaces the old one.

Nothing is ever deleted or hidden because of licensing. In read-only mode all conversations stay readable, and chat works again as soon as a valid key is entered.

Step 5

Review the settings

ChatTime works with its defaults. Change a setting only if your company needs something different.

Where: Setup → Custom Metadata Types → Chat Setting → Manage Records → Default → Edit. Open chats pick up a change within 5 minutes.

SettingDefaultWhat it does
Retention Days30Messages and their files older than this are deleted every night. Blank or 0 keeps them forever
Allow Message EditOnUncheck so users cannot edit their own messages
Allow Message DeleteOnUncheck so users cannot delete their own messages
Edit/Delete Window (minutes)15How long after sending a message can be edited or deleted. Blank means no limit
Allow AttachmentsOnUncheck to turn off file attachments
Max Attachment Size (MB)10Largest file that can be attached
Allowed File TypesImages, PDF, Office files, txt, csv, zipComma-separated extensions without dots. Files are not virus-scanned, so keep executables out
Real-Time ModeAutoHow open chats learn about new messages (see below)
Auto Switch At (%)70In Auto mode, the share of the org's daily platform event deliveries at which chat switches to polling
Push Throttle Minutes2A person gets at most one push per chat within this many minutes

Leave Chat Tab API Name as it is. It is set by Salesforce Time.

The two decisions worth making

Retention. Messages are deleted for good after the retention period, including from the Recycle Bin. Check the number against your company's record-keeping rules before users start chatting. The cleanup runs every night at 2:00 AM through the flow Chat Retention Cleanup; change the time or pause it under Setup → Flows.

Real-time mode. Leave it on Auto unless you have a reason to change it.

LivePolling
New message in an open chatInstantWithin about 5 seconds
Unread badge and sound while minimizedInstantWithin about 30 seconds
Mobile push notificationInstantInstant
Uses the org's daily platform event allowanceYesNo

Auto uses Live and switches to Polling by itself when chat would use too much of the org's platform event allowance, which is shared with your other apps and integrations. Choose Polling if you want chat to use none of it.

Change or translate the wording

Every piece of text ChatTime shows is a Custom Label: button names, notices, error messages, the emoji category names and the push notification text. You can reword any of them, or translate them into the languages your users work in, without changing the product.

  1. Setup → Quick Find → Translation Workbench → Translation Language Settings. Enable Translation Workbench if it is not on, and add the languages you need.
  2. Setup → Translation Workbench → Override.
  3. Choose the package ChatTime, the language, and the setup component Custom Label.
  4. Find the label, enter your wording in the override column, and save.

The labels all start with Chat_, for example Chat_Message_Placeholder for "Write a message…". To reword the English text, choose English as the language. Users see a change after they refresh the page.

Some labels contain placeholders such as {0}, which ChatTime fills in with a name or a number. Keep them in your wording.

Step 6

Check that it works

Test with two users before you tell everyone. Use a second browser, a private window, or Setup → Users → Login to act as the second user.

If any of these fails, see Troubleshooting below.

Troubleshooting

What you seeLikely causeWhat to do
"You don't have access to Chat" in the panelThe user does not have ChatTime UserAssign the permission set (Step 1)
Chat worked for a user and then disappearedThe user's Salesforce license or profile was changed, which removes permission setsAssign ChatTime User again
"No ChatTime seat is available for you"More users have Chat access than the license covers, and this user was added lastRemove access from someone who does not need it, or email [email protected] for more users
A notice that chat is read-only, and no message boxThe license expired more than 14 days ago, or the trial ended without a keyEnter a valid license key on the ChatTime License tab
"This license key was made for a different org"The key belongs to another org, for example production instead of this oneSend [email protected] the org ID shown on the ChatTime License tab
"This license key is not valid"The key was cut off or changed when copiedPaste the whole key again, exactly as received
Chat is not in the utility barIt was not added to this app, or the page was not refreshedAdd it (Step 2) and refresh
No unread count or sound until the panel is opened"Start automatically" is not checked on the utility itemEdit the utility item and check it
Messages arrive after a few seconds, not instantlyChat is in polling modeNormal in Polling mode, and in Auto mode on busy days. Messages are not lost
No soundThe browser blocks sound until the user has clicked on the page, or the user muted itClick anywhere in Salesforce; check the speaker button next to the people search
No push notification on the phoneChat Message is not enabled for the Salesforce mobile app in Notification Delivery Settings, notifications are off for the Salesforce app on the phone, the chat is muted, or a push for that chat was sent in the last 2 minutesCheck Notification Delivery Settings (Step 3), the phone's notification settings and the chat's mute state
Tapping a push does not open the chatThe Chat tab is not available to the user in the mobile appAdd the Chat tab to the app's navigation (Step 3)
A user cannot open the app that has ChatIt is a console app and the user's license does not allow console appsAdd Chat to a standard app, or use the Chat tab
An old version of the chat appears after an upgradeThe browser cached the previous versionHard-refresh: Cmd+Shift+R on Mac, Ctrl+Shift+R on Windows
A file is rejected when attachingIts type is not in Allowed File Types, or it is larger than Max Attachment SizeChange the settings (Step 5) if the file should be allowed
Old messages are goneRetention deleted them after the configured number of daysExpected. Raise Retention Days for the future; deleted messages cannot be restored
Need a hand?

We're happy to help with setup.

Send us your question, or your org ID and user count for a license key.

Email [email protected]