ServiceNow CLI - an interesting feature to play with SN using REST API calls

-

 The ServiceNow CLI is a command-line interface that lets us to perform instance operations from our local system. We can extend the CLI to include new commands that meet the application's needs.

Benefits

The ServiceNow CLI lets us to:

  • Perform basic CRUD operations on records in SN instance.
  • Develop custom components and deploy them to SN instance to personalize a UI.
  • Create custom commands that enable to manage custom applications from the command line.
  • Use the ServiceNow CLI in scripts to simplify setup tasks and operational activities.

 

Architecture

Commands are stored in a table on the instance where we are connected to. When the ServiceNow CLI connects to the instance, it receives all the available commands supported by that instance. Commands map to a REST endpoint that executes asynchronously. 














Activating ServiceNow CLI in Windows machine:

 

Here are the steps I followed to run this functionality successfully from my personal laptop using my PDI

 

  1. Download the CLI client from SN store and here is the link: https://store.servicenow.com/sn_appstore_store.do#!/store/application/9085854adbb52810122156a8dc961910/1.1.0?referer=%2Fstore%2Fsearch%3Flistingtype%3Dallintegrations%25253Bancillary_app%25253Bcertified_apps%25253Bcontent%25253Bindustry_solution%25253Boem%25253Butility%25253Btemplate%26q%3DCLI&sl=sh
  2. Make sure to have the CLI Metadata plugin installed in the SN instance.














  1. Make sure to have the SNC Client path should be set in the PATH variable (Environment) [Eg:C:\Users\urspv\.snc]


SN CLI Path and profile config setup:

This is the path where we have all the necessary files are useful to run this CLI functionality













This is the command to run after CLI installation done from the store. With this we are creating config.json file and /default folder where we have the commands.json file mentioned below
































Commands JSON file to connect to the SN instance using REST API service call from SN CLI client on the command line:




















Sample commands from command line using "snc record" command:

  1. This is for list of all incidents from SN PDI instance after successful REST API call done using the below command




















  1. This is to create a new incident in SN instance using REST service call on table API





















  1. End result after adding a new record from the command line












References:

1) www.Google.com

2) https://docs.servicenow.com/

3) https://developer.servicenow.com/

4) https://store.servicenow.com/sn_appstore_store.do#!/store/home

5) https://github.com/ServiceNow/servicenow-cli















Popular posts from this blog

Connecting Claude to Pega Infinity 25.1.3 via MCP — Step-by-Step

-
Image
Enable AI-powered access to your Pega Investigative Case Management data directly from Claude prompts using the Model Context Protocol (MCP) and OAuth 2.0. What is MCP and why connect Pega to Claude? The Model Context Protocol (MCP) is an open standard that lets AI assistants like Claude securely call tools and read data from external systems — all from a natural-language prompt. Think of it as a universal adapter between your enterprise systems and AI. Pega Infinity V25.1.3 ships with a first-class MCP service built on its existing REST framework. Once enabled, Claude can: Query and summarize investigative cases without switching apps Retrieve assignment details and case status on demand Trigger Pega workflows from conversational prompts Version requirement: This guide is based on Pega Infinity V25.1.3 (Community Edition) with the Rule-Service-MCP rule type. Earlier versions may not include native MCP support. Architecture overview The connection uses three layers: Claude as the AI c...
Read more

itextpdf API to generate PDF doc from an image file using Pega PE

-
Image
Probably some of the techies might have an idea on an opensource called " itextpdf " (earlier name is lowagie ) to convert an image file(png,jpeg,jpg,tiff,gif etc.) to a PDF file. It is very simple to use this API in Pega function to build the logic using java code. Moreover, this API comes in one single jar file and we need to import it in Pega before we start using it.  I see the conversion comes good in PDF file but not sure if any limitations of this API in terms of conversion is like formatting, font, images etc. So far so good and may be we can keep this API as one of our solutions while working on the requirements accordingly.  Heard that same API can be used to convert the text file to PDF but I didn't explore on it. Those who are interested to work on text -> PDF can take a look at the documentation. Don't hesitate to contact me offline for any further discussion in this context :) :) Prerequisites for doing this exercise: 1) itextpdf 5.4.0 jar file 2) Peg...
Read more

Understanding of Hugging Face platform for AI/ML platform

-
Image
Hugging Face is a platform that provides tools and libraries for natural language processing (NLP), machine learning, and artificial intelligence. It is known for its Transformers   library, which offers pre-trained models for tasks such as text classification, translation, question answering, and more. Hugging Face also hosts a model hub where users can share and discover pre-trained models. Hugging Face is useful in various domains, including: Natural language processing (NLP): Provides tools and pre-trained models for tasks like text classification, translation, sentiment analysis, and question answering. Machine learning research: Offers state-of-the-art models and datasets for researchers to experiment and innovate. Data science and analytics: Helps data scientists analyze and interpret large volumes of text data. AI application development: Enables developers to build AI-powered applications with ease using pre-trained models and APIs. A very simple exercise using the google...
Read more