Usecases

Usecases are sequences of pages that are orthogonal to the website, i.e. they can be executed without leaving the current URI. They are mainly used to execute CMS functions, e.g., to publish a page. Usecases are specified by

• a name and
• a set of steps.

A usecase is executed using the request parameters lenya.usecase and lenya.step.

To match a usecase in a sitemap, the WildcardRequestParameterMatcher is used on the lenya.usecase and lenya.step request parameters. The predefined matchers have the types usecase and step. A simple example of a usecase pipeline would be:

<map:match type="usecase" pattern="publish">
      
  <!-- confirmation screen -->
  <map:match type="step" pattern="showscreen">
    <map:generate type="serverpages"
        src="content/publishing/publish-screen.xsp"/>
    <map:transform src="xslt/publishing/publish-screen.xsl"/>
    <map:serialize/>
  </map:match>

  <!-- call publish task -->
  <map:match type="step" pattern="publish">
    <map:act type="task">
      <map:parameter name="publication-id" value="{../../1}"/>
      <map:parameter name="task-id" value="{request-param:task-id}"/>
      <map:redirect-to uri="{request:requestURI}" session="true"/>
    </map:act>
  </map:match>
        
</map:match>

The main usecase sitemap supports a set of generic usecases. It is located at lenya/usecase.xmap. To implement your publication-specific usecases or to override a generic usecase, just add a usecase.xmap sitemap to your publication directory. The Lenya usecase sitemap looks for it and mounts it before the generic usecases are matched.

The following use cases are known:

Resource upload

lenya.usecase=upload

Create

lenya.usecase=create

Rollback

lenya.usecase=rollback

View Logs

lenya.usecase=view-logs

Usecases versus FlowScript

The usecase concept in Lenya 1.2 is inferior to FlowScript. Lenya 2.0-dev contains a simple Usecase Framework for writing usecases based on flow, JX templates, and Java classes for business logic.