Skip to content

Home

Jump to bottom
Fuuz Documentation Team edited this page Jun 7, 2026 · 2 revisions

Plex Datasource Tools V2.0.0

Article Type: Concept / Developer Tool Overview Audience: Application Designers, Integration Specialists, Developers Module: Orchestration / Developer Tools Applies to Versions: 2.0.0+

1. Overview

The Plex Datasource Tools package is a developer utility that enables application designers to browse, explore, and rapidly integrate Plex Manufacturing Cloud datasources into Fuuz data flows. Instead of manually looking up datasource keys, input parameters, and output columns in Plex documentation, developers can use this tool to query available datasources directly from a configured Plex connection and copy pre-formatted node configurations to their clipboard for immediate use in the Data Flow Designer.

This package significantly accelerates the development of Plex integrations by providing a visual interface for datasource discovery and eliminating the tedious manual process of configuring Plex Datasource nodes with correct parameter mappings.

Note: This tool requires an active Plex API connection configured in Fuuz. Datasources are read directly from the Plex system via the configured connection, ensuring you always see the current available datasources for your Plex tenant.

Note: The original KB article includes the installable package attachment PlexDatasourceTools2001.fuuz. Download it from the original article; the file must be re-attached/linked in this repo.

2. Architecture & Data Flow

Key Definitions

  • Plex Datasource: A pre-built data retrieval or action endpoint in Plex Manufacturing Cloud, similar to a stored procedure or API endpoint. Each datasource has a unique key, defined input parameters, and structured output columns.
  • Datasource Key: A unique numeric identifier assigned to each Plex datasource. This key is required when configuring Plex Datasource nodes in Fuuz data flows.
  • Plex Datasource Node (plexDatasourceV2): A Fuuz Data Flow node type that executes calls to Plex datasources, handling authentication, parameter passing, and response parsing.
  • Connection: A configured Plex API connection in Fuuz that provides authentication credentials and endpoint configuration for accessing Plex datasources.
  • Datasource Whitelisting: The Fuuz data model that stores metadata about Plex datasources, enabling search and discovery within the platform.

Package Components

Component Type Count Description
Screens 2 Table for browsing datasources, Form for viewing details
Routes 2 Navigation paths in the Orchestration module

How It Works

The Plex Datasource Tools work by querying the Plex API directly through a configured connection:

  1. Connection Selection: The user selects a Plex connection from available configured connections.
  2. Datasource Query: The tool calls the Plex API to retrieve available datasources, optionally filtered by key or name.
  3. Metadata Display: Datasource details, including inputs (parameters) and outputs (columns), are displayed.
  4. Node Generation: The "Copy To Node" action generates a properly formatted Plex Datasource node configuration.
  5. Clipboard Transfer: The node configuration is copied to the clipboard for pasting into the Data Flow Designer.

3. Use Cases

Datasource Discovery

Developers building Plex integrations often need to find the correct datasource for their use case. Instead of searching through Plex documentation or asking Plex support, developers can browse available datasources directly from Fuuz, filtering by name to find relevant options (e.g., searching "Part" to find part-related datasources).

Parameter Mapping

Each Plex datasource has specific input parameters that must be provided. The tool displays all required and optional parameters with their data types, enabling developers to understand exactly what inputs are needed before building their integration.

Output Schema Review

Understanding what data a datasource returns is critical for building transforms. The tool displays all output columns with their data types, helping developers plan their JSONata transformations before even adding the node to a data flow.

Rapid Node Configuration

The "Copy To Node" feature generates a complete Plex Datasource node configuration, including the datasource key, parameter template, and a descriptive note with column documentation. This eliminates manual configuration and reduces errors in datasource key entry.

Integration Documentation

The generated node includes a note field documenting the datasource name, key, and all output columns with their types. This serves as inline documentation within data flows, making it easier for other developers to understand what data the node retrieves.

4. Screen Details

Datasources Whitelisted Table

Route: /system/orchestration/datasourceWhitelistings

The main browsing interface for discovering Plex datasources. This screen queries available datasources from a selected Plex connection and displays them in a searchable table.

Filters:

Filter Type Description
Connection Combobox Select the Plex connection to query (required)
Datasource Key Text Filter by specific datasource key number
Name Text Search datasources by name (partial match)

Table Columns:

Column Description
Datasource Key Unique numeric identifier (clickable link to detail form)
Name Descriptive name of the datasource
Description Documentation about the datasource purpose

Datasource Detail Form

Route: /system/orchestration/datasourceWhitelistings/form/:id/:connectionId

The detail view for a specific datasource, displaying complete metadata including input parameters and output columns.

Form Fields:

Field Type Description
Datasource Key Display The unique datasource identifier
Name Display Datasource name
Description Markdown Detailed documentation
Inputs JSON Input parameters with names and data types
Output JSON Output columns with names and data types

Form Actions:

Action Icon Description
Save 💾 save Save datasource whitelisting record (disabled by default)
Delete 🗑️ trash Delete datasource whitelisting record (disabled by default)
Copy To Node 📋 clipboard Generate and copy a Plex Datasource node to the clipboard

5. Technical Details

Copy To Node Output

When the "Copy To Node" action is executed, the following node configuration is generated and copied to the clipboard:

{
  "type": "plexDatasourceV2",
  "selected": true,
  "x": 0,
  "y": 0,
  "data": {
    "parameterTransform": "{ ... input parameters ... }",
    "responseTransform": "$",
    "returnErrors": false,
    "connectionNameTransform": undefined,
    "datasourceKey": "[key number]"
  },
  "name": "[Datasource Name]",
  "note": "Datasource Key: [key]\nDatasource Name: [name]\n--------Columns--------\n[column1]: [type]\n[column2]: [type]\n..."
}

Node Configuration Fields

Field Description
type Always plexDatasourceV2 for Plex datasource nodes
parameterTransform JSONata template with input parameter names (values set to null)
responseTransform Default $ to pass through the response unchanged
datasourceKey The Plex datasource key number
name Node label displayed in the Data Flow Designer
note Documentation including column names and types

Connection Requirements

The tool filters connections to only show Plex API connections (connector ID: 72974b11-897f-47bd-896d-133962ef7bbb). Ensure you have at least one Plex connection configured before using this tool.

API Integration

The screens use remote transforms to query datasource metadata via the Plex API:

  • Method: GET
  • Parameters: datasourceKey (numeric) or datasourceName (string)
  • Response: Array of datasource metadata records with inputs and outputs/columns

6. Implementation Approach

Prerequisites

  • Active Plex Manufacturing Cloud subscription with API access
  • Plex API connection configured in Fuuz (using the Plex connector)
  • App Admin or Developer access type to install packages and access orchestration tools

Installation Steps

  1. Navigate to the Fuuz Package Manager.
  2. Upload the Plex Datasource Tools package (.fuuz file).
  3. Complete the installation process.
  4. Verify the screens are accessible at /system/orchestration/datasourceWhitelistings.

Typical Workflow

  1. Navigate to Datasources Whitelisted: Access via the Orchestration module menu or direct URL.
  2. Select Connection: Choose your Plex connection from the dropdown.
  3. Search for Datasource: Enter a name filter (e.g., "Part_Get") or leave blank to browse all.
  4. Click Search: Execute the query to display matching datasources.
  5. Open Datasource Detail: Click the datasource key to view full details.
  6. Review Inputs/Outputs: Examine the parameter requirements and output schema.
  7. Copy To Node: Click the Copy To Node button to copy the node configuration.
  8. Paste in Data Flow Designer: Open your data flow and paste (Ctrl+V) to add the node.
  9. Configure Parameters: Replace null values in parameterTransform with actual values or context references.

Tip: After pasting the node, you'll need to replace null values in the parameterTransform with actual parameter values. You may also need to set the connectionNameTransform if not using a default connection.

7. Extensibility

The Plex Datasource Tools package is designed as a developer utility that can be extended.

Potential Extensions

  • Datasource Favorites: Enable the Save action to whitelist frequently used datasources for quick access.
  • Usage Tracking: Add logging to track which datasources are copied, for usage analytics.
  • Connection Preselection: Modify the table to remember the last used connection.
  • Bulk Copy: Add functionality to copy multiple datasource nodes at once.
  • Template Variations: Create different node templates (e.g., with error handling, logging, or retries pre-configured).
  • Documentation Export: Add an action to export datasource documentation to Markdown or PDF.

Supporting Other Connectors

The same pattern could be applied to create similar discovery tools for other enterprise systems with discoverable APIs, such as SAP, Oracle, or custom REST endpoints. Clone the screens and modify the connection filter and API calls to support additional connectors.

8. Troubleshooting

Issue Possible Cause Resolution
No connections in dropdown No Plex connections configured Create a Plex API connection in Connection management
Search returns no results Name filter too specific Use broader search terms or leave name blank
API error on search Connection credentials invalid Verify Plex connection settings and test connectivity
Copy To Node doesn't work Browser clipboard permissions Allow clipboard access when prompted by the browser
Pasted node shows errors Null parameters need replacement Replace null values with actual values or remove unused parameters
Form shows empty data Missing connectionId in URL Navigate from the table (which includes the connection) rather than a direct URL

9. Resources

  • Fuuz Industrial Operations Platform — Main product site
  • Data Flow Designer Documentation — Creating and configuring data flows
  • Plex Datasource Node Reference — Detailed plexDatasourceV2 node documentation
  • Connection Management Guide — Configuring Plex API connections
  • Plex Manufacturing Cloud — Plex documentation and support

10. Revision History

Version Date Editor Description
1.0 2025-01-24 Fuuz Documentation Team Initial release documenting Plex Datasource Tools v2.0.0

See Also

Source: support.fuuz.com

This article was moved from the Fuuz Platform Help wiki to live alongside its package.

Clone this wiki locally