4PointX Documentation
Introduction
Getting Started with 4PointX Cloud
Deploy 4PointX Self-Managed
Pre-requisites
Pre Installation Guide
K8s Installation Guide
Installation Steps for Master Nodes
Step 1: Create 4px user
Step 2 Install Docker:
Step 3: Install Kubernetes
Installation Steps for Worker Nodes
Step 1: Create 4px user
Step 2: Install Docker
Step 3: Install Kubernetes
(Optional) Enable Scheduling on Master Node
Resource Limit Adjustments
Helm Installation Guide
Prerequisite:
Steps:
Install Helm in RHEL OS
Install Helm in Rocky Linux
Useful Helm commands:
Longhorn Installation Guide
Prerequisites:
Installing Longhorn (Only on Master Node)
Before deploying the 4px setup, ensure to follow the below steps after completing the Longhorn installation:Using WebUI (Recommended)
Using CLI ( if required )
Deploy 4PointX on K8s
Modify the containerd.service configuration to allow Kubernetes to access the Docker registry.
Configuring Worker Nodes For OpenSearch.
Preparing SSL Certificate (in master only).
Create a 4px Namespace in the K8S Cluster.
OSD Secret.
Docker Registry Secret
Kafka TLS Certificate Setup
Deploying 4PX Setup
Testing the 4PX OSD
Log in to 4PointX
Upgrade or Uninstall 4PointX
Upgrade 4PointX Platform
Uninstall 4PointX Platform
Monitor and Maintain 4PointX
K8s Dashboard Guide
Resize 4PointX Modules
PV Backup and Restore
Prerequisites
Step 1: Create a GCP Bucket Secret
Secret Manifest Example
Apply the Secret
Step 2: Backup PVC in Longhorn
Step 3: Restore OpenSearch PV and PVCs from Backup
Step 3.1: Delete Existing PVCs (If Present)
Step 3.2: Create PV and PVC Manifests
Step 3.3: Apply the Manifest
Step 3.4: Restart/ScaleUp OpenSearch StatefulSet
Step 3.5: Verify
TLS Security
Design
Updating SSL Certificates
Next Steps
Apps
Energy Monitoring
Specific Energy
User Guide: Idle Energy Monitoring
Overview
Filters and Navigation
Key Data Displays
Idle Energy Summary
Idle Energy Trend
All Functions
Idle Energy Trend by Function
How to Use the Idle Energy Tab Effectively
Product Variation
User Guide: Energy Monitoring Dashboard
Introduction
Overview
Filters
Key Metrics
Consumption Trend Chart
Production vs. Specific Energy Chart
Functions
Additional Features
Condition-based Maintenance
Summary
Asset Health Dashboard
Real-Time Monitoring
Fault Diagnostics
Process Correlation
Predictive Maintenance
Asset Anomalies
Process Anomalies
Workbench
Dashboards
Alerting
Alerts
Total Alerts
Unique Triggers
Alerts by Severity
Alerts Over Time
All Alerts
Grouped by Triggers
Trigger Drilldown
Trigger Selection
Watchers
Notebooks
Discover
Query Workbench
Introduction
1. Mapping SQL to OpenSearch Concepts
2. Basic Query Translation
3. Aggregation Queries
4. Joins
5. Important Differences and Limitations
6. Limitations -
7. Best Practices
8. Summary
Data Management
IoT Gateways
Introduction to IoT Gateways tab
4PointX IoT Gateway
Data Onboarding
Data Source: Edge IoT Gateway
Source Sub Type: Modbus RTU
Source Sub Type: OPC-UA
Source Sub Type: Modbus TCP
Source Sub Type: File
Source Sub Type: SQL
Data Source: Third-Party Apps
Source Sub Type: Infinite Uptime
Source Sub Type: CimCon Digital
Data Source: Cloud
Source Sub Type: AWS S3
Source Sub Type: Google Cloud Storage
Source Sub Type: Azure Data Lake
Firmware Update
Requirements
Step-by-Step Instructions
1. Log in to the 4PointX Dashboard
2. Navigate to the Gateway Management Section
3. Find Your Gateway
4. Check Gateway Status
5. Start the Firmware Update
6. Wait for the Update to Complete
7. Verify Completion
Tips
Requirements
Steps
1. Connect to the Gateway via SSH
2. Copy the Firmware ZIP File to the Gateway
3. Update the Gateway Firmware and Libraries
4. Install the Firmware
5. Verify the Updates
Tips
Asset Metadata
Plants
Functions
Function Monitors
Assets
Asset Monitors
Administration
User Management
Support Users
Steps to create support users (UI)
Create support users using Dev Tools
Repeat Step No. 5 for support-admin user.
License Management
License Tiers
Energy Monitoring System (EMS)
Condition-Based Maintenance (CBM)
IIoT Workbench
Process Anomaly (PA / PDM Module)
License Tiers
IIoT Workbench
Energy Monitoring (EMS)
Condition-Based Maintenance (CBM)
Process Anomalies
Notes:
API Documentation
Asset Metadata APIs
Assets
Create Asset
Delete Asset
Update Asset
Fetch Asset
Fetch List of Assets
Get Count of Assets
Functions
Create a Function
Delete a Function
Update Function
Fetch Function
Fetch List of Functions
Monitors
Create a Monitor
Delete Monitor
Update Monitor
Fetch Monitors
Fetch List of Monitors
Get Count of Monitors
Plants
Create a Plant
Delete a Plant
Update Plant
Fetch Plant
Fetch List of Plants
Pipelines
Fetch List of Pipelines
Count Pipelines
Execute Pipeline Action
Pipelines (Edge Server)
Create Edge Server Pipeline
Delete Pipeline
Update Pipeline
Fetch Pipeline
Handshake
Fetch Firmware
Update Pipeline Firmware Version
Pipelines (Infinite Uptime)
Create IU Pipeline
Delete Pipeline
Update Pipeline
Fetch Pipeline
Sites
Create a New Site
Delete Site
Update Site
Fetch Site
Fetch List of Sites
Samples
Retrieve Sample Trend
Retrieve Sample Count
Tags
Retrieve Tags List
Retrieve Tags Count
Query Tags Trend
Other APIs
Server Time
SQL Connect
EMS APIs
EMS Asset
EMS Benchmarking
Fetch Product Variation Table for Plant
EMS Function
Fetch Energy Metrics for Function
Fetch Energy Metrics for Functions in Plant
Fetch Energy Metric Trend for Function
EMS Monitor
Fetch Energy Metrics for Monitor
Fetch Energy Metrics Monitors in Plant or Function
Fetch Energy Metric trend for Monitor
EMS Plant
Fetch Energy Metrics for Plant
Fetch Energy Metric trend for Plant
Notebooks APIs
Notebooks
Create Notebook
Delete Notebook
Rename Notebook
Fetch Notebook Details
Fetch List of Notebooks
Fetch Count of Notebooks
Run Notebook
Schedule Notebook
Unschedule Notebook
Alerting APIs
Alerts
Fetch Alerts Count
Fetch List of Alerts
Fetch Alerts Trend
Add a Note
Watchers
Create Watcher
Delete Watcher
Update Watcher
Fetch Watcher
Fetch List of Watchers
Fetch Watcher Count
User Management APIs
Users
Create New User
Delete User
Updating User
Fetch User
Fetch List of Users
Password
Generate OTP
Validate OTP
Update User Password
CBM APIs
CM Assets
CM Assets Fault
CM Assets List
CM Events
Update Event
Fetch Event
Fetch Event List
CM Faults
CM Fault’s Status
CM Monitors
CM Monitor
CM Monitors List
CM FFT
CM FFT Peaks
CM Asset Fault Summary
CM FFT Spectrum
CM FFT Spectrum Timestamps
License Management APIs
Licenses
Generate a License
Update License
Get License
Fetch List of Licenses
Activate Licenses
Get Notification
Verify App Access
4PointX Documentation
Data Management
IoT Gateways
View page source
IoT Gateways
¶
Introduction to IoT Gateways tab
4PointX IoT Gateway
Data Onboarding
Data Source: Edge IoT Gateway
Source Sub Type: Modbus RTU
Source Sub Type: OPC-UA
Source Sub Type: Modbus TCP
Source Sub Type: File
Source Sub Type: SQL
Data Source: Third-Party Apps
Source Sub Type: Infinite Uptime
Source Sub Type: CimCon Digital
Data Source: Cloud
Source Sub Type: AWS S3
Source Sub Type: Google Cloud Storage
Source Sub Type: Azure Data Lake
Firmware Update
Requirements
Step-by-Step Instructions
1. Log in to the 4PointX Dashboard
2. Navigate to the Gateway Management Section
3. Find Your Gateway
4. Check Gateway Status
5. Start the Firmware Update
6. Wait for the Update to Complete
7. Verify Completion
Tips
Requirements
Steps
1. Connect to the Gateway via SSH
2. Copy the Firmware ZIP File to the Gateway
3. Update the Gateway Firmware and Libraries
4. Install the Firmware
5. Verify the Updates
Tips