Skip to content

Updating ServiceNow plugin setup documentation#9030

Open
ogi-m wants to merge 1 commit into
mattermost:masterfrom
ogi-m:servicenow-plugin-docs-update-1
Open

Updating ServiceNow plugin setup documentation#9030
ogi-m wants to merge 1 commit into
mattermost:masterfrom
ogi-m:servicenow-plugin-docs-update-1

Conversation

@ogi-m

@ogi-m ogi-m commented Jun 12, 2026

Copy link
Copy Markdown

Summary

When setting up the plugin I've found that with changes made to the UI in more recent ServiceNow releases, searching for the auth table list view, the way the documentation currently describes, returns no results.

The quickest way to access it now is directly via the URL. It is also the safest option as it's backwards compatible and will work on the oldest still-supported ServiceNow releases (Utah / Vancouver) all the way through the latest (Zurich).

The way the documentation currently describes searching for ` x_830655_mm_std_servicenow_for_mattermost_notifications_auth_list.` doesn't work in the latest ServiceNow releases.

The most straightforward way of accessing it now is straight trough the URL, and it is also the safest as it's backwards compatible all the way to the oldest still-supported ServiceNow releases (Utah / Vancouver) all the way through the latest (Zurich).
@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

A single line in the ServiceNow integration guide was updated to replace menu-based navigation instructions with a direct URL for accessing the auth table list view during setup.

Changes

ServiceNow Setup Documentation

Layer / File(s) Summary
ServiceNow auth table list access URL update
source/integrations-guide/servicenow.rst
Step 2 of the ServiceNow setup instructions now directs users to access the auth table list view via a direct URL (with instance subdomain placeholder) instead of using the All > ...auth.list menu navigation path.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: updating ServiceNow plugin setup documentation to reflect UI changes in recent releases.
Description check ✅ Passed The description clearly explains the rationale for the change: the existing UI-based navigation method no longer works in recent ServiceNow releases, and provides the alternative solution with justification for its compatibility.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
source/integrations-guide/servicenow.rst (1)

52-52: ⚡ Quick win

Normalize placeholder style for consistency with earlier instructions.

The placeholder on line 52 uses lowercase <your-instance>, but the earlier placeholder on line 19 uses uppercase <YOUR-MATTERMOST-URL>. For consistency across the documentation, both placeholders should use the same casing style.

✏️ Proposed fix for placeholder consistency
-2. In your ServiceNow instance, open the auth table's list view by navigating directly to ``https://<your-instance>.service-now.com/x_830655_mm_std_servicenow_for_mattermost_notifications_auth_list.do``, replacing <your-instance> with your ServiceNow instance subdomain.
+2. In your ServiceNow instance, open the auth table's list view by navigating directly to ``https://<YOUR-INSTANCE>.service-now.com/x_830655_mm_std_servicenow_for_mattermost_notifications_auth_list.do``, replacing <YOUR-INSTANCE> with your ServiceNow instance subdomain.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@source/integrations-guide/servicenow.rst` at line 52, The placeholder
"<your-instance>" in the ServiceNow URL example should use the same uppercase
placeholder style as earlier docs; update the text that contains
"https://<your-instance>.service-now.com/..." to use "<YOUR-INSTANCE>" instead
(i.e., "https://<YOUR-INSTANCE>.service-now.com/...") so the placeholder casing
matches the earlier "<YOUR-MATTERMOST-URL>" style.

Source: Coding guidelines

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@source/integrations-guide/servicenow.rst`:
- Line 52: The placeholder "<your-instance>" in the ServiceNow URL example
should use the same uppercase placeholder style as earlier docs; update the text
that contains "https://<your-instance>.service-now.com/..." to use
"<YOUR-INSTANCE>" instead (i.e., "https://<YOUR-INSTANCE>.service-now.com/...")
so the placeholder casing matches the earlier "<YOUR-MATTERMOST-URL>" style.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 50324be7-6858-431c-a34d-2d6a5219bea2

📥 Commits

Reviewing files that changed from the base of the PR and between ea7ca0d and e5b14d8.

📒 Files selected for processing (1)
  • source/integrations-guide/servicenow.rst

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant