Kanoa System Functions
Kanoa API
Welcome to our api documentation. We provide over 850 system.kanoa functions that handle everything from configuring assets, materials, modes, state, schedules, shifts, and quality checks to returning production and quality analysis.
Each function is described in detail, along with examples. You can also look inside the kanoaAPP project to see how we use the system.kanoa functions.
Function groups
| Group | What it covers |
|---|---|
system.kanoa.asset | Configure and retrieve assets: the asset hierarchy, modes, states, counters and tags. |
system.kanoa.attribute | Configure and retrieve custom (dynamic) attributes. |
system.kanoa.cmms | Kanoa Maintenance: work orders, procedures, maintenance types and KPIs. |
system.kanoa.config | MES application configuration, such as navigation and settings. |
system.kanoa.dashboard | Configure and retrieve dashboards and marquees. |
system.kanoa.date | Date and time helpers, including time zone conversions. |
system.kanoa.event | Event history: production, state, mode and counter events and their summaries. |
system.kanoa.file | File management utilities. |
system.kanoa.image | Image utilities. |
system.kanoa.inventory | Inventory management. |
system.kanoa.item | Items (materials), item classes, units and item states. |
system.kanoa.logger | Application logging. |
system.kanoa.lot | Lot tracking. |
system.kanoa.measures | Measures. |
system.kanoa.operators | Operators and crews. |
system.kanoa.order | Production orders. |
system.kanoa.performanceState | Performance states. |
system.kanoa.quality | Quality checks (QDS). Split into the sub-groups below. |
↳ system.kanoa.quality.analysis | Analysis of quality check data. |
↳ system.kanoa.quality.config | Configuration of checks, check items and their images. |
↳ system.kanoa.quality.event | Retrieval and analysis of check event data. |
↳ system.kanoa.quality.image | Image management for quality checks. |
↳ system.kanoa.quality.schedule | Scheduling of quality checks. |
↳ system.kanoa.quality.sheet | Configuration and retrieval of check sheets. |
↳ system.kanoa.quality.spc | Statistical process control (SPC). |
system.kanoa.schedule | Operations scheduling. |
system.kanoa.security | User management, roles and security functions. |
system.kanoa.serial | Serial number management. |
system.kanoa.shift | Shift management. |
system.kanoa.utilities | General helpers, such as dataset conversion and formatting. |
From Kanoa API →