Knowledge Base
Browse documentation from the CoCoCo knowledge base.
Api
- CoCore GraphQL API Overview — Introduction to CoCore's GraphQL API for developers familiar with JDF, covering core concepts, domain architecture, and how to map traditional print production workflows to modern GraphQL patterns.
- Core GraphQL Patterns — Comprehensive guide to fundamental GraphQL patterns in CoCore including keyset pagination, filtering, sorting, error handling, and best practices for efficient data fetching.
- Job Management — Complete guide to managing print jobs in CoCore, covering job lifecycle, state management, creating and updating jobs, components integration, and production workflows.
- Components and Media — Detailed guide to working with print components and media specifications in CoCore, including substrate properties, layout and imposition, color management, and file handling for production workflows.
- Orders and Commerce — Guide to the commerce domain model - orders, customers and more.
- Introduction to GraphQL — A comprehensive introduction to GraphQL concepts, benefits, and how it works within the CoCore platform.
- GraphQL for REST Users — A comprehensive guide for REST API developers transitioning to GraphQL, comparing concepts and providing practical migration strategies.
- GraphQL for XML Users — A guide for developers familiar with XML/SOAP APIs to understand GraphQL concepts, highlighting key differences and migration strategies.
- Recommended GraphQL Tooling — Essential GraphQL development tools, clients, and utilities for building applications with the CoCore platform.
Custom Apps
- Custom Apps Development Guide — Build custom functionality directly within CoCore using Custom Apps - from simple widgets to full applications, without managing infrastructure or deployment.
- Kiosk Mode - Purpose-Built Interfaces for Focused Work — Deploy Custom Apps as dedicated kiosk interfaces for shop floor workers, quality control stations, customer check-ins, and other focused workflows that require simple, purpose-built interactions with your production data.
Mqtt
- MQTT Getting Started Guide — Introduction to connecting devices to CoCoCo using MQTT protocol for real-time monitoring, centralized data management, and enhanced analytics.
- MQTT Connection Configuration — Detailed guide for configuring MQTT connections including authentication parameters, regional endpoints, and TLS security requirements.
- MQTT Data Types — Overview of the four data types supported by CoCoCo MQTT - metrics for time series data, toggles for boolean states, gauges for current values, and counters for cumulative changes.
- MQTT Publishing Data — Complete guide to publishing device data to CoCoCo using MQTT topics and payload formats for status, errors, metrics, toggles, gauges, and counters.
- MQTT Subscribing to Commands — Guide for subscribing to MQTT topics to receive commands and configuration updates from the CoCoCo platform sent to your devices.
- MQTT JavaScript Example — Complete JavaScript implementation example using MQTT.js showing connection setup, data publishing, command subscription, and error handling patterns.
- MQTT Automation with Reactions — Guide for creating automated workflows using CoCoCo Reactions to respond to MQTT device data with Lua scripting for intelligent device management and proactive responses.
Scripting
- Lua Scripting API Overview — Comprehensive overview of the Lua scripting API that allows developers to write custom logic and interact with application functionality through predefined modules.
- Lua Beginners Guide — Essential Lua programming guide covering variables, data types, control structures, and functions for beginners writing scripts in CoCoCo.
- Sandbox Environment — Describes the security-focused sandbox environment that restricts dangerous modules and functions to ensure scripts cannot access the file system or execute system commands.
- Cache Module — Provides distributed caching functionality with TTL support and prefix-based isolation for storing and retrieving data across script executions.
- Database Module — Provides secure access to execute SQL queries against configured databases with parameterized queries and permission-based access control.
- GraphQL Module — Enables execution of GraphQL queries and mutations against the application's core schema with automatic actor-based authorization.
- Notifiers Module — Provides comprehensive notification functionality for sending messages to individual recipients or groups through multiple channels with user preference support.
- HTTP Module — Provides secure HTTP request functionality with SSRF protection, automatic retries, and response parsing for API integration and external service communication.
- Templates Module — Provides powerful template rendering capabilities using Liquid templating syntax with support for dynamic data processing and sophisticated templating features.
- Encoding Module — Provides functionality to convert Lua data structures into common interchange formats like JSON and XML for API integrations and data export.
- Print Module — Provides enhanced output functionality that replaces Lua's standard print function with structured logging and debugging capabilities.
- Time Module — Provides comprehensive date and time manipulation utilities with ISO8601 format support for consistent timezone-aware timestamp handling.
- JDF and JMF Builder Modules — Build JDF (Job Definition Format) and JMF (Job Messaging Format) XML documents programmatically using chainable builder APIs for print production workflows.
- Metrics Module — Enables Lua scripts to record analytics data points while automatically provisioning metrics when they do not yet exist.
Workflow
- Expressions — Provides comprehensive date and time manipulation utilities with ISO8601 format support for consistent timezone-aware timestamp handling.