SERVICE type

FS_LIST, SERVICE type

The FS_LIST type SERVICE can be used to link external components or modules, which are to provide data for the input component. The function and appearance are highly dependent on the individual implementation of the module. Further information is provided in the FirstSpirit Developer Manual for Components.

Access-API example use case
The exemplary implementation FsListEditorValueExample shows some simple examples of use for the reading, writing and creating access to the data object (FsListEditorValue) and its inner data container (FormDataList) of the input component by means of the FirstSpirit Access-API.

• Example of use: FsListEditorValueExample
• Data object: FsListEditorValue
• Container type: FormDataList

Parameter

The following table gives the parameters of the DATASET input component.

Overview

name

The attribute "name" is the variable name of an input component with which the the result object of the input component can be used in the templates - with the help of $CMS_VALUE()$ - or the content can be output.

Overview

allowEmpty

The "allowEmpty" parameter is used to specify whether a value has to be entered for an input value or not.

If allowEmpty="YES" input is not mandatory; however, it is if allowEmpty="NO".

Input components with allowEmpty="NO" are also called mandatory input components.

The default value for allowEmpty is YES.

Overview

hFill

An input component is always displayed with a pre-defined width.

However, if the input component is to use the full available display width the parameter hFill must be given with the value YES .

Overview

height

The height parameter is used to determine the display height of the input component in pixel.

The parameter expects an integer value. If the parameter is not defined the height of the input component is set by default to 500 pixel.

According to the layout, the function (for example the expand behaviour) and (when indicated) the parameter rows, the height should not be too low.

If the input component is used within a group (CMS_GROUP), the height will comply with the height of the highest input component of the group.

Overview

hidden

With the "hidden" parameter an input component can be hidden from the editor.

If hidden="YES" the input component is not visible for the editor, if hidden="NO" it is visible.

The default value for hidden is NO.

Overview

noBreak

The noBreak parameter can be used to suppress automatic line break after an input component.

The noBreak parameter must be given with value "YES" (noBreak="YES") to suppress the automatic line break.

Overview

preset

Using the preset attribute the handling of default values in an input component can defined (see also chapter Default values). If preset="default" is set, the fall-back value defined in the form is used. If this value in the form is changed later on, these changes will be affect all usages of this default value in the input components maintained by the editor, as long as a value will be set manually in the input component. This is the default setting. If preset="copy" is set, the value entered by the editor is copied directly into the input component. Subsequent changes to the default value in the form do not have any effect on the usages of this default value in the input components maintained by the editor.

Overview

rows

If an overview is defined for the input component of the DATASOURCE types DATABASE, INLINE or SERVICE (<ADD component="overview" ... >) you can use the parameter rows to specify the height of this overview in rows. For this purpose, the number of rows must be specified. For the DATASOURCE type PAGE the figure which is specified by rows refers to the height the input component in rows. A horizontal splitter is available to modify the height of the overview and the detailed views.

The parameter expects an integer value.

The default is 10.

Overview

width

The width parameter can be used to specify the display width of the input component in pixels.

The parameter expects an integer value.

If the parameter is not given the default width is 480 pixels.

The parameter does not have any effect if the hFill parameter is used.

Overview

DATASOURCE

The DATASOURCE tag defines the data type the input component should draw from.

If the tag is given more than once for an input component, the last/lowest definition is always adopted and all other definitions are removed.

Overview

type

The mandatory parameter type defines the data type which the input component should draw from or, rather, the type of data origin.

The following types are supported:

• DATABASE: With this parameter it is possible to create a list of data sets. The table template on which the content source is based, from which data sets are to be selected or created in the new data sets, must be given with the TABLE tag.
• INLINE: With this parameter it is possible to create a list of sections and links. The TEMPLATES tag and its source parameter must be used to define whether a section or link list is to be defined.
• PAGE: With this parameter it is possible to display a list of the sections of the current page.
• SERVICE: With this parameter it is possible to use a service module to link to external data suppliers which provide data for the input component. Further information on the configuration is provided in the FirstSpirit Developer Manual for Components.

Overview

maxEntries

The parameter "maxEntries" defines how many entries can be selected or added at most. The parameter expects an integer value.

Overview

useLanguages

The useLanguages parameter can be used to specify whether or not an input component is to store different or deviating values for different languages (multi-lingual maintenance).

If the parameter is not given, deviating values are stored for the different languages as a default.

If NO (...useLanguages="NO") is specified, one value is stored for all languages.

Overview

LABELS

By default, the following are used for labeling, e.g. the labeling of the overview, tab, bars and tool tips:

1. the names of all input components, which are contained in the selected section, link or table template (identifiers), in square brackets and
2. the values (if available), which are saved in the input components, if they are of the data type string (e.g. CMS_INPUT_TEXT, CMS_INPUT_TEXTAREA, CMS_INPUT_DOM)

The LABELS tag can be used to influence the labeling.

DATASOURCE type PAGE: LABELS / LABEL are not supported for this data source type.

In this case, a LABEL tag must be given for each language.

IMPORTANT: At least the fall-back label ("*") must be defined:

<LABELS>
 <LABEL lang="*">...</LABEL>
</LABELS>

LABEL

The LABEL tag can be used to define flexible, language-dependent labeling for each language.

To define the labeling for a language, the abbreviation of the project language must be given in the lang parameter:

...
<LABEL lang="DE">...</LABEL>
<LABEL lang="EN">...</LABEL>
...

Fall-back values are given with the special language code * ("for all languages"):

...
<LABEL lang="*">...</LABEL>
...

The lang parameter is a mandatory parameter.

The labeling text is given within an opening and closing <LABEL> tag (see placeholder TEXT).

Overview

lang

The lang parameter is used to give the language abbreviation which is entered in the server properties see , Chapter "Language templates") to specify for which project languages the definitions are to apply, e.g. DE for German, EN for English, FR for French etc. The following characters can be used as often as required: -, _, 0-9 and A-Z. Lower case letters are transformed automatically into upper case letters after having saved the template. In addition * can be used for fallback values.

Overview

TEXT

Here it is possible to define alternative labeling.

The system object #item is available to access the values stored in the input component.

In the case of the DATASOURCE type DATABASE, the variable of the column (identifier of the input component) is appended, separated by a dot, e.g.

#item.cs_lastname

If the table referenced via FS_LIST is connected to another table via a foreign (external) key, the values of a column in the connected table can be used for the labeling in FS_LIST by using #item with the foreign key identifier and the required column name, e.g.

#item.product_Properties_Type.Name

where product_Properties_Type is the foreign key name, Name is the name of a column in the table defined via product_Properties_Type.

In the case of the DATASOURCE type INLINE, the variable of the respective section or link template (identifier of the input component) is appended, separated by a dot, e.g.

#item.st_headline

In both cases, combinations of the values of several input components are also possible, e.g.

<LABELS>
 <LABEL lang="*">#item.cs_firstname + " " + #item.cs_lastname</LABEL>
</LABELS>

In order, for example, to define an alternative value for display, in case the input component concerned is not filled, the if(...) function can be used, e.g.

<LABELS>
 <LABEL lang="*">if(#item.st_headline.isEmpty, "No headline", #item.st_headline)</LABEL>
</LABELS>

In this example, the text "No headline" is displayed if the input component is not filled.

In the case of the DATASOURCE type INLINE, the identifier of input components of different section and link templates can also be given. This option suggests itself if the selection is not limited to one template and the identifiers of the input components vary from template to template. If an identifier given by #item is not available in the template selected by the editor, nothing is output.

Example:
FS_LIST enables the selection to be made from two section templates of which one contains a text field with the identifier "st_text" and one contains a text field with the identifier "st_headline".

If the editor now chooses the section template containing the identifier "st_text", the syntax

<LABELS>
 <LABEL lang="*">#item.st_text + #item.st_headline</LABEL>
</LABELS>

uses the stored value of the input component "st_text" for the labeling.
If the editor chooses the section template containing the identifier "st_headline", the stored value of the input component "st_headline" is used.

If a template contains both identifiers, both are used for the labeling. A separator should be provided for this case, e.g.

<LABELS>
 <LABEL lang="*">#item.st_text + " " + #item.st_headline</LABEL>
</LABELS>

Care should be taken to ensure that the variables used (identifiers of the input components) are given correctly, and the variables should also actually be present in the templates available to choose from. Otherwise, the default labeling is used (name and all values of all input components of the selected template). For optimum clarity and user-friendliness of the component, the shortest possible labeling should be chosen.

In the case of the DATASOURCE type INLINE, it is also possible to determine the template of a section or link in the list. The system object #template is available for this purpose.

The reference name of the template used can, e.g., be output for labeling via the following syntax:

<LABELS>
 <LABEL lang="*">#template.uid</LABEL>
</LABELS>

Here, too, the if(...) function can be used to implement labeling depending on the template selected.

DATASOURCE type PAGE: LABELS / LABEL are not supported for this data source type.

ACTIONS

Using the tag ACTIONS you can define which editing options are to be available in the input component. For this purpose, related icons will be displayed in the input component, e.g. for creating, moving or deleting list elements.

For each editing option one ACTION tag must be specified.

ACTION

Each editing option is defined by an ACTION tag.

Overview

name

The name parameter can be used to define different editing options.

The following keywords are available to choose from:

• ADD
  This icon is used to add a new element to the list. Each entry of the external data supplier can only be selected once. The insertion position can be specified using the keyword add-index within the ACTIONS / ACTION / PARAM tags.
• REMOVE
  Icon for deleting an element selected in the list from the list. The keyword show-confirm can be used within the ACTIONS / ACTION / PARAM tags to define whether the data set is removed immediately or only after accepting a confirmation prompt.
• DOWN / UP
  Icons for moving down/up an element selected in the list
• DETACH
  Icon for opening the selected list entry in a separate window
• VIEW
  Icon for showing the selected list entry.
  If overview and detail views are used in the component, when an entry is clicked the corresponding detail view is expanded. If only the overview is used, click an entry in the overview to display the corresponding detail view in a separate window.

Example
If the input component is to have icons with which elements can be added to the list, removed and moved, the following syntax must be used:

<ACTIONS>
 <ACTION name="ADD"/>
 <ACTION name="REMOVE"/>
 <ACTION name="UP"/>
 <ACTION name="DOWN"/>
</ACTIONS>

The order in which the editing options are given within ACTIONS also affects the order of the icons in the input component.

Overview

PARAM

The PARAM tag can be used to define further settings for the behavior of the FS_LIST input component.

A PARAM tag must be given for each setting.

Overview

name

The name parameter can be used to define different settings. The following keyword is available:

• show-confirm (used with <ACTION name="REMOVE"/>): The "show-confirm" value can be used to control whether or not a confirmation prompt (yes/no) is displayed before removing an element from the list. By default, a confirmation prompt is displayed.

Overview

TEXT

The following options are available for show-confirm:

• yes: Before deleting or removing a list element, a confirmation prompt is displayed. This is the default setting.
• no: When deleting or removing a list element, no confirmation prompt is displayed. The element is directly deleted or removed.

Example

...
<ACTIONS>
 <ACTION name="ADD"/>
 <ACTION name="REMOVE">
 <PARAM name="show-confirm">no</PARAM>
 </ACTION>
 <ACTION name="UP"/>
 <ACTION name="DOWN"/>
</ACTIONS>
...

LAYOUT

This tag can be used to freely define the appearance of the list. Various "components" are available for this (e.g. toolbar, overview, detail view), which can be positioned in different places (e.g. top, bottom, right, left).

ADD

An ADD tag can be given for each "component" of the layout.

Overview

component

This parameter is used to select the required layout component.

The following values are allowed:

• overview: Overview above the entries of the list (see diagram below, constraint parameter, item 2.)
• toolbar: Toolbar with icons for editing the entries; these are displayed depending on the editing options defined via ACTIONS / ACTION (see diagram below, constraint parameter, item 1.).
• stackedview: The detail views of all list entries are displayed under each other. Depending on the configuration, the PARAM tag (see below) can be used to minimize or maximize the detail views using the and icons or by double-clicking the entry in the overview (if available). I.e. potentially, this view simultaneously displays all information on all entries. This view corresponds to the view of FS_LIST up to and including FirstSpirit Version 4.2R2. In addition, above each detail view, icons are displayed for editing the list entries.
• singleview: This value is used to display the detail view of only the element selected in the overview below the overview. In addition, above each detail view, icons are displayed for editing the list entries.
• simpleview: This value is used to display the detail view of only the element selected in the overview below the overview. No icons for editing or for navigating through the list elements are displayed above the detail views. It is only possible to navigate through the list elements via a selection in the overview.

The toolbar definable with component="toolbar" and its icons always only relate to the entry currently selected / marked in the overview. If no overview (component="overview") is used, the list entries cannot be uniquely selected. In this case, component="toolbar" should also not be used; the list entries can then only be edited using the icons available in the detail views (see also screenshots on the keyword toolbar-assembly within the LAYOUT / ADD / PARAM tags).

The component parameter must be used with the constraint parameter (see below). Not every combination of component="..." and constraint="..." is meaningful.

In the "stackedview" (component="stackedview"), "singleview" (component="singleview") and "simpleview" (component="simpleview") modes, apart from the position details using the constraint parameter, other configuration options are also available. See PARAM tag within the LAYOUT / ADD tags.

Overview

constraint

This parameter can be used to give the position of the layout component:

• top: The layout component is displayed at the top.
• center: The layout component is displayed in the middle.
• bottom: The layout component is displayed at the bottom.
• left: The layout component is displayed on the left.
• right: The layout component is displayed on the right.
• hide: The layout component is hidden.

The values top, bottom, center, left and right may only be used once, hide may be used more than once.

This parameter must be used with the component parameter.

Example:

<LAYOUT>
 <ADD component="toolbar" constraint="top"/>
 <ADD component="overview" constraint="center"/>
 <ADD component="stackedview" constraint="bottom"/>
</LAYOUT>

Overview

PARAM

The PARAM tag can be used to define further settings for the behavior of the FS_LIST input component.

A PARAM tag must be given for each setting.

Overview

name

In stackedview mode (<ADD component="stackedview" constraint="...">) the name parameter can be used to define various settings with regard to the detail views. The following keywords are available:

• expand-behaviour: name="expand-behaviour" can be used to control the expand behavior of the detail views (e.g. by means of the icons). In this way, for example, lists with many entries or with many input components within the entries can be laid out in a clearer way, making the editors' work easier.
• toolbar-assembly: Each detail view has its own toolbar with the icons displayed on the basis of the definition of ACTIONS / ACTION. name="toolbar-assembly" can be used to control the display of this toolbar.
• show-language-tabs: name="show-language-tabs" can be used to control whether or not the detail views are to have language tabs.

The following keyword can be used in singleview mode (<ADD component="singleview" constraint="...">):

• show-language-tabs: name="show-language-tabs" can be used to control whether or not the detail views are to have language tabs.

The following keyword can be used in simpleview mode (<ADD component="simpleview" constraint="...">):

• show-language-tabs: name="show-language-tabs" can be used to control whether or not the detail views are to have language tabs.

Overview

TEXT

The following options are available for expand-behaviour (only stackedview mode):

• collapse_all: Initially (and after updating the view), all detail views are displayed collapsed (closed).
  This is the default setting.
  If the "Maximize"/"Minimize" or arrow icons are clicked or the bar of any element is double-clicked, the detail view of the element opens or closes. All detail views can be simultaneously displayed opened or closed.
• expand_all: Initially (and after updating the view), all detail views are displayed expanded (folded down).
  They can be simultaneously closed or re-opened by clicking the "Minimize all" or "Maximize all" icon, respectively, on the bar of any element. A single detail view can be closed or opened by clicking the arrow icons or double-clicking the bar.
  Note: If this option is used, it can take quite a while to load all data sets. This should be taken into account in the configuration.
• expand_follows_mouse: Initially (and after updating the view), all detail views are displayed collapsed (closed).
  The detail view of a list element opens if the mouse cursor is held over the corresponding bar, by clicking the "Maximize" or the corresponding arrow icon, or by double-clicking the entry in the overview. It closes again if the "Minimize" or arrow key is clicked or when another detail view is opened.
• expand_follows_current: Initially (and after updating the view), only the detail view of the last / bottom list element is displayed expanded.
  If the "Maximize"/"Minimize" or arrow icons are clicked or the bar of any element is double-clicked, the detail view opens or closes.
• expand_first: Initially (and after updating the view), only the detail view of the first (top) list element is displayed expanded.
  In Edit mode, a detail view can be opened or closed by clicking the "Maximize"/"Minimize" or arrow icons or by double-clicking the bar of any element. All detail views can be simultaneously displayed opened or closed.
• expand_last: Initially (and after updating the view), only the detail view of the last (bottom) list element is displayed expanded.
  In Edit mode, a detail view can be opened or closed by clicking the "Maximize"/"Minimize" or arrow icons or by double-clicking the bar of any element. All detail views can be simultaneously displayed opened or closed.

In general, the list elements can also be opened by double-clicking the entry in the overview.

The following options are available for toolbar-assembly (stackedview mode only):

• panel: The toolbar is displayed directly on the bar:
• subform: The toolbar is displayed underneath the bar:
  This is the default setting.

The following options are available for show-language-tabs:

• yes: The detail views are displayed with their own language tabs, through which the editorial content can be entered in the available project languages:
  
  This option is not necessary if useLanguages="no" is set for the input components displayed within the list entry.
• no: The detail views are displayed without language tabs. It is necessary to switch to the content stored for other languages at section, page or data set level using the language tabs. This is the default setting.
  
  See also parameter useLanguages.

Example

...
<LAYOUT>
 <ADD component="overview" constraint="center"/>
 <ADD component="toolbar" constraint="top"/>
 <ADD component="stackedview" constraint="bottom">
 <PARAM name="expand-behaviour">expand_follows_current</PARAM>
 <PARAM name="toolbar-assembly">panel</PARAM>
 <PARAM name="show-language-tabs">yes</PARAM>
 </ADD>
 </LAYOUT>
...

In each PARAM tag, a name parameter can only be assigned one value. If several value definitions exist for a name parameter, the first (top/highest) definition is always taken into consideration in the form.

PROVIDER

This tag can be used to define the provider.

Overview

name

This parameter contains the name of the provider.

Overview

PARAM

One parameter is supplied by the tag PARAM.

Overview

name

This parameter contains the parameter name.

Overview

TEXT

The value is given here.

LANGINFOS

Using the tag LANGINFOS language-dependent information can be defined for each input component, e.g. which title is to be used for the input component in the different project languages (parameter label), which tooltip is to be displayed (parameter description) etc. For reasons of clarity, definitions which are identical in multiple languages will be merged. For example,

<LANGINFOS> 
 <LANGINFO lang="*" label="Datum"/> 
 <LANGINFO lang="DE" label="Datum"/> 
 <LANGINFO lang="EN" label="Datum"/>
</LANGINFOS>

will be merged to

 <LANGINFOS> 
 <LANGINFO lang="*" label="Datum"/> 
</LANGINFOS>

after saving.

Up to and including FirstSpirit version 4.2R2 language definitions will be deleted only in the case if the values are identical in all languages (as in example above). Furthermore, only the parameters lang, description and label are taken into account when merging.

Since FirstSpirit version 4.2R4 all parameters are taken into account (e.g. format and length). Furthermore, language definitions are also merged within LANGINFOS tags, if they are identical in at least two languages. For example,

<LANGINFOS> 
 <LANGINFO lang="*" label="Date" format="dd.MM.yy"/>
 <LANGINFO lang="DE" label="Date" format="dd.MM.yy"/>
 <LANGINFO lang="EN" label="Date" format="MM/dd/yy"/>
</LANGINFOS>

will become

 <LANGINFOS> 
 <LANGINFO lang="*" label="Date" format="dd.MM.yy"/>
 <LANGINFO lang="EN" label="Date" format="MM/dd/yy"/>
</LANGINFOS>

after saving.

The definition for the fallback value (*) will not be deleted in any case. If there are two or more language definitions with identical values the first one will be maintained, the other will be deleted.

IMPORTANT: Up to and including FirstSpirit version 4.2R2 at least one definition for the fallback labelling ("*") must be given:

<LANGINFOS>
 <LANGINFO lang="*" label="TEXT"/>
</LANGINFOS>

From FirstSpirit version 4.2R4 the fallback definition can be omitted. In this case, the language which is defined first will be used automatically as fallback value. For example,

<LANGINFOS>
 <LANGINFO lang="EN" label="Date"/>
 <LANGINFO lang="DE" label="Datum"/> 
</LANGINFOS>

will become

 <LANGINFOS> 
 <LANGINFO lang="*" label="Date"/>
 <LANGINFO lang="DE" label="Datum"/> 
</LANGINFOS>

after saving.

LANGINFO

The LANGINFO tag is used to give values or attributes for a language as well for use as fallback values.

In order to state values or attributes for a language it is necessary to give the abbreviation of the project language in the lang parameter:

...
<LANGINFO lang="DE".../>
...

Fallback values are given with the special language abbreviation * ("for all languages"):

...
<LANGINFO lang="*".../>
...

The lang parameter is a mandatory parameter.

Overview

lang

The lang parameter is used to give the language abbreviation which is entered in the server properties see , Chapter "Language templates") to specify for which project languages the definitions are to apply, e.g. DE for German, EN for English, FR for French etc. The following characters can be used as often as required: -, _, 0-9 and A-Z. Lower case letters are transformed automatically into upper case letters after having saved the template. In addition * can be used for fallback values.

Overview

description

The description parameter can be used to give a description which is used to display a tool tip (mouse-over).

Overview

label

The label parameter is used to give the surface labelling for input and visualisation components.

Overview

LanguageAbbreviation	Language abbreviation, e.g. DE, EN, FR or * for return values
PositiveInteger	Positive integer
YesNo	Switch to apply an attribute or not NO Do not apply attribute YES Apply attribute
String	A random character string
Preset	How to deal with default values Copy The value entered by the editor is copied directly into the input component, subsequent changes do not have any effect Default The fall-back value defined in the form is used, as long as a value will be set manually
LayoutConstraint	Position of the layout component LEFT Layout component is shown on the left RIGHT Layout component is shown on the right TOP Layout component is shown at the top BOTTOM Layout component is shown at the bottom CENTER Layout component is shown in the middle. HIDE Layout component is hidden
DataSourceType	Data origin types DATABASE Access to the data of a table INLINE Access to data via section or link templates PAGE Access to sections on the current page SERVICE Access to data from external components or modules
Designator	Unique identifier of variable length; must start with a letter or underscore and may only contain the characters "A-Z", "a-z", "0-9" and "_", e.g. "fr_st_varName"