AspenTech APRM

.NET AGENT

Item Type Support

CONDITIONSASSETS

Overview

The APRM Connector allows Seeq access data from AspenTech’s Production Record Manager (APRM), an event and batch process datasource. APRM’s DataSources and Areas are indexed as Seeq assets in an asset tree and APRM Batches and Sub-Batches are indexed as conditions.

Prerequisites

You must have the REST API configured for APRM access.

Configuration

This is an example configuration template that is displayed in the Additional Configuration box that appears when you click Configure for an existing datasource (or if a new datasource is being created, in the Create new datasource connection modal that appears after clicking Add Datasource) on the Datasources administration page.

JSON

{
      "HostName": "<Your APRM server address>",
      "Port": null,
      "Username": "<Your APRM Username>",
      "Password": "<Your APRM Password>",
      "ConditionMaxDuration": "2h",
      "ServerProtocol": "https",
      "VerboseLogging": false,
      "BatchCharacteristicsQueryBatchSize": 100000,
      "BatchCharacteristicsQueryExpandDuration": "1 sec"
}

APRM Additional Configuration Field Information

Property Name	Default Value	Data Type	Description
`HostName`	A help text that must be replaced	String	The hostname for the server hosting your APRM instance. It may be an IP address or something like `sub-domain.domain.tld`.
`Port`	`null`	Integer	The port on which your APRM instance is configured to communicate on. For `http` connections, the default is `80` for `https` connections, the default is `443`.
`Username`	A help text that must be replaced	String	The username to access the APRM instance.
`Password`	A help text that must be replaced	String	The password to access the APRM instance.
`ConditionMaxDuration`	`2h`	String	The largest duration that a capsule in this condition series can be.
`ServerProtocol`	`https`	String	The protocol to be used to communicate with the APRM server. In addition to the default, `http` is also supported.
`VerboseLogging`	`false`	Boolean	A flag that determines whether additional logging should be made. This flag should be set to `true` if you encounter any issues as it could allow for valuable troubleshooting information to be logged.
`BatchCharacteristicsQueryBatchSize`	`100,000`	Integer	This field determines how many rows the APRM connector requests from your APRM instance for each call. You can lower the value if you observe memory or processor pressures on your APRM instances. Increasing this value (if your APRM instance has the headroom for it) should lower indexing and data retrieval times.
`BatchCharacteristicsQueryExpandDuration`	`1 sec`	String	The duration to expand the end of a query by to ensure that all relevant batches are retrieved.

Known Issues

Some APRM instances have limited time-resolution support, meaning that a batch or sub-batch with a START TIME of 2020-01-01T12:00:00.500Z may be retrieved for the following query START TIME >= 2020-01-01T12:00:00.600Z. If you observe such on your APRM instance, you can adjust the BatchCharacteristicsQueryExpandDuration configuration parameter to address the issue.

Please report any other issues you encounter to our support portal.

Troubleshooting

If you are having trouble connecting to or accessing data from APRM, view our guide for troubleshooting datasource issues.

Performance Considerations

View our guide on optimizing datasource performance for general guidance.