Special form variables

Note that this list does not include any of the Interchange search engine parameters, which also happen to be prefixed with "mv_".

mv_arg

mv_action

See the Interchange form actions page.

mv_cartname

Sets the shopping cart name.  You may define and use as many shopping carts as you need.

mv_check

Names a callback routine to call to set variables, or perform further actions, after an update.

The named callback will be looked for in the in the scratchpad and, if not found there, in the Profiles or OrderProfile file(s).

See the form callback functions page for more information.

mv_cleanup

Names a callback routine that will be called after the mv_click and mv_check routines have completed.

The named callback will be looked for in the in the scratchpad and, if not found there, in the Profiles or OrderProfile file(s).

See the form callback functions page for more information.

mv_click

Names a callback routine to call to set variables, or perform further actions, before an update.

The named callback will be looked for in the in the scratchpad and, if not found there, in the Profiles or OrderProfile file(s).

See the form callback functions page for more information.

mv_click_arg

Instead of defining individual callbacks and calling them by name, using the mv_click variable, you can define a single mv_click callback and pass it an argument via this variable.

The mv_click callback code can retrieve the value of the mv_click_arg variable by either calling [scratch mv_click_arg] or by using $Scratch->{mv_click_arg}.

mv_data_undef

Set the value of a column to "undef".

Usage example:

Availability This form variable was introduced in version 5.5.0, and is therefore not available for use with any earlier Interchange version.

mv_doit

The name of an Interchange form action that can be used to set a default if no mv_todo is specified.  The mv_todo variable takes preference over mv_doit.

mv_email

Sets a "Reply-to" address for orders, if not set elsewhere.  It is better to set this using the MailOrderTo or Route directives.

mv_fail_form

Sets CGI values to use if a form profile check fails.

The format is expected to be as follows:

Using the above, if the mv_form_profile fails then [cgi foo] will be set to "bar" and [cgi kevin] will be set to "walsh".

mv_fail_href

Sets the "mv_nextpage" to use if a form fails its profile check.  The "mv_nextpage" variable expects an Interchange page name, whereas this variable expects a full URI.  Also see the mv_success_href variable.

mv_fail_zero

Delete all $Values variables if the form fails its profile check.

mv_form_profile

Check the form submission using the named form profile.

mv_nextpage

Sets the page that will be displayed when the form processing is complete and on the success of any form profiles.  Also see the mv_fail_href and mv_success_href variables.

Note This variable can be overridden in an mv_click callback routine.

mv_no_count

Causes Interchange to generate URIs without including an incremental "page count" number.  See mv_pc.

mv_orderpage

mv_order_group

Allows grouping of master item/sub items.

mv_order_item

Specifies a product's item code to place in the current cart.

mv_order_quantity

Specifies the quantity of the mv_order_item item that should be placed in the current cart.

mv_order_profile

Check the order submission using the named order profile.

mv_order_receipt

Specifies the name of the template file used to generate the customer's order receipt, if not set elsewhere.  It is better to set this using the Route directive.

mv_order_report

Specifies the name of the template file used to generate the merchant's order report, if not set elsewhere.  It is better to set this using the Route directive.

mv_order_route

By setting a value in a "mv_order_route" <form> field, you can specify one or more routes to run.  Rows in the cart array may also contain a "mv_order_route" attribute.  See the order routing page for more information

Deprecation notice The "mv_order_route" <form> field is the deprecated method of route selection, used in earlier Interchange 4.6.x and Minivend 4 routes.  This method will still work fine for the time being but may be withdrawn in the future. The "mv_order_route" cart item attribute is not deprecated, and remains as valid method of route selection.

mv_pc

This CGI variable has three distinct uses within Interchange.  One of the following uses has been deprecated, but that still leaves two distinct uses.

Use as a page counter

This is an incrementing "page count" number that Interchange will attach to all URIs automatically generated by [area] etc., unless the "mv_no_count" scratchpad variable is set true and/or the "no_count" parameter is passed to the [area] tag.

The idea is that the incrementing number will prevent proxies and browsers from caching dynamic pages.

An alternative to "mv_pc" is provided by the "mv_no_cache" scratchpad variable.  If you set the "mv_no_cache" scratchpad variable true then Interchange will transmit the following along with the current page's HTTP response headers:

This allows finer grained control over which pages may be cached and which may not.

Note The "mv_no_cache" scratchpad variable will not persist in the user's session, and will therefore only influence caching of the current page.

Use as a session reset tool

If you pass a "mv_pc=RESET" URI argument along with a page request then a new empty session will be created and used.  This can sometimes be more convenient than getting your browser to clear its cookies when testing certain pages and processes.

Affiliate identification

If a page request is received along with a "mv_pc" value that contains non-numerics, then the "mv_pc" will be taken to be an affiliate ID.

Deprecation notice This usage has been deprecated in favour of "mv_source".  Please do not use this parameter to specify an affiliate ID, as this usage may be removed, without warning, at any time.

mv_separate_items

This directive changes the default, when ordering an item, to allowing multiple lines on the order form for each item code.  If not specified then the default is taken from the SeparateItems local configuration directive, or will be false.  The false default, puts all orders with the same part number on the same line, with an appropriate quantity value.

Setting this variable true allows the item attributes to be easily set for different instances of the same part number.  This would allow easy setting of attributes such as size and colour etc.

mv_session_id

The randomly-generated value used to identify the user's session.  You can use the [data session id] tag, or $Session->{id} in Perl, to obtain the current value.

mv_source

If this CGI value is provided along with a page request, then the value will be saved as the "source" value in the user's session.  See [data session source].  The source value is generally used as an affiliate identifier.  Also see the mv_pc form variable.

mv_success_form

Sets CGI values to use on successful form profile check.

The format is expected to be as follows:

Using the above, if the mv_form_profile succeeds then [cgi foo] will be set to "bar" and [cgi kevin] will be set to "walsh".

mv_success_href

Sets the mv_nextpage to use if a form passes its form profile check.  The mv_nextpage variable expects an Interchange page name, whereas this variable expects a full URI.  Also see the mv_fail_href variable.

mv_success_zero

Delete all $Values variables if the form passes its form profile check.

mv_tmp_session

Bypass the session read and write operations for this request.

mv_todo

The name of an Interchange form action that will take preference over mv_doit.

mv_todo.map

See the Interchange form actions page.

mv_todo.checkout.x

See the Interchange form actions page.

mv_todo.x

See the Interchange form actions page.

mv_todo.y

See the Interchange form actions page.

Category:  Interchange forms

Last modified by: Kevin Walsh Modification date: Friday 7 July 2006 at 8:26 PM (EDT)