Tagged: modules
53 documents
clear filterAction Assemblies
Structuring actions with input modules, data formatting, API invocation, error handling, and output modules to process external system requests within automations.
Module Browser
View source code for all system modules and Module API classes, with options to toggle between LZX and Java implementations.
Tags
Organize and search catalog modules and assemblies using custom tags. Assign multiple tags to items via right-click menu, then filter content by tags to quickly locate what you need.
Date/Time Triggers
Schedule automation workflows to execute at specific dates and times or on recurring intervals such as hourly, daily, or weekly schedules.
Assembly editor settings
Configure assembly editor behaviors including scroll speed, grid snapping, service account visibility, data reuse optimization, automatic module execution, and debug mode options for diagram construction.
Batch Jobs
Scheduled execution of assemblies at regular intervals using Cron, daily, or hourly scheduling for recurring background tasks like feed refreshes and data synchronization.
Default Rate Limit
Connection-level rate limits control how frequently HTTP calls can be made from an app, enforced either per connection or globally across all accounts and connections in the system.
Catalog
Left sidebar panel in the assembly editor displaying available modules, assemblies, and subassemblies organized by community and personal collections with search and filtering capabilities.
HTTP, XML, and XPath
Core concepts of HTTP, XML, and XPath required for building assemblies, plus the subset of XPath functionality supported within assembly modules for selecting nodes and attributes.
API Credentials Management
Encrypted storage system for API credentials and OAuth secrets accessed from the Admin Console or Assembly Editor, with import/export functionality and keyvault value retrieval modules.
Assembly versioning
Assembly versions track changes made during editing with messages explaining why modifications occurred. View version history, compare different versions graphically with color-coded changes, or revert to previous states.
App Assemblies
App assemblies handle user credential collection and validation for API integrations, supporting patterns like no authentication, user-entered credentials, and OAuth workflows.
Error Handlers
Custom assemblies that intercept module errors and perform post-processing, such as converting technical error messages into user-friendly ones or suppressing errors entirely.
Export Triggers
Export triggers enable one-time bulk data exports from external systems by fetching all API data via pagination. Export automations run only in manual export mode without recurring schedules.
Module Definition
Drag-and-drop interface for designing module inputs and controls that appear in the assembly editor, with preview functionality and named components for implementation access.
Subassemblies
Reusable assembly diagrams with defined inputs and outputs that can be nested within other diagrams to reduce complexity and promote functionality reuse.
Gated Triggers
Gated triggers fire once when threshold criteria are met, then reset only after the condition reverses. Configure thresholds and conditions using the Trigger (Gated) module.
Assemblies
Foundational concepts for building automations with APIANT, including assemblies, modules, data streams, wires, and the tools used to design connected software systems.
Exporting assemblies and modules
Account holders with export permissions can download assemblies and modules as files via right-click menu or the File menu, then import them into other systems.
RSS Feeds
RSS feeds deliver content in standardized XML format; learn how to generate and configure feeds in assemblies using specialized modules.
Module Description
Write catalog descriptions for modules and link sample assemblies by including sample syntax in the description field to provide users with runnable examples.
Automatic Error Retries
Configures which errors trigger automatic retries with exponential backoff scheduling up to eight attempts, primarily for transient HTTP and communication failures in transaction modules.
API Integrations
Build apps, triggers, and actions by creating assemblies in the Assembly Editor that control automation execution, configuration, and error handling.
Disabling logging
Turn off debug logging for automation triggers and actions to save filesystem space, while maintaining the ability to re-enable it anytime via menu settings.
Module Implementation
Edit and compile JavaScript and Java implementations for modules using the built-in code editor, with optional debug mode to trace execution and test in the assembly editor.
Your first assembly
Step-by-step walkthrough of building your first assembly by fetching and displaying article titles from an RSS feed using the assembly editor.
Web Services
REST-style API endpoints built as assembly diagrams that accept query parameters or POST payloads and return data in XML, JSON, or CSV format via Web Service Output modules.
Cloning items
Duplicate modules, subassemblies, and nested items using keyboard modifiers with drag operations on Mac and Windows.
Importing assemblies and modules
Methods for importing previously exported assembly and module files into your account, including context menu and File menu options.
Importing an automation
Restore previously exported automation files to your account using the Import menu, choosing between standard import to update existing automations or create new to duplicate them.
Service Accounts
Service accounts in the assembly editor group multiple API connections under a single named context so credentials can be rotated or scoped without touching each module individually.
Module Properties
Configuration options for browser-based visual modules that control their appearance and behavior within the APIANT platform interface.
Protocol Thread Triggers
Server-side always-running threads that maintain persistent connections using SDKs, with two variations: Unary threads handling all data for an app, and Per-Trigger threads with one thread per active automation.
Obtain an item's UUID
Assemblies and modules each have a unique identifier that you can retrieve by right-clicking an item in the catalog and selecting Get UUID to copy it to your clipboard.
Debug mode
Enable debug mode in the assembly editor to view module logging output, inspect data structures, and evaluate JavaScript expressions for troubleshooting assembly behavior.
Webhook Triggers
Webhook triggers enable automations to execute immediately when third-party systems push data via webhook URLs, supporting both manually configured and API-registered webhook variations.
Module Settings
Design module settings using a drag-drop interface to control behavior without adding complexity to the module's interface or wiring data inputs.
Publishing content to production
Process for deploying assemblies and modules from development to production systems, including selecting destination systems and tenants with automatic account mapping.
Trigger/Action Commonality
Shared capabilities of trigger and action assemblies including API credential handling, error handling behavior, and configuration settings exposed to automation editors.
Developer options
Access debugging tools, API documentation, and execution options for assembly developers, including trace logs, webhook monitoring, and code references for Java JSP extensions.
Managing Content
Content management for assemblies and modules enables you to organize, update, and maintain your integration components throughout their lifecycle.
Two-Way Sync
Bidirectional synchronization between systems using specialized triggers and actions that prevent infinite loops by tracking unique row identifiers and mapping data fields between applications.
Disabling item execution
Prevent modules and subassemblies from running during assembly execution by disabling them individually or in bulk using right-click context menu options.
Export an automation
Download an automation and all its dependencies as a portable file for transferring between systems or sharing with other users.
Logging
Configure debug logging for modules and subassemblies during assembly execution, enabling output to automation history or the debugger window with per-item toggle controls.
Module numbering
Modules receive automatic sequential numbers in assembly diagrams based on vertical position, enabling unique identification and reference in execution logs.
Protecting output data
Restrict module output data visibility to assembly owners only, preventing other account users from viewing sensitive information in editors, logs, and debug mode.
Publish template to production
Publish automation templates from development to production systems using gear or group menu options, selecting destination systems and tenants.
Selecting items
Methods for selecting individual items, multiple items, or all items in a diagram, including drag selection and hierarchical selection options for reorganizing workflow layouts.
What is APIANT?
APIANT is an integration platform you drive through Claude Code and the APIANT plugin. Describe the integration in plain English; Claude builds, tests, and ships it.
Assembly Development Cycle
Assembly developers submit work for review to designated reviewers, receive feedback via email with annotations, and iterate on changes through a structured review workflow.
Module IDE
Native modules built with the Module IDE extend assembly functionality with optimized performance, created by copying existing modules and edited through the integrated development environment.
Keyvalue Storage
Generic database storage mechanism organized in a five-level hierarchy of scopes, key groups, keys, value names, and values with modules for inserting, retrieving, and deleting data.