Runbook 1.1.0

Welcome to Runbook - created and maintained by Sascha Wildgrube.

Features

Renders an operations runbook for an instance.

Disclaimer

Runbook is NOT an officially supported ServiceNow product.

Runbook does NOT come with any kind of warranty. If you use it, you own it!

System Requirements

• Tokyo or Utah
• Access to GitHub.com
• DevTools 1.65.0

Installation

1. Create an account on GitHub - if not done already.
2. Create a personal access token for your GitHub account.
3. Add credentials to access GitHub - use "Basic Auth".
4. Fork the repository https://github.com/saschawildgrube/servicenow-devtools.
5. Go to Studio and import the DevTools application from source control.
6. Perform all installation steps for the DevTools application documented here: https://www.wildgrube.com/servicenow-devtools/ 
7. Fork the repository https://github.com/saschawildgrube/servicenow-runbook.
8. Go to Studio and import the Runbook application from source control.
9. The InstallApp() function must be executed.
   Run the following script as a background script in scope x_snc_run_book:

x_snc_devtools.InstallApp("x_snc_run_book");

10. Assign the x_snc_run_book.viewer role to user that should have access to the runbook.

Reference

The Runbook UI Page is the main entry point. The html in the UI Page is generated by the HtmlRenderRunbook() function.

Configuration Options

• x_snc_run_book.active

  Controls if the Runbook application is active.

• x_snc_run_book.logging.verbosity

  Controls the verbosity of log output produced by the Runbook application.

Roles

• x_snc_run_book.admin

  A user that can administrate the Runbook application.

• x_snc_run_book.viewer

  A user that can view the runbook.

Script Includes

• AppGetDependencies

  Retrieves information about the app's dependencies to other apps and required versions.

• AppGetProperty

  Gets a system property of this application.

• AppInstall

  This script installs Runbook.

• AppSetDefaults

  Sets all system properties to default values.

• AppSetProperty

  Sets a system property of this application.

• Debug

  Produces a log output in the application log using the DevTools Debug function.

• DevTools

  Implements the extension point for DevTools.

• DevToolsGetApplicationStatus

  The function DevToolsGetApplicationStatus is called by the DevTools extension point instance class and returns the application status object with additional status information to be displayed on the "DevTools Application Overview" page.

• DevToolsGetFormatConfig

  The DevToolsGetFormatConfig function is called by the DevTools extension point instance class and returns an object with field formatting information.

• DevToolsGetInstancePipelineName

  The function DevToolsGetInstancePipelineName is called by the DevTools extension point instance class and returns the pipeline name of an instance based on the given actual name.

• DevToolsGetLinkDirectory

  The DevToolsGetLinkDirectory function is called by the DevTools extension point instance class and returns an extended (or modified) link directory object that serves as the basis for the DevTools Link page.

• DevToolsGetParentRecord

  The DevToolsGetParentRecord function is called by the DevTools extension point instance class and returns a parent record for the given record if it can be determined.

• DevToolsRenderDebugDump

  The function DevToolsRenderDebugDump is called by the DevTools extension point instance class and returns additional debug information provided by the application.

• HtmlRenderRunbook

  Renders an operations runbook for the instance.

• IsActive

  Returns true if the application is active, otherwise false.

• Log

  Produces a log output in the application log.

• LogError

  Produces an error log output in the application log.

• LogWarning

  Produces a warning log output in the application log.

License

Copyright 2022-2023 by Sascha Wildgrube

Licensed under the Apache License, Version 2.0 (the "License")

You may not use Runbook except in compliance with the License.

You may obtain a copy of the License at: https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Release Notes

1.1.0 - 2023-08-07

1. San Diego is no longer actively supported.
2. Runbook as been fully tested in Utah.
3. DevTools 1.65.0 is now required.
4. Added chapter "Connections" to the runbook.
5. Added test for function HtmlRenderRunbook().
6. Removed not required template code.
7. Changed AppInstall() to not execute other AppInstall() functions.

1.0.0 - 2022-11-14

First baselined version