/grunt-servicenow

Servicenow Grunt Task

Primary LanguageJavaScript

ServiceNow Grunt Tasks

Grunt tasks used to work with pushing and pullin records to a ServiceNow instance

Installation

You need Grunt CLI installed globally:

$ npm install -g grunt-cli
$ npm install grunt-servicenow --save-dev

Tasks

  • watchAndPush - Monitor all directories for changes and push to instance
  • pull - Grab changes to records from instance and bring down
  • push - Grab local changes and push to instance
  • runserver - Run a local server that proxies REST requests to the defined instance

init

This sets up the configuration file with a hash of your instance credentials, insstance name, and project prefix

$ grunt init

grunt init

This is a mandatory tasks to run for all instance related tasks.

watchAndPush 

$ grunt watch
$ grunt watch:FolderName

pull

With Prompts

This task will prompt what record type(s) you want to pull down

$ grunt pull

Specific Record Type

This pulls down all records in the given record type (e.g. ui_pages, content_css). By default, we will only pull down files prefixed with whatever project prefix you specified during grunt init.

You can access any record type specified in .sn-config.json

$ grunt pull:RecordType

Specific Record

This pulls down a specific record from a specific record type (e.g. a ui_page called project_prefixrecordName). By default, we will prepend the name you specify with the project prefix you specified during grunt init.

$ grunt pull:RecordType:RecordName

pullLike

Wraps the pull task and adds a prefix to search a given record type (e.g. find all ui_pages that start with prefix). This enables you to override the prefix specified in .sn-config.json or pull down a file with a specific name.

$ grunt pullLike:RecordType:prefix

push

With Prompts

This task will prompt what folders you wan to update from and ask for a file wildcard

$ grunt push

Specifc Folder

This updates all records from the files in the given folder (e.g. ui/_pages, content/_css). You can access any folder specified in .sn-config.json

Note If you want to use a prefix for finding records, use grunt push or grunt pushLike

$ grunt push:FolderName

Specific File

This updates a specific record from a specific folder (e.g. a ui_page called fileName).

$ grunt push:FolderName:FileName

pushLike

Wraps the push task and adds a prefix to search a given folder (e.g. find all ui_pages that start with prefix)

$ grunt pullLike:FolderName:prefix

runserver 

$ grunt runserver #default port 3000
$ grunt runserver:PORT

Version

0.4.1

License

MIT