Compilation, Installation, and Configuration

Editorial Search and Replace is provided as a Zip package containing the source code and supporting files such as icon graphics.

Before the module is ready for use, it must be compiled, installed on a FirstSpirit server, and configured for use within a FirstSpirit project. This page provides information about each of these processes.

Compilation

Prerequisites

To compile the module's source package into a FirstSpirit Module (FSM) file, it is necessary to meet certain prerequisites:

Software

• Java Development Kit (JDK) 1.7.0 or higher
  • The environment variable JAVA_HOME must be set to the proper path.
• Apache ant 1.8 or higher

Libraries

• fs-access.jar (available in [SERVER_ROOT]/data/fslib)
• fs-client.jar (available in [SERVER_ROOT]/web/fs5root/clientjar)

Compilation Process

1. Download the Editorial Search and Replace source Zip package.
2. Extract the Zip package into the desired directory (the Zip package already contains a top-level directory named editorialsar, which will be extracted along with its contents - that directory will be represented by the placeholder [MODULE_ROOT] in the following steps).
3. Place the files fs-access.jar and fs-client.jar into the directory [MODULE_ROOT]/lib.
4. Open a command line window or terminal session and navigate to the top-level module directory (extraction path in step 2, sub-directory editorialsar).
5. Run the ant script appropriate for your operating system (adding its path if necessary) with the target editorialsar.fsm as the only command-line parameter:
   
   ant editorialsar.fsm
6. The file editorialsar.fsm will be placed in the directory [MODULE_ROOT]/target/fsm.

Installation

1. Start FirstSpirit ServerManager from the FirstSpirit start page.
2. Open the Server Properties panel (menu "Server" / "Properties").
3. Navigate to the "Modules" page and click "Install".
4. Locate the file editorialsar.fsm created in Compilation Process and click "Open".
5. Once module installation has completed, click "OK" to confirm.

As this module is not signed by a trusted software key, it must be configured with "All permissions" in order to use project-specific configuration. For information about the effects of trusting an unsigned module as well as how to assign "All permissions" to a module, see FirstSpirit Manual for Administrators, Chapter 7.3.11.1.

Configuration

Installing the Project Application

The module's project application must be installed in each FirstSpirit project in which search and replace functionality should be available. Upon installation of the project application in a project, the Editorial Search and Replace report will become available when that project is loaded in SiteArchitect and ContentCreator.

1. Start FirstSpirit ServerManager from the FirstSpirit start page.
2. Select the project you wish to configure and click "Change properties".
3. Navigate to the "Project components" page and click "Add".
4. In the "Add" window, select the project component "Editorial Search and Replace: Project Application" from the list and click "OK".

Activating Templates for Search and Replace Operations

In order to identify search results and perform replacement processes in the search modes "Pages and Sections" (SiteArchitect)/"Web Pages" (ContentCreator) and "Datasets" as well as in element metadata, templates must be activated for search and replace processes via the project application's configuration panel.

• The Editorial Search and Replace module will only consider a data-providing element (i.e., find and/or replace search string occurrences in Page, Section, and Dataset elements as well as in inline objects of FS_LIST editor components) if its associated template is activated for search and replace processing.
• Metadata of elements will only be considered if the project's metadata template is activated for search and replace. Metadata for data-providing elements will only be considered for search and replace if the element's template is also activated for search and replace.
• Data within DOM editor components (CMS_INPUT_DOM and CMS_INPUT_DOMTABLE) will be processed in a cascading manner, traversing the DOM node tree and processing each node only if that node's associated format template is activated for search and replace processing. If, for example, the module's search adapter code encounters a node associated with a block-level format template which is not activated for search and replace processing, it will not process this node nor any child nodes, even if those child nodes are associated with activated inline-level format templates.

1. Start FirstSpirit ServerManager from the FirstSpirit start page.
2. Select the project you wish to configure and click "Change properties".
3. Navigate to the "Project components" page, select the component "Editorial Search and Replace: Project Application", and click "Configure".
4. In the configuration window, switch through all template type tabs and check each template that should be considered in search and replace operations in this project.
5. Click "OK" to store the configuration settings and return to the "Project components" page.

If the project application configuration is changed, the new settings (i.e. the set of activated templates) will come into effect in new client sessions only. Users with currently active client sessions should end these and start new client sessions

Preparing a ContentCreator Web Application

If Editorial Search and Replace functionality should be available in a particular project in ContentCreator as well, follow the instructions outlined in the FirstSpirit Manual for Administrators to create or update and roll out a project-specific ContentCreator web application, adding the component "Editorial Search and Replace: run-time library for WebClient 5" to that web application in the process.