Getting Started
This document will introduce you to key tools and concepts that you should understand prior to using the Snippet Framework.
Introduction
Before starting development using the Snippet Framework you should understand all of the SL1 developer pre-requisites. The SL1 Development Pre-requisites section covers the crucial topics you should understand to utilize this framework fully.
Start by reading the Low-Code Philosophy section to understand what the Snippet Framework means for Dynamic Applications. Then read the Snippet Framework page, which will introduce the concepts step-by-step and show you how the Snippet Framework works. These sections will teach you the essential fundamentals. The next steps you take in the documentation will depend on your learning style:
If you like to see practical working examples, go to the Snippet Framework PowerPack section.
If you prefer “learning by doing” with a visual walk-through of the development and testing process, go to the Development Tutorial.
Understanding the Snippet Framework lets you fully employ the steps for your specific Toolkit PowerPack.
Snippet Framework API
The Snippet Framework’s API is defined as anything available through the ScienceLogic package silo.low_code. By importing this package, you will have access to the API. Using anything outside of that scope may result in incompatibility between versions.
API breaks for silo.low_code are defined as:
Any removal of functions from the package import.
Modification of function signatures from the package import.
Default snippet modification.
Extending the Framework
The Snippet Framework helps you develop Dynamic Applications in an easy and standard way by maximizing step reuse between applications and technologies.
Although the Snippet Framework provides a low-code syntax and out-of-the-box steps, you might encounter situations in which you need to create custom step.
To create custom step to extend the framework, you need a basic understanding of Python development and a thorough understanding of the Snippet Framework. If you meet these requirements, see Creating a Custom Step.
You can add collection step to your SL1 system through the use of a ScienceLogic library in an execution environment or through a snippet in a Dynamic Application. Low-Code Decorators allow you to write custom collection step for Dynamic Applications in a snippet. Snippet-created collection step can only be used within the Dynamic Application in which they were created.
Troubleshooting
If you encounter issues while using the Snippet Framework, you can find additional information at Reference: Logging/Debugging