Argomento precedente: faq

Argomento successivo: doSelectKD()

search

I parametri seguenti sono validi per il metodo search:

Parametro

Tipo

Descrizione

SID

Numero intero

Identifica la sessione recuperata dall'accesso.

problema

Stringa

Identifica la descrizione del problema per cui trovare le soluzioni.

resultSize

Numero intero

Identifica il numero di documenti per cui si desidera recuperare informazioni dettagliate. I documenti rimanenti restituiscono solo i propri ID. È possibile accedere alle informazioni dettagliate di questi documenti in seguito utilizzando il metodo getDocumentsByIDs(). L'impostazione predefinita è 10.

propertyList

Stringa

Identifica l'elenco di valori separato da virgole di campi di database da cui si desidera recuperare le informazioni. I campi seguenti vengono sempre restituiti, indipendentemente dal parametro propertyList:

  • ID
  • DOC_TYPE_ID

sortBy

Stringa

Identifica il campo di database che si desidera utilizzare per ordinare i risultati. Più campi di ordinamento non sono supportati. Il valore predefinito è RELEVANCE. Se id è un ordinamento secondario, ordina sempre i risultati. Per una proprietà di ordinamento valida, vedere il metodo faq.

descending

Boolean

Identifica un indicatore che è possibile utilizzare per ordinare i risultati in ordine decrescente.

relatedCategories

Boolean

Restituisce un elenco di tutte le categorie correlate per i documenti trovati.

searchType

Numero intero

Tipo di ricerca da eseguire:

  • 1 = Ricerca in lingua naturale (NLS)
  • 2= Ricerca Gestione della conoscenza

matchType

Numero intero

Rappresenta il tipo di corrispondenza:

  • 0 = Corrispondenza di tipo OR
  • 1 = Corrispondenza di tipo AND
  • 2 = Corrispondenza esatta

Nota: se per il parametro searchType viene selezionato NLS, sono validi solo i matchTypes OR e AND.

searchField

Numero intero

Rappresenta la combinazione binaria di campi in cui eseguire la ricerca:

  • Titolo = 1
  • Riepilogo = 2
  • Problema = 4
  • Risoluzione = 8

Ad esempio, per ricercare in tutti i campi, specificare 15 (1+2+4+8). Per ricercare solo nei campi Riepilogo e Problema, specificare 6 (2+4).

Nota: il valore predefinito esegue la ricerca nel campo Problema.

Se si imposta il parametro searchType su NLS, il parametro searchFields viene ignorato poiché le ricerche NLS possono essere eseguite solo nel campo Problema.

categoryPath

Stringa

Limita i risultati della ricerca a una o più categorie specifiche. È necessario specificare il percorso completo dell'ID della categoria e, nel caso di più categorie, separarle utilizzando le virgole. Ad esempio, 1-3-5, 1-4-8 per limitare la ricerca alle categorie 5 e 8 (e le relative sottocategorie).

whereClause

Stringa

Utilizzare questo parametro per aggiungere la propria ‘clausola where SQL’ per il filtraggio dei risultati della ricerca.

maxDocIds

Numero intero

Rappresenta il numero massimo di ID dei documenti che può essere restituito. Ad esempio, se per il parametro resultSize si specifica 10 e per il parametro maxDocIds 50, se nel database sono presenti 100 documenti corrispondenti, per 10 di essi verranno recuperate le informazioni dettagliate e per 40 verranno restituiti gli ID. I 50 documenti rimanenti non vengono restituiti. L'impostazione predefinita è 100.

Descrizione

Ricerca le soluzioni per un problema. I documenti vengono recuperati in base al problema passato. Viene restituito qualsiasi documento che corrisponde alla descrizione del problema oppure a una descrizione simile. Per migliorare le prestazioni, questi metodi restituiscono solo informazioni dettagliate su un insieme di documenti definito dall'utente, che viene controllato tramite il parametro resultSize. I documenti rimanenti restituiscono solo i propri ID. Utilizzando questo metodo, è possibile ad esempio impostare un meccanismo di paging in cui l'utente può fare clic sui collegamenti ‘In alto’, ‘Precedente’, ‘Successivo’ e ‘In basso’. Quando si deve recuperare l'insieme successivo di informazioni, è possibile utilizzare il metodo getDocumentsByIDs().

Valore restituito

Un nodo <UDSObjectList> con le sezioni seguenti:

Nodo <UDSObject> dalla sezione relativa alla descrizione del nodo <UDSObject> di questo capitolo. Sarà un nodo <UDSObject> con tutte le proprietà per i primi n documenti che il metodo trova quando il valore di n è uguale al valore del parametro resultSize. Ad esempio, se il parametro resultSize è 10, il parametro maxDocIds è 50 e il metodo trova 100 documenti, vi saranno 10 nodi <UDSObject> con tutte le proprietà richieste nella sezione <Attributes> e 40 nodi <UDSObject> con la sola proprietà ID nella sezione <Attributes>. Per recuperare le informazioni dettagliate sul nodo <UDSObject> per i documenti 11-20, è necessario eseguire una chiamata al metodo getDocumentsByIDs() e passarvi gli ID.

Se il parametro getRelatedCategories è impostato su True, il nodo <UDSObjectList> viene incluso nella sezione <Attributes> per le categorie correlate. Ogni nodo <INDEX_DOC_LINKS> contiene l'ID relazionale della categoria, come mostrato nell'esempio seguente:

1-70