Novell Documentation: eGuide 2.1 - Paramètres de commandes et exemples

Paramètres de commandes et exemples

No Action

Lorsqu'aucune opération n'est indiquée sur la ligne de commande et en " mode anonyme ", l'opération eGuideForm est déclenchée. En " mode d'authentification forcée ", AuthForm est chargé.

Paramètre

Paramètre	Description
None

Exemple

http://www.nom-domaine.com/eGuide/servlet/eGuide

AuthForm

Il s'agit de l'opération par défaut en mode d'authentification forcée. Cette opération configure les cadres initiaux des pages de login et utilise authform.xsl. authform.xsl déclenche l'opération vers AuthHeader et AuthBody.

Paramètres

Paramètres	Description
Action=AuthForm
User.context=rypxSbuoirAi	Un paramètre User.context vide crée une session.

Exemples

Mode d'authentification forcée :

http://www.nom-domaine.com/eGuide/servlet/eGuide

Mode d'authentification forcée uniquement :

http://www.nom_domaine.com/eGuide/servlet/eGuide?Action=AuthForm

REMARQUE : Lorsque vous créez un thème sans cadre, supprimez les liens de authform.xsl vers AuthHeader et AuthBody. Comme le processus d'authentification charge le paramètre authbody.xsl par défaut, authform.xsl et authbody.xsl doivent contenir les mêmes informations.

AuthHeader

Cette opération est appelée après AuthForm pour terminer la configuration des cadres. Le fichier authheader.xsl est chargé par défaut.

Paramètres

Paramètre	Description
Action=AuthHeader
User.context=rypxSbuoirAi	Un paramètre User.context vide crée une session.

Exemple

Mode d'authentification forcée uniquement :

eGuide?Action=AuthHeader&User.context=rgyadiof

AuthBody

Cette opération est appelée pour configurer la page HTML d'authentification principale. Elle est accessible en mode anonyme à l'aide de l'opération " Login ". Le fichier authbody.xsl est chargé par défaut.

Paramètres

Paramètre	Description
Action=AuthBody
User.context=rypxSbuoirAi	Un paramètre User.context vide crée une session.

Exemples

Mode d'authentification forcée uniquement :

eGuide?Action=AuthBody&User.context=rgyadiof

Mode anonyme :

eGuide?Action=Login&User.context=rgyadiof

Detail.get

Ces opérations afficheront les détails de l'entrée LDAP à partir d'un annuaire spécifié.

Paramètres

Paramètre	Description
Action=Detail.get	Opération
User.dn=cn=name,ou=name2,o=novell	Nom distinctif de l'entrée
Directory.uid=DirectoryName	Ce nom vous sera fourni par l'administrateur système de eGuide.
Object.uid=USER	Catégorie de définition de l'entrée

Paramètre optionnel	Description
User.context=	Contrôle de la session
stsh=other.xsl	Spécifie une feuille de style autre que celle par défaut.
RecurseDN=false	Lit le DN et renvoie les informations qui y sont définies.

Exemple

eGuide?User.context=rytuUjkhhkAi&Action=Detail.get&User.dn=cn=userid,ou=org,o=Novell&Directory.uid=Extensive&Object.uid=USER'

DetailEdit

Reportez-vous à Detail.get et remplacez l'opération par les opérations voulues. La seule différence est que le document XML contient des informations supplémentaires pour ces opérations.

DetailModify

Reportez-vous à Detail.get et remplacez l'opération par les opérations voulues. La seule différence est que le document XML contient des informations supplémentaires pour ces opérations.

DetailUpdate

Cette opération met à jour l'entrée LDAP dans l'annuaire et renvoie les résultats.

REMARQUE : Les attributs modifiés sont renvoyés à eGuide avec le nom clé de l'attribut et la valeur. La valeur doit être créée au format XML et codée avec le marqueur CDATA. Si le mot-clé " nochange " est détecté pour la valeur, l'attribut est ignoré et n'est pas mis à jour.

Paramètres

Paramètre	Description
Action=DetailUpdate	Opération
User.dn=cn=name,ou=name2,o=novell	Nom distinctif de l'entrée
Directory.uid=DirectoryName	Ce nom vous sera fourni par l'administrateur système de eGuide.
Object.uid=USER	Catégorie de définition de l'entrée
AttributeKeyName=<undefined><value><![CDATA[new value]]</value></undefined>

Paramètre optionnel	Description
User.context=	Contrôle de la session
stsh=other.xsl	Spécifie une feuille de style autre que celle par défaut.
RecurseDN=false	La valeur par défaut est true et remplace le DN par les informations sur l'utilisateur.

Exemple

<form action="eGuide?&Action=DetailUpdate method="post" > 
     <input name=Directory.uid type=hidden value="novell"> 
     <input name="User.context" type="hidden" value="eiadyda"> 
     <input name="Object.uid" type="hidden" value="USER"> 
      <input name="User.dn" type="hidden" value="cn=name,ou=organUnit,o=novell"> 
     <input name="TITLE" type="text" value="<undefined><value> <![CDATA[new value]]> 
</value> </undefined>" > 
</form>

eGuideForm

Il s'agit de l'opération par défaut en mode anonyme ou après le processus d'authentification en mode d'authentification forcée.

Paramètres

Paramètre	Description
Action= eGuideForm	Opération
User.context=rypxSbuoirAi	Un paramètre User.context vide crée une session.

Paramètre optionnel	Description
stsh=otherform.xsl	Permet de spécifier une feuille de style autre que celle par défaut.

Exemple

Mode anonyme :

eGuide

eGuide?Action=eGuideForm&User.context=rgyadiof&stsh=otherform.xsl

eGuideHeader

Cette opération est appelée à partir du fichier eguideform.xsl et configure les catégories et attributs de recherche eGuide.

Paramètres

Paramètre	Description
Action=eGuideHeader	Opération
User.context=rypxSbuoirAi	Un paramètre User.context vide crée une session.
Search.rows=1	Nombre de lignes de recherche à afficher par défaut.

Paramètre optionnel	Description
stsh=otherform.xsl	Permet de spécifier une feuille de style autre que celle par défaut.

Exemple

eGuide

eGuide?Action=eGuideForm&User.context=rgyadiof&stsh=otherform.xsl

eGuide.verifyCredentials

Cette opération est utilisée dans le processus d'authentification pour établir une connexion authentifiée à l'annuaire et vérifier les références des utilisateurs.

Paramètres

Paramètre	Description
Action=eGuide.verifyCredentials	Opération
User.context=rypxSbuoirAi	Un paramètre User.context vide crée une session.
Value1	DN de l'utilisateur à authentifier
Value2	Mot de passe

Paramètre optionnel	Description
RememberUserInfo=true	Lorsque la valeur est true, ce paramètre stocke les références dans un cookie du navigateur.

Exemple

eGuide?eGuide.verifyCredentials&User.context=rypxSbuoirAi&DN=cn=Admin,o=novell

eGuide.verifyNewPassword

Cette opération est utilisée lorsque le mot de passe a été paramétré pour un délai d'expiration et doit être redéfini.

Paramètres

Paramètre	Description
Action=eGuide.verifyNewPassword	Opération
User.context=rypxSbuoirAi	Un paramètre User.context vide crée une session.
OldPassword=	Ancien mot de passe
Value1=	Mot de passe
Value2=	Mot de passe

Exemple

eGuide?Action=eGuide.verifyNewPassword&User.context=rypxSbuoirAi&OldPassword=old &Value1=new psswrd&Value2=new psswrd

eGuide.selectContext

Cette opération est utilisée dans le processus d'authentification lors de la détection de plusieurs utilisateurs ayant le même ID de login.

Paramètres

Paramètre	Description
Action=eGuide.selectContext	Opération
User.context=rypxSbuoirAi	Un paramètre User.context vide crée une session.
DN=cn=name,o=container	DN sélectionné à authentifier

Exemple

eGuide?eGuide.selectContext&User.context=rypxSbuoirAi&DN=cn=Admin,o=novell

List.get

Requête de recherche avec un filtre spécifié. Le résultat obtenu est une liste. Le filtre de recherche est appliqué à l'un ou à l'ensemble des annuaires configurés dans l'outil d'administration de eGuide. Utilisez la clé max pour mettre en cache les résultats de liste supérieurs au jeu de valeurs, puis consultez l'opération List.get suivante pour connaître les listes en mémoire cache.

Paramètres

Paramètre	Description
Action=list.get	Opération
val1=value	Valeur recherchée
attr1=attribute	Nom clé de l'attribut
crit1=sw	Critères utilisés pour estimer la valeur
Object.uid=USER	Catégorie de la recherche
Search.attributes=attr1,attr2,attr3,...	Attributs renvoyés par une recherche

Paramètre optionnel	Description
User.context=rypxSbuoirAi	Un paramètre User.context vide crée une session.
Primary.sortkey=attr1	Attribut permettant de déterminer l'ordre de tri de la liste
Secondary.sortkey=attr2	Attribut permettant de déterminer l'ordre de tri de la liste
max=20	Spécifie le nombre à afficher à tout moment dans le navigateur ; ce paramètre accélère la réalisation de la requête pour l'utilisateur final.
stsh=otherform.xsl	Permet de spécifier une feuille de style autre que celle par défaut.

Exemple

<form action="eGuide?&Action=List.get&Object.uid=USER&User.context=" method="post" > 
 <input name="Search.attributes" type="hidden" value="GIVENNAME,LASTNAME,DEPARTMENT"> 
  <input name="Primary.sortkey" type="hidden" value="LASTNAME"> 
  <input name="Secondary.sortkey" type="hidden" value="GIVENNAME"> 
 <select name="crit1"> 
  <option value="co">contains</option> 
  <option value="eq">equals</option> 
  <option selected="true" value="sw">starts with</option> 
 </select> 
 <select name="attr1"> 
  <option value="GIVENNAME">First Name</option> 
  <option selected="true" value="LASTNAME">Last Name</option> 
 </select> 
 <input size="20" type="text" name="val1"> 
 <input type="Submit"> 
</form>

List.get (Liste en cache)

L'opération de liste, lorsqu'elle utilise les paramètres max et start, extrait les informations d'une liste précédemment mise en cache. L'utilisateur final observe une hausse significative des performances avec une liste mise en cache. La requête list.get initiale doit utiliser le paramètre max pour mettre en cache les résultats dans la session des utilisateurs. La valeur start indique ensuite à eGuide le point de départ dans la liste en cache. Utilisez les valeurs prev et next dans le fichier XML pour déterminer la valeur start.

Paramètres

Paramètre	Description
Action=list.get	Opération
start=100	Spécifie le point de départ suivant de la liste
max=20	Spécifie le nombre à afficher à tout moment dans le navigateur ; ce paramètre accélère la réalisation de la requête pour l'utilisateur final.

Paramètre optionnel	Description
stsh=otherform.xsl	Permet de spécifier une feuille de style autre que celle par défaut.
User.context=rypxSbuoirAi	Un paramètre User.context vide crée une session.

Exemple

eGuide?Action=list.get&max=20&start=20&User.context=rypxSbuoirAi

List.get (Avancé)

Requête de recherche avec un filtre spécifié. Le résultat obtenu est une liste. La différence entre l'opération de liste et l'opération de liste avancée tient au fait qu'il peut y avoir un nombre quelconque de valeurs et d'attributs envoyés dans la requête pour définir le filtre de recherche. Quel que soit le nombre de valeurs (paramètre val1,val2,val3) soumis, il doit y avoir le même nombre d'attributs (attr1, attr2, attr3) et de critères correspondants (crit1,crit2,crit3) soumis. Les groupes d'attributs, de critères et de valeurs (attr1, crit1, val1), (attr2, crit2, val2) doivent être séparés par une valeur booléenne (aoval1).

Paramètres

Paramètre	Description
Action=list.get	Opération
val1=valu1&val2=val2&val3=value3
attr1=attribute&attr2=attribute&attr3=attribute3
crit1=sw&crit2=cq&crit3=sw
Object.uid=USER	Catégorie de la recherche
Search.attributes=attr1,attr2,attr3,...	Attributs renvoyés par la recherche

Paramètre optionnel	Description
User.context=rypxSbuoirAi	Un paramètre User.context vide crée une session.
Primary.sortkey=attr1	Attribut permettant de déterminer l'ordre de tri de la liste
Secondary.sortkey=attr2	Attribut permettant de déterminer l'ordre de tri de la liste
aoval1=and	Pour les requêtes avancées, lors de la définition d'une recherche portant sur plusieurs valeurs
max=20	Spécifie le nombre à afficher à tout moment dans le navigateur ; ce paramètre accélère la réalisation de la requête pour l'utilisateur final.
stsh=otherform.xsl	Permet de spécifier une feuille de style autre que celle par défaut.

Login

Cette opération est généralement appelée pour authentifier le mode anonyme de eGuide. Elle démarre le processus d'authentification et la feuille de style authbody.xsl est chargée.

Paramètres

Paramètre	Description
Action=Login	Opération

Paramètre optionnel	Description
User.context=rypxSbuoirAi	Un paramètre User.context vide crée une session.

Exemple

eGuide?Action=Login&User.context=rypxSbuoirAi

OrgChart

Il s'agit d'une combinaison d'opérations de liste et d'opérations de détails. OrgChart extrait les informations sur le responsable d'un annuaire spécifié. Les subordonnés peuvent quant à eux être extraits de plusieurs annuaires.

Paramètres

Paramètre	Description
Action=Org.Chart	Opération
Directory.uid=DirectoryName
Manager.dn=cn=userid,o=org,o=novell
attr1=Manager
crit1=eq
val1=cn=userid,o=org,o=novell
Search.attributes=GIVENNAME,LASTNAME,ORGCHARTPARENTDN,ORGCHARTISPARENT
Object.uid=USER
User.dn=cn=userid,ou=org,o=novell

Paramètre optionnel	Description
User.context=rypxSbuoirAi	Un paramètre User.context vide crée une session.
stsh=other.xsl	Spécifie une feuille de style autre que celle par défaut.
RecurseDN=false	La valeur par défaut est true et renvoie des infos sur l'utilisateur.

Exemple

eGuide?User.context=rytuUjkhhkAi&Action=Org.Chart&Directory.uid=Extensive&User.dn=cn=nbjensen,ou=eGuide,ou=Demo,o=Novell&Object.uid=USER&Search.attributes=GIVENNAME,INITIALS,LASTNAME,EMAIL,TITLE,ORGCHARTPARENTDN,ORGCHARTISPARENT,&attr1=MANAGER&crit1=eq&Manager.dn=cn=Bgarrett,ou=eGuide,ou=Demo,o=Novell&val1=cn=Bgarrett,ou=eGuide,ou=Demo,o=Novell

OrgChartUpdate

OrgChartUpdate permet de mettre à jour l'attribut assigné à la clé " ORCHARTPARENT ".

Paramètres

Paramètre	Description
Action=Org.Chart	Opération
Directory.uid=DirectoryName
Manager.dn=cn=userid,o=org,o=novell
attr1=Manager
crit1=eq
val1=cn=userid,o=org,o=novell
Search.attributes=GIVENNAME,LASTNAME,ORGCHARTPARENTDN,ORGCHARTISPARENT
Object.uid=USER
TargetDN=cn=userid,ou=org,o=novell	Modification par l'utilisateur
AttrTargetValue=cn=admin,o=novell	Valeur à modifier
AttrTargetName=ORGCHARTPARENTDN	Nom clé de l'attribut à mettre à jour

Paramètre optionnel	Description
User.context=rypxSbuoirAi	Un paramètre User.context vide crée une session.
stsh=other.xsl	Spécifie une feuille de style autre que celle par défaut.
RecurseDN=false	La valeur par défaut est true et renvoie des infos sur l'utilisateur.

Exemple

Reportez-vous à OrgChart, mais ajoutez TargetDN, AttrTargetValue et AttrTargetName en tant que paramètres.

PasswordModify

Cette opération permet de configurer l'affichage de la page en vue de modifier le mot de passe. L'utilisateur final visualisera l'écran correspondant à son rôle. Un administrateur responsable d'utilisateurs (configuration dans l'outil d'administration de eGuide) ou un utilisateur dont le rôle lui permet de modifier le mot de passe d'autres utilisateurs verra s'afficher deux champs d'entrée. Un utilisateur normal verra s'afficher trois champs.

Paramètres

Paramètre	Description
Action=PasswordModify	Opération
User.dn=cn=name,ou=name2,o=novell	Nom distinctif de l'entrée
Directory.uid=DirectoryName	Ce nom vous sera fourni par l'administrateur système de eGuide.
Object.uid=USER	Catégorie de définition de l'entrée

Paramètre optionnel	Description
User.context=rypxSbuoirAi	Un paramètre User.context vide crée une session.

PasswordUpdate

Paramètres

Paramètre	Description
Action=PasswordModify	Opération
User.dn=cn=name,ou=name2,o=novell	Nom distinctif de l'entrée
Directory.uid=DirectoryName	Ce nom vous sera fourni par l'administrateur système de eGuide.
Object.uid=USER	Catégorie de définition de l'entrée
Value1=	Nouveau mot de passe
Value2=	Nouveau mot de passe
OldPassword=	Ancien mot de passe

Paramètre optionnel	Description
User.context=rypxSbuoirAi	Un paramètre User.context vide crée une session.

PhotoModify

Cette opération crée l'écran dans lequel l'utilisateur final ajoute et/ou supprime une photo et autorise l'affichage de sa photo.

Paramètres

Paramètre	Description
Action=PhotoModify	Opération
User.dn=cn=name,ou=name2,o=novell	Nom distinctif de l'entrée
Directory.uid=DirectoryName	Ce nom vous sera fourni par l'administrateur système de eGuide.
Object.uid=USER	Catégorie de définition de l'entrée

Paramètre optionnel	Description
User.context=	Contrôle de la session
RecurseDN=false	La valeur par défaut est true et renvoie des infos sur l'utilisateur.

REMARQUE : User.context permet d'assurer le suivi de la session des utilisateurs actuels. Lors d'une requête initiale, le paramètre User.context peut être omis. En revanche, toutes les pages suivantes doivent contenir ce paramètre.