Le Web Client InterAction peut être configuré en modifiant les fichiers de configuration XML. InterAction utilise une série de fichiers XML pour déterminer les pages que les utilisateurs voient lorsqu'ils travaillent dans le Web Client. Ces fichiers sont stockés sur le serveur d'application.
XML (Extensible Markup Language) est un langage de balisage similaire à HTML. La principale différence est que XML est plus structuré et extensible – un document XML peut utiliser un ensemble personnalisé de balises de balisage. Pour en savoir plus sur XML en général, consultez Vue d'ensemble de l'édition des fichiers XML.
Il existe trois principaux types de fichiers XML que vous utilisez généralement lors de la configuration du Web Client :
- Déclarations de méthode de page définissent les pages réelles que vous voyez lorsque vous travaillez dans le Web Client. Une méthode de page détermine la disposition générale et le contenu de la page.
- Déclarations de liste de nuggets définissent des listes de liens qui peuvent être placées sur une page.
- Déclarations de liste de recherche définissent également des listes de liens. Elles sont généralement utilisées pour des listes plus simples que les listes de nuggets, comme les liens sur la page d'accueil.
Cette référence décrit chacun des éléments XML (également appelés balises) disponibles dans les fichiers de configuration.
Un autre type de déclaration est utilisé pour configurer les menus. Les déclarations de menu ne sont pas couvertes dans cette référence, mais pour plus de détails sur la configuration du menu de gauche, consultez Vue d'ensemble de la personnalisation du menu principal du Web Client.
Avant d'utiliser cette référence et de configurer le Web Client, vous devez être familier avec les bases de XML. Vous devez comprendre les termes et concepts suivants :
- Éléments et balises
- La différence entre les balises ouvrantes et fermantes
- L'imbrication d'une balise dans une autre balise
- Attributs
- Attribuer des valeurs aux attributs
- Rendre un document XML bien formé
Si vous n'êtes pas familier avec ces concepts, consultez Vue d'ensemble de l'édition des fichiers XML pour un aperçu. Notez que vous devez être à l'aise avec le travail sur XML pour configurer le Web Client InterAction.
Notez que vous n'avez pas besoin de modifier les fichiers XML pour créer ou modifier des profils ou des formulaires de recherche du Web Client.
Utilisation de la référence XML
Il existe plusieurs façons d'obtenir des informations sur les fichiers XML utilisés pour configurer le Web Client InterAction.
Pour une vue d'ensemble des trois principaux types de fichiers de déclaration XML, consultez :
- Vue d'ensemble des déclarations de méthode de page
- Vue d'ensemble des déclarations de liste de nuggets
- Vue d'ensemble des déclarations de liste de recherche
Pour des détails sur les éléments et attributs individuels que vous pouvez utiliser dans chacun de ces types de fichiers, consultez le chapitre de référence approprié :
- Éléments et attributs pour une déclaration de méthode de page
- Éléments et attributs pour une déclaration de liste de nuggets
- Éléments et attributs pour une déclaration de liste de recherche
Ces sections fournissent des exemples de code et des informations détaillées sur les éléments et attributs. Pour chaque élément, la référence fournit les informations suivantes :
- Nom et description de l'élément.
- La liste des autres éléments qui peuvent être imbriqués dans l'élément.
- Les attributs qui peuvent être définis pour l'élément.
- Toutes autres notes ou exemples nécessaires.
Recherche d'informations XML
Vous pouvez rechercher des balises XML dans les sections qui suivent. Utilisez ces informations sur XML pour trouver les éléments suivants :
-
Éléments XML (balises) que vous pouvez utiliser dans les fichiers de configuration. Par exemple, vous pouvez rechercher <description>. Étant donné que les méthodes de page, les listes de nuggets et les déclarations de liste de recherche utilisent des balises portant des noms identiques, elles sont listées dans l'index avec le type de déclaration entre parenthèses, comme suit :
<description> (listes de nuggets)
<description> (méthodes de page)
-
Attributs que vous pouvez définir pour une balise XML. Les balises auxquelles un attribut s'applique apparaissent sous le nom. Par exemple, l'attribut class peut être défini pour trois balises différentes, il apparaît donc comme suit :
-
Mots-clés que vous pouvez utiliser lors de la définition des valeurs de balise ou d'attribut. Ceux-ci sont formatés de manière similaire aux attributs. Par exemple, le mot-clé modal peut être utilisé avec deux balises différentes, il apparaît donc comme suit :
- Nuggets et paramètres de nuggets qui sont discutés dans les différentes sections de référence. Notez que ce guide ne fournit pas une référence complète à tous les nuggets disponibles, bien que les nuggets couramment utilisés soient discutés dans les sections de référence.
Entrer des URL dans les déclarations du serveur d'application
Plusieurs déclarations du serveur d'application nécessitent que vous saisissiez des URL vers d'autres pages du Web Client. Par exemple, dans une déclaration de liste de recherche, vous fournissez une URL pour la page qu'un lien doit afficher.
Pour utiliser l'URL d'une autre page du Web Client, vous fournissez normalement une valeur comme la suivante :
$(PAGE_SERVER)/contact-lists-home?folderclass=1&
searchdescription=Contact+Types&folderType=All
Cette valeur se décompose comme suit :
- $(PAGE_SERVER) est une variable qui sera remplacée par l'emplacement réel du serveur de pages dans votre environnement.
- contact-lists-home est le nom de la méthode de page pour la page à afficher.
- Les valeurs restantes après le point d'interrogation (?) sont des paramètres qui transmettent des informations à la page. Cela est appelé une chaîne de requête.
Si votre serveur d'application s'appelait “AppServer1”, l'URL ci-dessus se résoudrait en :
http://AppServer1/InterAction/contact-lists-home?folderclass=1&
searchdescription=Contact+Types&folderType=All