.. include:: ../external_links.txt


###############
Getting Started
###############

This document will introduce you to key tools and concepts that you should
understand prior to using the |FRAMEWORK_NAME|.

**********


************
Introduction
************

Before starting development using the |FRAMEWORK_NAME| you should understand
all of the SL1 developer pre-requisites. The
:ref:`SL1 Development Pre-requisites <sl1-dev-prereq>` section covers the
crucial topics you should understand to utilize this framework fully.

Start by reading the :ref:`Low-Code Philosophy <low_code_philosophy>` section
to understand what the |FRAMEWORK_NAME| means for Dynamic Applications. Then
read the :ref:`Snippet Framework <snippet-framework>` page, which will
introduce the concepts step-by-step and show you how the |FRAMEWORK_NAME|
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 :ref:`Development Tutorial <build-da-with-low-code>`.

Understanding the |FRAMEWORK_NAME| lets you fully employ the
|STEP_NAME_PLURAL| for your specific Toolkit PowerPack.

**********


********************
|FRAMEWORK_NAME| API
********************

The |FRAMEWORK_NAME|'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 |FRAMEWORK_NAME| helps you develop Dynamic Applications in an easy and
standard way by maximizing |STEP_NAME| reuse between applications and
technologies.

Although the |FRAMEWORK_NAME| provides a low-code syntax and out-of-the-box
|STEP_NAME_PLURAL|, you might encounter situations in which you need to
create custom |STEP_NAME|.

To create custom |STEP_NAME| to extend the framework, you need a basic
understanding of Python development and a thorough understanding of the
|FRAMEWORK_NAME|. If you meet these requirements, see
:ref:`Creating a Custom Step <creating-custom-step>`.

You can add collection |STEP_NAME| to your SL1 system through the use of
a ScienceLogic library in an execution environment or through a snippet in a
Dynamic Application. :ref:`Low-Code Decorators <low_code_decorators>` allow
you to write custom collection |STEP_NAME| for Dynamic Applications in a
snippet. Snippet-created collection |STEP_NAME| can only be used within
the Dynamic Application in which they were created.

**********


***************
Troubleshooting
***************

If you encounter issues while using the |FRAMEWORK_NAME|, you can find
additional information at
:ref:`Reference: Logging/Debugging <reference-logging-debugging>`