FirstSpirit

https://docs.e-spirit.com/odfs/
Admin
FirstSpirit is a content management system for which this documentation provides structured...
Tokens:1,274,790
Snippets:17,329
Trust Score:9.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install and Start FirstSpirit Server

Source: https://docs.e-spirit.com/odfs/edocs/inst/quick-guide-tes/installation/index.html

Use this command to install and start the FirstSpirit service on Windows.

```bash
fs-server installstart
```

--------------------------------

### Windows Server Installation and Start Commands

Source: https://docs.e-spirit.com/odfs/edocs/modd/server-installa/index-2.html

Commands for installing and starting the FirstSpirit server as a Windows service.

```batch
~FS\bin\fs-server install
~FS\bin\fs-server start
```

--------------------------------

### Install FirstSpirit Server

Source: https://docs.e-spirit.com/odfs/edocs/admi/firstspirit-ser/unix/index.html

Installs the FirstSpirit Server service. Use 'installrun' to also start the server immediately after installation.

```bash
~FS/bin/fs-server install
```

```bash
~FS/bin/fs-server installrun
```

--------------------------------

### Example Installation Archive Filename

Source: https://docs.e-spirit.com/odfs/edocs/inst/installing-firs/index.html

The filename of the FirstSpirit installation archive includes a version number.

```text
fs-install-1.0.0.tar.gz
```

--------------------------------

### Get List Information

Source: https://docs.e-spirit.com/odfs/template-develo/template-syntax/system-objects/list/index.html

This example demonstrates how to retrieve and display the total number of list elements, the starting value for counting, and the value of the last list element using the #list system object's count, start, and count2 methods.

```html
The list contains $CMS_VALUE(#list.count)$ elements.  
The counting begins with the value $CMS_VALUE(#list.start)$.  
The value of the last list element is $CMS_VALUE(#list.count2)$.
```

--------------------------------

### Install and Start FirstSpirit Server as Windows Service

Source: https://docs.e-spirit.com/odfs/edocs/admi/firstspirit-ser/windows/index.html

Installs and starts the FirstSpirit Server as a Windows system service. Administrator permissions are required. If the service name has changed, uninstall the old service first using 'remove' before installing the new one.

```bash
~FS\bin\fs-server installstart
```

--------------------------------

### Specify Launcher Installation Directory

Source: https://docs.e-spirit.com/odfs/edocs/inst/starting-applic/index.html

Optionally specify a custom installation folder during silent installation. This example uses the default value.

```bash
-dir %LOCALAPPDATA%\Programs\FSLauncher
```

--------------------------------

### installFeature Method

Source: https://docs.e-spirit.com/odfs/access/index-files/index-9.html

Starts a server-side feature installation process for the given feature file or options.

```APIDOC
## Method installFeature(FeatureFile, LayerMapper)

### Description
Starts a server side feature installation process for the given feature file.

### Interface
de.espirit.firstspirit.feature.FeatureInstallAgent
```

```APIDOC
## Method installFeature(FeatureInstallOptions)

### Description
Starts a server side feature installation process for the given `FeatureInstallOptions`.

### Interface
de.espirit.firstspirit.feature.FeatureInstallAgent
```

--------------------------------

### Example of Installation Order for Archive Restoration

Source: https://docs.e-spirit.com/odfs/edocs/admi/firstspirit-ser/elemente-menuel/projekt/index.html

Illustrates the correct sequence for installing archive files to restore a specific element, ensuring version history integrity. This is crucial when subsequent archives have been created after the target archive.

```text
1. Installation der Archivdatei vom 30.03.2014, 12:00
2. Installation der Archivdatei vom 23.03.2014, 12:00
3. Installation der Archivdatei vom 16.03.2014, 12:00
4. Installation der Archivdatei vom 09.03.2014, 12:01
```

--------------------------------

### Client Home Directory Example (Windows)

Source: https://docs.e-spirit.com/odfs/edocs/admi/firstspirit-ser/configuration-f/firstspirit-ser/area-server/index.html

Example of setting the client home directory for Windows workstations.

```properties
CLIENT_HOME_DIR_WINDOWS=C:/.test
```

--------------------------------

### Example Log File Name

Source: https://docs.e-spirit.com/odfs/edocs/admi/firstspirit-ser/integration-int/logging-firstsp/index.html

Provides a concrete example of a FirstSpirit web application log file name, based on a local installation.

```text
fs-webapp-localhost-1088.log
```

--------------------------------

### Quickstart - Interface

Source: https://docs.e-spirit.com/odfs/access/index-files/index-17.html

Represents a quickstart item that provides a convenient way to open SiteArchitect or ContentCreator with a predefined link.

```APIDOC
## Quickstart Interface

### Description
A quickstart item provides a convenient way for opening SiteArchitect or ContentCreator with a predefined link on the start page.

### Type
Interface

### Package
de.espirit.firstspirit.access.admin
```

--------------------------------

### Placeholder for Installation Archive Version

Source: https://docs.e-spirit.com/odfs/edocs/inst/installing-firs/index.html

Use this placeholder to represent the version of the installation archive during installation.

```text
fs-install-[version].tar.gz
```

--------------------------------

### Configuration Example: cxt.platform.internal-url

Source: https://docs.e-spirit.com/odfs/edocs/cxt/installation-mo/installing-modu/platform/index.html

Example of setting the internal URL for the CXT platform's accessibility.

```properties
cxt.platform.internal-url=http://localhost:8888/cxt-platform/
```

--------------------------------

### getServerConfiguration

Source: https://docs.e-spirit.com/odfs/access/index-files/index-7.html

Retrieves the current server configuration, providing access to Web Start Configuration and Quickstarts.

```APIDOC
## getServerConfiguration

### Description
Returns an instance of the current server configuration, including access to the `Web Start Configuration` and `Quickstart`s.

### Method
GET (assumed, as it retrieves information)

### Endpoint
Not specified, typically accessed via an agent interface.

### Parameters
None

### Response
- **ServerConfigurationAgent**: An instance of the server configuration agent.
```

--------------------------------

### Configuration Example: cxt.platform.external-url

Source: https://docs.e-spirit.com/odfs/edocs/cxt/installation-mo/installing-modu/platform/index.html

Example of setting the external URL for the CXT platform's accessibility in a browser.

```properties
cxt.platform.external-url=https://external/cxt-platform/
```

--------------------------------

### Example web.xml for ContentCreator Module

Source: https://docs.e-spirit.com/odfs/plug-developmen/implementation/module-architec/web-application/index.html

This web.xml example is used in the ContentCreator Example module framework. It defines basic web application information and a runtime parameter.

```xml
<?xml version="1.0" encoding="ISO-8859-1"?>
  
<web-app
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns="http://java.sun.com/xml/ns/j2ee"
 xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
 version="2.4">
  
<name>webclient_examples_jar</name> 
<displayname>FirstSpirit WebEdit Examples</displayname>
 <description>WebApp to provide all classes.</description>
  
 <context-param>
 <param-name>webedit.action.workflow</param-name>
 <param-value>$WORKFLOW</param-value>
 </context-param>
  
</web-app>
```

--------------------------------

### Start FirstSpirit Server

Source: https://docs.e-spirit.com/odfs/edocs/admi/updating-firsts/manual-update/index.html

Use this command to start the FirstSpirit server after updating files.

```bash
~FS/bin/fs-server start

```

--------------------------------

### FragmentCreator Configuration Parameter Example

Source: https://docs.e-spirit.com/odfs/edocs/cxt/installation-mo/installing-modu/fragmentcreator/index.html

An example of a configuration parameter for the FragmentCreator module.

```properties
markdownEditorType=simplemde
```

--------------------------------

### Configuration Example: cxt.dataservice.url

Source: https://docs.e-spirit.com/odfs/edocs/cxt/installation-mo/installing-modu/platform/index.html

Example of configuring the address at which the DAP Bridge can be accessed.

```properties
cxt.dataservice.url=http://localhost:8080/cxt/
```

--------------------------------

### Start FirstSpirit Server (Linux/MacOS)

Source: https://docs.e-spirit.com/odfs/edocs/inst/quick-guide-tes/installation/index.html

Start the FirstSpirit server on Linux or MacOS. Use 'fs-server stop' to stop.

```bash
fs-server start
```

--------------------------------

### Example Java Client Context Menu Items Plugin

Source: https://docs.e-spirit.com/odfs/plug-developmen/sitearchitect-e/interactive-fea/context-menu-it/code-example/index.html

Implements the JavaClientContextPluginsMenuItemsPlugin interface to provide context menu items for the 'Plugins' submenu. Requires setUp, tearDown, and getItems methods.

```java
public class ExampleJavaClientContextPluginsMenuItemsPlugin implements JavaClientContextPluginsMenuItemsPlugin {
  
    // Field definitions for objects that are required during the lifetime of a class instance.  
    private BaseContext _context;  
  
  
    @Override  
    public void setUp(@NotNull final BaseContext context) {
        _context = context;
    }
  
  
    @Override  
    public void tearDown() {
    }
  
  
    @NotNull  
    @Override  
    public Collection<? extends JavaClientContextMenuItem> getItems() {
        // Create and return an array list that includes individual context menu item objects.  
        return Arrays.asList(
            new ExampleExecutableContextMenuItem(),
            SeparatorContextMenuItem.INSTANCE,
            new ExampleGroupingContextMenuItem()
        );
    }
  
  
    /* Include one or several private static classes here that implement context menu item interfaces,  
       either ExecutableContextMenuItem or GroupingContextMenuItem. */  
  
}
```

--------------------------------

### Starting the fs-cli Command Line Tool

Source: https://docs.e-spirit.com/odfs/edocs/sync/how/2-import/index-2.html

This command initiates the fs-cli tool, which is used for importing and exporting data between the FirstSpirit project and the file system. Ensure you are in the 'bin' directory of your FSDevTools installation.

```bash
D:\fs-cli\bin>fs-cli _[command]_
```

--------------------------------

### ServerManager Web Start Configuration Parameters

Source: https://docs.e-spirit.com/odfs/edocs/admi/firstspirit-ser/configuration-f/firstspirit-ser/area-web-start/index.html

These parameters configure the web start settings for the FirstSpirit ServerManager application. They correspond to user-specific web start configurations.

```properties
webstart.admin.connection=  
webstart.admin.server=  
webstart.admin.port=  
webstart.admin.memory=  
webstart.admin.compression=  
webstart.admin.encryption=  
webstart.admin.servletZone=  
webstart.admin.usehttps=  
webstart.admin.parameters=
```

--------------------------------

### getProject()

Source: https://docs.e-spirit.com/odfs/access/index-files/index-7.html

Returns the project associated with this quickstart configuration. This method is part of the Quickstart interface.

```APIDOC
## getProject()

### Description
Returns the project this quickstart configuration is related to.

### Interface
de.espirit.firstspirit.access.admin.Quickstart
```

--------------------------------

### SiteArchitect Web Start Configuration Parameters

Source: https://docs.e-spirit.com/odfs/edocs/admi/firstspirit-ser/configuration-f/firstspirit-ser/area-web-start/index.html

These parameters configure the web start settings for the FirstSpirit SiteArchitect application. They affect quick-start entries on the start page unless overridden.

```properties
webstart.client.connection=  
webstart.client.server=  
webstart.client.port=  
webstart.client.memory=  
webstart.client.compression=  
webstart.client.encryption=  
webstart.client.servletZone=  
webstart.client.usehttps=  
webstart.client.parameters=
```

--------------------------------

### Example Management Page URL

Source: https://docs.e-spirit.com/odfs/edocs/cxt/installation-mo/installing-modu/platform/index.html

An example of the full URL to access the management page on a Tomcat server.

```text
http://myServer:8080/cxt-platform/management
```

--------------------------------

### getQuickstart()

Source: https://docs.e-spirit.com/odfs/access/index-files/index-7.html

Returns the list of quickstart items configured. This method is part of the ServerConfiguration interface.

```APIDOC
## getQuickstart()

### Description
Returns the list of quickstart items configured.

### Method
N/A (Method in interface)

### Endpoint
N/A (Method in interface)

### Interface
de.espirit.firstspirit.access.ServerConfiguration
```

--------------------------------

### Full Server Configuration Example

Source: https://docs.e-spirit.com/odfs/edocs/admi/firstspirit-ser/configuration-f/firstspirit-ser/area-communicat/index.html

Demonstrates a comprehensive set of server configuration parameters, including HTTP and socket ports, base URL, and specific URL connection settings for hostname, socket port, HTTP port, and HTTPS usage.

```properties
HTTP_PORT=5000
SOCKET_PORT=5100
URL=http://myServer:8000
fs.url.hostname=aliashost
fs.url.socketport=8300
fs.url.httpport=8200
fs.url.usehttps=true
```

--------------------------------

### Example %WEBeditURL% Placeholder

Source: https://docs.e-spirit.com/odfs/templates-basic/composition-tem/workflows/state-diagram-t/properties-an-a/index.html

Provides an example of a URL generated with the %WEBeditURL% placeholder, linking to a preview page in ContentCreator.

```plaintext
http://myServer:9999/fs5webedit/?project=476656&store=pagestore&element=477196
```

--------------------------------

### getWebstartConfiguration (JavaClientQuickstart)

Source: https://docs.e-spirit.com/odfs/access/index-files/index-7.html

Returns the webstart configuration.

```APIDOC
## getWebstartConfiguration (JavaClientQuickstart)

### Description
Returns the webstart configuration.

### Method
GET

### Endpoint
`/quickstart/webstart-configuration`

### Parameters
This method does not take any parameters.

### Response
#### Success Response (200)
- **webstartConfiguration** (object) - The webstart configuration.
```

--------------------------------

### Get Sublist from Start Index

Source: https://docs.e-spirit.com/odfs/template-develo/template-syntax/data-types/list/index.html

Returns a portion of the list from a start index to the end of the list.

```java
subList(int)
```

--------------------------------

### Media Store Reference Example

Source: https://docs.e-spirit.com/odfs/template-develo/template-syntax/functions/instructions/ref/index.html

Example of using ref() to specify an identifier for a picture from the Media Store.

```html
media:"suedsee"
```

--------------------------------

### Start All Services Automatically

Source: https://docs.e-spirit.com/odfs/edocs/admi/firstspirit-ser/configuration-f/firstspirit-ser/area-misc/index.html

Configure the FirstSpirit Server to automatically start all installed services upon server startup.

```configuration
SERVICES=*
```

--------------------------------

### Get Sublist with Start and End Index

Source: https://docs.e-spirit.com/odfs/template-develo/template-syntax/data-types/list/index.html

Returns a portion of the list from a start index to an end index (exclusive).

```java
subList(int, int)
```

--------------------------------

### MySQL Database Connection Configuration Example

Source: https://docs.e-spirit.com/odfs/edocs/admi/firstspirit-ser/database-connec/data-source-con/index.html

Provides a concrete example of configuring a MySQL database connection, including driver, URL, schema, user, password, and layer class.

```properties
content1.jdbc.DRIVER=com.mysql.jdbc.Driver
content1.jdbc.URL=jdbc:mysql://localhost:3306/mydb
content1.jdbc.SCHEMA=mydb
content1.jdbc.USER=cms
content1.jdbc.PASSWORD=cms
content1.jdbc.layerclass=de.espirit.or.impl.mysql.MySQLLayer
```

--------------------------------

### Get Current Page Index

Source: https://docs.e-spirit.com/odfs/template-develo/template-syntax/system-objects/global/multiple-pages/index.html

Use #global.pageParams.index to get the index of the currently generated page. Counting starts at 0.

```html
$CMS_VALUE(#global.pageParams.index)$
```

--------------------------------

### getInstalledExportFiles

Source: https://docs.e-spirit.com/odfs/access/index-files/index-7.html

Get filename list of installed exports and backups.

```APIDOC
## getInstalledExportFiles

### Description
Get filename list of installed exports and backups.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### FS_REFERENCE Input Component Example

Source: https://docs.e-spirit.com/odfs/template-develo/forms/input-component/reference/index.html

This is a basic example of the FS_REFERENCE input component, showing its structure with language-specific information.

```XML
<FS_REFERENCE name="_IDENTIFIER_" useLanguages="YES">
      <LANGINFOS>
        <LANGINFO lang="*" label="_TEXT_FALLBACK_" description="_TEXT_FALLBACK_"/>
        <LANGINFO lang="DE" label="_TEXT_DE_" description="_TEXT_DE_"/>
        <LANGINFO lang="EN" label="_TEXT_EN_" description="_TEXT_EN_"/>
      </LANGINFOS>
 </FS_REFERENCE>
```

--------------------------------

### Online Help System - Input Component Examples

Source: https://docs.e-spirit.com/odfs/templates-basic/basics/tools-developer/index.html

Describes how to access and use example syntax for input components from the Online Help system, including drag-and-drop functionality.

```text
In the Forms area, one or more examples of the syntax of a valid configuration for the respective input component type are listed at the end of the page. The “for example” link takes you directly to them. These examples show how the corresponding input component is used and as many parameters as can reasonably be combined with them are illustrated. When using the Online Help system in SiteArchitect (“Help / Index” menu) or `F1`, the example that is linked via the “for example” link can be moved directly to the template using drag-and-drop and edited further there.
```

--------------------------------

### Install imagerecognition-module

Source: https://docs.e-spirit.com/odfs/template-develo/contentcreator/automatic-cropp/index.html

Non-cloud customers must install the module using this command. Ensure you replace '[version]' with the correct module version.

```bash
imagerecognition-module-[version].fsm
```

--------------------------------

### Get Release Start Element for Server Release

Source: https://docs.e-spirit.com/odfs/access/index-files/index-7.html

Retrieves the start element for a server release action. This method is specific to server-side release operations.

```java
getReleaseStartElement() - Method in interface de.espirit.firstspirit.storage.ServerReleaseOperation
    
Returns the start element of the server release action. 

```

--------------------------------

### Get Unique Initial Letters from Names

Source: https://docs.e-spirit.com/odfs/template-develo/template-syntax/expressions/mapping-express/index.html

Use distinct() with a lambda to get the first occurrence of names starting with each letter. The result is then sorted alphabetically.

```CMS Script
$CMS_SET(_names, ["Birgit", "Andreas", "Barbara", "Emma", "Anne", "Celine"])$
```

```CMS Script
$CMS_FOR(_name, _names.distinct(x -> x.charAt(0)).sort)$
   $CMS_IF(!#for.isFirst)$ | $CMS_END_IF$
   $CMS_VALUE(_name.charAt(0))$
$CMS_END_FOR$
```

--------------------------------

### getWebstartConfiguration (ServerConfiguration)

Source: https://docs.e-spirit.com/odfs/access/index-files/index-7.html

Returns the webstart configuration specified by the given name.

```APIDOC
## getWebstartConfiguration (ServerConfiguration)

### Description
Returns the webstart configuration specified by the given name.

### Method
GET

### Endpoint
`/server/configuration/webstart/{name}`

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the webstart configuration.
```

--------------------------------

### Error Message for Incorrect Archive Installation Order

Source: https://docs.e-spirit.com/odfs/edocs/admi/firstspirit-ser/elemente-menuel/projekt/index.html

An example of an IllegalArgumentException that may occur if archive files are not installed in the correct chronological order, leading to inconsistencies in the version history.

```java
unknown revision id: 18, latest: 46
```

--------------------------------

### Comprehensive listConfig Example

Source: https://docs.e-spirit.com/odfs/template-develo/forms/input-component/domtable/index.html

A detailed example demonstrating various form field types (text, list, boolean, number, color) with different parameters like maxlen, upcase, and allowed characters.

```plaintext
a:Text[type=text;maxlen=30;upcase=true;allowed=abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ],
b:List type[4:Capital letter|2:Numbers|6:roman numbers],
c:Checkbox[boolean],
d:Number[type=number;maxlen=3],
f:Color[color],
g:Free text
```

--------------------------------

### Configure Optional Web Start Parameters

Source: https://docs.e-spirit.com/odfs/edocs/admi/firstspirit-sta/areas-the-start/user/index.html

Store optional parameters for Web Start configuration, separated by semicolons. These parameters can override or supplement existing settings for encryption, compression, and other communication aspects.

```properties
PARAMETER1=VALUE1; PARAMETER2=VALUE2
```

--------------------------------

### Example of URL Conflict Due to Index Entry

Source: https://docs.e-spirit.com/odfs/advanced-topics/generation/advanced-urls/configuration/index.html

Illustrates how a retained 'index' entry for a start page can cause subsequent start pages to be assigned numbered URLs instead of the desired 'index.html'.

```plaintext
../Startpage/index.html
```

--------------------------------

### Getting Navigation Folder Reference

Source: https://docs.e-spirit.com/odfs/template-develo/template-syntax/functions/header/navigation/index.html

Use #nav.folder to obtain the link to a folder within the Site Store for navigation display. This is useful for checking if a folder contains a start page or start folder.

```HTML
$CMS_IF(#nav.folder == #global.node.parent)$  
   <Output for start page>  
$CMS_ELSE$
   <Output for start folder>
$CMS_END_IF$

```

--------------------------------

### StartWorkflowWebeditInlineEditItemsPlugin Example

Source: https://docs.e-spirit.com/odfs/plug-developmen/contentcreator/interactive-fea/inlineedit-butt/functional-over/index.html

Provides an InlineEdit button for dataset button bars that starts a workflow referenced in web.xml.

```Java
package de.espirit.firstspirit.opt.example.webedit.inlineedit;

import de.espirit.firstspirit.access.editor.ui.WebeditUiAccess;
import de.espirit.firstspirit.access.editor.ui.webedit.inlineedit.WebeditInlineEditItem;
import de.espirit.firstspirit.access.editor.ui.webedit.inlineedit.WebeditInlineEditItemFactory;
import de.espirit.firstspirit.access.editor.ui.webedit.inlineedit.WebeditInlineEditItemFactoryContext;
import de.espirit.firstspirit.access.editor.ui.webedit.inlineedit.action.WorkflowAction;
import de.espirit.firstspirit.access.project.ProjectScriptContext;

import java.util.ArrayList;
import java.util.List;

/**
 * Example for the implementation of a "StartWorkflow" InlineEdit button.
 */
public class StartWorkflowWebeditInlineEditItemsPlugin implements WebeditInlineEditItemFactory {

    @Override
    public List<WebeditInlineEditItem> create(final WebeditInlineEditItemFactoryContext context) {
        final List<WebeditInlineEditItem> items = new ArrayList<>();
        final WebeditUiAccess uiAccess = context.getUiAccess();
        final ProjectScriptContext scriptContext = context.getScriptContext();

        // "Start Workflow" button
        items.add(uiAccess.createWebeditInlineEditItem(
                "Start Workflow",
                "Start workflow",
                "/images/icons/workflow.png",
                new WorkflowAction("webedit.action.workflow") // Workflow UID from web.xml context parameter
        ));

        return items;
    }
}

```

--------------------------------

### installWebApp Method

Source: https://docs.e-spirit.com/odfs/access/index-files/index-9.html

Installs or updates a web-app component into the specified web app and deploys it to its web server.

```APIDOC
## Method installWebApp(String, String, WebAppId)

### Description
Installs or updates the given web-app component into the specified web app and deploys the web app to its web-server.

### Interface
de.espirit.firstspirit.agency.ModuleAdminAgent
```

--------------------------------

### Language.getAbbreviation()

Source: https://docs.e-spirit.com/odfs/access/index-files/index-7.html

Gets the abbreviation used for this language, for example 'DE' for 'German'. This method is part of the Language interface.

```APIDOC
## getAbbreviation()

### Description
Get the abbreviation used for this language, for example "DE" for "German".

### Method
GET

### Endpoint
N/A (Method Signature)
```

--------------------------------

### Configure Process Creation by Context

Source: https://docs.e-spirit.com/odfs/edocs/admi/firstspirit-ser/configuration-f/execution-const/index.html

This example demonstrates how to enable process creation by default while disabling it specifically for templates. Changes to fs-exec.conf are reloaded automatically at runtime.

```ini
[default]
ProcessStartConstraint.enabled=false

[Invoker]
ProcessStartConstraint.enabled=true
```

--------------------------------

### Getting Remaining Rows with #cell.remainingRows

Source: https://docs.e-spirit.com/odfs/template-develo/template-syntax/system-objects/cell/index.html

Calculates the number of rows remaining in the table, starting from the current row (inclusive).

```html
$CMS_VALUE(#cell.remainingRows)$
```

--------------------------------

### getUpdateMode

Source: https://docs.e-spirit.com/odfs/access/index-files/index-7.html

Gets the update mode of a subscription. It determines if imports start automatically or manually. This method is part of the Subscription interface.

```APIDOC
## getUpdateMode

### Description
Gets the update mode of this subscription. If the update mode is `Subscription.MODE_AUTOMATIC` (default) the import of this subscription will start automatically as soon as a new version of the belonging `Package` is available. In `Subscription.MODE_MANUAL` mode the import has to be started manually.

### Method
GET (assumed, as it's a getter method)

### Endpoint
Not applicable (Java method)

### Parameters
None

### Response
- **updateMode** (string) - The update mode of the subscription (e.g., `Subscription.MODE_AUTOMATIC`, `Subscription.MODE_MANUAL`).
```

--------------------------------

### Example fs-license.conf Configuration

Source: https://docs.e-spirit.com/odfs/edocs/admi/firstspirit-ser/configuration-f/licence-configu/index.html

This snippet shows a typical structure and parameters found in the fs-license.conf file. It includes license metadata and the license key block.

```properties
#FIRSTspirit license  
#Mon Jan 02 10:34:22 CET 2018  
license.MAXPROJECTS=5  
license.EXPDATE=15.12.2019  
license.MODULES=personalisation,search,integration,newsletter,portal,form_edit,enterprise_search  
license.ARCHIVE=1  
license.VERSION=5  
license.USER=e-spirit  
license.WORKFLOW=1  
license.DOCUMENTGROUP=1  
license.MAXSESSIONS=20  
license.WEBEDIT=1  
license.MAXUSER=20  
license.APPTAB_SLOTS=5  
-----begin FirstSpirit license key-----  
...
-----end FirstSpirit license key-----
```

--------------------------------

### Get Depth of Page

Source: https://docs.e-spirit.com/odfs/template-develo/template-syntax/system-objects/global/page-specific/index.html

Returns the depth of the page relative to the root node in the Page Store, starting with 0 for the root.

```html
#global.page.depth
```

--------------------------------

### Example %FIRSTspiritURL% Placeholder

Source: https://docs.e-spirit.com/odfs/templates-basic/composition-tem/workflows/state-diagram-t/properties-an-a/index.html

Demonstrates the format of a URL generated using the %FIRSTspiritURL% placeholder, which links to a specific node in the project.

```plaintext
http://myServer:9999/start/FIRSTspirit.jnlp?app=client&project=QS_akt&name=vorlage_1&type=Page&id=4394331&host=myServer&port=9999&mode=HTTP
```

--------------------------------

### Starting a Specific Project via URL

Source: https://docs.e-spirit.com/odfs/edocs/cxt/installation-mo/access-the-firs/index.html

Use the 'project' parameter in the URL to directly start the FragmentCreator with a specified project ID. This is useful for linking to or bookmarking specific project environments.

```URL
localhost:8000/fragments?project=12345
```

--------------------------------

### Get and modify a nested JSON field

Source: https://docs.e-spirit.com/odfs/enhanced-json-s/api-customize-j/index.html

Use `get` to access a field's value and then chain `set` to modify it. This example demonstrates adding a new string value to the 'data' field of a section's JSON representation.

```html
$CMS_SET(jsonObject, json(#this))$
```

```html
$CMS_SET(void, jsonObject.get("data").set("anotherString","anotherValue"))$
```

```html
$CMS_VALUE(jsonObject)$
```

```html
$CMS_SET(set_data, json(#this).get("data").set("anotherString","anotherValue"))$
$CMS_VALUE(json(#this).set("data",set_data))$
```

--------------------------------

### Get Depth of Page Reference

Source: https://docs.e-spirit.com/odfs/template-develo/template-syntax/system-objects/global/page-specific/index.html

Returns the depth of the page reference relative to the root node in the Site Store, starting with 0 for the root.

```html
#global.node.depth
```

--------------------------------

### Jumping to References Example (Template Set Tab - FirstSpirit Objects)

Source: https://docs.e-spirit.com/odfs/templates-basic/basics/tools-developer/index.html

Illustrates navigating to referenced FirstSpirit objects like media or global content from a Template Set tab.

```text
Reference to FirstSpirit objects:
Example: referenced medium
Click to get to the picture _icon_print_.
Example: referenced GCA object
Click to get to the global content _homepage_.
Example: referenced template
Click to get to the template _tooltip_.
```

--------------------------------

### Get Revisions within a Time Frame

Source: https://docs.e-spirit.com/odfs/advanced-topics/aenderungsverfo/get-revision/index.html

Retrieve a list of revisions between a start and end revision, with optional limits on the number of revisions and filtering.

```java
start = project.getRevision(context.getStartTime());
end = project.getRevision(new Date());
revisions = project.getRevisions(start, end, 0, null);
```

--------------------------------

### Store Mapping Example

Source: https://docs.e-spirit.com/odfs/plug-developmen/contentcreator/management-exte/store-mapping/code-example/index.html

This example demonstrates the implementation of store mapping. It shows how to define and use mappings for content elements.

```java
package com.example.firstspirit.contentcreator.management.storemapping;

import de.espirit.firstspirit.access.project.ProjectScriptContext;
import de.espirit.firstspirit.content.contentcreator.management.storemapping.StoreMapping;
import de.espirit.firstspirit.content.contentcreator.management.storemapping.StoreMappingEntry;
import de.espirit.firstspirit.content.contentcreator.management.storemapping.StoreMappingEntry.Type;

import java.util.ArrayList;
import java.util.List;

public class StoreMappingExample {

    public static void main(ProjectScriptContext context) {
        // Create a new store mapping
        StoreMapping storeMapping = new StoreMapping();

        // Add entries to the store mapping
        List<StoreMappingEntry> entries = new ArrayList<>();
        entries.add(new StoreMappingEntry("key1", "value1", Type.STRING));
        entries.add(new StoreMappingEntry("key2", "value2", Type.INTEGER));
        entries.add(new StoreMappingEntry("key3", "value3", Type.BOOLEAN));

        storeMapping.setEntries(entries);

        // You can now use the storeMapping object, for example, to retrieve values
        String value1 = (String) storeMapping.getEntry("key1").getValue();
        System.out.println("Value for key1: " + value1);

        // In a real scenario, this storeMapping would be associated with a specific
        // ContentCreator configuration or used within a management extension.
    }
}
```

--------------------------------

### Query Definition with Parameter Assignment

Source: https://docs.e-spirit.com/odfs/template-develo/forms/input-component/index/index.html

Assign values to query parameters using the PARAM tag. This example filters products by name starting with 'DS%'.

```XML
<QUERY name="Products.names"> 
 <PARAM name="name">DS%</PARAM> 
</QUERY>
```

--------------------------------

### Example CLI Call with Proxy Settings

Source: https://docs.e-spirit.com/odfs/edocs/sync/getting-started/komponenten/command-line-to/index.html

Demonstrates how to include proxy host and port settings in a command-line call to FirstSpirit CLI. Proxy settings are only effective in HTTP/HTTPS modes.

```bash
fs-cli -h example.com -port 4242 -c HTTP -hph myproxy.com -hpp 8080 [...]
```

--------------------------------

### Method Invocation Example: Getting Variable Data Type

Source: https://docs.e-spirit.com/odfs/template-develo/template-syntax/expressions/method-invocati/index.html

Shows how to use the getClass() method to determine the data type of a variable, in this case, a BigInteger.

```html
$CMS_SET(myVar, 42)$  
Return value: $CMS_VALUE (myVar.getClass())$
```

--------------------------------

### Example of URL Conflict Resolution

Source: https://docs.e-spirit.com/odfs/advanced-topics/generation/advanced-urls/configuration/index.html

Shows the resulting URL when a new start page is assigned a consecutive number due to a conflict with a previously generated 'index' entry.

```plaintext
../Startpage/index.1.html
```

--------------------------------

### Example %HISTORY% Placeholder

Source: https://docs.e-spirit.com/odfs/templates-basic/composition-tem/workflows/state-diagram-t/properties-an-a/index.html

Illustrates the output format for contextual workflow information using the %HISTORY% placeholder.

```plaintext
April 16, 2012 – Admin, manual  
Activity: Request release  
State: Release requested  
Comment: UserB: Please approve release
```

--------------------------------

### Render Script in PDF Template

Source: https://docs.e-spirit.com/odfs/templates-basic/composition-tem/scripts/properties-tab/index.html

Example of calling a script within a PDF template for rendering specific content. Ensure the script name and parameters match your project setup.

```XML
<fo:table table-layout="fixed" width="170mm">
    $CMS_RENDER(script:"fotablecolumns",colWidth:set_cw,colNumbers:set_cn)$
    <fo:table-body>
        $CMS_VALUE(#content)$
    </fo:table-body>
</fo:table>
```

--------------------------------

### FS_CATALOG Configuration Example

Source: https://docs.e-spirit.com/odfs/template-develo/forms/input-component/catalog/index.html

Example configuration for the FS_CATALOG input component, used for listing sections. It includes language-specific labels and descriptions.

```xml
<FS_CATALOG name="_IDENTIFIER_" useLanguages="NO">
      <LANGINFOS>
        <LANGINFO lang="*" label="_TEXT_FALLBACK_" description="_TEXT_FALLBACK_"/>
        <LANGINFO lang="DE" label="_TEXT_DE_" description="_TEXT_DE_"/>
        <LANGINFO lang="EN" label="_TEXT_EN_" description="_TEXT_EN_"/>
      </LANGINFOS>
      <TEMPLATES type="SECTION"/>
 </FS_CATALOG>
```

--------------------------------

### Obtain and Use a Service

Source: https://docs.e-spirit.com/odfs/plug-developmen/implementation/using-firstspir/services/index.html

Retrieve a service object (either server-wide or client-specific) using the ServicesBroker. This example demonstrates how to get an instance of MyClientServiceClass and includes error handling for when the service is not found.

```Java
final ServicesBroker servicesBroker = context.requestSpecialist(ServicesBroker.TYPE);
  
try {  
    final MyClientServiceClass myClientServiceObject = servicesBroker.getService(MyClientServiceClass.class);
} catch (ServiceNotFoundException e) {  
    // Handle cases in which the requested service cannot be obtained.
}
```

--------------------------------

### Execute Full Preview Deployment

Source: https://docs.e-spirit.com/odfs/edocs/cxt/installation-mo/installing-modu/firstspirit-caa/index.html

This executable is used to provide all changed content from a fragment project to the Preview CaaS server via a schedule entry.

```bash
#!executable-class
cxt-caas-integration-full-preview-deployment-executable
```

--------------------------------

### FirstSpirit Server URL Example

Source: https://docs.e-spirit.com/odfs/edocs/inst/starting-applic/index.html

Use this URL format to access the FirstSpirit Server. Ensure the hostname, domain, and TLD are replaced with your specific settings. A standard installation uses port 8000, but this can vary.

```text
http://[hostname].[domain].[tld]:[port]
```

--------------------------------

### Configuration File Placeholder Example

Source: https://docs.e-spirit.com/odfs/edocs/admi/firstspirit-ser/general-configu/index.html

This example demonstrates the use of placeholders in FirstSpirit configuration files, where a value can be dynamically assigned to a parameter using expressions like ${Key_2}.

```properties
Key _1 = ${Key_2}
```

--------------------------------

### getUnmappedLayers()

Source: https://docs.e-spirit.com/odfs/access/index-files/index-7.html

Lists layer names from the source project that exist in the feature due to unmapped schema nodes or datarecords. An overloaded version is available for getting unmapped layer information when installing backup files.

```APIDOC
## getUnmappedLayers()

### Description
Lists layer names from the source project that exist in the feature due to unmapped schema nodes or datarecords. An overloaded version is available for getting unmapped layer information when installing backup files.

### Method
Various (depends on the implementing class/interface)

### Endpoint
N/A (Method call)

### Parameters
- `long id` - (long) - Identifier for backup files.
- `String name` - (String) - Name for backup files.
- `List<ExportFile> files` - (List<ExportFile>) - List of export files.

### Response
Returns a list of unmapped layer names or unmapped layer information for installing backup files.
```

--------------------------------

### Setting Validation Level for Input

Source: https://docs.e-spirit.com/odfs/edocs/cxt/templates/fragments/checking-conten/index.html

This example shows how to set the restriction level for content validation using the 'VALIDATION' tag with the 'scope' attribute. 'RELEASE' scope prevents the release workflow from starting if the input is invalid.

```xml
<VALIDATION scope="RELEASE">
...
</VALIDATION>
```

--------------------------------

### setWebstartConfiguration (JavaClientQuickstart)

Source: https://docs.e-spirit.com/odfs/access/index-files/index-19.html

Sets the webstart configuration. This method is part of the JavaClientQuickstart interface.

```APIDOC
## setWebstartConfiguration(WebstartConfiguration) - JavaClientQuickstart

### Description
Sets the webstart configuration.

### Method
N/A (Interface method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
None
```

--------------------------------

### Configure JDBC Driver Module in Database Layer

Source: https://docs.e-spirit.com/odfs/edocs/admi/firstspirit-ser/database-connec/installation-co/database-layer/index.html

Add the 'module' parameter to the database configuration in FirstSpirit Server properties to specify the name of the installed JDBC driver module. This example uses 'JDBC_PostgreSQL_9_3' as the module name.

```properties
module=JDBC_PostgreSQL_9_3
```

--------------------------------

### Define Rule Execution on Lock/Edit Mode

Source: https://docs.e-spirit.com/odfs/template-develo/rules/time-execution/index.html

Use the 'when="ONLOCK"' attribute to trigger a rule when the user enters edit mode or creates new elements. This is suitable for initial setup or checks upon starting to edit content.

```XML
<RULES>
	<RULE when="ONLOCK">
...

```

--------------------------------

### Example FirstSpirit Server Configuration for Client Cookies

Source: https://docs.e-spirit.com/odfs/edocs/admi/firstspirit-ser/configuration-f/firstspirit-ser/area-communicat/index.html

An example configuration for `fs-server.conf` demonstrating how to set client cookie names, their domain, path, and secure flag. This is useful when integrating with web app firewalls.

```properties
clientCookieNames=cookieName1
clientCookie.cookieName1.domain=*.domain.com
clientCookie.cookieName1.path=/
clientCookie.cookieName1.secure=true
```

--------------------------------

### Automatic List Numbering with #listitem.index and #list.count2

Source: https://docs.e-spirit.com/odfs/template-develo/template-syntax/system-objects/listitem/index.html

This example demonstrates how to automatically number list items using #listitem.index, considering a starting value defined in list configurations. It also shows how #list.count2 can be used to display the total count of list items, ensuring the numbering reflects the overall list size.

```html
<li>
  $CMS_VALUE(#listitem.index)$ / $CMS_VALUE(#list.count2)$: $CMS_VALUE(#content)$
</li>
```

```html
<li>
  257 / 261: 1st Value
</li>
<li>
  258 / 261: 2nd Value
</li>
<li>
  259 / 261: 3rd Value
</li>
<li>
  260 / 261: 4th Value
</li>
<li>
  261 / 261: 5th Value
</li>
```

--------------------------------

### Optional fs-server-custom.shconf Configuration

Source: https://docs.e-spirit.com/odfs/edocs/admi/firstspirit-ser/unix/index.html

Defines the user for starting the FirstSpirit Server and the path to the Java version. Uncomment and set values as needed.

```bash
RUN_AS_USER=<Username>  
export FS_JAVA_HOME=<path to java> 
```

--------------------------------

### Task Result Start Time

Source: https://docs.e-spirit.com/odfs/access/index-files/index-7.html

Retrieves the date when the execution of a task has started, or null if not yet started.

```APIDOC
## getStartTime() - TaskResult

### Description
Returns the date execution of this task has been started or `null` if the execution has not yet started.

### Method
GET (assumed)

### Endpoint
`/access/schedule/TaskResult/getStartTime` (assumed)

### Parameters
None

### Response
#### Success Response (200)
- **Date or null**: The date execution started, or null if not yet started.
```

--------------------------------

### Module Descriptor XML Example

Source: https://docs.e-spirit.com/odfs/edocs/admi/firstspirit-sta/areas-the-start/legal-informati/index.html

Example of a module descriptor XML file showing how to specify the path to a license file.

```xml
<module>
  ...
 <licenses>META-INF/licenses.csv</licenses>
 ...
</module>
```

--------------------------------

### Schedule Context Start Time

Source: https://docs.e-spirit.com/odfs/access/index-files/index-7.html

Retrieves the start time of a schedule entry, which may differ from when it actually started.

```APIDOC
## getStartTime() - ScheduleContext

### Description
Gets the start time for a schedule entry. This time is not necessarily when the schedule entry was initiated. Refer to `ScheduleContext.setStartTime(java.util.Date)` for more details.

### Method
GET (assumed)

### Endpoint
`/access/schedule/ScheduleContext/getStartTime` (assumed)

### Parameters
None

### Response
#### Success Response (200)
- **Date**: The scheduled start time.
```

--------------------------------

### Configuring URL Creator for Welcome Filenames

Source: https://docs.e-spirit.com/odfs/advanced-topics/generation/advanced-urls/index.html

Shows how to use a script to generate files based on page reference display names instead of 'index.*' files.

```java
context.setProperty("#urlCreatorSettings", Collections.singletonMap("usewelcomefilenames", "false"));
```

--------------------------------

### Execute Full Live Deployment

Source: https://docs.e-spirit.com/odfs/edocs/cxt/installation-mo/installing-modu/firstspirit-caa/index.html

This executable is used to provide all released content from a fragment project to the Live CaaS server via a schedule entry.

```bash
#!executable-class
cxt-caas-integration-full-live-deployment-executable
```

--------------------------------

### GomSingleLine Example

Source: https://docs.e-spirit.com/odfs/access/serialized-form.html

Example of a single line field.

```java
YesNo _singleLine
```

--------------------------------

### Silent Installation of FirstSpirit Launcher

Source: https://docs.e-spirit.com/odfs/edocs/admi/firstspirit-sta/areas-the-start/firstspirit-lau/index.html

Install the FirstSpirit Launcher silently for multiple workstations using group policy. Optionally specify the installation directory.

```bash
FSLauncher.exe -q
FSLauncher.exe -q -dir %LOCALAPPDATA%\Programs\FSLauncher
```

--------------------------------

### install Method (ModuleAdminAgent)

Source: https://docs.e-spirit.com/odfs/access/index-files/index-9.html

Installs or updates a given module from an input stream. This method is the recommended way to install modules since version 5.2.241104.

```APIDOC
## Method install(InputStream, ModuleAdminAgent.UpdateUsagesMode)

### Description
**Installs** or **updates** the given module.

### Interface
de.espirit.firstspirit.agency.ModuleAdminAgent
```

```APIDOC
## Method install(InputStream, boolean)

### Description
Deprecated.
since 5.2.241104, use `ModuleAdminAgent.install(InputStream, UpdateUsagesMode)` instead

### Interface
de.espirit.firstspirit.agency.ModuleAdminAgent
```

```APIDOC
## Method install(InputStream, boolean, boolean)

### Description
Deprecated.
since 5.2.241104, use `ModuleAdminAgent.install(InputStream, UpdateUsagesMode)` instead

### Interface
de.espirit.firstspirit.agency.ModuleAdminAgent
```
Tokens:
Raw