Robo Connector Documentation

Introduction

Robo Connector is a JS-based integration system for embedding workflows, dynamic documents, and custom functions directly into web interfaces using HTML tags. It supports dynamic rendering, document hierarchies, access control, and interaction with API-based backend logic.

Installation & Setup

• Load the script: <script src="https://robo-meister.com/js-api/public/RoboConnector.js"></script>
• Initialize using either:

  <meta name="robo-connector" data-init="my_id" data-client="Lingo Meister" />

  or

  <robo-connector robo-connector-init="my_id" data-client="Robo Connector" data-project="project1"></robo-connector>

• You may restrict script execution to specific domains via the API module's domain whitelist.

Basic Usage

Users, Clients, and Organizations

• User: A system actor with authentication and permissions.
• Client: Usually an external party (e.g. customer) with access to limited documents/functions.
• Organization: A container for users, projects, clients, documents, and more.

Documents

Documents are content blocks that can be:

• Written in HTML and served via web or API.
• Converted to PDF.
• Included in other documents using templates with %%content%%.
• Context-aware (e.g. visible only to the associated client, case, or project).
• Dynamically injected using:

<document>doc_name</document>
<document data-document="doc_name"></document>
<div data-document="doc_name"></div>
        

        
Documents can also include embedded flows and functions:
  
<flow>support_ticket</flow>
<function data-function="login"></function>

Flows

A flow represents a dynamic, multi-step business process. You can:

• Start a flow:

<flow>flow_name</flow>
<flow data-flow="flow_name"></flow>
<div data-flow="flow_name"></div>

• See step-by-step forms and current statuses.
• Use data-option for configuration (like auto-refresh, styling, user role).
• Understand that flow templates define the blueprint; instances are the live executions.

Functions

Functions are dynamic interactive blocks (similar to actions). They can be:

• Workflow-related or independent (e.g. login, fetch cart).
• Injected like:

<function data-function="login"></function>
<function data-function="cart" data-option='{"client_id":123}'></function>

Supported attributes include:

• data-after-function: trigger chaining
• data-hide-after-function: conditional visibility
• data-provider: switch backend providers

Examples

1. Login & Register

<function data-function="login"></function>
<function data-function="register"></function>

2. Offers with Subscriptions

• Create limited-time offers, bind them to a client, or restrict based on login.
• Use documents to show content and functions to handle actions.

3. Embedded Cart or One-Page Checkout

<function data-function="cart"></function>
<document data-document="checkout-page"></document>