@janus-idp/backstage-scaffolder-backend-module-servicenow-dynamic v1.4.6

ServiceNow actions for Backstage

This plugin provides Backstage template actions for ServiceNow.

The following actions are currently supported in this plugin:

• Table API

Prerequisites

• A Backstage project

Installation

Run the following command to install the action package in your Backstage project:

yarn workspace backend add @janus-idp/backstage-scaffolder-backend-module-servicenow

Installing the action on the legacy backend

Register the ServiceNow actions by modifying the packages/backend/src/plugins/scaffolder.ts file from your project with the following changes:

/* highlight-add-next-line */
import { createServiceNowActions } from '@janus-idp/backstage-scaffolder-backend-module-servicenow';

export default async function createPlugin(
  env: PluginEnvironment,
): Promise<Router> {
  // ...

  /* highlight-add-next-line */
  const actions = [
    ...builtInActions,
    ...createServiceNowActions({ config: env.config }),
  ];

  return await createRouter({
    actions,
    logger: env.logger,
    config: env.config,
    database: env.database,
    reader: env.reader,
    catalogClient,
    identity: env.identity,
  });
}

Installing the action on the new backend

Add the following to your packages/backend/src/index.ts file:

const backend = createBackend();

// Add the following line
backend.add(
  import('@janus-idp/backstage-scaffolder-backend-module-servicenow/alpha'),
);

backend.start();

Configuration

Update the app-config.yaml file to include the following config:

servicenow:
  # The base url of the ServiceNow instance.
  baseUrl: ${SERVICENOW_BASE_URL}
  # The username to use for authentication.
  username: ${SERVICENOW_USERNAME}
  # The password to use for authentication.
  password: ${SERVICENOW_PASSWORD}

Usage

Action : servicenow:now:table:createRecord

Request Type: POST

Input

Output

Action : servicenow:now:table:deleteRecord

Request Type: DELETE

Input

Action : servicenow:now:table:modifyRecord

Request Type: PUT

Input

Output

Action : servicenow:now:table:retrieveRecord

Request Type: GET

Input

Output

Action : servicenow:now:table:retrieveRecords

Request Type: GET

Input

Output

Action : servicenow:now:table:updateRecord

Request Type: PATCH

Input

Output