esppy.connectors.PISubscriber

class esppy.connectors.PISubscriber(afelement=None, iselementtemplate=None, name=None, is_active=None, snapshot=None, rmretdel=None, pisystem=None, afdatabase=None, afrootelement=None, afattribute=None, configfilesection=None)

Bases: esppy.connectors.base.Connector

Subscribe to operations from a PI Asset Framework (AF) server

Parameters

afelementstring

Specifies the AF element or element template name. Wildcards are supported.

iselementtemplateboolean

Specifies whether the afelement parameter is an element template name. By default, the afelement parameter specifies an element name.

snapshotboolean, optional

Specifies whether to send snapshot data

rmretdelboolean, optional

Removes all delete events from event blocks received by the subscriber that were introduced by a window retention policy.

pisystemstring, optional

Specifies the PI system. The default is the PI system that is configured in the PI AF client.

afdatabasestring, optional

Specifies the AF database. The default is the AF database that is configured in the PI AF client.

afrootelementstring, optional

Specifies the root element in the AF hierarchy from which to search for parameter afelement. The default is the top-level element in the AF database.

afattributestring, optional

Specifies a specific attribute in the element. The default is all attributes in the element.

configfilesectionstring, optional

Specifies the name of the section in the config file to parse for configuration parameters. Specify the value as [configfilesection].

Returns

PISubscriber

__init__(self, afelement=None, iselementtemplate=None, name=None, is_active=None, snapshot=None, rmretdel=None, pisystem=None, afdatabase=None, afrootelement=None, afattribute=None, configfilesection=None)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(self[, afelement, …])	Initialize self.
clear(self)
copy(self[, deep])	Return a copy of the object
from_element(data[, session])	Construct connector from XML definition
from_parameters(conncls[, type, name, …])
from_xml(data[, session])	Construct connector from XML definition
get(self, key[, default])
items(self)
keys(self)
pop(self, key[, default])	If key is not found, d is returned if given, otherwise KeyError is raised.
popitem(self)	as a 2-tuple; but raise KeyError if D is empty.
set_properties(self, \*\*kwargs)	Set connector properties
setdefault(self, key[, default])
to_element(self)	Export connector definition to ElementTree.Element
to_xml(self[, pretty])	Export connector definition to XML
update(\*args, \*\*kwds)	If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
values(self)

Attributes

connector_key
property_defs