KAAT (Kentika As A Toolbox) : service "Select"

Permet d'effectuer une recherche et d'obtenir en retour tout ou partie des informations relatives aux enregistrements trouvés.

La fonction de recherche proposée dans l'API exploite la recherche disponible sur le portail avec l'intégralité des possibilités. Pour une description détaillée des possibilités de recherche de Kentika : cliquer ici.

Les points forts de la recherche documentaire de Kentika sont nombreux, les principaux sont :

• recherche multi-champs ;
• opérateurs et approximation phonétique ;
• recherche sur date floue (exemple : été 2015) ;
• tri des résultats par pertinence ;
• autopostage ;
• recherche full text avec opérateurs de proximité...

Paramètres

URL : Rest/Select

Table : nom de la table ou du type (cf ci-dessus) ;

Sort : critère de tri ."A" ou "D" suivi du numéro de champ précédé de = (D=41 pour un tri par date de parution antéchronologique), "recent" pour un tri par ordre antéchronologique de création ou "auto" pour un tri par pertinence .

result_startat : numéro d'ordre du premier enregistrement à retourner ;

result_howmany : nombre de fiches (valeur par défaut : 10) ;

result_fields : champ à retourner (tous si non précisé), séparés par des points virgule.

Recherche sur un champ

what : valeur cherchée ;

field : champ sur lequel la recherche doit porter ("all" pour tous les champs) ;

oper (optionnel) : opérateur de comparaison.

Recherche multi-critère

query : équation de recherche exprimée sous la forme champ, opérateur de comaparaison, valeur recherchée, opérateur de combinaison.

Exemple : Titre='Kentika ged' AND Date de parution > '2014'

Opérateur de combinaison : AND ; OR ; AND NOT

Opérateur de comparaison : = ; > ; < ; >= ; <= ; !=

Pour une valeur vide, utiliser comme valeur "!null" ; pour une valeur non vide, utiliser "!all".

Exemple : pour sélectionner tous les enregistrements ayant un commentaire renseigné : Commentaire = !all

Autres possibilités

Recherche prédéfinie

L'utilisation d'une requête prédéfinie correspond au cas où on doit faire exécuter régulièrement une recherche avec des critères identiques (exemple : rechercher les courriers que l'utilisateur connecté doit approuver).

list : folder

folder : (numéro de la requête).

Panier

list : selection

select : (numéro du panier)

Exemples

Obtenir toutes les informations de tous les enregistrements de type "Classeur"

{"table": "classeur",

"result_howmany": "5",

"result_startat": "1"}

Les sociétés dont la ville est "Boulogne"

{"table": "société",

"what": "boulogne",

"field": "ville",

"result_howmany": "5",

"result_startat": "1"}

Exemples de requêtes correctes

{

"list": "selection",

"select": "14",

"result_howmany": "5",

"result_startat": "1"

}

{

"list": "folder",

"folder": "7",

"result_howmany": "5",

"result_startat": "1"

}

{

"table": "classeur",

"field": "fulltext",

"what": "kentika AND GED",

"result_howmany": "15",

"result_startat": "1"

}

{

"table": "thesaurus",

"what": "france",

"result_howmany": "15",

"result_startat": "1"

}

Résultats

result_nb : nombre d'enregistrements répondant à la requête

result_list : pour chaque enregistrement : un entête ; les champs demandés ; les archives éventuelles.

{

"result_nb": 20,

"result_list": [

{

"record_num": "244512406279",

"record_table": "Document.Classeur",

"record_title": "Pub A4 Archimag - lancement d'Atomic",

"record_url": "http://Localhost/KENTIKA-244512406279-Pub-a4.htm",

"Documents_Titre": "Pub A4 Archimag - lancement d'Atomic",

"Documents_Date_de_parution": "21/07/2015",

"Documents_Statut": "Publié",

"archives": [

{

"archive_url": "http://Localhost/GEIDEFile/pub_a4_kentika.jpg?Archive=191550291973&File=pub%5Fa4%5Fkentika%5Fjpg",

"archive_preview": "http://Localhost/GED_KDE/preview/P191550291973.JPG",

"archive_name": "pub-A4-kentika.jpg"

},

{

"archive_url": "http://Localhost/GEIDEFile/Kentreprise_analyse_SiteWeb.odt?Archive=192980291016&File=Kentreprise%5Fanalyse%5FSiteWeb%5Fodt",

"archive_preview": "http://Localhost/GED_KDE/preview/P192980291016.jpg",

"archive_name": "KEntreprise_Analyse_SiteWeb.odt"

}

]

},

record_Num : numéro interne Kentika de l'enregistrement sous forme codée.

Pour retrouver un enregistrement en particulier, il est possible d'utiliser la requête suivante :

{"table": "document",

"what": "244512406279",

"field": "Record_num" }

record_table : table maître suivi du type

record_title : titre de l'enregistrement

record_url : URL d'accès sur le portail à la fiche

record_relevance : pertinence de l'enregistrement par rapport à la requête

+ (champ spécifiquement demandés dans la requête)

archives : les fichiers GED attachés à la notice auxquels l'utilisateur spécifié a droit

archive_url : URL d'accès au fichier

archive_preview : URL de l'imagette

archive_name : nom du fichier

archive_relevance : pertinence du fichier

Pertinence du fichier : si la recherche portait sur le "FullText", indique que ce fichier comportait l'expression recherchée ainsi que son niveau de pertinence (echelle de 0 à 100).

Kentika permet d'écrire des scripts (en langage 4D) qui permettent de créer des rubriques virtuelles. Ces scripts peuvent être utilisés, en restituation, comme des champs réels de la base de données.

Exemple : sur le portail Atomic, les consultations des enregistrements font l'objet d'écriture dans le log. Il est ensuite possible de calculer le nombre de fois où un enregistrement a été vu via un script et d'en utiliser le résultat comme si c'était un champ de la base.

{

"table": "classeur",

"result_howmany": "5",

"result_startat": "1",

"result_fields": "Titre;Mots cles;AScript_Nb de consultations web depuis 3 mois"

}

Codes d'erreur

Si la requête ne peut aboutir, un code d'erreur est renvoyé :

{

"err_code": 52,

"err_msg": "no record found"

}

Liste des codes d'erreur : cliquer ici.

<WR_Val_EN>

KAAT (Kentika As A Toolbox) : "Select" service

Allows searching and retrieving all or part of the information about the records found.

The search function available in the API exploits the search available on the portal with the full version. For a detailed description of Kentika's research capabilities: click here.

Key features of the documentary search in Kentika are :

- multi-field search;

- operators and phonetic approximation;

- fuzzy date search (example: summer 2015) ;

- sorting results by relevance ;

- autoposting using the thesaurus;

- full text search with proximity operators...

Parameters

URL : Rest/Select

Table : name of the table or type (see above);

Sort : sort criterion "A" or "D" followed by the field number preceded by = (D = 41 for sorting by antechronological publication date), or "auto" for sorting by relevance )

result_startat : number of the first record to be returned;

result_howmany : number of records (default: 10);

result_fields : Field to return (all if unspecified), separated by semicolons.

Search on a field

what : value searched;

field : field on which to be carried ("all" pour tous les champs) ;

oper (optional) : comparison operator .

Multi-criteria search

query : search equation expressed as field, comaparaison operator, searched value, combination operator.

Example: Title = 'Kentika EDM' AND Release date> '2014'

Combination operator: AND ; OR ; AND NOT

Comparison operator: = ; > ; < ; >= ; <= ; !=

For an empty value, use as value "!null"; for a non-empty value, use "!all".

Example: to select all records with "comment" not empty: Comment =!all

Other possibilities

Predefined search

The use of a predefined query corresponds to the case where one must regularly execute a search with identical criteria (example: search the mails that the connected user must approve).

list : folder

folder : (query number).

Baskets

list : selection

select : (basket number)

Examples

Get all the information from all the "Workbook" records

{"table": "workbook",

"result_howmany": "5",

"result_startat": "1"}

Companies whose city is "Boulogne"

{"table": "companies",

"what": "boulogne",

"field": "city",

"result_howmany": "5",

"result_startat": "1"}

Examples of correct queries

{

"list": "selection",

"select": "14",

"result_howmany": "5",

"result_startat": "1"

}

{

"list": "folder",

"folder": "7",

"result_howmany": "5",

"result_startat": "1"

}

{

"table": "classeur",

"field": "fulltext",

"what": "kentika AND GED",

"result_howmany": "15",

"result_startat": "1"

}

{

"table": "thesaurus",

"what": "france",

"result_howmany": "15",

"result_startat": "1"

}

Results

result_nb: number of records responding to the query

result_list: for each record: a header; the requested fields; the archives.

{

"result_nb": 20,

"result_list": [

{

"record_num": "244512406279",

"record_table": "Document.Classeur",

"record_title": "Pub A4 Archimag - Atomic",

"record_url": "http://Localhost/KENTIKA-244512406279-Pub-a4.htm",

"Documents_Titre": "Pub A4 Archimag - Atomic",

"Documents_Date": "21/07/2015",

"Documents_Status": "Public",

"archives": [

{

"archive_url": "http://Localhost/GEIDEFile/pub_a4_kentika.jpg?Archive=191550291973&File=pub%5Fa4%5Fkentika%5Fjpg",

"archive_preview": "http://Localhost/GED_KDE/preview/P191550291973.JPG",

"archive_name": "pub-A4-kentika.jpg"

},

{

"archive_url": "http://Localhost/GEIDEFile/Kentreprise_analyse_SiteWeb.odt?Archive=192980291016&File=Kentreprise%5Fanalyse%5FSiteWeb%5Fodt",

"archive_preview": "http://Localhost/GED_KDE/preview/P192980291016.jpg",

"archive_name": "KEntreprise_Analyse_SiteWeb.odt"

}

]

},

record_Num : record number.

To get a specific record, use the following syntax :

{"table": "document",

"what": "244512406279",

"field": "Record_num" }

record_table : master table with type

record_title : record title

record_url : URL

record_relevance : relevance of the record, acccording to the query

+ (fields)

archives : files (EDM) attached to the record to which the specified user can access

archive_url : URL of the file

archive_preview : URL of the preview

archive_name : name of the file

archive_relevance : relevance of the file

Relevance of the file: if the search focused on the "FullText", indicates that this file included the sought expression as well as its level of relevance (scale from 0 to 100).

Kentika allows you to write scripts (in 4D language) that can create virtual topics. These scripts can be used, in restituation, as real fields of the database.

Example : on the Atomic portal, records lookups are written to the log. It is then possible to calculate the number of times a record was seen via a script and to use the result as if it were a field in the database.

{

"table": "folder",

"result_howmany": "5",

"result_startat": "1",

"result_fields": "Title;Keywords;AScript_NumberofDisplay since 3 months"

}

Error codes

If the request can not succeed, an error code is returned:

{

"err_code": 52,

"err_msg": "no record found"

}

List of error codes : click here.

</WR_Val_EN>