Linkiir Scripting API
Reference for the Lua scripting API available inside Linkiir workflow scripts.
Modules
| Module | Use it for |
|---|---|
Script Globals (script.globals) | Values and functions available in every script without requiring any module: the script's input payload, the current node directory, and stdlib-style helpers for loading modules and debug printing. |
Message Data (linkiir.data) | Parse (extract), build (create), and serialize messages of any supported format (HL7, X12, XML), plus the node-tree interface returned by those calls. |
Message Flow (linkiir.flow) | Everything about a message's movement through a channel: acknowledge what came in, route/enqueue what goes out. |
Connectivity (linkiir.link) | All connectivity to external systems, named for the heart of Linkiir. |
Database (linkiir.store) | Database access, named for what it does (store / retrieve). |
Byte Transforms (linkiir.codec) | Everything that turns bytes into other bytes and back: text encodings, compression, and character-set conversion. |
JSON (linkiir.json) | JSON parse and serialize operating on plain Lua tables. |
Security (linkiir.sec) | Security primitives with modern, explicit parameters. |
Runtime & System (linkiir.sys) | Small runtime helpers and filesystem access in one place. |
Logging (linkiir.log) | Emit structured log events to the workflow event topic. |
Node Configuration (linkiir.config) | Read the current node's configuration fields. |
Lua Table Library (table) | Standard Lua 5.1 table library for building and manipulating array-style tables (insert/remove/sort/concat). |
Lua Math Library (math) | Standard Lua 5.1 math library. |
Lua OS Library (time/env) (os) | Time and environment functions from the standard Lua 5.1 os library, plus the file/process functions (os.execute, os.remove, os.rename, os.tmpname, os.exit). |
Lua IO Library (files/stdio) (io) | Standard Lua 5.1 io library: local file and standard-stream I/O, available exactly as in stock Lua/LuaJIT (registered by the runtime alongside table/math/os/string). |
Lua String Library (string) | Standard Lua 5.1 string library. |
Lua Debug Library (debug) | Standard Lua 5.1 debug library: introspection and instrumentation for the call stack, locals, upvalues, and metatables. |