Article Type: Node Reference
Audience: Developers, App Admins
Module: Data Flows / Node Designer
Applies to Versions: Platform 3.0+
Prerequisites: Basic understanding of Data Flow concepts, familiarity with GraphQL

1. Overview

What are Fuuz Platform Nodes?

Fuuz Platform Nodes are specialized nodes that interact directly with core Fuuz platform capabilities. These nodes provide access to the GraphQL API, document generation, email services, calendar functions, and flow orchestration - enabling deep integration with the platform's data and services.

Why are they important?

These nodes eliminate the need for external API calls when working with Fuuz data and services. They provide optimized, secure access to query and modify data models, generate documents, send notifications, and orchestrate complex multi-flow processes.

The 8 Fuuz Platform Nodes

2. Query Node

The Query node gives you access to the Fuuz GraphQL API including custom schema. The node supports both handwritten GraphQL statements as well as a query builder where you can build out what you want the query to return.

You provide the filtering parameters you require into the variables section. For better type hinting, you can use the API explorer to provide auto-completes for the structure of the variables based on your $variable definitions in the query.

Configuration Parameters

Example Query

query Query($where: CalendarWhereInput, $orderBy: 
  calendar(where: $where, orderBy: $orderBy, first: 
    edges {
      node {
        id
      }
    }
  }
}

3. Mutate Node

The Mutate node provides the ability to perform CRUD (Create, Update, Delete) operations on Fuuz Data Models. This includes both System and Application models.

Configuration Parameters

Upsert Mutation Example

Mutation:

mutation upsertCalendar($payload: [UpsertCalendarInput!]!) {
  upsertCalendar(payload: $payload) {
    id
    name
    description
  }
}

Variables:

{
  "payload": [
    {
      "where": { "name": "My Test Calendar" },
      "create": {
        "name": "My Test Calendar",
        "description": "New Calendar"
      },
      "update": {
        "name": "My Test Calendar",
        "description": "The Test Calendar"
      }
    }
  ]
}

4. Aggregate Node

The Aggregate node allows you to write MongoDB pipelines against the current tenant's data. This gives the ability to group, unique, and aggregate data.

Configuration Parameters

5. Saved Query Node

The Saved Query Node allows you to select a saved query to run and provide the variables required to it. This node is useful if you are copying/pasting the same query in many different places - you only need to edit it in one place and all flows using it will be updated.

Configuration Parameters

Saved Query Operation Types

6. Execute Flow Node

The Execute Flow node allows you to call a deployed flow that has Request and Response nodes. The node makes an HTTP POST request to the selected Data Flow. The Data Flow will receive the data you provide in the payload transform at its Request Node.

When the called Data Flow hits its Response Node, the result is returned through the output of this Execute Flow node. If the called Data Flow throws an error, it will be bubbled up to the Execute Flow node that called it.

Configuration Parameters

Use Case Example

There is a need for a common way to format a payload to create a document in the same format. Rather than copying and pasting the same chain of nodes to each data flow, you could create a single flow that formats the data. Other flows can then execute the formatting flow through an Execute Flow node for consistent formatting.

7. System Email Node

The System Email node utilizes Amazon SES (Simple Email Service) to send emails. This node is useful for automated error emails and reports. Emails are sent from mail@{enterprise_name}.fuuz.app.

Configuration Parameters

8. Render Document Node (Requires Stimulsoft Module - Cloud Only)

The Render Document Node is used to generate document designs within a Data Flow. Documents are generally emailed out or written to an FTP after generation.

Configuration Parameters

9. Get Calendar Node (Deprecated)

The Get Calendar Node allows you to retrieve a calendar formatted for the JSONata bindings to find events within the calendar. This can be done by selecting a static calendar from the Combobox picker or through a transform for dynamic evaluation.

Configuration Parameters

Calendar JSONata Bindings

The calendar data retrieved can be used with the following JSONata bindings:

10. Best Practices

Query & Mutate Best Practices

• Use the API Explorer for auto-complete and type hinting when building queries
• Prefer Query/Mutate nodes over Aggregate for standard CRUD operations
• Use Saved Queries for frequently reused queries across multiple flows
• Be careful when modifying Saved Queries - changes affect all flows using them

Integration Standards (from Design Guidelines)

• Use of $integrate() in transforms is highly discouraged (may be deprecated)
• Intent is to make all outbound calls pink in color for easier reference
• Use native nodes over HTTP node when available (e.g., use Plex node instead of HTTP for Plex calls)

Email Best Practices

• Be specific in subjects for easy identification (include IDs, names)
• Use HTML body for formatted tables rather than CSV attachments when practical
• Set Reply To for integrations where customers might respond
• Use BCC for QA monitoring without appearing as a recipient
  
• Use Notification Channels to manage recipients outside the flow

11. Troubleshooting

12. Related Resources

• Custom Fuuz Only JSONata Library - Platform-specific bindings including $query, $mutate, $document
• Script & Validation Nodes Complete Guide - Custom scripting capabilities
• Data Flow Design Standards - Development guidelines and best practices
• Document Designer User Manual - Creating document templates
• GraphQL API Explorer - Interactive query builder and tester
• Platform Website: fuuz.com

13. Revision History