Novell Documentation: eGuide 2.1.3 - Command Parameters and Examples

Command Parameters and Examples

No Action

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

Parameter

There are no parameters for this command.

Example

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

AuthForm

The default action when eGuide is 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

Parameters	Description
Action=AuthForm	Action
User.context=rypxSbuoirAi	A blank User.context that creates a new session

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 that go to AuthHeader and AuthBody. Because the authentication process loads the authbody.xsl by default, authform.xsl and authbody.xsl need to contain the same information.

AuthHeader

Called after AuthForm to finish setting up the frames. The authheader.xsl file is loaded by default.

Parameters

Parameter	Description
Action=AuthHeader	Action
User.context=rypxSbuoirAi	A blank User.context that creates a new session

Example

Only Forced Authentication mode:

   eGuide?Action=AuthHeader&User.context=rgyadiof

AuthBody

Called to set up the main authentication HTML page. It can be accessed when eGuide is in Anonymous mode by using the Login action. The authbody.xsl file is loaded by default.

Parameters

Parameter	Description
Action=AuthBody	Action
User.context=rypxSbuoirAi	A blank User.context that creates a new session

Examples

Only Forced Authentication mode:

   eGuide?Action=AuthBody&User.context=rgyadiof

Anonymous mode:

   eGuide?Action=Login&User.context=rgyadiof

Detail.get

Displays the details of the LDAP entry from a specified directory.

Parameters

Parameter	Description
Action=Detail.get	Action
User.dn=cn=name,ou=name2,o=novell	Distinguished name of the entry
Directory.uid=DirectoryName	Ask your eGuide system administrator for this name
Object.uid=USER	The category in which the entry is defined

Optional Parameter

Description

User.context=

Session control

stsh=other

Specify a style sheet other than the default

NOTE: For all actions that use the stsh parameter, do not include the file extension (.xsl). For example, if the stylesheet name is mysheet.xsl, make the parameter be stsh=mysheet.

RecurseDN=false

Read the DN and return info defined in the DN

Example

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

DetailEdit

See Detail.get and replace the action with the desired actions. The only difference is that 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 that the XML document has additional information for these actions.

DetailUpdate

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

Parameter	Description
Action=DetailUpdate	Action
User.dn=cn=name,ou=name2,o=novell	Distinguished name of the entry
Directory.uid=DirectoryName	Ask your eGuide system administrator for this name
Object.uid=USER	The category in which the entry is defined
AttributeKeyName=<undefined><value><![CDATA[new value]]</value></undefined>	N/A

Optional Parameter

Description

User.context=

Session control

stsh=other

Specify a style sheet other than the default style sheet

NOTE: For all actions that use the stsh parameter, do not include the file extension (.xsl). For example, if the stylesheet name is mysheet.xsl, make the parameter be stsh=mysheet.

RecurseDN=false

Replaces the DN with user info. The default is True.

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 Authentication mode.

Parameters

Parameter	Description
Action= eGuideForm	Action
User.context=rypxSbuoirAi	A blank User.context that creates a new session

Optional Parameter	Description
stsh=otherform	Used to specify style sheet other than the default style sheet NOTE: For all actions that use the stsh parameter, do not include the file extension. For example, if the stylesheet name is mysheet.xsl, make the parameter be stsh=mysheet.

Optional Parameter

Description

stsh=otherform

Used to specify style sheet other than the default style sheet

NOTE: For all actions that use the stsh parameter, do not include the file extension. For example, if the stylesheet name is mysheet.xsl, make the parameter be stsh=mysheet.

Example

Anonymous mode:

eGuide

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

eGuideHeader

Called from the eguideform.xsl file and sets up the eGuide search categories and attributes.

Parameters

Parameter	Description
Action=eGuideHeader	Action
User.context=rypxSbuoirAi	A blank User.context that creates a new session
Search.rows=1	The number of Search rows to display by default

Optional Parameter	Description
stsh=otherform	Used to specify a style sheet other than the default style sheet NOTE: For all actions that use the stsh parameter, do not include the file extension. For example, if the stylesheet name is mysheet.xsl, make the parameter be stsh=mysheet.

Optional Parameter

Description

stsh=otherform

Used to specify a style sheet other than the default style sheet

NOTE: For all actions that use the stsh parameter, do not include the file extension. For example, if the stylesheet name is mysheet.xsl, make the parameter be stsh=mysheet.

Example

eGuide

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

eGuide.verifyCredentials

Used in the authentication process to make an authenticated connection to the directory and verify the user's credentials.

Parameters

Parameter	Description
Action=eGuide.verifyCredentials	Action
User.context=rypxSbuoirAi	A blank User.context that creates a new session
Value1=	The user's DN to authenticate
Value2=	The password

Optional Parameter	Description
RememberUserInfo=True	When True, stores credentials as a cookie in the browser

Example

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

eGuide.verifyNewPassword

Used when the password needs to be reset.

Parameters

Parameter	Description
Action=eGuide.verifyNewPassword	Action
User.context=rypxSbuoirAi	A blank User.context that creates a new session
OldPassword=	The old password
Value1=	The password
Value2=	The password

Example

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

eGuide.selectContext

Used in the authentication process when multiple users are found with the same login ID.

Parameters

Parameter	Description
Action=eGuide.selectContext	Action
User.context=rypxSbuoirAi	A blank User.context that creates a new session
DN=cn=name,o=container	The selected DN to authenticate

Example

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

List.get

A search request with a specified filter. The result 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

Parameter	Description
Action=list.get	Action
val1=value	Value searching for
attr1=attribute	Attribute key name
crit1=sw	The criteria used to evaluate the value
Object.uid=USER	The search category
Search.attributes=attr1,attr2,attr3,...	The attributes returned from a search

Optional Parameter	Description
User.context=rypxSbuoirAi	A blank User.context that creates a new session
Primary.sortkey=attr1	The first attribute used to determine the sort order of the list
Secondary.sortkey=attr2	The second attribute used to determine the list's sort order
max=20	The number to display on the browser at any one time; this speeds up the request to the end user
stsh=otherform	Specifies a style sheet other than the default NOTE: For all actions that use the stsh parameter, do not include the file extension. For example, if the stylesheet name is mysheet.xsl, make the parameter be stsh=mysheet.

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)

When using max and start parameters, this action retrieves information from a previously cached list. The end user sees 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 user's 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

Parameter	Description
Action=list.get	Action
start=100	The next starting point on the list
max=20	The number to display on the browser at any one time; this speeds up the request to the end user

Optional Parameter	Description
stsh=otherform	Specifies a style sheet other than the default NOTE: For all actions that use the stsh parameter, do not include the file extension. For example, if the stylesheet name is mysheet.xsl, make the parameter be stsh=mysheet.
User.context=rypxSbuoirAi	A blank User.context that creates a new session

Optional Parameter

Description

stsh=otherform

Specifies a style sheet other than the default

NOTE: For all actions that use the stsh parameter, do not include the file extension. For example, if the stylesheet name is mysheet.xsl, make the parameter be stsh=mysheet.

User.context=rypxSbuoirAi

A blank User.context that creates a new session

Example

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

List.get (Advanced)

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 number of values and attributes sent in the query to define the search filter. For any 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

Parameter	Description
Action=list.get	Action
val1=valu1&val2=val2&val3=value3	N/A
attr1=attribute&attr2=attribute&attr3=attribute3	N/A
crit1=sw&crit2=cq&crit3=sw	N/A
Object.uid=USER	The search category
Search.attributes=attr1,attr2,attr3,...	The attributes returned from the search

Optional Parameter	Description
User.context=rypxSbuoirAi	A blank User.context that creates a new session
Primary.sortkey=attr1	The first attribute used to determine the sort order of the list
Secondary.sortkey=attr2	The second attribute used to determine the sort order of the list
aoval1=and	For advanced searches when defining more than one value to search on
max=20	Specifies the number to display on the browser at any one time; this speeds up the request to the end user
stsh=otherform	Specifies a style sheet other than the default NOTE: For all actions that use the stsh parameter, do not include the file extension. For example, if the stylesheet name is mysheet.xsl, make the parameter be stsh=mysheet.

Login

Usually called to authenticate when eGuide is in Anonymous mode. It starts the authentication process and the authbody.xsl style sheet is loaded.

Parameters

Parameter	Description
Action=Login	Action

Optional Parameter	Description
User.context=rypxSbuoirAi	A blank User.context that creates a new session

Example

	eGuide?Action=Login&User.context=rypxSbuoirAi

OrgChart

A combination of the List and Details actions. It retrieves the manager information from a specified directory but the subordinates can be retrieved from multiple directories.

Parameters

Parameter	Description
Action=Org.Chart	Action
Directory.uid=DirectoryName	N/A
Manager.dn=cn=userid,o=org,o=novell	N/A
attr1=Manager	N/A
crit1=eq	N/A
val1=cn=userid,o=org,o=novell	N/A
Search.attributes=GIVENNAME,LASTNAME,ORGCHARTPARENTDN,ORGCHARTISPARENT	N/A
Object.uid=USER	N/A
User.dn=cn=userid,ou=org,o=novell	N/A

Optional Parameter

Description

User.context=rypxSbuoirAi

A blank User.context that creates a new session

stsh=other

Specifies a style sheet other than the default

NOTE: For all actions that use the stsh parameter, do not include the file extension. For example, if the stylesheet name is mysheet.xsl, make the parameter be stsh=mysheet.

RecurseDN=false

Returns User info. The default is true.

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

Used to update the attribute mapped to the key ORGCHARTPARENT.

Parameters

Parameter	Description
Action=Org.Chart	Action
Directory.uid=DirectoryName	N/A
Manager.dn=cn=userid,o=org,o=novell	N/A
attr1=Manager	N/A
crit1=eq	N/A
val1=cn=userid,o=org,o=novell	N/A
Search.attributes=GIVENNAME,LASTNAME,ORGCHARTPARENTDN,ORGCHARTISPARENT	N/A
Object.uid=USER	N/A
TargetDN=cn=userid,ou=org,o=novell	User modifying
AttrTargetValue=cn=admin,o=novell	The value we want to change
AttrTargetName=ORGCHARTPARENTDN	The attribute key name to update

Optional Parameter

Description

User.context=rypxSbuoirAi

A blank User.context that creates a new session

stsh=other

Specifies a style sheet other than the default

NOTE: For all actions that use the stsh parameter, do not include the file extension. For example, if the stylesheet name is mysheet.xsl, make the parameter be stsh=mysheet.

RecurseDN=false

Returns User info. The default is true

Example

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

PasswordModify

Sets up the page view to modify the password. The end user receives a view based on his or her role. A user administrator (set up in the eGuide Administration utility. See Accessing the eGuide Administration Utility.) or a user with the role to modify other's passwords is given two input fields. A normal end user is given three.

Parameters

Parameter	Description
Action=PasswordModify	Action
User.dn=cn=name,ou=name2,o=novell	Distinguished name of the entry
Directory.uid=DirectoryName	Ask your eGuide system administrator for this name
Object.uid=USER	The category in which the entry is defined

Optional Parameter	Description
User.context=rypxSbuoirAi	A blank User.context that creates a new session

PasswordUpdate

Sets up the page view to update the password.

Parameters

Parameter	Description
Action=PasswordUpdate	Action
User.dn=cn=name,ou=name2,o=novell	Distinguished name of the entry
Directory.uid=DirectoryName	Ask your eGuide system administrator for this name
Object.uid=USER	The category in which the entry is defined
Value1=	The new password
Value2=	The new password
OldPassword=	The old password

Optional Parameter	Description
User.context=rypxSbuoirAi	A blank User.context that creates a new session

PhotoModify

Creates the page view that lets the end user add or remove a photo and accept a photo agreement.

Parameters

Parameter	Description
Action=PhotoModify	Action
User.dn=cn=name,ou=name2,o=novell	Distinguished Name of the entry
Directory.uid=DirectroyName	Ask your eGuide system administrator for this name
Object.uid=USER	The category in which the entry is defined

Optional Parameter	Description
User.context=	Session control
RecurseDN=false	Returns User info. The default is True.

NOTE: The User.context keeps 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.