Tagged: modules
53 documents
clear filterCatalog
This document provides a comprehensive overview of the assembly editor's catalog, highlighting its various features and functionalities. Discover how this catalog encompasses a wide range of modules, assemblies, and subassemblies, both public and private.
Module Browser
The module browser is a convenient tool that enables users to easily access and explore the implementation code of various modules within the system. This includes the highly valuable Module API classes. Within the catalog, the Module API classes take pre
Tags
Find modules and assemblies easily in the assembly editor's catalog. Add or edit tags for items by right-clicking and selecting the Tags option. Tags can be entered with commas, making it simple to search for items using their assigned tags.
Action Assemblies
Learn about input, error handling, and output of Action assemblies in an automation system. Find out how to define input data fields, handle errors, and format outputs for API sending. Discover how to skip data rows or extract output data fields. Ensure y
Batch Jobs
Learn how to effectively use Batch Jobs to schedule and execute assemblies automatically. Discover the three different types of Batch Job modules - Cron, Daily, and Hourly - and how to activate and manage them. Keep track of the number of times your Batch
Assembly editor settings
Learn about the different settings available in the assembly editor menu, including scroll speed, snap drag, and service account field display. Discover debugging options such as reporting execution errors, module execution timing, debugging nested module
Default Rate Limit
The system can optionally enforce connection-level rate limits for making API calls
Date/Time Triggers
Learn how to use date/time triggers to activate functions at specific dates or times in this comprehensive document. Discover how the Trigger on Date Time module enables you to define the schedule, while Parameter modules allow users to customize it to th
Module Definition
Learn how to define and preview a module's appearance in the assembly editor with this document. Discover how each user interface component is named for easy access to its value in the implementation code.
Export Triggers
Learn about export triggers, which allow you to perform bulk data exports from one system to another. These triggers fetch API data in a paginated manner, ensuring all data is retrieved. While export automations can only be initiated manually with no on/o
App Assemblies
Learn how to effectively use app assemblies in the APIANT catalog for seamless app integrations. This document delves into the various methods for obtaining and validating user credentials in order to make API calls on behalf of trigger and action assembl
Assembly versioning
Learn how the system tracks and stores assembly edits with detailed version history in this informative document. Discover how users can open and access previous versions, compare them with the current version, and easily revert back to a saved version. E
HTTP, XML, and XPath
Learn about HTTP, XML, and XPath with this document. Discover the supported XPath functionality in assembly modules, with examples and a comprehensive table. Enhance your expertise by utilizing the Extension - Server-Side Script module for advanced XPath
API Credentials Management
Learn how to manage API credentials in the Keyvault system. This document explains how the root admin account's Keyvault contains all necessary API credentials for publicly used apps. Discover how to access and manipulate Keyvault items through the Admin
Error Handlers
Normally, when a module raises an error the assembly halts execution immediately and reports the module's error mesage
Subassemblies
Learn about subassemblies in assembly diagrams, which promote functionality re-use and reduce wiring diagram complexity. They can be easily dragged from the catalog and placed within other diagrams, appearing with a distinctive blue window in the editor.
API Integrations
Learn how the Automation Editor utilizes assemblies in the Assembly Editor to build various apps, triggers, and actions. Discover how modules within these assemblies enable seamless configuration of these components. Uncover powerful assembly logic that e
RSS Feeds
Learn how to generate and format an RSS feed for your blog or news articles using assemblies. This document provides an example using the Emit RSS Feed module and the Data Nodes - Serialize module to save the feed contents as a file on the server. Improve
Gated Triggers
Learn how gated triggers work and how they can be easily implemented for specific threshold criteria. Discover how to configure the threshold value using the Trigger (Gated) and Parameter modules, enabling the trigger to fire only once when the desired co
Module Description
Learn how to properly reference and link a sample assembly in a module's catalog entry with this comprehensive document. By including the assembly UUID in the description, you can effortlessly add a button to the module's help information, allowing users
Exporting assemblies and modules
Learn how to export assemblies and modules in a downloadable format from the catalog using the "Export" permission. Find out how to export the currently opened assembly from the File menu. Discover the process of importing the exported file into a system.
Automatic Error Retries
Learn how the system's configuration setting allows for automatic error retrying with a range of retry schedules, from 1 minute to 4 hours. Discover which errors are considered retryable, such as HTTP status codes >= 500 and communication-level errors, an
Module Implementation
Learn how to edit and compile module implementations using the code editor with this comprehensive document. Whether you're working on JavaScript implementations for the browser or Java implementations for the server, this guide will walk you through the
Importing an automation
Learn how to import a previously exported automation file with step-by-step instructions. Choose between Standard Import and Create New options, update existing automations and retain unique identifiers. Ensure all referenced apps, triggers, actions, and
Disabling logging
Learn how to manage and save filesystem space by disabling automation logging in this document. Access default debug logs for triggers and actions, stored as ZIP files, through a graphical history view. Troubleshoot efficiently with the information provid
Module IDE
Learn how to enhance assembly functionality with APIANT by creating new modules using the Module IDE. Discover how the system offers extension modules for Java, JavaScript, and PHP, but emphasizes best performance with native modules. Access the Module ID
Cloning items
Learn how to quickly clone modules and subassemblies on both Mac and Windows with this easy-to-follow guide. With just a simple key combination, you can duplicate elements effortlessly. Find out how to hold the Option key on Mac or the Control key on Wind
Your first assembly
Learn how to build a basic assembly and create a widget that shows the latest article titles from the CNBC news feed. This tutorial provides step-by-step instructions and screenshots on fetching XML data, using modules like HTTP Transaction and HTML Rende
Assembly development cycle
This document outlines a system that facilitates the development cycle for assemblies. With the "Assembly Reviewer" permission, developers can submit their work for review and receive valuable feedback from reviewers. Through comments and review request e
Importing assemblies and modules
Learn how to import assembly or module files into a catalog with this informative document. Choose your item type, select the file, and effortlessly import it by right-clicking or using the File menu. Be cautioned about using exports as an archive, as sys
Web Services
Learn how web services work and how they can be utilized to create REST-style API endpoints. Discover the different output formats available, such as XML, JSON, and CSV. Understand how input can be received through query parameters or a POST payload. Expl
Service Accounts
Learn about how the assembly editor uses the term "service account" and how users can create and manage multiple service accounts with unique names. Discover how these accounts are associated with necessary API credentials and how certain modules in the A
Protocol Thread Triggers
Learn how to use Protocol Threads with this informative document. Discover the two variations, Unary Protocol Threads and Per-Trigger Protocol Threads, and how they continuously run on the server. Find out how to create freeform threads or webhook listene
Module Properties
Discover the untapped potential of module properties in web browsers with our comprehensive document. Explore how these properties enhance visual modules and gain insights on their undocumented features for unrivaled functionality. Maximize your understan
Debug mode
Learn how to activate the assembly editor's debug mode and unlock its powerful advantages with this comprehensive document. Discover step-by-step instructions on managing the debug window, from opening and closing to clearing, minimizing, and resizing. Ex
Webhook Triggers
Learn about webhook triggers and how they are activated when data is pushed to a webhook URL by a third-party system. Discover the different variations of webhooks, including those with one event type per URL, those with multiple event types per customer
Key Concepts
This document explores the key components and concepts of assembly diagrams in a software system. It covers the assembly editor, data streams, module deprecation, JSON and XML data formats, module functionality, subassemblies, wire connections, XPath for
Obtain an item's UUID
Learn how to quickly obtain the universally unique identifier (UUID) for any assembly or module in our catalog. Simply right-click on the item, choose "Get UUID," and easily copy it to your computer's clipboard for seamless integration.
Module Settings
This document provides a comprehensive overview of a drag-drop designer tool that enables users to conveniently configure various additional settings for module behavior. With a convenient preview feature and easy accessibility through a module link, thes
Trigger/Action Commonality
Learn about the key characteristics and functionalities of Trigger and Action assemblies in this comprehensive document. Discover how API credentials are essential for most triggers and actions, with detailed instructions on acquiring them through differe
Publishing content to production
Learn how to publish assemblies and modules from development systems to linked production systems in this document. Find out how users with the "Publish to Production" permission can easily publish items from the development system using the right-click m
Keyvalue Storage
Learn about Keyvalue Storage, a versatile database system with table and modules for data insertion, retrieval, and deletion. Discover its hierarchical structure including scopes, key groups, keys, value names, and values. Explore the wide range of module
Managing Content
Learn about the extensive range of content management features offered for assemblies and modules in this comprehensive document. Discover how these features can enhance your workflow and simplify the management of your content.
Developer options
Learn how to use the developer menu to streamline the development and review process for assemblies. Access the Admin Console, Javadoc for appJSP and VTD-XML parser, trace log viewer, system webhooks log, server execution, and assembly review request all
Two-Way Sync
Learn how to achieve two-way sync between systems without infinite loops in this document. Discover the importance of data mapping and transformation with a valuable example of app value mapping. Understand the potential conflicts when records are simulta
Disabling item execution
Learn how to disable modules and subassemblies in an assembly with this helpful document. Disabling items prevents their execution during assembly runs, with their execution flag status saved upon saving the assembly. Simply right-click on a single item a
Export an automation
Learn how to export automations as downloadable files in this document. Find out how to include all the necessary components such as apps, triggers, actions, assemblies, and modules. Import the exported file later into your system, but bear in mind that i
Logging
Learn how to disable debug logging for modules and subassemblies in a software assembly with this document. Save the state of each item's debug logging flag by saving the assembly. Easily disable debug logging for individual items by right-clicking on the
Module numbering
Learn how modules within assembly diagrams are automatically numbered for easy identification in assembly execution logs. These numbers do not indicate execution order but rather represent the vertical positioning of modules in the diagram. Dive into this
Protecting output data
Learn how to protect the output data of a module in an assembly with this comprehensive guide. Discover the benefits of keeping module output data hidden from unauthorized access or logs. Only the assembly's owner can access the protected data, manipulate
Publish template to production
Learn how to publish automation templates from development systems to linked production systems. Users with the "Publish to Production" permission can easily select the option from the gear menu. Multiple automations can be published at once by choosing t
Selecting items
Learn how to select and deselect items in a diagram with this helpful document. Discover the steps to select a single item, select all items, select multiple items, and make space for new modules. Find out how to move selected modules as a group and quick
What is APIANT?
Discover APIANT, the low-code browser-based platform for building automated workflows and integrating APIs without coding. With its drag-and-drop editor, create trigger and action API integrations effortlessly. Customize your solutions through coding, ens