Rapid Platform Documentation

website·Indexed 29 days ago

https://rapiddocs.z8.web.core.windows.net/

Technical documentation and changelogs for the Rapid Platform, featuring guides on Adaptive Designer components like Split Choices, workflow diagrams, and platform updates including SendGrid support, SharePoint Permission Sync, and Data Table features.

Tokens
126.7K
Snippets
178
Records
1.2K
Agent score
47%

What's inside Rapid Platform

  1. Overview of Menus in Rapid Platform Designer

    In the Rapid Platform, menus function as lists of buttons used to navigate information pages or trigger specific actions. Menu options are configured via the Designer Sidebar. There are two primary applications for menus:

    1. Configuring Sidebars for the Explorer and Designer views.
    2. Configuring the command bar within the Explorer view of a data table.
  2. Overview of RAPID Platform Experiences

    RAPID Platform uses 'Experiences' as self-contained interfaces for interacting with site data. The primary experiences are:

    • Explorer: Used for direct data management, allowing users to view, edit, and delete items in the site. Accessible via quick link buttons at the bottom of the main site menu.
    • Workflow: A BPMN 2.0-based tool for creating and managing process diagrams and automating business activities. Accessible via quick navigation buttons at the bottom of the main site sidebar.
    • Designer: The administrative tool used to define Table and Column structures, manage pages and views, and perform general site administration. Accessible via the navigation bar at the bottom of the menu.
    • Tasks: A dedicated interface for users to find and manage their assigned tasks, accessible at https://tasks.rapidplatform.com/.
  3. Overview of the Embedded Files component

    The Embedded Files component acts as a designated 'pigeon hole' or window for files, providing a UI clue to users that a specific file needs to be uploaded, included, or viewed within a page context. It allows developers to pre-configure SharePoint storage locations, enforce naming conventions, and set upload constraints.

    Key Capabilities:

    • Pre-configure SharePoint folder paths for saving files.
    • Define file name templates for consistent naming.
    • Provide custom labels to prompt users.
    • Set files as mandatory for upload.
    • Restrict uploads to either a single file or multiple files.

    Warning: This component is no longer supported as of Update 1.40.0.

  4. Overview of the Linked Items component

    The Linked Items component displays a list of universal links created for a specific item. While linked items are accessible by default via the link icon in the Explorer, the Linked Items component allows developers to provide a dedicated, organized space on a page to prevent the UI from becoming cluttered and to improve discoverability of relevant links.
  5. Overview of Rapid Workflow automation

    The Workflow application allows authorized users (Keypers) to create BPMN 2.0-compliant diagrams of company processes and automate them using a combination of code and flowchart logic. Once these diagrams are executed, they are referred to as 'Processes'.

    Common automation capabilities in Rapid Standard include:

    • Automatically copying and converting items (e.g., converting a quote to an invoice).
    • Scheduling tasks and assigning them to users via User lookup fields.
    • Creating sequential task flows that wait for user responses (e.g., onboarding or performance reviews).
    • Generating dynamic emails based on item data.
    • Generating documents and PDFs using site data.
  6. Overview of Rapid Platform UI Components

    Components in the Rapid Platform are used to define how users view and interact with information. A component must be configured within a Page. Available components include:

    • Data & Lists: Data Table, Linked Items, Activity Feed
    • Visualizations: Gantt Chart (tasks against time frame), Board, Pipeline, Process Diagram, PowerBI Report (General and Item Level)
    • Forms & Input: Form, Embedded Form, Counter
    • Files & Media: Attachments, Embedded Files, File Browser, File Preview, Image
    • General: External Page, Label
  7. Overview of the Workflow Process Diagram interface

    The Workflow Process Diagram interface consists of four primary sections:

    • Command Bar: Contains global actions for the diagram, such as Save, editing process name/details, Zoom In/Out, Download Diagram, Review Process Runs, Open Process Runs in Explorer, Inline Refresh, and Launch Process.
    • Toolbar: Contains drawing buttons (icons) used to add elements to the canvas.
    • Canvas: The central area where the process diagram is drawn.
    • Properties Panel: Used to configure individual elements or the entire process diagram. It is accessed by clicking an element on the canvas (or clicking the background for diagram-wide properties) and can be toggled using the double chevrons at the top.
  8. Overview of Folder Nesting in Document Storage

    Folder Nesting allows document folders created for items in a child table to be placed inside folders belonging to items in a parent table. This creates a hierarchical document structure, ensuring that documents related to the same parent entity (e.g., a Project) are grouped together even if they belong to different child entities (e.g., Quotes).