ISML Function - action()

Name

action()

Short Description

generates parts of a URL string (requested pipeline, server group, domain, locale, currency, application type)

Table of Contents

Product Version

6.5

Product To Version

 

Statusfinal

1 Introduction

There are two ways to generate dynamic content:

  • Using custom servlets
    This is done through the ISML function servlet(). See servlet() for detailed information.
  • Using pipelines
    This is done through the ISML function action() . This procedure is described in this document.

The action() function is only used as a parameter in combination with the functions url() and urlex() . It generates the part of a URL string containing information about the requested pipeline, server group, domain (storefront name), locale, currency and application type.

Note

All parameter values you can specify for action() are case sensitive.

2 Syntax

action()
action(<action>)
action(<action>,<servergroup>)
action(<action>,<servergroup>,<domain>)
action(<action>,<servergroup>,<domain>,<locale>)
action(<action>,<servergroup>,<domain>,<locale>,<currency>)
action(<action>,<servergroup>,<domain>,<locale>,<currency>,<application>)

3 Example

The following example shows a simple pipeline call:

<a href="#URL(action('CheckBasketReadyToOrder-Start'))#">
... link text to be displayed ...
</a>

The next example shows a pipeline call with a change of locale and currency:

<a href="#URL(action('CheckBasketReadyToOrder-Start','','','en_US','USD', ''))#">

This example shows a pipeline call with a change of domain (storefront name):

<a href="#URL(action('CheckBasketReadyToOrder','server group', …, 'TransactionStore'))#">

4 Parameters

The parameters you can specify are optional and listed below. It is possible to specify only an empty string (="") for a parameter. In this case, the default value of the parameter is used. If =action() is used without specifying any parameters at all, the function will address the default page (home page) of the domain.

4.1 action

action = string

The string defines the name of the target pipeline and an appropriate start node. The default value is the default pipeline (and its start node) of the current storefront (the string Default-Start is returned).

Note

The name and start node of the default pipeline is hardcoded in the RequestHandlerServlet. To modify the default pipeline/start node for your site, you can use, for example, the URL rewriting or cartridge assignment mechanisms.

4.2 server

server group = string

The string defines the type of the target server group, e.g., web front or Intershop 7 back office servers. The default value for server group is the current server group of the session.

4.3 domain

domain = string
The string defines the name of the target domain (storefront name). The default value is the current domain of the session.

4.4 locale

locale = string
The string defines the locale of a store. The default value is the current locale of the request.

4.5 currency

currency = string
The string defines the currency of shown prices. The default value is the current currency of the session.

4.6 appID

appID = string
The string defines the application of a site. The default value is represented by the negative sign ( -).

Reference - ISML Functions

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Support Tickets