Reference · built on requestConnectorPLC, SCADA & MES

KEPServerEX

Tag values, channel and device definitions, and server logs from KEPServerEX through the Configuration API and IoT Gateway.

About

KEPServerEX is PTC's connectivity server for industrial devices. It runs as a Windows service, polls PLCs and other equipment through driver-specific channels, and presents their tags to clients over OPC UA and other server interfaces. Its Configuration API is an HTTPS REST service for adding, editing, reading, and deleting channels, devices, tags, and tag groups as JSON. The optional IoT Gateway feature publishes tag name, value, quality, and timestamp to REST and MQTT endpoints, and its REST Server agent answers browse, read, and write requests.

Through Fibric, an operator reads tag values from the IoT Gateway REST Server on a schedule, watches the event and audit logs, and proposes a tag write or a configuration change. You approve. Each change is sent once and leaves a receipt: what changed, why, and how to undo it.

This is a reference listing. It documents what Fibric would read from KEPServerEX and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • Tag values by Channel.Device.Tag id through the IoT Gateway REST Server: GET or POST /iotgateway/read and GET /iotgateway/browse
  • Tag updates on value change or at a publish rate, as JSON with tag ID, value, quality, and timestamp, from REST Client and MQTT Client agents
  • Channels, devices, tags, and tag groups under /config/v1/project through the Configuration API
  • Server users, user groups, and UA endpoints under /config/v1/admin
  • Event log, transaction log, and audit log at /config/v1/event_log, /config/v1/transaction_log, and /config/v1/audit_log
  • Configuration API health at /config/v1/status, which needs no credentials, and server details at /config/v1/about

Proposed actions

  • Target capability: propose a tag value write through POST /iotgateway/write on a REST Server agent with the write endpoint enabled
  • Target capability: propose adding or editing a channel, device, or tag through the Configuration API project endpoints
  • Target capability: propose a tag group or alias change under /config/v1/project

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Catch a stale or bad-quality tag before it hides a fault

    The IoT Gateway payload carries quality with every value. The operator reads tag values on a schedule, lists tags whose quality is not good, and proposes a note to the controls engineer.

    With Sensor Health, Alarm Triage

  • Reconstruct a line stop from the tag history

    Execution and fault tags read through /iotgateway/read feed a timeline of the stop. The operator drafts the sequence of events for the shift lead and files the values it used.

    With Line Downtime, Root Cause

  • Review who changed the server project

    The audit and transaction logs under /config/v1 record configuration changes. The operator reads them daily and proposes an annotation on the affected metrics when a tag or device definition changed.

    With Audit Trail, Change Annotation

Requirements

  • KEPServerEX with the Configuration API service running; it installs as a Windows service and starts with the system
  • The IoT Gateway feature with a REST Server agent, which is optional and separately configured
  • A REST Server agent bound to a network adapter other than the default Localhost only, reachable from where Fibric runs
  • A User Manager account other than Administrator; the Administrator password cannot be reset and must be 14 to 512 characters
Authentication
Configuration API calls use HTTPS Basic Authentication with a server User Manager account, or a Bearer token for Active Directory users; IoT Gateway agents validate against the same User Manager unless anonymous access is enabled.

Limits

  • Tag writes through /iotgateway/write require Enable write endpoint on the agent and a tag marked read/write
  • Collection and publish rates on REST and MQTT Client agents range from 10 milliseconds to 99999990 milliseconds
  • REST Server computer names with underscores are not valid endpoints and return HTTP 500
  • User accounts lock for 10 minutes after 10 successive failed logins

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request KEPServerEX ↗

Questions and answers

Does KEPServerEX push tag changes, or must Fibric poll?
Both. The IoT Gateway's REST Client and MQTT Client agents publish an update when a tag value changes or a publish rate is met. The REST Server agent answers GET and POST requests to /iotgateway/read on demand.
What does the Configuration API manage?
Project objects: aliases, channels, devices, tags, and tag groups, plus server users, user groups, UA endpoints, and Configuration API settings. It also serves event, transaction, and audit logs and a health status endpoint. Runtime tag values come from the IoT Gateway or OPC UA, not from this API.
Which ports are involved?
PTC lists the Configuration API on HTTP 57412 and HTTPS 57512, the IoT Gateway REST Server agent on 39320, and the default UA server on 49320 for a standard install. Other Kepware editions use different assignments.
Ask about KEPServerEX

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.