Skip to main content


This capability is being deprecated and will be removed in a future release of InterSystems IRIS. Please reach out to your account team if you need an alternative solution.

Method Inventory


Additional class path that should be loaded to run the AE described in AEDESCRIPTOR.
Full path to the Descriptor of the Analysis Engine that should be invoked to process the property data this index is registered for.
Name of the XData block defining additional features and indices to configure for the annotation store. If left blank, the system will look for an XData block with the same name as the index and use that if it exists. If there is no such XData block either, the default settings will be used.
Password for FILERUSER.
parameter FILERUSER = _SYSTEM;
Username the Annotation Filer component should use to connect back into InterSystems IRIS. You can create a dedicated user with just connect privileges (%Service_Login) and no access rights on actual databases for this purpose. The internal APIs will grant appropriate privileges for the duration of the Filer's session.


classmethod DeleteIndex(pID As %RawString, pArg... As %Binary)
This method is invoked when an existing instance of a class is deleted.
classmethod InsertIndex(pID As %RawString, pArg... As %Binary)
This method is invoked when a new instance of a class is inserted into the database.
classmethod PurgeIndex()
classmethod SortBeginIndex()
classmethod SortEndIndex(pCommit As %Integer = 1)
classmethod UpdateIndex(pID As %RawString, pArg... As %Binary)
This method is invoked when an existing instance of a class is updated.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab