KoliBri 1.1.0

Welcome to KoliBri - created and maintained by Sascha Wildgrube.

Overview

Build React applications based on the KoliBri UI Framework directly in ServiceNow. Create applications that are accessible to everyone.

Disclaimer

KoliBri is NOT an officially supported ServiceNow product.

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

System Requirements

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-reactor.
  8. Go to Studio and import the Reactor application from source control.
  9. Perform all installation steps for the Reactor application documented here: https://www.wildgrube.com/servicenow-reactor/ 
  10. Fork the repository https://github.com/saschawildgrube/servicenow-kolibri.
  11. Go to Studio and import the KoliBri application from source control.
  12. The InstallApp() function must be executed.
    Run the following script as a background script in scope x_snc_kolibri:
  13. x_snc_devtools.InstallApp("x_snc_kolibri");

Setting up a new React app using the KoliBri framework

  1. Create a new UI Script to contain the main React component.
  2. Use the syntax editor macro "react" to get started.
  3. Create a Reactor Component and refer to the UI Script. The component name and the class name of the React component must be identical.
  4. Create a UI Page and add the following code into the html body:
    <g2:no_escape>$[
    x_snc_reactor.Render('KoliBriDemoApp',{ theme: 'default' });
    ]</g2:no_escape>
  5. Ajust the code for your new React component.
  6. Test the UI page.

React(or) Components

API

KoliBriCDN

Loads the KoliBri components from the CDN.

KoliBriCodiconCDN

Imports the Codicon icons.

KoliBriComponentsCDN

Loads yet another module required for KoliBri

KoliBriReactCDN

Loads the KoliBri React connector from a CDN

App

KoliBriDemoApp

A demo application to showcase the use of KoliBri components.

themestringThe KoliBri theme to be used for the application on startup. Default is "default". At the moment, only the default theme is supported.

Reference

Configuration Options

Roles

This app does not define any roles.

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 KoliBri.

  • 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.

  • 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 2023 by Sascha Wildgrube

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

You may not use KoliBri 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-09-14

  1. DevTools 1.67.0 and Reactor 1.5 are now required.
  2. Now using KoliBri 1.6.2.
  3. Added support for KoliBri react components.
  4. Always loading the DEFAULT theme.
  5. Added more components to the demo app.
  6. Added the "Reactor Components" navigation module.

1.0.0 - 2023-08-18

First baselined version