-
Notifications
You must be signed in to change notification settings - Fork 11
docs: servicenow integration #51
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
simong
wants to merge
5
commits into
cobrowseio:master
Choose a base branch
from
simong:feat/servicenow
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
2b01bd8
docs: servicenow integration
simong df17cd1
chore: update app prefix
simong 3ddcd6f
chore: more lingering old app prefix changes
simong a7c6de4
docs: cobrowse device id needs to go into ServiceNowChat at instantia…
simong f5b7eb9
chore: merge origin/master
simong File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
94 changes: 94 additions & 0 deletions
94
agent-side-integrations/crm-helpdesk-integrations/servicenow.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,94 @@ | ||||||||||||||||||
--- | ||||||||||||||||||
description: >- | ||||||||||||||||||
Cobrowse integrates seamlessly with ServiceNow workflows, enabling real-time | ||||||||||||||||||
visual collaboration between agents and customers. This integration is | ||||||||||||||||||
available through the ServiceNow Store. | ||||||||||||||||||
--- | ||||||||||||||||||
|
||||||||||||||||||
# ServiceNow | ||||||||||||||||||
|
||||||||||||||||||
## Overview | ||||||||||||||||||
|
||||||||||||||||||
Cobrowse integrates seamlessly with ServiceNow workspaces such as _Service | ||||||||||||||||||
Operations Workspace_ or _Customer Service Management_, enabling real-time | ||||||||||||||||||
visual collaboration between agents and customers. This integration is available | ||||||||||||||||||
through the [ServiceNow Store](https://store.servicenow.com). | ||||||||||||||||||
Comment on lines
+12
to
+15
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Continuing the previous comment:
Suggested change
|
||||||||||||||||||
|
||||||||||||||||||
## Installation guide | ||||||||||||||||||
|
||||||||||||||||||
To install and configure the Cobrowse integration with ServiceNow: | ||||||||||||||||||
|
||||||||||||||||||
1. Sign up for a [Cobrowse account](https://cobrowse.io/register) | ||||||||||||||||||
2. As a Cobrowse Administrator: | ||||||||||||||||||
1. Generate a public key under Settings > Integrations > JWT SSO. | ||||||||||||||||||
2. Generate a key store for it under Settings > Integrations > ServiceNow | ||||||||||||||||||
3. As a ServiceNow administrator: | ||||||||||||||||||
1. Install the app from the [ServiceNow Store](https://store.servicenow.com). | ||||||||||||||||||
2. Add the keystore under All > Multi-Provider SSO > Administration > x509 | ||||||||||||||||||
Certificate. | ||||||||||||||||||
1. Name: Cobrowse.io | ||||||||||||||||||
2. Type: Java Key Store | ||||||||||||||||||
3. Attachments > Choose your generated keystore | ||||||||||||||||||
4. Submit | ||||||||||||||||||
3. Link the new keystore for the Cobrowse JWT key under All > System OAuth > | ||||||||||||||||||
JWT Keys > Cobrowse.io | ||||||||||||||||||
1. Signing Keystore: Click the magnifying glass and look for the added | ||||||||||||||||||
keystore | ||||||||||||||||||
2. Signing Key: The password that was given on the cobrowse dashboard. By | ||||||||||||||||||
default, this is `my-cobrowse-keystore`. | ||||||||||||||||||
4. Configure the system properties, All > `sys_properties.list` + enter > | ||||||||||||||||||
Search for `x_billc`: | ||||||||||||||||||
1. Update the `x_billc_cobrowse_i.license` property and set it to your | ||||||||||||||||||
cobrowse account license which you find on the cobrowse dashboard> | ||||||||||||||||||
Settings > General | ||||||||||||||||||
2. _(Optional)_ If you are | ||||||||||||||||||
[self-hosting](../../enterprise-self-hosting/self-hosting-overview.md) | ||||||||||||||||||
your Cobrowse.io instance, update the `x_billc_cobrowse_i.base_url` | ||||||||||||||||||
system property and point it at your own installation. | ||||||||||||||||||
|
||||||||||||||||||
### Enabling Cobrowse for Portable Virtual Agent chat widget | ||||||||||||||||||
|
||||||||||||||||||
The cobrowse device id needs to be passed into the chat widget. This can be done | ||||||||||||||||||
as follows: | ||||||||||||||||||
|
||||||||||||||||||
```javascript | ||||||||||||||||||
const snUrl = 'https://your-instance.service-now.com' | ||||||||||||||||||
const script = document.createElement('script') | ||||||||||||||||||
script.type = 'module' | ||||||||||||||||||
script.src = `${snUrl}/uxasset/externals/now-requestor-chat-popover-app/index.jsdbx?sysparm_substitute=false` | ||||||||||||||||||
script.onload = () => { | ||||||||||||||||||
CobrowseIO.client().then(function() { | ||||||||||||||||||
const deviceId = CobrowseIO.deviceId() | ||||||||||||||||||
const chat = new ServiceNowChat({ | ||||||||||||||||||
instance: snUrl, | ||||||||||||||||||
context: { | ||||||||||||||||||
cobrowse_device_id: deviceId | ||||||||||||||||||
}, | ||||||||||||||||||
}); | ||||||||||||||||||
}); | ||||||||||||||||||
} | ||||||||||||||||||
document.body.appendChild(script) | ||||||||||||||||||
|
||||||||||||||||||
// We also recommend that the chat widget itself is automatically ignored for your agents | ||||||||||||||||||
CobrowseIO.ignoredViews = ['now-requestor-chat-popover']; | ||||||||||||||||||
``` | ||||||||||||||||||
|
||||||||||||||||||
Don't forget to include the [Cobrowse SDK](../../sdk-installation/web.md) into | ||||||||||||||||||
the webpage where the Portable Virtual Agent chat widget is running. No further | ||||||||||||||||||
changes should be necessary on the ServiceNow side to enable cobrowsing. | ||||||||||||||||||
|
||||||||||||||||||
## Controlling user access | ||||||||||||||||||
|
||||||||||||||||||
The Cobrowse ServiceNow application includes two roles for managing user | ||||||||||||||||||
permissions: | ||||||||||||||||||
|
||||||||||||||||||
1. `x_billc_cobrowse_i.Administrator` | ||||||||||||||||||
|
||||||||||||||||||
Grants access to the Cobrowse.io application via the All > Cobrowse.io > | ||||||||||||||||||
Dashboard. Users with this role can view active devices, sessions, and | ||||||||||||||||||
settings. | ||||||||||||||||||
|
||||||||||||||||||
2. `x_billc_cobrowse_i.Agent` | ||||||||||||||||||
|
||||||||||||||||||
Grants access to the Cobrowse sidebar, allowing agents to initiate cobrowse | ||||||||||||||||||
sessions during customer interactions. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Gitbook displays the description as a subtitle so it ends up duplicating the overview