ConsilioCatalog (open)

Properties

• PROPERTY definedby
  

  Where was this catalog defined?

• PROPERTY fieldgroups
  

  Enabled fieldgroups

• PROPERTY id
  

  Id of this catalog

• PROPERTY lang
  

  Language of this catalog

• PROPERTY managed
  

  Is this a managed catalog?

• PROPERTY priority
  

  Catalog indexing priority (0 is default, higher priorities get indexed earlier)

• PROPERTY suffixed
  

  Is this catalogs suffixed?

• PROPERTY suffixmask
  

  The suffix mask used (eg "-*")

• PROPERTY tag
  

  Tag of this catalog

• PROPERTY title
  

  Catalog title

Functions

• OBJECT FUNCTION AddCustomContentSource(STRING tag, STRING contentsourceobject, RECORD options)
  

  Add a new custom content source to a index

• OBJECT FUNCTION AddFolderToCatalog(INTEGER targetfolder, RECORD options)
  

  Add a publisher content source

• MACRO AddObjects(RECORD ARRAY objects, RECORD options)
  

  Add objects to this catalog

• MACRO ApplyConfiguration(RECORD options)
  

  Make sure configuration is applied and, if unsuffixed, the root index exists

• INTEGER FUNCTION AttachIndex(INTEGER indexmanager, RECORD options)
  

  Attach an index (backing store) to a catalog. Creation may not apply until you've waited for reconfiguration (WaitReady with forconfiguration := TRUE)

• MACRO DeleteObjects(STRING ARRAY objectids, RECORD options)
  

  Delete objects from this catalog

• MACRO DeleteSelf()
  

  Delete this catalog

• MACRO DeleteSuffix(STRING suffix)
  

  Delete a suffix from the index manager

• MACRO DetachIndex(INTEGER indexid)
• RECORD ARRAY FUNCTION GetExpectedMapping()
• STRING FUNCTION GetStorageInfo()
  

  Describe how the catalog is stored. Useful for debugging

• RECORD ARRAY FUNCTION GetSynonyms()
  

  Get the catalog's synonyms list

• BOOLEAN FUNCTION IsReadyForStorage()
• RECORD ARRAY FUNCTION ListAttachedIndices()
  

  List of indices for this catalog. First returned record is the primary index

• RECORD ARRAY FUNCTION ListContentSources(RECORD options)
  

  List the contentsources in this catalog

• RECORD ARRAY FUNCTION ListSuffixes()
  

  List suffixes created in this index

• OBJECT FUNCTION OpenContentSource(STRING tag)
  

  Open catalog by tag

• OBJECT FUNCTION OpenContentSourceById(INTEGER id)
  

  Open catalog by id

• MACRO Refresh()
  

  Explicitly refresh. You'll sometimes need this to ensure visibility of recent index changes

• MACRO ReindexCatalog(RECORD options)
  

  Reindex the catalog

• MACRO SetSynonyms(RECORD ARRAY words)
  

  Update the catalog's synonyms list

• MACRO UpdateCatalog(RECORD settings)
  

  Update catalog settings. Note thate some settings will not apply until you've waited for reconfiguration (WaitReady with forconfiguration := TRUE)

• BOOLEAN FUNCTION WaitReady(DATETIME deadline, RECORD options)
  

  Wait until the index is ready for storage