Crownpeak Digital Experience Platform

https://docs.e-spirit.com/
Admin
Crownpeak Digital Experience Platform is an enterprise SaaS solution providing content management,...
Tokens:349,092
Snippets:5,043
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install TranslationStudio Service

Source: https://docs.e-spirit.com/cloud/translationstudio/TranslationStudio_Installation_Manual_EN.html

Install the TranslationStudio application as a service. This command requires root privileges and sets up the application to start at boot time.

```bash
./translationstudio install
```

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

### Initialize Configuration Member

Source: https://docs.e-spirit.com/cloud/translationstudio/TranslationStudio_Tutorial_Connector_DE.html

Example of storing the configuration XML in a member variable during the setup process.

```java
**/**
 * Hold the configuration
 */**
**private** **final** Configuration m_pConfiguration = **new** Configuration();

**/**
 * {@inheritDoc }
 */**
_@Override_
**public** **boolean** setup(String sTmsId, String sConfigurationXml, String sWorkingDirectory, IConnectorContext pContext)
{
    m_pConfiguration.load(sConfigurationXml);
    **return** true;
}
```

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

### Implement Connector Setup

Source: https://docs.e-spirit.com/cloud/translationstudio/TranslationStudio_Tutorial_Connector_DE.html

The setup method initializes the connector with configuration XML and context. It is called before any operations are requested.

```java
**/**
 * Setup the connector
 *
 * @param sTmsId Tms Id
 * @param sConfigurationXml Connector Configuration (as provided by {@link com.idmedia.translationstudio.api.connector.gui.ITranslationMemorySystemConnectorConfigurationGui.getConnectorConfiguration}
 * @param sWorkingDirectory Connector Working Directory
 * @param pContext Connector Context
 * @return
 */**
**public** **boolean** setup(String sTmsId, String sConfigurationXml, String sWorkingDirectory, IConnectorContext pContext);
```

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

### Start Solr and SmartSearch Servers

Source: https://docs.e-spirit.com/delivery_modules/smart_search/SmartSearch_Migration-Guide_EN.html

Starts the Solr and SmartSearch services after the upgrade and configuration import are complete.

```bash
sudo systemctl start solr
sudo systemctl start smart-search
```

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

### Storefront Hostname Example

Source: https://docs.e-spirit.com/ecom/contentconnect-salesforce/ContentConnect_Documentation_EN.html

Example format for the optional Storefront Hostname field.

```text
https://<DIFFERENT SUBDOMAIN INSTANCE>.demandware.net/
```

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

### Tracking Plug-in Initialization Example

Source: https://docs.e-spirit.com/module/abtesting/AB_Testing_Documentation_EN.html

Example demonstrating the initialization of variables within a tracking plug-in. This is crucial for the persistence of information entered in the configuration dialog.

```javascript
var pluginname=( function(){
   $-- init variables --$
   var variable;

   return {
      $-- add gui --$
      addGui: function (container) {
         [...]
      },
      [...]
   };
})();
```

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

### Start Service via su

Source: https://docs.e-spirit.com/cloud/translationstudio/TranslationStudio_Installation_Manual_DE.html

Command used by the system to start the application as the fs5 user.

```bash
su fs5 -c "java …" 
```

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

### Install FirstSpirit Connect libraries

Source: https://docs.e-spirit.com/ecom/fsconnect-sap-headless/FS_Connect_SAP_hl_Documentation_EN.html

Install the necessary npm packages to enable FirstSpirit integration in the Spartacus Storefront.

```bash
npm install fs-spartacus-bridge
npm install fs-spartacus-view-components
npm install fs-spartacus-common
```

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

### Install Helm Chart

Source: https://docs.e-spirit.com/module/caas-platform/CaaS_Platform_Operations_Guide_EN.html

Commands to create a namespace and install the Helm chart using a custom values file.

```bash
kubectl create namespace caas
helm install RELEASE_NAME . --namespace=caas --values /path/to/custom-values.yaml
```

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

### Minimal Export Parameters Example

Source: https://docs.e-spirit.com/cloud/developer-cloud-documentation/Cloud_Development_Handover_DE.html

This example demonstrates the minimal set of export parameters required for a basic export operation.

```bash
root:templatestore projectproperty:RESOLUTIONS
```

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

### Start UX-Bus on Windows

Source: https://docs.e-spirit.com/module/fos/FOS_Admin-Documentation_EN.html

Execute this command to start the UX-Bus in standalone operation on Windows systems. Navigate to the 'bin' directory of the unzipped distribution first.

```batch
bin/activemq
```

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

### Refinement Key-Value Pair Examples

Source: https://docs.e-spirit.com/ecom/contentconnect-salesforce/ContentConnect_Documentation_EN.html

Examples of refinement definitions for product search improvements.

```text
cgid=new-arrivals|electronics
```

```text
price=(0..100)
```

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

### Start TranslationStudio Service

Source: https://docs.e-spirit.com/cloud/translationstudio/TranslationStudio_Installation_Manual_EN.html

Start the TranslationStudio service. This command requires appropriate privileges to manage system services.

```bash
service translationstudiod start
```

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

### Start Solr and SmartSearch Services

Source: https://docs.e-spirit.com/delivery_modules/smart_search/SmartSearch_Migration-Guide_EN.html

Starts the Solr and SmartSearch services after the upgrade and configuration changes. Also initiates the reindex tool.

```bash
sudo systemctl start solr
sudo systemctl start smart-search
java -jar reindex-tool.jar
```

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

### Initialize Configuration in Setup

Source: https://docs.e-spirit.com/cloud/translationstudio/TranslationStudio_Tutorial_Connector_EN.html

Loads the connector configuration from the provided XML string during the setup process. The configuration is stored in a member variable for later use.

```java
/**
 * Hold the configuration
 */
private final Configuration m_pConfiguration = new Configuration();

/**
 * {@inheritDoc }
 */
@Override
public boolean setup(String sTmsId, String sConfigurationXml, String sWorkingDirectory, IConnectorContext pContext)
{
    m_pConfiguration.load(sConfigurationXml);
    return true;
}
```

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

### Install API to Local Maven Repository

Source: https://docs.e-spirit.com/module/uxbridge/UX-Bridge_DeveloperDocumentation_EN.html

Use this command to install the API jar file into your local Maven repository.

```bash
mvn install:install-file -Dfile=<path-to-file> -DgroupId=<group-id> -DartifactId=<artifact-id> -Dversion=<version> -Dpackaging=<packaging>
```

```bash
mvn install:install-file -Dfile= D:\uxbridge-module-api-1.2.4.1133.jar -DgroupId=com.espirit.moddev.uxbridge -DartifactId=uxbridge-module-api -Dversion=1.2.4.1133 -Dpackaging=jar
```

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

### Start UX-Bus on OS X/Linux

Source: https://docs.e-spirit.com/module/fos/FOS_Admin-Documentation_EN.html

Use this command to start the UX-Bus in standalone operation on OS X or Linux systems. Ensure you are in the 'bin' directory of the unzipped distribution.

```bash
./bin/activemq console
```

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

### Example FirstSpirit GraphQL API URL

Source: https://docs.e-spirit.com/module/caas-connect/CaaS_Connect_FSM_Documentation_EN.html

This is a complete example URL for accessing the FirstSpirit GraphQL API to query preview content. It includes the base URL, tenant ID, and project GID with a suffix.

```url
https://my-caas-dev.e-spirit.cloud/graphql/my-caas-dev/631e4786-0dc3-4db6-bad8-adaad685944a-preview-content
```

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

### Start TranslationStudio from Command Line (Linux)

Source: https://docs.e-spirit.com/cloud/translationstudio/TranslationStudio_Installation_Manual_EN.html

Use this command to start the TranslationStudio application from the command line on Linux systems. Ensure you run it from within the TranslationStudio Application folder. This can help diagnose startup issues when log files are incomplete.

```bash
java -cp .:./lib/*:translationstudio.jar -Xloggc:log/gc.log -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=log/crash.hprof -Djava.util.logging.config.file=conf/logging.properties -Dtranslationstudio_basedir== com.idmedia.translationstudio.ServiceMain console
```

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

### Initialize News Example Release Script Parameters

Source: https://docs.e-spirit.com/module/uxbridge/UX-Bridge_DeveloperDocumentation_EN.html

Initializes variables for the news release process and writes them to the session. Ensure all listed parameters are configured for the `uxb_news_example_release_init` script.

```plaintext
detail_page| pressreleasesdetails
query_uid| Products.pressdetailsfilter
single_query_uid| Products.pressdetailfilter
query_param| Id
schedule_name| UX-Bridge
scheduler_uxb_generate| UX-Bridge Generate
scheduler_generate| Generate
transition_name| Release
```

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

### GET /rest/api/v1/datagenerator/{type}/{name}/start

Source: https://docs.e-spirit.com/delivery_modules/smart_search/SmartSearch_Documentation_EN.html

Triggers the start of a specific Data Generator.

```APIDOC
## GET /rest/api/v1/datagenerator/{type}/{name}/start

### Description
Starts a Data Generator automatically. Useful for triggering crawl processes after generation.

### Method
GET

### Endpoint
https://localhost:8181/rest/api/v1/datagenerator/{type}/{name}/start

### Parameters
#### Path Parameters
- **type** (string) - Required - The type of the Data Generator (e.g., WEB).
- **name** (string) - Required - The name of the Data Generator.

### Response
#### Success Response (200)
- Status: OK

#### Error Response (409)
- Status: Conflict (Data Generator is already running)
```

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

### Building the add-on via command line

Source: https://docs.e-spirit.com/ecom/fsconnect-sap/FirstSpirit_Connect_SAP_Documentation_EN.html

Execute these commands in the platform directory to set the environment, install the add-on, and compile the system.

```bash
// 1.
. ./setantenv.sh

// 2.
ant addoninstall -Daddonnames="fscontentconnect"
-DaddonStorefront.yb2bacceleratorstorefront="yb2bacceleratorstorefront"

// 3.
ant clean all
```

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

### GET /rest/api/v1/datagenerator/external/{name}/status

Source: https://docs.e-spirit.com/delivery_modules/smart_search/SmartSearch_REST-API-Documentation_EN.html

Retrieves the current status of an external datagenerator. The status can be used to determine if a datagenerator can be started.

```APIDOC
## GET /rest/api/v1/datagenerator/external/{name}/status

### Description
Retrieves the current status of an external datagenerator. An external datagenerator may only be started if the current state is IDLE or ERROR; otherwise, the call to begin will return with PRECONDITION FAILED.

### Method
GET

### Endpoint
/rest/api/v1/datagenerator/external/{name}/status

### Parameters
#### Path Parameters
- **name** (string) - Required - The configured datagenerator name.

### Request Example
```
GET /rest/api/v1/datagenerator/external/xigtbewetb/status HTTP/1.1
Accept: text/plain
Authorization: Basic dXNlcjpwYXNzd29yZA==
Host: localhost:8181
```

### Response
#### Success Response (200)
- **status** (string) - The status of the datagenerator (e.g., CRAWLING, IDLE, ERROR).

#### Response Example
```
CRAWLING
```

#### Error Responses
- **404** - NOT FOUND: The datagenerator name does not exist.
- **415** - UNSUPPORTED MEDIA TYPE: Either the accept header is missing or not set to 'text/plain'.
```

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

### Log Message for UX-Bus Startup

Source: https://docs.e-spirit.com/module/fos/FOS_Admin-Documentation_EN.html

This is an example log message indicating that the ActiveMQ JMS Message Broker, which powers the UX-Bus, has successfully started.

```log
INFO ActiveMQ JMS Message Broker (ID:apple-s-Computer.local-51222-1140729837569-0:0) has started
```

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

### Verify SmartSearch Server Startup

Source: https://docs.e-spirit.com/delivery_modules/smart_search/SmartSearch_Admin-Manual_EN.html

Check the log file to confirm the server has successfully started before initiating subsequent instances.

```bash
less /opt/SmartSearch/logs/SmartSearch.log
(...) Started Server in 60 seconds (JVM running for 61.2)
```

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

### Prometheus Scrape Configuration Example

Source: https://docs.e-spirit.com/delivery_modules/smart_search/SmartSearch_Admin-Manual_EN.html

This YAML snippet shows how to configure Prometheus to scrape metrics from the SmartSearch endpoint. Ensure the `job_name` matches your setup.

```yaml
scrape_configs:
   - job_name: 'smart-search'
```

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

### Setup Connector Implementation

Source: https://docs.e-spirit.com/cloud/translationstudio/TranslationStudio_Tutorial_Connector_EN.html

Sets up the connector with essential parameters including TMS ID, configuration XML, working directory, and context. This method is called once during connector initialization.

```java
/**
 * Setup the connector
 *
 * @param sTmsId Tms Id
 * @param sConfigurationXml Connector Configuration (as provided by {@link com.idmedia.translationstudio.api.connector.gui.ITranslationMemorySystemConnectorConfigurationGui.getConnectorConfiguration}
 * @param sWorkingDirectory Connector Working Directory
 * @param pContext Connector Context
 * @return
 */
public boolean setup(String sTmsId, String sConfigurationXml, String sWorkingDirectory, IConnectorContext pContext);
```

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

### Get Translatable Files to Retry

Source: https://docs.e-spirit.com/cloud/translationstudio/TranslationStudio_Tutorial_Connector_EN.html

Provides a list of translatable files that could not be processed and should be retried. Returns an empty list as retry logic is not implemented in this example.

```java
/**
 * {@inheritDoc }
 */
@NotNull
@Override
public List<ITranslatableFile> getTranslatableFilesToRetry()
{
    return new ArrayList<>(0);
}
```

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

### Commit Datageneration Request

Source: https://docs.e-spirit.com/delivery_modules/smart_search/SmartSearch_REST-API-Documentation_DE.html

Example of a POST request to commit a datageneration. The optional body can include a 'message' for the commit. A 204 status code indicates the commit process was successfully started.

```http
POST /rest/api/v1/datagenerator/external/vlrqjvjhhn/commit HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Basic dXNlcjpwYXNzd29yZA==
Host: localhost:8181 Content-Length: 29
{
   "message" : "Commit DG"
}
```

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

### Example Actuator Endpoints Response

Source: https://docs.e-spirit.com/delivery_modules/smart_search/SmartSearch_Admin-Manual_EN.html

This JSON structure shows the available actuator endpoints and their URLs, typically accessed via a GET request to the /actuator endpoint. Basic authentication with an admin user is required.

```json
{
   "_links": {
      "self": {
         "href": "https://smart-search-server:8181/actuator",
         "templated": false
      },
      "auditevents": {
         "href": "https://smart-search-server:8181/actuator/auditevents",
         "templated": false
      },
      "beans": {
         "href": "https://smart-search-server:8181/actuator/beans",
         "templated": false
      },
      "health": {
         "href": "https://smart-search-server:8181/actuator/health",
         "templated": false
      },
      "conditions": {
         "href": "https://smart-search-server:8181/actuator/conditions",
         "templated": false
      },
      [...] 
      "mappings": {
         "href": "https://smart-search-server:8181/actuator/mappings",
         "templated": false
      }
   }
}
```

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

### Start Solr Service

Source: https://docs.e-spirit.com/delivery_modules/smart_search/SmartSearch_Migration-Guide_EN.html

Start the Solr service after completing the upgrade steps.

```bash
sudo systemctl start solr
```

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

### Check Server Startup Log

Source: https://docs.e-spirit.com/delivery_modules/smart_search/SmartSearch_Migration-Guide_EN.html

Expected log message indicating the server has started successfully.

```text
(...) Started Server in 60 seconds (JVM running for 61.2)
```

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

### Configure JVM Heap Size Parameters

Source: https://docs.e-spirit.com/cloud/translationstudio/TranslationStudio_Installation_Manual_EN.html

Standard JVM startup parameters for defining initial and maximum heap sizes.

```text
-XX:InitialHeapSize=value
-XX:MaxHeapSize=value
```

```text
-XX:InitialHeapSize=197212416 -XX:MaxHeapSize=3155398656
```

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

### etracker Tracking Code Example

Source: https://docs.e-spirit.com/module/webcontrolling/WebControlling_Documentation_EN.html

Example snippet of the etracker tracking code header.

```html
<!-- Copyright (c) 2000-2018 etracker GmbH. All rights reserved. -->
```

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

### Export Store Root Nodes Example

Source: https://docs.e-spirit.com/cloud/developer-cloud-documentation/Cloud_Development_Handover_DE.html

Demonstrates exporting store root nodes like the templatestore.

```bash
templatestore
```

```bash
root:templatestore
```

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

### Jetty SSL Debug Output Example

Source: https://docs.e-spirit.com/delivery_modules/smart_search/SmartSearch_Admin-Manual_EN.html

Sample log output showing selected protocols and ciphers during startup.

```text
May 22 11:14:50 smart-search-cluster-1 server.jar[1208]: 2017-05-22 11:14:50.621 DEBUG 1230 --- [ main] o.e.jetty.util.ssl.SslContextFactory : Selected Protocols [TLSv1, TLSv1.1, TLSv1.2] of [SSLv2Hello, SSLv3, TLSv1, TLSv1.1, TLSv1.2]
May 22 11:14:50 smart-search-cluster-1 server.jar[1208]: 2017-05-22 11:14:50.622 DEBUG 1230 --- [ main] o.e.jetty.util.ssl.SslContextFactory : Selected Ciphers [TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, [...]
May 22 11:14:50 smart-search-cluster-1 server.jar[1208]: A, SSL_DH_anon_WITH_DES_CBC_SHA, [...]
```

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

### Render Start Node with Language Parameter

Source: https://docs.e-spirit.com/tpp/releasenotes/index.html.en

Specify the rendering language for the start node operation.

```javascript
TPP_API.Operation.renderStartNode
```

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

### Initialize FirstSpirit Preview

Source: https://docs.e-spirit.com/tpp/snap/index.html

Logs the availability status of the FirstSpirit Preview after internal initialization. Use this to confirm the preview is ready.

```javascript
TPP_SNAP.onInit(async (success) => console.log(`FirstSpirit Preview is ${success ? 'now' : 'NOT'} available!`))
```

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

### Unpack Solr Installation Script

Source: https://docs.e-spirit.com/delivery_modules/smart_search/SmartSearch_Migration-Guide_EN.html

Extracts the Solr service installation script from the downloaded archive.

```bash
tar xzf solr-7.7.3.tgz solr-7.7.3/bin/install_solr_service.sh --strip-components=2
```

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

### Example Supplementary Message

Source: https://docs.e-spirit.com/module/fos/FOS_Developer-Documentation_EN.html

A complete example of a FirstSpirit XML message including attribute and media lists.

```xml
<supplementary>
 <attributes>
  <PageFolder uid="umsetzungmitfirstspirit">
   <portlettype>WIDGET</portlettype>
  </PageFolder>
  <Page uid="firstspirit">
   <pageportletname>Blog</pageportletname>
  </Page>
 </attributes>
 <medialist>
  <Media uid="connector_cable" originType="PageRefFolder" origin="firstspirit"/>
 </medialist>
</supplementary>
```

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

### Start a Data Generator

Source: https://docs.e-spirit.com/delivery_modules/smart_search/SmartSearch_Documentation_EN.html

Trigger a data generator start using its type and name. Requires basic authentication.

```bash
curl -X GET 'https://localhost:8181/rest/api/v1/datagenerator/WEB/mithras/start' -H 'Authorization: Basic YWRtaW5AbG9jYWxob3N0Lsdf5Re'
```

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

### Example Pod Status Output

Source: https://docs.e-spirit.com/module/caas-platform/CaaS_Platform_Operations_Guide_EN.html

Sample output showing the expected running status of CaaS components.

```text
NAME                                 READY     STATUS        RESTARTS   AGE
caas-mongo-0                         2/2       Running       0          4m
caas-mongo-1                         2/2       Running       0          3m
caas-mongo-2                         2/2       Running       0          1m
caas-rest-api-1851714254-13cvn       1/1       Running       0          5m
caas-rest-api-1851714254-13cvn       1/1       Running       0          4m
caas-rest-api-1851714254-xs6c0       1/1       Running       0          4m
```

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

### Export Elements by Path Example

Source: https://docs.e-spirit.com/cloud/developer-cloud-documentation/Cloud_Development_Handover_DE.html

Demonstrates exporting elements by specifying their path within the FirstSpirit store.

```bash
path:/<STORE>/<UID>|<NAME>
```

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

### Autocomplete response examples

Source: https://docs.e-spirit.com/delivery_modules/smart_search/SmartSearch_Documentation_EN.html

Example JSON responses returned by the autocomplete function based on user input prefixes.

```json
[
   "sold",
   "solar energy",
   "solar spectrum"
]
```

```json
[
   "solar energy",
   "solar spectrum"
]
```

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

### Example Stored XML Structure

Source: https://docs.e-spirit.com/cloud/translationstudio/TranslationStudio_Tutorial_Component_EN.html

This is an example of how processed XML is stored with a 'txt' parent node and a 'type' attribute.

```xml
<txt type="myidentifier">
    <mycomponents-root-node any="attribute">
        <label>
            <TEXT>translatable text</TEXT>
        <label>
        <property name="some_property">
            <value>
                <TEXT>translatable text</TEXT>
            </value>
        </property>
    </mycomponents-root-node>
</txt>
```

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

### Initialize SmartSearch

Source: https://docs.e-spirit.com/module/smartsearch.js/smartsearchjs_Developer-Documentation_DE.html

Connect to a SmartSearch instance hosted in the cloud or on a custom backend.

```javascript
// Connect to SmartSearch hosted in the e-spirit cloud
const host = "https://your.e-spirit.cloud.url";
const preparedSearch = "My_Prepared_Search";

const fsss = new SmartSearch(host, preparedSearch);
```

```javascript
// Connect to SmartSearch hosted by you
const host = "https://my.smartsearch.backend";
const preparedSearch = "My_Prepared_Search";

const SmartSearchOptions = {
    endpoint: "/rest/api/v1/prepared_search"
};

const fsss = new SmartSearch(host, preparedSearch, SmartSearchOptions)
```

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

### Initialize Connector Configuration

Source: https://docs.e-spirit.com/cloud/translationstudio/TranslationStudio_Tutorial_Connector_DE.html

Implementation of onInit to capture configuration data and communicator instance.

```java
**/**
 * {@inheritDoc }
 */**
_@Override_
**public** **void** onInit(String sId, String sConfiguration, List<IProjectJobConfigurtion> vsAvailableConfigurations, IExchangeCommunicator pCommunicator)
{
    m_sXmlGui = sConfiguration == **null** ? "" : sConfiguration;

    **if** (vsAvailableConfigurations != **null**)
        m_vpJobs.addAll(vsAvailableConfigurations);

    m_pCommunicator = pCommunicator;
}
```

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

### Build and Run Adapters

Source: https://docs.e-spirit.com/module/uxbridge/UX-Bridge_DeveloperDocumentation_EN.html

Commands to package the application or run it directly using the Tomcat 7 plugin.

```bash
mvn package
```

```bash
mvn tomcat7:run
```
Tokens:
Raw