Command Definitions

 Top  Previous  Next

MoreMotion supports a concept called "Page Command Definitions" in order to control the way a page is accessed. The configuration element command and its child element param are used to define the valid commands and their parameters that can be given when accessing a particular page.

0 or more command definitions can be made for a page. If a command definition is made for a page then the page cannot be accessed without a command parameter ("_cmd").

The command Element

  <command name="" clearPageVars="" clearSessionVars="">
    <param name="" scope="" mandatory="" nonBlank="" 
           encrypted="" notAllowed="" initialValue="" />
  </command>

The Attributes of command Element

name Attribute

Defines the name of the command that can be used when accessing to the page.

clearPageVars Attribute (Accepts MScript)

Should contain true if all the page variables to be cleared when this command is used.

clearSessionVars Attribute (Accepts MScript)

Should contain true if all the session variables to be cleared when this command is used.

 

The nested param Element

The parameters of a command is defined using the nested element param.

The Attributes of param Element

 
name Attribute

The name of the request parameter.

scope Attribute (Accepts MScript)

This attribute is specified if the value of the parameter should be saved either as page variable or a session variable. The valid values for the attribute are "p" for page variable, and "s" session variable.

mandatory Attribute (Accepts MScript)

Should contain true is this parameter must be supplied along with the command.

nonBlank Attribute (Accepts MScript)

Should contain true if the parameter must have a value when used for the command.

encrypted Attribute (Accepts MScript)

Should contain true if the parameter contains an encrypted value.

notAllowed Attribute (Accepts MScript)

Should contain true if this parameter cannot be given with the command.

initialValue Attribute (Accepts MScript)

Defines the default value if this parameter is not specified of has no value.

 

Examples:

  <command name="ShowDetails" clearPageVars="true">
    <param name="ID" scope="p" mandatory="true" nonBlank="true" encrypted="true" />
    <param name="FULL_DETAILS" scope="p" initialValue="true" />
  </command>
 
  <command name="Navigate">
    <param name="ID" notAllowed="true" />
    <param name="BLOCK_NUMBER" mandatory="true" nonBlank="true" />
  </command>

display.doms?pg=PageX&_cmd=ShowDetails&ID=!723wgdwgj&FULL_DETAILS=false

 

display.doms?pg=PageX&_cmd=Navigate&BLOCK_NUMBER=2