Action Steps are the configurations of Field Blocks and HTML Blocks within Layout Elements for each individual 'page' of the Action Process you want participants to progress through.
Action Process
The Action Process order is determined by the order the Action Steps are listed in the [Action Edition]? folder.
Action Step Options
An Action Step has the following options:
- Layouts: what the layout and design elements on the Action Step will be (e.g. one column vs two column)
- Validators: what checks are made when the Action Step is submitted (e.g. ensure required fields are entered and format valid according to the settings in the Edit Schemas tab of the Action Edition)
- Tasks: what actions will be taken when the Action Step is submitted. The supplied tasks include:
- Store form contents: Stores the information submitted in an action record (either adds a new action record or updates an existing one)
- Store tracking information: Stores tracking information in the action record. The tracking needs to be setup on the site for this to be complete.
- Send thanks email: Sends the configured Thank You Email to the action edition participant.
- Send email to targets: Sends the Action Message to the configured [Person Target]? or [Organisation Target]? set in the [Action Edition]?)
- Update action listing: Updates the Action Record Catalog with the details for publicly listing those who have participated in the action.
| Note: | If you change the layout, all existing contents of the Layout Elements will be deleted and you will need to add the desired Field Blocks and HTML Blocks into the relevant Layout Element |
|---|
Action Step Elements
An Action Step consists of multiple Layout Elements, each of which can contain Field Blocks and HTML Blocks. In general, the Layout Elements are:
- Header: what will appear at the top of the Action Step content area
- Content: what will appear between the Header and Footer of the Action Step content area. There are usually two of these by default (left and right for two column) but can be reduced to one for single column or additional content areas added.
- Footer: what will appear at the bottom of the Action Step content area
The placement of these Layout Elements is flexible and may be changed with Style Sheets.
Layout Elements
Layout Elements are for grouping a collection of related content together so that it appears in the Action Steps together and can be styled together using Style Sheets.
Layout Elements can contain several types of content:
- 'HTML Blocks': a block of HTML
- 'Field Blocks': one or more form fields with its label and description to be displayed
- 'Links': URLs? to other content on the web
- 'Target Organisation': the information you entered for a specific 'Organisational Target'
- 'Target Person': the information you entered for a specific 'Person Target'
These allow you to automatically insert static or dynamic content for form fields into the Action Step when it is displayed.
The exact names of the Layout Elements are determined either by the [Action Type]? you choose or your custom configurations. When an [Action Type]? configures these, they are usually based on a 'one-column' or 'two-column' layout. The layout Elements generated for each Layout are:
- One column: Header, Content, Footer
- Two column: Header, Left, Right, Footer
Editing a 'Layout Element'
- Select the 'contents' tab from the Action Step to get a list of the various 'Action Elements' the Action Step contains, including the 'Layout Elements'
- Select the Layout Element you want to edit
- Click on the item within the Layout Element you wish to edit and then press the 'edit' tab.
- Edit as appropriate (add content for HTML Block, select a field for a Field Block, etc).
- Save
- Done (now test it displays properly)
| Note: | you can add additional content items to a Layout Element if you wish - just select what other content you want from the 'add to folder' options. |
|---|
Field Blocks
Field Blocks are used within Layout Elements to display Fields that were configured via the 'Edit Schemas' tab of an [Action Edition]? on a particular Action Step. Fields will display in the order they appear in the Layout Element contents view.
There are three options for a Field Block:
- Data source field: This is the field from the [Action Edition]? schema that you want to display within that that Action Step's Layout Element
- Display condition: This is the condition under which the Field Block will (or will not) appear on the within that Action Step's Layout Element. It uses a TALES expression - a common expression syntax in Zope and Plone (see http://www.zope.org/Documentation/Books/ZopeBook/2_6Edition/AppendixC.stx#2-43 )
- Custom data accessor: If used, this overrides the 'Data source field' and fetches custom content into the Field Block. This means a programmer can extend the use of Field Blocks as they need. This is used to fetch the Thank You Page for all pre-configurations of Action Types.
HTML Blocks
HTML Blocks are used within Layout Elements to display HTML based content. They are created and edited like any other HTML content with one addition - they can be conditionally displayed when the 'Display condition' is set. The display condition uses a TALES expressions (see link above).
HTML Blocks are primarily used for:
- Advanced customisation of the look and feel of an Action Step
- With conditions to customise the messaging to a set of conditions a participant does (or doesn't) fulfil
- In conjunction with Field Blocks (including conditional Fiend Blocks) to have fine-grained control over the display of the form on an Action Step
