Il pacchetto ibm_opensearch include un archivio dati conforme all'API di lettura dojo.data. Il pacchetto ibm_opensearch package viene utilizzato per stabilire un'interfaccia con un server con funzionalità di ricerca aperte. Generalmente, il supporto lato server consiste nell'ospitare un documento descrittivo OpenSearch che definisca gli URL utilizzati per interrogare il server. Il server può restituire i dati in qualsiasi formato, con il tipo di ritorno definito nell'elemento URL del documento descrittivo. Generalmente, il tipo di ritorno è X/HTML o un feed Atom o RSS.
Per creare un'istanza di questo archivio dati, viene utilizzato un URL per un documento descrittivo OpenSearch. A meno che non si disponga di una configurazione proxy, come ad esempio il componente AjaxProxy, questo documento e tutti gli endpoint di ricerca devono trovarsi sullo stesso server (ossia sullo stesso dominio) della pagina in cui viene creato l'archivio dati, a causa di limitazioni di browser tra domini. Quando si crea un'istanza dell'archivio, analizza il documento descrittivo, determina il migliore elemento URL da utilizzare, se sono presenti più elementi, in base alla semplicità di analisi dei risultati. I tipi, nell'ordine, sono Atom, RSS e HTML. In seguito, quanto i risultati vengono richiamati dall'archivio dati, sostituisce il parametro searchTerms e gli altri parametri forniti, in base al modello ed agli elementi forniti nella richiesta. L'archivio interroga il server per richiamare i risultati. Ancora una volta, a causa di limitazioni tra domini, gli endpoint URL devono trovarsi sullo stesso dominio della pagina in cui si trova l'archivio dati.
Consultare le pagine Riferimento ed Esempi di utilizzo.
L'archivio dati OpenSearch viene distribuito in due pacchetti differenti.
Il pacchetto è organizzato nel seguente modo: