Overview

Connect your Node-RED flows to the Process Link platform. Upload files, send notifications, and integrate with industrial automation systems.

Available Nodes

| Node | Description | |------|-------------| | files upload | Upload files to Process Link Files API | | send email | Send emails via ProcessMail API (with optional attachments) | | send SMS | Send SMS messages via ProcessMail API (Twilio) | | system info | Output system diagnostics (hostname, memory, disk, uptime, etc.) |

Installation

Via Node-RED Palette Manager (Recommended)

1. Open Node-RED
2. Go to Menu → Manage palette → Install
3. Search for @processlink/node-red-contrib-processlink
4. Click Install

Via npm

cd ~/.node-red
npm install @processlink/node-red-contrib-processlink

Then restart Node-RED.

Quick Start

1. Get Your Credentials

1. Log in to the Process Link Portal
2. Go to Developer → API Keys
3. Click Generate API Key
4. Copy your Site ID and API Key

2. Add and Configure a Node

1. Find the files upload node in the palette under "Process Link"
2. Drag it into your flow
3. Double-click to configure
4. Click the pencil icon next to "Config"
5. Enter your Site ID and API Key
6. Click Add, then Done

3. Connect Your Flow

[Inject] → [File In] → [files upload] ─┬─ Output 1 (success) → [Debug]
                                       └─ Output 2 (error)   → [Debug]

Node Reference

Files Upload

Uploads files to the Process Link Files API.

Configuration

| Property | Description | |----------|-------------| | Config | Your Process Link credentials (Site ID + API Key) | | Filename | Filename for uploaded file (takes priority over msg.filename) | | Location | Destination area/folder in the Files app (default: site root) | | Prefix with timestamp | Adds YYYY-MM-DD_HH-mm-ss_ prefix to filename (ISO 8601 format) | | Timeout | Request timeout in milliseconds (default: 30000) |

Filename priority: Config filename → msg.filename → file.bin

Location: The dropdown shows your site's folder structure organized by area. Select where uploaded files should be stored. Areas and folders are fetched from the Files API when you open the node configuration.

Timestamp prefix: When enabled, always prepends the current date/time to the filename, regardless of whether it came from config or msg.filename.

Inputs

| Property | Type | Description | |----------|------|-------------| | msg.payload | Buffer | string | The file content to upload | | msg.filename | string | (Optional) Fallback filename if not set in config |

Outputs

This node has two outputs:

| Output | When | Properties | |--------|------|------------| | 1 - Success | HTTP 201 | msg.payload.ok, msg.payload.file_id, msg.file_id, msg.statusCode | | 2 - Error | API error, network error, timeout | msg.payload.error, msg.statusCode |

Status Indicators

| Color | Meaning | |-------|---------| | 🔴 Red | Error occurred | | 🟡 Yellow | Uploading in progress | | 🟢 Green | Upload successful |

Status Codes

| Code | Meaning | |------|---------| | 201 | Success | | 400 | Bad request | | 401 | Invalid API key | | 403 | API access not enabled | | 404 | Site not found | | 429 | Rate limit exceeded (max 30/min) | | 507 | Storage limit exceeded |

Send Email

Sends emails via the ProcessMail API with optional file attachments.

Configuration

| Property | Description | |----------|-------------| | Config | Your Process Link credentials (API Key) | | To | Recipient email address(es) | | Subject | Email subject line | | Body | Email body content | | Body Type | Plain Text or HTML | | CC / BCC | Optional carbon copy recipients | | Reply-To | Optional reply-to address | | Timeout | Request timeout in milliseconds (default: 30000) |

Inputs

| Property | Type | Description | |----------|------|-------------| | msg.to | string | string[] | Recipient email address(es) | | msg.subject | string | Email subject | | msg.body | string | Email body content (optional - has default) | | msg.bodyType | string | "text" (default) or "html" | | msg.file_id | string | (Optional) Single file attachment from upload node | | msg.attachments | array | (Optional) Multiple attachments: [{ fileId: "uuid" }] |

Outputs

| Output | When | Properties | |--------|------|------------| | 1 - Success | HTTP 200 | msg.email_id, msg.resend_id, msg.statusCode | | 2 - Error | API/network error | msg.payload.error, msg.statusCode |

File Attachments

Single file (direct connection): Connect the upload node directly to the mail node. The mail node automatically uses msg.file_id.

[file-in] → [upload] → [send email]

Multiple files: Use a function node to collect file IDs into msg.attachments.

Status Codes

| Code | Meaning | |------|---------| | 200 | Email sent successfully | | 400 | Bad request (missing fields) | | 401 | Invalid API key | | 403 | Service not enabled | | 429 | Daily email limit reached |

Send SMS

Sends SMS messages via the ProcessMail API using Twilio.

Configuration

| Property | Description | |----------|-------------| | Config | Your Process Link credentials (API Key) | | To | Recipient phone number in E.164 format (e.g., +61412345678) | | Body | SMS message text | | Timeout | Request timeout in milliseconds (default: 30000) |

Inputs

| Property | Type | Description | |----------|------|-------------| | msg.to | string | string[] | Recipient phone number(s) in E.164 format | | msg.body | string | SMS message text | | msg.payload | string | (Fallback) Used as body if msg.body is not set |

Outputs

| Output | When | Properties | |--------|------|------------| | 1 - Success | HTTP 200 | msg.message_id, msg.twilio_sid, msg.payload.segment_count, msg.statusCode | | 2 - Error | API/network error | msg.payload.error, msg.payload.code, msg.statusCode |

Phone Number Format

Phone numbers must be in E.164 format: + followed by country code and number.

• Australia: +61412345678 (drop the leading 0)
• US/Canada: +12025551234
• UK: +447911123456

Status Codes

| Code | Meaning | |------|---------| | 200 | SMS sent successfully | | 400 | Bad request (missing fields, invalid phone, message too long) | | 401 | Invalid API key | | 403 | Service not enabled or missing scope | | 429 | Daily SMS limit reached | | 503 | SMS not configured (Twilio credentials missing) |

System Info

Outputs system information for diagnostics and monitoring.

Configuration

| Property | Description | |----------|-------------| | Send on deploy | When checked (default), outputs system info when the flow is deployed |

Triggers

• On deploy (if enabled) - Automatically sends when flow starts
• On input - Any incoming message triggers a fresh reading

Output

msg.payload contains:

| Property | Description | |----------|-------------| | timestamp | ISO 8601 UTC timestamp | | localTime | Device local time string | | timezone | Timezone name (e.g., "Australia/Sydney") | | hostname | Device hostname | | platform | "win32", "linux", or "darwin" | | os | OS name and version | | arch | CPU architecture | | user | User running Node-RED | | workingDirectory | Node-RED working directory | | uptime | System uptime (raw, breakdown, formatted) | | cpu | Model, cores, architecture | | memory | Total, free, used (bytes + formatted), usedPercent | | disk | Total, free, used (bytes + formatted), usedPercent | | network | primaryIP, mac, interfaces | | nodeRed | version, uptime | | nodejs | version | | processMemory | rss, heapTotal, heapUsed |

Uptime/Memory Structure

{
  "uptime": {
    "raw": 432000,
    "breakdown": { "days": 5, "hours": 0, "minutes": 0, "seconds": 0 },
    "formatted": "5d 0h 0m 0s"
  },
  "memory": {
    "total": { "bytes": 17179869184, "formatted": "16.00 GB" },
    "free": { "bytes": 8589934592, "formatted": "8.00 GB" },
    "used": { "bytes": 8589934592, "formatted": "8.00 GB" },
    "usedPercent": 50
  }
}

Example Flow

Copy the JSON below and import into Node-RED: Menu → Import → Clipboard

[
    {
        "id": "pl-inject",
        "type": "inject",
        "z": "",
        "name": "Upload File",
        "props": [],
        "repeat": "",
        "crontab": "",
        "once": false,
        "onceDelay": 0.1,
        "topic": "",
        "x": 110,
        "y": 100,
        "wires": [["pl-file-in"]]
    },
    {
        "id": "pl-file-in",
        "type": "file in",
        "z": "",
        "name": "Read File",
        "filename": "/tmp/myfile.csv",
        "filenameType": "str",
        "format": "",
        "chunk": false,
        "sendError": false,
        "encoding": "none",
        "allProps": true,
        "x": 270,
        "y": 100,
        "wires": [["pl-upload"]]
    },
    {
        "id": "pl-upload",
        "type": "processlink-files-upload",
        "z": "",
        "name": "Upload to Process Link",
        "server": "",
        "filename": "",
        "timeout": "30000",
        "apiUrl": "https://files.processlink.com.au/api/v1/sites/{siteId}/files/upload",
        "x": 470,
        "y": 100,
        "wires": [["pl-debug-success"], ["pl-debug-error"]]
    },
    {
        "id": "pl-debug-success",
        "type": "debug",
        "z": "",
        "name": "Success",
        "active": true,
        "tosidebar": true,
        "console": false,
        "tostatus": false,
        "complete": "true",
        "targetType": "full",
        "x": 680,
        "y": 80,
        "wires": []
    },
    {
        "id": "pl-debug-error",
        "type": "debug",
        "z": "",
        "name": "Error",
        "active": true,
        "tosidebar": true,
        "console": false,
        "tostatus": false,
        "complete": "true",
        "targetType": "full",
        "x": 670,
        "y": 120,
        "wires": []
    }
]

After importing:

1. Double-click the Read File node → change the file path to your file
2. Double-click the Upload to Process Link node → click the pencil icon → enter your Site ID and API Key
3. Click Deploy
4. Click the inject button to upload

Security

• ✅ API keys are stored encrypted by Node-RED
• ✅ All communication uses HTTPS
• ✅ Keys are never logged or exposed in flow exports

Requirements

• Node-RED >= 2.0.0
• Node.js >= 14.0.0

Support

• 🐛 Issues: GitHub Issues
• 📧 Email: [email protected]
• 🌐 Website: processlink.com.au

License

MIT