4PointX Documentation
Introduction
Getting Started with 4PointX Cloud
Deploy 4PointX Self-Managed
Pre-requisites
Pre Installation Guide
K8S Installation Guide
Helm Installation Guide
Longhorn Installation Guide
Prerequisites:
Installing Longhorn
Before deploying the 4px setup, ensure to follow these steps after completing the Longhorn installation:
Deploy 4PointX IAoT Suite On K8S
Modify the containerd.service configuration to allow Kubernetes to access the Docker registry.
Configuring Worker Nodes For OpenSearch.
Preparing SSL Certificate.
Create 4px Namespace in the K8S Cluster.
OSD Secret.
Docker Registry secret
Deploying 4PX Setup
Testing the 4PX OSD
Log in to 4PointX IAoT Suite
Upgrade or Uninstall 4PointX
Upgrade 4PointX Platform
Uninstall 4PointX Platform
Maintain 4PX Cluster
K8S DASHBOARD Guide
Resize 4PX Modules
TLS Security
Design
Updating SSL Certificates
Next Steps
Apps
Energy Monitoring
Specific Energy
Idle Energy
Product Variation
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
Data Management
Data Pipelines
Introduction
Data Onboarding
Edge IoT Gateway
Modbus RTU
OPC-UA
OPC Server > Python (Producer) > Kafka > Python (Consumer) > Elasticsearch
Modbus TCP
File
Steps to onboard data from File
Installing Logstash
CentOS
Testing Transformed Data
Third-Party Apps
Infinite Uptime
CimCon Digital
Cloud
AWS S3
Google Cloud Storage
Azure Data Lake
IoT Gateway
Initial Configuration Steps
Testing Modbus Slaves
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
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
Firmware
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
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
Workbench
Query Workbench
View page source
Query Workbench
¶