Glossary

Cacher

A Cacher is a step-type that caches the current result. Before collection, a cacher has the ability to fast-forward through previous steps if the data is already present.

Collection

Collection object defined by a SL1 Dynamic Application.

Execution Plan

A list of steps that inform the Snippet Framework how to gather and transform the data which will be consumed by SL1.

Processor

A Processor is a step-type that performs an operation on data from the previous step.

Request ID

The unique representation for the step that is used during de-duplication which increases the performance of the Snippet Framework. Likewise, if the uniqueness is not properly identified, non-unique requests may be grouped together.

Request More Data

Request More Data is a step-type that enables the Snippet Framework to perform a looping operation to collect additional data. For example, pagination would require a Request More Data step.

Requestor

A Requestor is a step-type that performs an IO operation to gather raw data.

Snippet

Python code defined within a SL1 Dynamic Application.

Snippet Arguments

A Snippet Argument is the interface between a user and the Snippet Framework and entered within the Dynamic Application Collections page. This text is processed by the Syntax that converts the text into an Execution Plan which then informs the Snippet Framework to execute the steps in the correct order.

Snippet Framework

The Snippet Framework enables the low-code / no-code collection of data to be consumed by SL1.

Step

A re-usable piece of code that performs a single function which is executed by the Snippet Framework. Steps are chained together to create an execution plan for the Snippet Framework.

Step Path

A list of unique Request IDs that define uniqueness that is used during de-duplication.

Substitution

Substitution enables a Snippet Argument to use context-aware information to create a targeted argument. For example, if you need to make a call using the device_id you would be able to specify $did within the argument and the Snippet Framework would automatically replace the text with the value.

Syntax

A Syntax is a step-type that converts the Snippet Argument into something the Snippet Framework can consume to perform the collection.