This Quickstart will help you get your KRL programming environment set up and working.
The old Quickstart for SquareTag is still available.
After completing this Quickstart lesson, you will:
- understand important concepts about programming in KRL including ruleset structure
- have created an account on KRE
- know how to use Devtools to register a ruleset
- have installed a ruleset in your pico
- understand how to flush a ruleset
Getting started with KRL can be a big leap because there are so many things that are different about programming in KRL:
- KRL is a rule-based language.
- KRL primarily follows an event-based programming model.
- KRL programs execute with a cloud-based model; there is no way to execute them from the command line.
- KRL programs are loaded from the cloud using HTTP.
- KRL programs execute in a system where identity is pervasive; all events are raised on behalf of a specific entity.
- KRL programs have built-in, entity-specific persistent storage; there is no need for external databases.
The result of these properties is a programming model that more closely resembles programming cloud-based persistent objects than anything else. We call these persistent computational objects "picos".
KRL is executed by the Kinetic Rules Engine (KRE), an open-source, cloud-based rule processing system. All of the properties listed above are present in any KRE system.
To be executed, a ruleset must be
- available via HTTP and identified by a URL
- The URL must be registered with one or more instances of KRE and given a ruleset ID or RID
- The RID must be installed in one or more picos
- The pico must receive a request via the Sky Cloud API or the Sky Event API
To complete the Quickstart, you will need
- An editor. There are KRL plugins for many popular editors
- A Github account
- An account on a KRE instance. The easiest way to do this is to use the Pico Labs-hosted instance of KRE.
Creating an Account and Pico
- Create a Kynetx account and pico
- Authorize the KRL Developer Tools application to access your account and it's associated pico (using OAuth).
The styling of the account creation and OAuth authorization page is different than the KRL Developer Tools page styling. This is normal in an OAuth situation.
Once you create your account, the minimum rulesets for running the pico and the KRL Developer Tools will have been installed. After authorizing the KRL Developer Tools you should see the main page:
Do the following:
- Create a
gitrepo for your KRL rulesets and put it on Github. You can create a different repo for each ruleset if you like or create one repo and put multiple rulesets in it.
Create file in your ruleset repo called
hello.krland put the following in it:
Use one of the methods in Tips for Developers to validate (parse) your ruleset.
Installing and using the KRL command line parser can be a real time saver if you're going to be writing several rulesets. Checking in and trying to execute rulesets that don't parse is one of the primary frustrations of beginning KRL developers.
- Check your ruleset into Github.
Registering Your Ruleset
Getting your parsed ruleset into Github is a great first step, but the rules engine doesn't know anything about it. Registering a ruleset gives it a Ruleset ID (RID) in the rules engine so that other users can install and run it.
To register the ruleset, click on the "Registered Rulesets" menu item in the KRL Developer tools, you will see this page that shows all your registered rulesets and a menu item to register a new ruleset:
When you click on "Register a new ruleset" you'll see this page:
You should enter the URL of the ruleset you saved in the last section. If you saved your ruleset in Github, ensure that you enter the raw URL.
After you press "Register Ruleset" you'll be returned to the list of registered rulesets. The ruleset you just registered should be in the list:
Note that registering a ruleset creates both
dev versions of the RID which can be updated independently. You can use different RID versions to create a production copy and a development copy of the ruleset.
The ruleset is now registered and ready for use.
You only need register a ruleset once. Once the RID is created, you can use the KRL Developer Tools to update the URL if you change the location where you're storing it.
Installing the Ruleset
Registering a ruleset tells the rules engine about it, but doesn't put in any pico so it can be run. Installing the ruleset in a pico is a separate activity. Registering rulesets is a developer activity, while installing them is a user activity. As a developer, you're in both roles, so you have to do both. Consequently, the next step is to install your ruleset. We're going to install it in the same pico that we're running the KRL Developer Tools from.
When you click on Installed Rulesets, you'll see a page that lists all of the installed rulesets and a menu item to install a new ruleset like so:
When you click on "New Ruleset" you will have a form in which you can type the RID of the ruleset to install. For now, you should stick with the
prod version of the RID.
When you click "Install" you'll be taken back to the list of installed rulesets:
Clicking on the ruleset you just installed will show you information about it (and give you a button for uninstalling it if you choose):
Flushing the Ruleset
When the rules engine reads a ruleset from the URL where it is located, the rules engine parses it, optimizes it, and caches the result. The next time the ruleset engine needs the ruleset it uses the cached copy, saving time in getting, parsing, and optimizing. This presents a challenge to the developer since changing the KRL in the ruleset doesn't tell the rules engine that new code is available.
One frustrating part of using Github for a rule repository is that changes that are checked in can sometimes take several minutes to be seen in the raw URL. Even if you have flushed the ruleset from the rules engine, if Github returns the old content, you'll see the old behavior. You can't really do anything but wait this out.
You can use the KRL Developer Tools to flush any ruleset you've registered, Click on "Registered Rulesets" and then on the ruleset you want to flush.
Clicking "Flush" will flush the selected ruleset.
The rules engine has an API for flushing rulesets so you can tell it that the code has changed. The Tips for Developers gives instructions on how to use the API to flush rulesets. I usually take the time to set up a post-commit hook in Github when I use the Github repository for my rulesets so that a soon as I check them in, they have been flushed from the rules engine. This saves countless frustrating moments trying to figure out why your changes are being seen in the rules engine when in fact you just forgot to flush the ruleset from the rules engine.
Debugging the Ruleset
See Debugging KRL Rulesets for detailed information.
After completing this Quickstart you should continue with the Pico Programming Lessons.