aaGetReplicationTagEntities
- Last UpdatedMar 10, 2025
- 2 minute read
Returns the replication entities configured in the Historian database. This procedure will return the properties of the replication tag entity based on the following parameter order:
-
If a ReplicationTagEntityKey is specified, then the specific entity properties are returned.
-
If a SourceTagName is specified, then all the entities with the specific SourceTagName are returned.
-
If the Replication Server and GroupName are not specified, then all the entities belonging to the specific replication type are returned.
-
If the Replication Server and GroupName and type are specified, then all the entities belonging to the specific group and type are returned.
Syntax
aaGetReplicationTagEntities ConfigurationToReturn, ReplicationServerName, ReplicationGroupName, ReplicationTypeKey, SourceTagName, ReplicationTagEntityKey, RowsToReturn, FetchModified
where:
|
Argument |
Description |
|---|---|
|
ConfigurationToReturn |
The return configuration for the replication entities. This value is of data type tinyint, with a default of 1. |
|
ReplicationServerName |
The name of the server. This value is nvarchar(255), with a default of NULL. |
|
ReplicationGroupName |
The name of the replication group. This value is nvarchar(255), with a default of NULL. |
|
ReplicationTypeKey |
The type of replication. Value values are: 1 - Simple Replication 2 - Analog Summary Replication 3 - State Summary Replication This value is of data type tinyint, with a default of 2. |
|
SourceTagName |
The name of the source tag. This value is of data type nvarchar(256), with a default of NULL. |
|
ReplicationTagEntityKey |
The unique identifier for the replication tag entity. This value is of data type int, with a default of NULL. |
|
RowsToReturn |
The number of rows to return. This value is of data type int, with a default of 3. |
|
FetchModified |
Returns requested entities. This value is of data type bit. Valid values are: 1 = Fetch only modified entities 0 = Fetch all |
Permission
Execute permission defaults to the aaUsers, aaPowerUsers, and aaAdministrators groups.