Tagged: assembly
82 documents
clear filterAssembly 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.
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.
Account Management
Account management interface in the Assembly Editor is identical to the Automation Editor — see the Automation Editor documentation for account creation, switching, and role management.
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.
Editor functionality
The assembly editor enables building sophisticated solutions through visual interfaces and drag-and-drop workflows without requiring code.
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.
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.
Test Account Selection
Control which connected service account runs during testing by selecting from a dropdown when multiple accounts are configured for an app.
Action Assemblies
Structuring actions with input modules, data formatting, API invocation, error handling, and output modules to process external system requests within automations.
Date/Time Triggers
Schedule automation workflows to execute at specific dates and times or on recurring intervals such as hourly, daily, or weekly schedules.
Execution history
View detailed records of each automation execution including processed rows, errors, billing units, and searchable history with retention based on system configuration or subscription plan.
Automations
Foundational concepts for the APIANT automation platform, including automations, triggers, actions, apps, and the automation editor used to build workflows.
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.
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.
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.
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.
Deleting content
Procedures for removing owned content from the catalog, including how to handle items that are referenced by other content elements.
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 Integrations
Build apps, triggers, and actions by creating assemblies in the Assembly Editor that control automation execution, configuration, and error handling.
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.
RSS Feeds
RSS feeds deliver content in standardized XML format; learn how to generate and configure feeds in assemblies using specialized modules.
Assemblies
Foundational concepts for building automations with APIANT, including assemblies, modules, data streams, wires, and the tools used to design connected software systems.
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.
Autosaved assemblies
APIANT automatically saves automation edits to the database at intervals and offers recovery prompts if your session ends unexpectedly before saving.
Download subroutine XML
Export a subroutine's XML definition to diagnose field mapping issues and inspect the underlying structure of your assembly components.
Subassemblies
Reusable assembly diagrams with defined inputs and outputs that can be nested within other diagrams to reduce complexity and promote functionality reuse.
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.
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.
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.
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.
Polling Triggers
Polling triggers periodically check an API for new or updated data at configurable intervals. They should only be used when webhooks are unavailable, as they consume more resources and may miss data.
Cloning items
Duplicate modules, subassemblies, and nested items using keyboard modifiers with drag operations on Mac and Windows.
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.
Integration Decision Trees
Visual flowcharts for determining which app, action, and trigger assembly types to use when building APIANT integrations.
Importing assemblies and modules
Methods for importing previously exported assembly and module files into your account, including context menu and File menu options.
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.
HTTP
HTTP app provides triggers to fetch data from URLs and actions to make REST API calls using common HTTP verbs like GET, POST, PUT, and DELETE.
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.
Building Assemblies
Create solutions using a low-code drag-and-drop assembly editor that connects components visually without writing code.
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.
Making content public/private
Control visibility of your catalog content by toggling between public and private status through context menu options on owned items.
Copy-paste items
Copy items using right-click or the Edit menu, then paste them into the same or different assembly tabs with automatic offset positioning for easy repositioning.
Downloading the automation XML definition
Export an automation's XML definition through the gear menu to review field mappings and diagnose configuration issues when you have Assembly Developer permissions.
Trigger Assemblies
Mechanisms that execute automation actions when criteria are met, including polling, webhooks, scheduled time-based triggers, gated threshold triggers, protocol connections, and bulk export options.
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.
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.
Manage account data
Access and search automation data stored at the account scope, with options to filter by column, sort by creation date, and perform individual row actions.
Managing stored data
Access and manage automation scope data stored in your account, including searching entries and performing row-level actions like deletion and editing.
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.
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.
Delete items
Remove one or more selected items from your assembly using the right-click context menu or Edit menu option.
Trigger/Action Commonality
Shared capabilities of trigger and action assemblies including API credential handling, error handling behavior, and configuration settings exposed to automation editors.
Replace one assembly with another
Substitute an assembly's implementation with another assembly of the same type, using the latest version of the source assembly.
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.
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.
Managing Content
Content management for assemblies and modules enables you to organize, update, and maintain your integration components throughout their lifecycle.
Sharing private content
Enable other accounts to access your private catalog items by granting read or write permissions through the sharing interface.
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.
Webhook Validation
Implement custom webhook validation logic using Java JSP code in the plugin editor to authenticate incoming webhooks before processing.
Web Service
Synchronous trigger that receives input data from external systems via HTTP and returns output data back to the caller after processing the automation logic.
Taking ownership of an assembly
Administrators can take ownership of assemblies they do not currently own through the catalog context menu, making themselves the assembly author.
Documenting assemblies
Add notes and links to assemblies to help others understand their purpose and functionality, including references to API documentation.
Keep edits for later
Save assembly edits as an autosave copy to resume work later without creating a new finished version of the assembly.
View an item's created and last edited dates
Access timestamps and ownership details for catalog items by right-clicking and selecting Properties to view creation date, last edit date, and owner information.
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.
View item references
Locate where catalog items are referenced by right-clicking an item and using Find options to display all items that reference it.
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.
Quick Picks
Store frequently used catalog items in the Quick Picks tray for rapid access during diagram creation. Drag items from the catalog to add them, reorder via drag-drop, and remove with the X icon.
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.
Tab sessions
Save and restore named groups of assembly diagram tabs to quickly switch between different working contexts in the assembly editor.
Tidy overlapped items
Resolving overlapped items in assembly diagrams using the automatic tidy feature to reposition elements and allow diagram saving.
Open a trigger or action assembly
Access the assembly implementation for triggers and actions through right-click context menu if you have Assembly Developer or Switch Account permissions.
Explore our documentation
Central hub for navigating APIANT documentation by subscription type or task, with quick links to account management, automation building, app connections, and platform features.
Other Assembly Types
Assembly types beyond the standard request-response pattern provide specialized integration capabilities for different workflow scenarios and data processing requirements.
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.
Assembly Editor
Visual drag-and-drop editor for building automations, API endpoints, batch jobs, and widgets by connecting app integrations, triggers, and actions into assembly diagrams.
Automation Editor
Build and manage sophisticated automation workflows with a visual editor that connects triggers, actions, and conditions to orchestrate complex business processes.
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.