Command Parameters and Examples

No Action

When no action is submitted on the command line and in Anonymous mode, the eGuideForm action will be initiated. If in Forced Authentication mode, AuthForm is loaded.

Parameter

Example

http://www.domainname.com/eGuide/servlet/eGuide

AuthForm

This is the default action when in Forced Authenticated mode. It sets up the initial frames for the login pages and uses Authform.XSL which initiates the action to AuthHeader and AuthBody.

Parameters

Examples

Forced Authentication mode:

   http://www.domainname.com/eGuide/servlet/eGuide

Only Forced Authentication Mode:

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

NOTE:  When creating a theme without frames, remove the links in Authform.XSL to AuthHeader and AuthBody. Because the authentication process loads the Authbody.XSL by default, Authform.XSL and Authbody.XSL should contain the same information.

AuthHeader

This action is called after AuthForm to finish setting up the frames. The Authheader.XSL file is loaded by default.

Parameters

Example

Only Forced Authentication mode:

   eGuide?Action=AuthHeader&User.context=rgyadiof

AuthBody

This action is called to set up the main authentication HTML page. It can be accessed when in Anonymous mode using the Login action. The Authbody.XSL file is loaded by default.

Parameters

Examples

Only Forced Authentication mode:

   eGuide?Action=AuthBody&User.context=rgyadiof

Anonymous mode:

   eGuide?Action=Login&User.context=rgyadiof

Detail.get

These actions display the details of the LDAP entry from a specified directory.

Parameters

Example

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

DetailEdit

See Detail.get and replace the action with the desired actions. The only difference is the XML document has additional information for these actions.

DetailModify

See Detail.get and replace the action with the desired actions. The only difference is the XML document has additional information for these actions.

DetailUpdate

This action updates the LDAP entry in the directory and returns the results.

NOTE:  The attributes being modified are returned to eGuide with the Key Name of the Attribute and the value. The value is to be created in XML format and should be wrapped with the CDATA tag. If the key word "nochange" is found for the value, then the attribute is ignored and not updated.

Parameters

Example

<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

The default action when in Anonymous mode or after the authentication process in Forced Authention mode.

Parameters

Example

Anonymous mode:

eGuide

or

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

eGuideHeader

This is called from the Eguideform.XSL and sets up the eGuide search categories and attributes.

Parameters

Example

eGuide

or

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

eGuide.verifyCredentials

This is used in the authentication process to make an authenticated connection to the directory and verify the users credentials.

Parameters

Example

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

eGuide.verifyNewPassword

This is used when the password has been determined to be expired and needs to be reset.

Parameters

Example

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

eGuide.selectContext

This is used in the authentication process when multiple users are found with the same login ID.

Parameters

Example

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

List.get

This is a search request with a specified filter, and the resultant set is a list. The search filter is searched against any or all directories configured in the eGuide Administration Utility. Use the max key to cache list results larger than the value set, then see the next List.get action for cached lists.

Parameters

Example

<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 (Cached list)

The list action when using max and start parameters will retrieve information from a previously cached list. The end user will see a significant increase in performance by using a cached list. The original list.get request must use the max parameter to cache the results in the users session. Then the start value tells eGuide where to start in the cached list. Use the prev and next values in the XML file to determine what value to start with.

Parameters

Example

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

List.get (Advanced)

This is a search request with a specified filter, and the resultant set is a list. The difference between the list and advanced list action is that there can be any given number of values and attributes sent in the query to define the search filter. For any given number of values (parameter val1,val2,val3) submitted there must be the same number of attributes (attr1,attr2,attr3) and supporting criteria (crit1,crit2,crit3) submitted. Each set of attributes, criteria and values (attr1,crit1,val1), (attr2,crit2,val2) must be separated by a Boolean value (aoval1).

Parameters

Login

This is usually called to authenticate when eGuide is in anonymous mode. It starts the authentication process and the Authbody.XSLstylesheet is loaded.

Parameters

Example

eGuide?Action=Login&User.context=rypxSbuoirAi

OrgChart

This is a combination between the list and details actions. It retrieves the manager information from a specified directory but the subordinates can be retrieved from multiple directories.

Parameters

Example

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

This is used to update the attribute mapped to the key ORCHARTPARENT.

Parameters

Example

See OrgChart , but add TargetDN, AttrTargetValue, and AttrTargetName as parameters.

PasswordModify

This is used to setup the page view to modify the password. The end user will receive a view based on his role. An user administrator (setup in the eGuide Administration Utility) or a user with the role to modify other's passwords are given two input fields. A normal end user is given three.

Parameters

PasswordUpdate

Parameters

PhotoModify

This creates the page view to allow the end user to add or remove a photo as well as accept a photo agreement.

Parameters

NOTE:  The User.context is used to keep track of the current user's session. When making an initial request, the User.context can be omitted, but any pages to follow must contain the User.context parameter.