snrepl - ServiceNow REPL for VSCode

Description

snrepl is a VSCode extension that allows you to execute ServiceNow background scripts directly from your editor.

Features

• Execute JavaScript code on a remote ServiceNow instance.
• View execution results and logs within VSCode.
• Securely manage ServiceNow credentials.

Installation

This extension is not yet available on the VSCode Marketplace. To install it, package it into a .vsix file and then install it manually via the Extensions view in VSCode.

Usage

1. Configure your ServiceNow credentials by going to the extension settings (Ctrl+, or Cmd+, on macOS, then search for snrepl).
2. Open a JavaScript file and write your ServiceNow script.
3. Run the command Run script on instance to execute the script.

Setting the Scope

You can specify the scope for the script by adding an annotation at the top of your script file. Use the @scope annotation followed by the desired scope. For example:

// @scope: global
console.log('This script runs in the global scope.');

If you do not specify a scope, the script will run in global.

Configuration

• snrepl.username: ServiceNow Username
• snrepl.password: ServiceNow Password
• snrepl.instance: ServiceNow Instance hostname
• snrepl.sessionCookie: ServiceNow Session Cookie (optional)

Session Cookie Configuration for SSO

If you're using Single Sign-On (SSO) to authenticate with ServiceNow, you can manually set the session cookie in the extension settings. To do this, navigate to your ServiceNow instance in a web browser and inspect the cookies. You can copy the whole cookie string, or just the part that sets JSESSIONID. Then paste that into the ServiceNow Session Cookie field in the extension settings. This will allow the extension to use your existing authenticated session for its operations. With this approach, username and password are not required.

Prerequisites

This extension requires the Xplore toolkit utility to be installed on the target ServiceNow instance. You can find more information and download Xplore from xploretoolkit.com.

Credits

This extension utilizes the Xplore toolkit, created by James Neale. Xplore is a powerful utility for exploring and testing ServiceNow instances.

• Website: xploretoolkit.com
• GitHub: Xplore GitHub
• Twitter: Xplore Twitter

Xplore uses various open-source libraries including Bootstrap, JQuery, CodeMirror, Bootstrap Toggle, Google Code-Prettify, and jQuery Plugin: Are-You-Sure. It is licensed under the MIT License.

License

This project is licensed under the MIT License.