searchbox 2

Programmer's Reference Guide

release 2.2.0


Table of Contents

1. The searchbox documentation
User's Guide
Programmer's Reference Guide
CookBook
2. Introduction
3. Integrating searchbox
SOAP API
Complex data types
enum AccessType
struct AccessSpec
enum RootACLType
enum PluginType
enum ExtendedPluginType
struct PluginDLLInfo
struct ExtendedPluginValue
struct ExtendedPlugin
struct ExtendedPluginInfo
struct ExtendedPluginsBundle
struct Plugin
struct PluginInfo
struct DocFilter
struct DocFilterInfo
struct RendererPluginPipe
enum AuthType
enum CookieParamType
struct CookieParam
enum CookieActionType
struct CookieAuthParams
struct MetadataKey
struct MetadataValue
struct SourceConfiguration
struct ParamValue
struct AuthConfiguration
enum Frequency
enum Cache
struct ArchiveConfiguration
struct CollectionConfiguration
enum QueryView
enum QueryParser
enum WatchNotificationMedia
struct WatchNotificationEndpoint
struct WatchNotificationTiming
enum QueryInfo
struct QuerySliceWeight
enum NotificationDetail
struct WatchNotificationConfiguration
struct WatchConfiguration
enum QueryGroupType
struct QueryGroupRecipe
struct QueryGroupRecipeOption
enum QuerySortType
struct QuerySortRecipe
struct QuerySortRecipeOption
struct QueryGroup
struct QueryFilledGroup
struct QueryGroupKey
struct QueryGroupKeyDetail
struct QueryGroupDocData
struct QueryGroupDocData
struct QueryGroupingSpec
struct MetadataTemplateConfiguration
enum QuerySort
enum QueryAtomType
struct QueryAtom
struct QuerySpec
struct QueryResult
struct SourceInfo
enum ArchiveActivity
enum ArchiveDocumentActivity
struct ArchiveInfo
struct CollectionInfo
struct WatchInfo
struct MetadataTemplateInfo
enum PageFormat
enum Status
struct ExtendedStatus
struct CrawlLog
enum CrawlError
struct CrawlLogData
Methods
AddSource
RemoveSource
GetSourceConfiguration
SetSourceConfiguration
EnumSourceConfigurations
AddAuth
RemoveAuth
GetAuthConfiguration
SetAuthConfiguration
AddArchive
RemoveArchive
GetArchiveConfiguration
SetArchiveConfiguration
EnumArchiveConfigurations
GetArchiveInfo
ResetArchive
AddCollection
RemoveCollection
GetCollectionConfiguration
SetCollectionConfiguration
EnumCollectionConfigurations
AddWatch
RemoveWatch
GetWatchConfiguration
SetWatchConfiguration
EnumWatchConfigurations
NotifyWatches
AddMetadataTemplate
RemoveMetadataTemplate
GetMetadataTemplateConfiguration
SetMetadataTemplateConfiguration
EnumMetadataTemplateConfigurations
Query
QuickGroupingQuery
GroupingQuery
GetDocument
GetDocumentURL
GetDocumentIDs
AddDocument
RemoveDocument
GetKeepTime
SetKeepTime
ApplyMetadataTemplate
DeapplyMetadataTemplate
EnumAppliedMetadataTemplates
GetStatus
GetVersion
NormalizeURL
StartCrawl
StopCrawl
ReprocessDocuments
GetAvailableCrawlLogs
GetCrawlLog
AddUser
RemoveUser
GetUserData
SetUserData
SetUserPassword
AddGroup
RemoveGroup
EnumUsersAndGroups
GetRootACL
SetRootACL
EnumPluginDLLs
EnumExtendedPlugins
AddExtendedPlugin
RemoveExtendedPlugin
GetExtendedPlugin
SetExtendedPlugin
GetRootExtendedPluginsBundle
SetRootExtendedPluginsBundle
EnumPlugins
AddPlugin
RemovePlugin
GetPlugin
SetPlugin
EnumDocFilters
AddDocFilter
RemoveDocFilter
GetDocFilter
SetDocFilter
GetRootRendererPipe
SetRootRendererPipe
The SOAP notification service requirements
Complex data types
struct MetadataKey
struct MetadataValue
struct QueryResult
Methods
WatchNotify
I. The FFF document format
The <contents> tag - Document textual contents.
The <document> tag - Top level tag
The <fff> tag - Wraps the FFF proper
The <link> tag - An hyperlink to another document
The <low> tag - A list of words from the document
The <meta> tag - Metadata about the document
The <p> tag - A paragraph of text
Valid values for slice and dictionary ids - valid values for slice and dictionary ids
II. The XML interface
The <results> tag - Query results contents.
The <result> tag - A single query result
The <id> tag - Contains the document ID
The <URL> tag - Contains the document URL
The <title> tag - Contains the document title
The <mimetype> tag - Contains the document MIME type
The <coretextid> tag - Contains the document core text id
The <contextlist> tag - Wraps the document context list
The <context> tag - Contains a document context
The <archives> tag - Wraps the document archives list
The <archive> tag - Contains the document archive ID
The <timestamp> tag - Contains the document timestamp
The <servertime> tag - Contains the document server time
The <score> tag - Contains the document score
The <metadatalist> tag - Wraps the document metadata list
The <metadata> tag - Contains a document metadata
The <templatelist> tag - Wraps the document template list
The <template> tag - Contains a document template
4. Troubleshooting

List of Tables

3.1. Notification address formats
3.2. Special character sequences to use in notification strings