The Now Platform® Washington DC release is live. Watch now!

Help
cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 
Samyuktha Reddy
ServiceNow Employee
ServiceNow Employee

Sidebar FAQ’s:

 

Table of content:

1. Sidebar

2. Available Features

3. Sidebar is different than Connect Chat

4. Status of Connect Products

5. Install Sidebar plugins

6. Advanced Configuration

7. Useful resources

8. For more information

9. Where can I learn more about Workspace?

10. Community Forum

 

Sidebar

What is Sidebar?

–     Sidebar is a new collaboration framework in Next Experience. It enables Workspace Agents to have discussions with a specified group of people (agents or SMEs) to quickly resolve any ServiceNow task-based record or interaction record including cases, incidents, etc.  Discussions allow agents to triage tickets, and exchange information and knowledge to help resolve Cases, Incidents, Problems, and Tasks, faster and with higher-quality outcomes. 

 Some of the highlights are: 

  • Agents to discuss and chat within the context of the case or interaction, and share information including relevant attachments, knowledge base, or files for faster resolution with higher quality outcomes.
  • Agents can Search to quickly find items across discussions
  • Record Based discussions
  • Posting messages to Activity Stream
  • Favoriting discussions
  • Configurable Quick Actions
  • Search through discussions
  • Emojis
  • Notifications and @mentions 
  • Sidebar with Teams Integration

Our Sidebar product documentation here

When is Sidebar available for Customers?

–     Sidebar is available if Next Experience is enabled. 

–     Sidebar shares front end dependencies with Agent chat and Virtual Agent web client and these dependencies are on the family release. Outside of these dependencies, Sidebar is released as a store app in Tokyo. For Tokyo, Sidebar does not install OOTB, and customers will have to install the store app but starting in Utah the store app should be installed OOTB for all customers.  

 

Available Features

 

What are the features that are available with Sidebar?

–     Features include: 

  • Single/Multi discussions on a record
  • Utility Menu and Docked Chat Windows
  • Activity Stream conversation Tile
  • Posting messages to Activity Stream
  • Favoriting Conversations
  • Configurable Quick Actions
  • AI Search
  • Drag and drop file sharing
  • Emojis
  • Notifications and @mentions  
  • Sidebar with Teams Integration
  • Add Sidebar Discuss button for non supported Workspaces

 

What is meant by Record based conversations?

–     An agent can initiate a group discussion from a task or interaction-based record. Only one discussion can be created per record at any given time till Utah. From Vancouver onwards multiple discussions can be created on a record.  Find the Youtube Demo Video for multi discussions.

–     An agent fills out preliminary information and context for the discussion. 

–     An agent adds other agents or users subject matter experts to help with the record. 

 

Is this feature visible to the customer?

–     This feature will be visible to all logged in users when the Next Experience is enabled. However, users can only join chats if they have read access to the associated parent records. In addition to inheriting ACLs of the task-based record that it was created from, Admin can configure user queries to limit the users who have access to Sidebar Discussions. 

 

Is Sidebar connect with Teams users?

Yes, starting from Utah Sidebar can be integrated with Teams to add Teams users as participants in Sidebar discussions. Teams user can see all the participants in the discussions and exchange messages, emoji's and file. Sidebar discussions with Teams users are always initiated by Sidebar users only. Find Sidebar Teams overview here

 

                              Sidebar             <----------------------------------------->            MS Teams

SamyukthaReddy_1-1680710939876.png                      SamyukthaReddy_0-1680710931224.png

 

 

What steps to follow for Sidebar Teams integrations?

Follow these steps to integrate Sidebar and Microsoft Teams:

  1. Install the February store app on the Utah instance.
  2. Create the Microsoft Teams developer account and Azure app. See KB article KB1225842 for more information.
  3. Create the Microsoft Teams app. See KB article KB1225842 for more information.
  4. Enable the Microsoft Teams integration in Sidebar console using the information in Enable the Microsoft teams integration.

 

Sidebar is different than Connect Chat

 

Is Sidebar works along with Connect Chat and Connect Support?

–     No. Connect Chat or Connect Support should not be used along with Sidebar at the same time. Connect Chat and Connect Support are not supported by Next Experience. 

 

Is Sidebar an alternate product for Connect Chat and Connect Support?

–    Sidebar is not an alternate solution to Connect Chat but some of the features are like Connect Chat. Sidebar is more advanced than Connect Chat.  

–    There is no migration path, Connect Chat and Sidebar cannot be used at the same time.

–    Connect Support is not related to Sidebar. Workspace Agent Chat is the alternate solution to Connect Support.

 

Status of Connect Products

 

What is the status of Connect Chat and Connect Support?

–    Connect Chat is in maintenance mode and no new enhancements will be built.

–    Connect Support is deprecated and won’t be supported by ServiceNow from Utah.

 

What are the steps to follow to migrate from Connect Support to Sidebar?

–    Connect Support and Sidebar are not the same use case. The migration for Connect Chat is to move to Next Experience and start using Sidebar. There is no option to import conversations from Connect Chat to Sidebar. 

 

Where can I find more about Connect Support deprecation plan? 

–    Find the details below:  Connect Support deprecation community announcements  

 

Install Sidebar plugins

How can I install Sidebar?

–  Navigate to All > System Applications > All Available Applications > All 

Search for store app Omni-Experience Standard Feature Set 

find_real_file.png

– For Tokyo, customers will need to opt-in and install the above store app. Starting in Utah, this store app will be trued up and installed OOB. 

 

Is Sidebar a PRO feature?

–     No. Sidebar is available in Standard. 

 

What are the plugin dependencies?

–    One family release plugin: glide.cs.collab 

–    Explicit Dependencies:

                                                 com.glide.cs.custom.adapter 

                                                 com.glide.cs 

                                                 com.glide.quickactions 

 

Does it support self-hosted(on-Prem) instances?

–     This feature does not add any impediments to on-Prem instances. Find Link for Community post about installing store apps on-Prem. 

 

What other ServiceNow modules does it affect?

– Sidebar shares front end components with Agent chat and VA web client. To use Sidebar customers, Agent Chat and Agent workspace are activated.  

 

What activities can a user do in Sidebar?

– Below is a list of what users can do with Sidebar:  

  • Create discussion
  • Receive badge notification
  • Pin the discussion panel
  • Check unread messages
  • Favorite discussion
  • Search through discussions if AI Search is enabled
  • Exchange messages, files, links, and emojis
  • Add/remove messages from a discussion to Activity Stream
  • Add other participants
  • Leave a discussion
  • Join a discussion from the Activity Stream conversation tile 
  • @mentions 
  • Collaborate with Teams users with Utah release

 

Advanced Configuration

Where can I find configuration product documentation for Sidebar?

–    Install Sidebar

–    Configure Sidebar

–    Add the Sidebar button

–    Using Sidebar

–    Configuring Sidebar member query

–    Domain Separation and Sidebar

–    Sidebar Overview

–    Sidebar with Teams Integration 

 

How do I access Sidebar in Agent Workspace?

–     Sidebar is available on the Next Experience. After activating Sidebar, it will show Sidebar discussion Icon find_real_file.pngon right side top menu. See below picture.  

 find_real_file.png

When you select the Sidebar discussion icon find_real_file.png, the Sidebar discussion panel appears:

 find_real_file.png

Find more details here for the Sidebar discussions panel components. 

 

Is Sidebar domain separated?

–      Yes, sidebar supports basic domain separation and since the chats are record based, they will have the same domain as their parent record 

 

Does it need new roles or ACLs?

–      There are no new roles, but basic ACLs have been added to allow users to have access to the new tables 

 

Where is the Sidebar “Discuss” button added?

  • CSM Configurable Workspace, CSM Manager Workspace, ITSM Manager Workspace, Vendor Management Workspace, HR Agent Workspace, and UI16.
  • It will appear in the record view for all tables that extend task or interaction. In addition, the buttons will also show in the UI16 record view for tables that extend task or interaction.

 

How to add Sidebar Discuss button manually for the non supported Workspaces?

–      Follow Product Document and KB article KB1213249 for the setup details.

 

How to add Sidebar Discuss button to SOW workspace?

–      Follow Product Document and KB article KB1213249 for the setup details. 

NOTE: Sidebar functionalities are being integrated in Service operations workspace collaborate tab from SOW v3.0. If SOW v3.0 is installed please skip this KB and utilise the collaborate experience being built under SOW.

 

What are the available configuration customizations?

–      Admin Settings – requires admin role 

  1. Accessible through the Conversational Interfaces Settings
  2. Currently, we can only disable/enable emojis, disable Sidebar, and modify user Query

–      User Query Table 

  1. Used to customize experience when adding users to a chat or creating a chat
  2. Can be configured through the table view or admin settings page

–      Quick Actions 

  1. Customers can create quick actions, the same as in agent chat
  2. Limited by sidebar scriptable API
  3. KB article search quick action should be available if AI Search is enabled.

–      Theming – Sidebar theming can be changed by configuring a Next Experience theme 

 

What are the available Sys properties customizations?

Some of the Sys properties are below: 

  • glide.cs.collab.enabled

               – Enables/disables sidebar, removing it from the Polaris header 

               – Default: true 

  • collab.check_candidate_permission

               – Controls whether to check permissions for TBR when building candidate list to add members 

               – Default: true 

  • collab.candidate_search_limit

              – limits the number of search results when adding members to chat 

              – Default: 20 

  • collab.candidate_prefill_limit

               – Limits the number of users that will pre-fill when a chat is created 

               – Default: 100 

 

How many overflow menus can be configured?

–   The overflow menu allows the agent to access windows that aren't fully displayed on the screen. The maximum number of windows in the overflow menu is 25 and this can be configured. 

 

Are there any schema changes that may impact customer’s current use of the platform, data, customizations, or upgrade duration?

–      No, all the tables are new so there will be no conflicts to use Sidebar. 

 

Why can’t I add a user to a chat?

–      It’s likely the user does not have permission to the TBR, check if the user can view the TBR in table view 

–      Verify sys_cs_collab_user_query records are correct 

 

Why is KB Search quick action not working?

–      KB Search is disabled OOB, go to quickactions_action and enable “Search KB Article” for the sys_cs_collab_chat table by setting it to active 

–      Ensure that AI Search is enabled and correctly configured 

 

Why is chat search not working?

–      Verify that AI search is enabled and correctly configured 

 

How to enable logging for Sidebar:

Set glide.cs.debug sys_property to true 

Run this script in the background 

–      GlideSessionDebug.enable("cs_debug"); 

Go to sys_logger_configuration and set the com.glide.cs.collab record to active 

This will enable logging for Sidebar, which can be found in the system logs. 

Example log: 

“Exception sending message {0}” 

{0} = sys_cs_collab_message.sys_id 

 

Is the KB Search Quick action enabled OOB? How do you enable/disable it?

–      It is disabled, set quickactions_action record to active 

 

How many chats can be created per TBR?

–      one in Tokyo, multiple discussions per task-based record is targeted for a future release.

 

How do customers configure the theming for Sidebar?

 –      By Configuring a Next Experience Theme 

 

What tables support the Sidebar?

–      Tables that extend tasks or interactions 

 

What is the sys_cs_collab_user_query table used for?

–      Customizes the experience when adding members to a chat or the pre-filled users when a chat is created. 

 

Does CSM BU have any enhancements for Sidebar?

–      Yes, Please check with CSM AE team. 

 

How to turn off the Sidebar on Agent Workspace?

–      Find Here   

 

Useful resources

 

For more Information

Where can I learn more about Agent Chat?   

Visit the product documentation site: Workspace Agent chat  

Agent Chat FAQs

Where can I learn more about Advanced Work Assignment (AWA)?   

Visit the product documentation site: Advanced Work Assignment documentation 

AWA FAQs

Where can I learn more about Workspaces?   

Visit the product documentation site: Workspaces

Visit the Community site: Workspace UI

Workspace FAQs

Where can I learn more about Next Experience?   

Visit the Community site: Next Experience

Next Experience Quick Start Guide 

Activating Next Experience

Next Experience FAQs

 

Community Forum

  • Visit our community forum for Sidebar, Agent Chat and AWA: Link 
  • Subscribe to our bi-weekly Academy videos: Link 
  • Catch up on our past Knowledge labs: Link 
Comments
Chris Helming
Tera Guru
Tera Guru

Can you define acronyms before using them? I'm not sure what "TBR" means.

Jonah Piascik
Tera Expert

TBR = "Task-Based Record"

Taylor Williams
ServiceNow Employee
ServiceNow Employee

Does Sidebar interface or work with external chat applications such as Microsoft Teams? Can the user that is added to a sidebar chat respond in MS Teams. Similarly, could that user be notified in MS Teams?

 

How is agent 'presence' managed in Sidebar? Can I mark myself as available, away, out, etc?

 

 

iadityaps
Tera Expert

Thanks for the detailed FAQs @Samyuktha Reddy 😊

Samyuktha Reddy
ServiceNow Employee
ServiceNow Employee

Sidebar with MS team integration will be available soon in our next releases. From Sidebar discussions participants in Teams can be added and they can respond from teams to Sidebar.

 

Sidebar discussion will not look for participants' availability. When a participant is added to the discussion, a notification count shows up on the Sidebar menu for the participant to look into when they want.

Suganya12
Tera Expert

Hi,

I want to use sidebar on Service operations workspace. am able to add the 'Discuss' button (which is on task table ) on incident record however, when I click on the discuss button it doesnt pop up the start sidebar discussion window. Apart from this issue am able to configure all other side bar functionalities.

 

@Samyuktha Reddy  - Any pointers to this issue would be a great help. PFA screenshots for the same.

 

Discussbutton.pngIncidentdiscuss.png

Robert Maxwell
Giga Guru

Concept sounds ok, but aren't we exposing the risk of information not being 'on' the record?

I see potential for case resolution information being spread across work notes and sidebar. Might as well just have a Teams/Slack spoke and a link to a thread.

Nabeel Qazi1
Tera Contributor

@Suganya12 You will need to create mapping on "sys_ux_addon_event_mapping" table. Follow the steps here: https://support.servicenow.com/kb?id=kb_article_view&sysparm_article=KB1213249 

Stephen Bidgood
ServiceNow Employee
ServiceNow Employee

Can Sidebar conversations be purged? (I realize an agent can leave the sidebar conversation, but is there a central location for sidebar conversations which could be purged or deleted, or is everything a part of the case record? ) 

Piotr H
Tera Contributor

Is it possible to set the tables which the "Discuss" buttons appears on? By default, this button is available on all records extending Task / Interaction tables. Is it possible to, for example, only include it on the Incident table? If yes, where can that be configured?

 

This is for standard UI, not workspaces.

Ben42
Tera Contributor

Hi,

Are conversations/messages stored anywhere in the servicenow? if so, on which table the sidebar messages/conversations are stored?

 

Thanks,

Ben.

Jag5
Giga Guru

Thanks for this great information. I am testing Sidebar with Teams using my PDI and I see the below error when I initiate a chat. Could you please assist what am i missing here? Appreciate your response!

Screen Shot 2023-04-10 at 12.53.49 PM.png

Samyuktha Reddy
ServiceNow Employee
ServiceNow Employee

@Jag5  -  Can you please provide more details? Is your Microsoft Teams setup active and configured with Sidebar?

Jag5
Giga Guru

@Samyuktha Reddy Thank you for the response!

 

Yes, my Microsoft teams setup is Active and also configured with Sidebar (as instructed in this KB Article - https://support.servicenow.com/kb?id=kb_article_view&sysparm_article=KB1225842). I also took a free trial of Azure subscription for messaging charges but still I see all the below errors when I initiate a Discussion from workspace. Thank you!

Screen Shot 2023-04-10 at 2.49.01 PM.png

Tian Ye
ServiceNow Employee
ServiceNow Employee

Hi @Piotr H ,

Unfortunately, today the configuration is not supported for standard UI. Please reach out to our PMs and we should be able add that support.

Tian Ye
ServiceNow Employee
ServiceNow Employee

hi @Ben42 , the message are stored in sys_cs_collab_message and conversations are stored in sys_cs_collab_chat.

Tian Ye
ServiceNow Employee
ServiceNow Employee

Hi @Stephen Bidgood , you can go to sys_cs_collab_chat table to manually delete the conversation. The deletion of the record can trigger cascading deletion on other related recordings, including messages, attachments, etc.

You can also define your own policy in servicenow table cleaner. For example, you can define a rule to delete the chats if the tasks associated are closed and there are no activities in the chats for 30+ days.

Tian Ye
ServiceNow Employee
ServiceNow Employee

Hi @Jag5 , that 402 error may be caused by a recent change of MS process.
Can you try this below to see if that could resolve the error?
https://learn.microsoft.com/en-us/graph/metered-api-setup

Jag5
Giga Guru

Hello @Tian Ye , thank you for the article. That actually helped to resolve 402 error. I did add all the api permissions needed and the application has only one subscription but I still see the below errors including 403. I tried to find more info on these but no luck. Could you please provide any information on how to resolve these errors?

Screen Shot 2023-04-10 at 8.03.44 PM.png

Tian Ye
ServiceNow Employee
ServiceNow Employee

hi @Jag5 , Let me redirect your error messages to dev team to see if they saw the same error before.
The 400 error at the bottom usually happens when the current user is not associated with a Teams account properly. When you try to create a new chat, is there a modal asking you to sign into your Team account?
Also, can you check sys_cs_collab_user table to see if the current user has a record there. You can also find the Teams account associated with that user.

Jag5
Giga Guru

Hello @Tian Ye , thank you! I was able to resolve the 400 errors and now the integration seems to be working great but I still see 403 errors for every 30 min. I found that there is a scheduled job that runs periodically and I guess the error occurs when this job runs. Please correct if I'm wrong!

Screen Shot 2023-04-11 at 4.28.14 PM.pngScreen Shot 2023-04-11 at 4.24.32 PM.png

Tian Ye
ServiceNow Employee
ServiceNow Employee

hi @Jag5 , yes, we have the job to execute every 30 min to extend the subscription.
The errors look like you have more than 1 subscription to that Teams app. Can you make sure that Teams app is not subscribed in other instance? One Teams app can only have 1 subscription at one time.

Can you also check if the messages sent from Teams can be delivered to servicenow side? If not, that means your subscription is not successful on your current instance.

Lakshmi Royyala
Tera Contributor

We like the feature but want to disable Sidebar on a single custom table (extended from Task. It is not a workspace). How?

gjz
Kilo Sage

How can you get the discussion to appear in the ticket?  I see the option to "Post to activity stream" and I added "Sidebar discussion" and "Sidebar posted message" to the activity stream, but the discussion is not showing up in the ticket.

 

gjz_0-1682362195553.png

 

gjz_1-1682362291701.png

 

 

 

Al-jhon
Tera Guru

@gjz same concern here. i can't see disucssion messages on the activity stream after clicking post to activity stream. Do you know how now?

Tian Ye
ServiceNow Employee
ServiceNow Employee

Hi @gjz and @Al-jhon ,
This is a known issue that we are trying to improve. In the screenshot, you are viewing our legacy UI 16 page. It does not support displaying the posted message in activity stream. You have to be in the next experience to see them. 
We are working with PM to see if we can improve that in the future.
Sorry for the confusion here.

Al-jhon
Tera Guru

Hello @Tian Ye , thank you for your response.
I am in Next Experience UI but still cannot see them. Anyway, hopefully this feature can be enabled soon! 🙂 

Any update will be much appreciated. ^___^

DEEPAK KUMAR SI
Tera Contributor

Hi @Samyuktha Reddy 

Thank you very much. Just two questions which is bothering me before I proceed with integration 

1 → Is it "ServiceNow Sidebar - MS Teams" integration & "Integration via Pre published App or Custom App" are the same things?  YES / NO

 

2 → As per my knowledge from ServiceNow side it is provided as an Standard feature. Is there any type of separate costing involved from Microsoft Side ?

For example : Any kind of charge applied each time the MS Teams API is called (Messages Sent from ServiceNow to Teams and Vice Versa)

Ganesh84
Tera Contributor

Hello Everyone,

Is it possible to hide toggle connect sidebar for specific custom role in the system ?

Keerthi Kongari
Tera Contributor

Hi @Tian Ye , I see below errors, when I initiate the chat from sidebar. Could you please assist me in resolving the below errors. I have followed all the steps mentioned KB article KB1225842. Appreciate your response!

KeerthiKongari_0-1701196495488.png

 

Bas Tekampe
Tera Contributor

Thanks for the information, but i do have an "problem" if the agent left the chat and then after a couple hours the customer says it is not fixed there is not option to start a new chat. The continu chat gives an error in teams. Is there away around the continu chat option? 

 

Alexandre Assis
ServiceNow Employee
ServiceNow Employee

Hi everyone!

 

I have configured Sidebar in one of my custom Workspaces, however, I would like to show an attribute other than "short_description" in the Subject, how can I do that?

I'm in Vancouver patch 5, by the way.

 

Alex

VDM
Tera Explorer

Hi, @Samyuktha Reddy 
Is it possible to customise the functionality by removing the ability to:
1) delete messages
2) search attachments

3) post to Activity Stream?

My client wants to remove those. Thank you! 

Samyuktha Reddy
ServiceNow Employee
ServiceNow Employee

Hi VDM,

 

For activity steam, you can delete messages, edit messages and pin the messages.

 

 

VDM
Tera Explorer

@Samyuktha Reddy 
Thank you!

My question was if I can disable the possibility of deleting message for users?
And also disable two other features (see message above)

Jon K
Tera Explorer

@Samyuktha Reddy,

In the sys_cs_collab_user table. What functionality is driven by create_external_conversation vs external_user columns. My company has both ITSM and CSM. We want to enable Teams sidebar for Internal users but hide all CSM account contacts.

servicenow noob
Tera Contributor

Hi @Samyuktha Reddy  how can we enable sidebar multiple discussion for a single record in servicenow.

Samyuktha Reddy
ServiceNow Employee
ServiceNow Employee

@servicenow noob   Multiple discussions per record capability in available in Vancouver. You will have the access once you upgrade to this release.

Samyuktha Reddy
ServiceNow Employee
ServiceNow Employee

Hi @Jon K ,

 

I need more details to help you with better solutions. Is it possible to ask your ServiceNow account executive to connect with me to schedule a meeting for us to discuss.

 

sys_cs_collab_user table - you can manually look for thee users in thee table and deactivate to not allow interacting with Sidebar from Team. 

Samyuktha Reddy
ServiceNow Employee
ServiceNow Employee

@VDM 

 

As of now there is no granular configs for removing the functionality at that level. Post to activity stream might be a possibility, by disabling the corresponding filters. 

If your client don't want to use these capabilities what are their thoughts and what other options they are looking for? can you please provide more details.

Ali42
Tera Contributor

Hi, 

 

I'm facing an issue when using the sidebar and teams integration. 

Everything is well configured, but when I try to send a message to an end user in teams, through the side bar, I have the following message : 

Cannot query sys_cs_external_collab_chat_map record, collab_chat: 349bbdea4795c690d94c759bd36d430c, provider: 4bf5b90ac31211103f4fcd7b7940dd5e

 

Is this message mean something to you ? 

 

Thank you

Ali

Julie Benningf1
Tera Contributor

Thank you for this. I'm trying to determine why they are asking us to create an app in addition to the Azure App Registration in this KB article: https://support.servicenow.com/kb?id=kb_article_view&sysparm_article=KB1225842

Version history
Last update:
‎10-04-2023 10:35 AM
Updated by:
Contributors