Skip to content

RHIDP-10933: [Doc] ServiceNow plugin: Allow integration without changing ServiceNow infrastructure#2020

Open
rh-tokeefe wants to merge 13 commits into
redhat-developer:mainfrom
rh-tokeefe:RHIDP-10933
Open

RHIDP-10933: [Doc] ServiceNow plugin: Allow integration without changing ServiceNow infrastructure#2020
rh-tokeefe wants to merge 13 commits into
redhat-developer:mainfrom
rh-tokeefe:RHIDP-10933

Conversation

@rh-tokeefe
Copy link
Copy Markdown
Member

@rh-tokeefe rh-tokeefe commented Apr 6, 2026

IMPORTANT: Do Not Merge - To be merged by Docs Team Only

Merge to main and CP to release-1.10

Version(s):
1.10
Issue:
https://redhat.atlassian.net/browse/RHIDP-10993
Preview:
<!--- Add a link to the preview of the changed file(s). --->

@rhdh-bot
Copy link
Copy Markdown
Collaborator

rhdh-bot commented Apr 6, 2026

PR Build Results

Build passed -- 34/34 titles | 75s
Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-2020/


Content Quality Assessment

CQA Report

  • CQA-00a: Orphaned modules
  • CQA-00b: Directory structure
  • CQA-01: Vale AsciiDoc DITA compliance
  • CQA-02: Verify assembly structure
  • CQA-03: Verify content type metadata
  • CQA-04: Verify module templates
  • CQA-05: Verify required modular elements
  • CQA-06: Verify assemblies follow official template (one user story)
  • CQA-07: Verify TOC depth (max 3 levels)
  • CQA-08: Verify short description content quality
  • CQA-09: Verify short description format
  • CQA-10: Verify titles are brief, complete, and descriptive
  • CQA-11: Verify procedure prerequisites
  • CQA-12: Verify grammar and style (Vale)
  • CQA-13: Verify content matches declared type
  • CQA-14: Verify no broken links
  • CQA-15: Check redirects
  • CQA-16: Verify official product names
  • CQA-17: Verify legal disclaimers for preview features

Summary

Checks: 19 total, 19 pass, 0 fail

19 checks: 19 pass, 0 fail

Run node build/scripts/cqa/index.js --all --fix locally to review and auto-fix issues.


Updated 2026-05-13 17:42:10 UTC

@rh-tokeefe rh-tokeefe changed the title RHIDP-10933: [Doc] ServiceNow plugin: Allow integration without chang… RHIDP-10933: [Doc] ServiceNow plugin: Allow integration without changing ServiceNow infrastructure Apr 6, 2026
steps:
- id: create-incident
name: Create ServiceNow Incident
action: servicenow:create-incident
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.

I think this action name is wrong, list existed actions described here:

catalog-entities/extensions/plugins/servicenow-scaffolder-actions.yaml

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.

So valid action name should be servicenow:now:table:createRecord

- id: create-incident
name: Create ServiceNow Incident
action: servicenow:create-incident
input:
Copy link
Copy Markdown
Contributor

@AndrienkoAleksandr AndrienkoAleksandr May 12, 2026

Choose a reason for hiding this comment

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

I think format of the action input is another:

input:
  tableName: incident
  requestBody:
    short_description: "Printer is offline"
    description: "The office printer is not accessible via the network"
    severity: "3"
    # ... more servicenow columns fields

From another side users always can find information about installed actions and their actual options using RHDH UI: https://rhdh-url.some.domain/create/actions

config:
layout:
gridColumn: 1 / -1
height: 75vh
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.

and one more plugin - servicenow scaffolder action:

      - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-servicenow:bs_1.49.4__2.15.0
        disabled: false
        pluginConfig:
          servicenow:
            baseUrl: ${SERVICENOW_BASE_URL}
            username: ${SERVICENOW_USERNAME}
            password: ${SERVICENOW_PASSWORD}


[source,yaml]
----
scaffolder:
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.

But I think valid configuration for servicenow scaffolder plugin is:

servicenow:
  baseUrl: ${SERVICENOW_PROD_URL}
  username: ${SERVICENOW_USER}
  password: ${SERVICENOW_PASS}

== ServiceNow global configuration parameters

[cols="3,1,1,5", options="header"]
|===
Copy link
Copy Markdown
Contributor

@AndrienkoAleksandr AndrienkoAleksandr May 12, 2026

Choose a reason for hiding this comment

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

I'm not sure, but maybe it will be easier to show configuration examples:

  1. basic auth:
servicenow:
  instanceUrl: https://<your-dev-instance>.service-now.com
  basicAuth:
    username: admin
    password: <your-password>
  1. oauth:
servicenow:
  instanceUrl: https://<your-dev-instance>.service-now.com
  oauth:
    grantType: client_credentials
    clientId: <your-client-id>
    clientSecret: <your-client-secret>

oauth with with grant type "password" should work too:

servicenow:
  instanceUrl: https://<your-dev-instance>.service-now.com
  oauth:
    grantType: password
    clientId: <your-client-id>
    clientSecret: <your-client-secret>
    username: admin
    password: <your-admin-password>

@sonarqubecloud
Copy link
Copy Markdown

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

Labels

Technical review needed 🔩 Test all the procedures

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants