Lucy - An Integration Platform for the Smart World

This document will help you get started with Lucy.

Overview and Concepts

• Introduction
• Key Components
  • Model Designer
  • Orchestration Engine
  • Web Service Connector Toolkit
  • Connector Gateways
  • Data Collections
  • Syncing Data
• Key Concepts
  • Models
  • Attributes
  • Model Instances
    • Attributes of Model Instances
    • Creating Model Instances
    • Removing Model Instances
    • Instance Dashboards
  • Action Sequences
    • Triggering a sequence
    • Using Blocks
    • Specifying Inputs
      • Variable inputs
    • Specifying Outputs
    • Flow of Data and Execution
  • Actions
    • Defining an action
    • Modes of Execution
      • Run on Model
      • Run on Instance
      • Trigger New Instance
    • Types of Inputs
      • Key/Value Pairs
      • Structured JSON
      • Binary Data
    • Calling an action
    • Publishing Actions
    • Restricting access to Actions
  • Event Stream and Event Handling
    • Event Structure
    • Event ID Naming Convention
    • Registering Events
    • Triggering Events
    • Handling Events
    • Triggering on the Model
      • Sequence of Items
    • Trigger a new Instance
      • Sequence of Items
    • Triggering on Instance
      • Sequence of Items
  • Message Bus
    • Publishing Messages
    • Subscribing to a channel
    • Message Queues
      • Publishing Messages
      • Subscribing to a channel
  • Permissions and Authorization
    • Understanding how Authorization works in Lucy
    • Defining App Roles for Models
      • Applying Roles to Actions
      • Applying Roles to User Interfaces
    • Assigning App Roles to user roles
    • User Groups
• Publishing an API
  • Action to bind to
  • Route and Method
  • Authentication
    • Web Hooks
  • Body format
    • JSON
    • Form Data
    • Raw Text
    • Binary
  • Using path variables
  • Standard Inputs
  • Conflicts in input names
  • Publishing APIs for model instances
  • CORS
  • Testing your APIs
• Model Designer Reference
  • Toolbar
  • Execution Panel
  • Attribute Editor
  • Debugger
  • Errors and Warnings Panel
  • Concurrent Users Panel
  • Properties Panel
  • Staging Area
  • Block List
  • API Routes
  • Search Panel
  • Version History
  • Permissions Section
• Bulk Loading and Importing Data
  • Uploading Data
  • Error Handling
  • Downloading Empty Templates
  • Supporting Multiple Bulk Import Actions
  • Excel Sheet Format
• Testing and Debugging
  • Testing Actions
  • Debugging action sequences
    • Global Debug Log
    • Performance Implications
    • Privacy Implications
• Exporting and Importing your Models
  • Exporting models
  • Import Models
• Data Collections
  • Collection
    • Creating a Collection
    • Updating a Collection
    • Deleting a Collection
  • Attributes
    • Creating an Attribute
    • Updating an Attribute
    • Deleting an Attribute
  • Working with Collections
    • Lucy Data Collection Blocks
      • Insert one document
      • Insert all documents
      • Filter Configuration
      • Find one document
      • Find all documents
      • Update one document
      • Update all documents
      • Replace one document
      • Delete one document
      • Delete all documents
      • Count all documents
    • Javascript Data Collection API
      • insertOne
      • insertMany
      • findOne
      • findMany
      • updateOne
      • updateMany
      • replaceOne
      • deleteOne
      • deleteMany
      • count
      • aggregate
      • Arbitrary Options
  • Settings
• Queues
  • Configurations
• Trends
  • Working with Trends
    • Lucy Blocks
      • Add Point
      • Query Points
    • Javascript API
      • addPoint
      • addPointSync
      • addPoints
      • addPointsSync
      • queryPoints
      • Arbitrary Options
  • Settings
• Override API Key
  • Lucy Actions
  • Lucy Events
• Web Service Connector Toolkit
  • Defining a new Web Service
  • Setting up authentication details
    • Basic Authentication
    • OAuth 2
    • Custom Authentication
  • Web Service Method Definitions
    • Adding a method
    • Specifying the URL and HTTP Method
    • Editing Headers
    • Query String Parameters
    • Defining the body format
    • Using placeholders in the method definitions
    • Parsing Outputs
    • Error Handling
    • Custom Pre-Processing
    • Input Pin Configuration
  • Registering Accounts
  • User Agents
  • SSL
  • Using connectors
  • Javascript objects
    • request
    • runtime
  • Additional WebService Configuration
    • Create Additional Configuration
    • Update Additional Configuration
    • Delete Additional Configuration
    • Providing Value for Additional Configuration
    • Using the Additional Configuration
• On-Premise Connectors
  • Connector Types
  • Using a connector
  • Setting up a connector
  • Setting up a connector from Model Designer
  • Setting up a connector separately
  • Installing a Gateway
  • Setting up the Gateway
  • Diagnosing Problems and Monitoring
  • Architecture and Security
• Lucy Connector SDK
  • Obtaining the SDK
• Working with IoT and Real-Time Systems
  • MQTT Connector
    • Receiving MQTT messages in your model
      • MQTT Topic Pattern
      • Quality Of Service
      • Event ID
      • Content Type
    • Publishing to MQTT
  • Processing Real-Time Data
    • deadband-ref
    • setinredis-ref
    • publishmessage-ref
• Using Javascript Modules
  • Attaching Javascript Modules to Lucy Models
  • Structuring Modules
  • Referencing Javascript Modules
  • Referencing 3rd Party Modules
• Understanding Privacy Implications
  • Data Stored by your Models Instances
  • Metadata encoded in Models
  • Data stored in the debugger
  • Data stored in logs

Reference

• Blocks
  • Binary Output
  • JSON Output
  • Output
  • Action
  • Activate
  • AddDays
  • Add
  • AddMinutes
  • AddMonths
  • AddWeblet
  • AddYears
  • Get Attribute
  • Set Attribute
  • CallAction
  • Call Data Source
  • Call Service
  • Call Web Service
  • Combine
  • CurrentItem
  • CurrentUser
  • DateTime
  • Day Of Month
  • Day Of Week
  • Deactivate
  • Deadband
  • Debug
  • Delay
  • Divider
  • Equals
  • ES6Javascript
  • Event Trigger
  • Exception
  • Exists
  • ExtractValue
  • Fire Event
  • Convert JSON
  • Get Value
  • Greater
  • After
  • Hour
  • Increment By Value
  • Add Headers
  • Javascript
  • Make JSON Array
  • Exception with JSON
  • Make JSON Object
  • Extract JSON Path
  • Lookup
  • Less
  • Before
  • Merge Data
  • Minute
  • MqttPublish
  • Multiply
  • Not Equal
  • Not Installed
  • GenerateID
  • GetAccountSetting
  • GetUserByID
  • Now
  • PublishMessage
  • PublishMessageToQueue
  • SetAccountSetting
  • Parse Date
  • Parse JSON
  • InjectValue
  • PublishMessage
  • RegexCapture
  • Repeat Action
  • Schedule Action
  • Set Value
  • SetName
  • Split Text
  • String Interpolation
  • Subtract
  • Template
  • Serialize JSON
  • Unknown Action
  • Wait on Channel
  • Year
• Javascript Library
  • lucy
  • model

Appendix

• Datatypes in Lucy
  • Text Data
  • Numeric Data
  • DateTimes
  • Dictionaries
  • JSON
  • Result Sets
  • Arrays
  • Binary Data
  • Null Data
  • Dictionaries and Objects
  • Working with Dates and Times
  • Working with Binary Data
• iviva Expression Langauge
  • Syntax
  • Logic
  • Formatting
  • Transformers
  • Functions
  • Available Variables and Objects
  • Available Transformers
  • Available Functions
• Time Zone Codes