1. Get Started

Welcome to FirstSpirit Cloud - our Software as a Service (SaaS) environment. This document will guide you through the first steps, which are necessary to use FirstSpirit.

1.1. Sign up/User management

New accounts are created and managed by our Technical Support Team. To get access please create a ticket via Jira Service Desk or send an email to help@e-spirit.com.

For more information please have a look at Help @ e-Spirit.

1.2. Sign in

After your account is created, you will get an email to activate your account first.

How to activate your account:

  • Please open the URL https://accounts.e-spirit.cloud/

    pw self service
    Figure 1. Password Self Service
  • Please enter your email address, which represents your FirstSpirit user name (e.g myEmailAdress@e-spirit.com)

  • Afterwards you will receive an email to set your password
    Please check your spam folder, just in case the confirmation email got delivered there instead of your inbox.

  • Please set your password and make sure that no German Umlaut is used
    After changing the password no further email will be sent!

1.3. Help @ e-Spirit

If you have any technical issues, please contact our Technical Support. There are two ways to create a ticket:

Create a Ticket via eMail

Please contact our Technical Support via email to help@e-spirit.com.

Create a Ticket via Jira Service Desk/Sign up

Alternatively you can sign up to the Jira Service Desk where you can also create a ticket. Here you can additionally track and check the status of your requests/tickets.

For more information please have a look at Our Support Services.

1.4. Your FirstSpirit Environment

Your FirstSpirit Cloud includes three environments, which are described below.

Development (DEV)

This is the area for Developers.

Quality Assurance (QA)

This environment (also called staging or testing area) is a nearly exact replica of the production environment for testing and to ensure quality before transfer to the Production Environment.

Production (PROD)

This is the area for creating and editing your content. Every content which is deployed/published is saved here.

1.5. New Projects

New projects are created by our Technical Support. If new projects are required, please create a ticket.

Following information are needed:

  • Project name (defined by you; e.g myProject)

  • On which stage the project is needed (DEV/QA/PROD)

  • Which roles/user shall have access to this project

For more information please have a look at Roles & Permissions.

2. System URLs

Below you will find the most important URLs for your Cloud Environment.

2.1. FirstSpirit Landingpage/Stages

Your FirstSpirit stages are reachable via following URLs:

  • Development (DEV)
    https://<customer>dev.e-spirit.hosting

  • Quality Assurance (QA)
    https://<customer>qa.e-spirit.hosting

  • Production (PROD)
    https://<customer>.e-spirit.hosting

2.2. Developer URLs

2.2.1. Build-Pipeline / Logging

There is no web interface for Artifactory; the URL appears here only for completeness. The URL can still be relevant for module development.

2.2.2. CloudFront URLs/Configuration (S3 Deployment)

Development (DEV)

Table 1. Development URLs

Target Platform S3 Bucket

<customer>dev.e-spirit.cloud

Base URL

https://<customer>dev.e-spirit.cloud/

Distribution ID

<CloudFront Distributions ID DEV>

Quality Assurance (QA)

Table 2. QA URLs

Target Platform S3 Bucket

<customer>qa.e-spirit.cloud

Base URL

https://<customer>qa.e-spirit.cloud/

Distribution ID

<CloudFront Distributions ID QA>

Production (PROD)

Table 3. Production URLs

Target Platform S3 Bucket

<customer>prod.e-spirit.cloud

Base URL

https://<customer>prod.e-spirit.cloud/

Distribution ID

<CloudFront Distributions ID PROD>

3. Roles and Permissions

3.1. Default groups

This is a list of default groups. These are best practise advice and can be used or extended individually.

Editorial Groups

Editor can manage, edit and request content for release
Chief-Editor can manage, edit and release content for publishing

Administrators

Project-Admin has full control at project level

Developer Groups

GIT User has access to Bitbucket & Bamboo
Template Distribution User is able to transfer templates (Page Templates, Section Templates, etc.) from one stage to another

3.2. Create or change user accounts

New or existing user accounts are managed by our Technical Support. For new accounts or for changes on existing accounts, please create a ticket which should contain the following information

  • First name

  • Last name

  • email address

  • Role (e.g. chief-editor)

  • Stage (Development, Quality Assurance, Production)

  • Additional Role (in case of existing accounts)

  • Role to remove (in case of existing accounts)

New user accounts or changes to existing accounts can be requested by <customer-name> or with the approval of <customer-name> only.

4. Delivery strategy

Currently the content can be published (via push strategy) in the S3 bucket from AWS. Files such as HTML, CSS, JavaScript and media, i.e. everything without server-side-logic, can be stored here. The Content as a Service can be used for the pull strategy and embedded in its own (hybrid approach) applications.

For further information please have a look at CDN.

5. CaaS Connect (Content as a Service)

This service is usage-based. A valid CaaS license is required

The Content as a Service (hereafter referred to as CaaS) is the component that runs on the FirstSpirit server. It enables the compilation and dispatch of information to the CaaS platform. The information concerns all new, changed or deleted editorial content of the used FirstSpirit project.

CaaS offers companies the agility necessary for this customer communication. It enables the provision of content fragments and has an interface for their retrieval. Without any additional implementation effort, data can thus be reused indefinitely. Publishing to a targeted channel is no longer necessary. In accordance with the best-of-breed philosophy, the design and composition of the presented contents are thus completely detached from FirstSpirit. This increases independence, flexibility and speed in project implementation.

For further information please have a look at Content as a Service.

5.1. CaaS URLs

Below you’ll find the CaaS URLs.
The URL for Preview and Live is the same

  • Development (DEV)
    https://<customer>-dev-caas-api.e-spirit.cloud

  • Quality Assurance (QA)
    https://<customer>-qa-caas-api.e-spirit.cloud

  • Production (PROD)
    https://<customer>-caas-api.e-spirit.cloud

5.2. CaaS API Keys

To use CaaS, you need credentials to authorize.

Development (DEV)

Live <CaaS-DEV-LIVE>
Preview <CaaS-DEV-PREVIEW>

Quality Assurance (QA)

Live <CaaS-QA-LIVE>
Preview <CaaS-QA-PREVIEW>

Production (PROD)

Live <CaaS-PROD-LIVE>
Preview <CaaS-PROD-PREVIEW>

This service is usage-based. A valid CaaS license is required.

FirstSpirit provides its own template-based navigation function for statically generated pages. In the modern headless world, a different solution is needed, one that seamlessly integrates a dynamic mapping between a navigation route and the corresponding content behind it.

For further information please have a look at Navigation Service.

  • Development (DEV)
    https://<customer>-dev-navigationservice.e-spirit.cloud

  • Quality Assurance (QA)
    https://<customer>-qa-navigationservice.e-spirit.cloud

  • Production (PROD)
    https://<customer>-prod-navigationservice.e-spirit.cloud

7. SmartSearch

This service is usage-based. A valid license is required.

7.1. SmartSearch URLs/Credentials

Development (DEV)

Table 4. Development URLs

Cockpit

https://<customer>-dev-search.e-spirit.cloud/login.html

API-GW

https://<customer>-dev-search-api.e-spirit.cloud/

User

Password

Production (PROD)

Table 5. Production URLs

Cockpit

https://<customer>-search.e-spirit.cloud/login.html

API-GW

https://<customer>-search-api.e-spirit.cloud/

User

Password

8. Intelligent Content Engine (ICE)

This service is usage-based. A valid license is required.

The Intelligent Content Engine module provides FirstSpirit with numerous functions that allow editors to represent even the most complex use cases relating to A/B testing, real-time targeting, and personalization. Despite the complexity, you can take full advantage of the benefits of FirstSpirit via the cloud-based implementation, even at times of unpredictable load peaks: The Intelligent Content Engine does not place additional strain on your current hardware. Simple things remain simple and complex things become possible. Thanks to the integration into FirstSpirit, the highly dynamic system remains very easy to manage - even without in-depth knowledge of the system.

For further information please have a look at FirstSpirit ICE.

9. TranslationStudio

This service is usage-based. A valid license is required.

The next level of translation management. TranslationStudio is AI-based and also offers out-of-the-box TMS connectors such as Across, memoQ and many more.

For more information please have a look at TranslationStudio.

10. Content Delivery Network (CDN)

This service is usage-based. A valid license is required.

10.1. General

For Content Delivery Network (hereafter referred to as CDN) and website hosting you can use your own domain. For this we need the SSL certificate for the domain. Please send us your certificate via email to help@e-spirit.com.

On the customer side a custom CNAME has to be added with the CDN URL. The URL is usually https://<customer>.e-spirit.cloud.

A separate CDN URL is required for each TLD (TopLevelDomain). It is important to choose the best project architecture at the very beginning. In case of international and multilingual sites, the following best practice is recommended: <COUNTRY> / <LANGUAGE> / Content.

In this way, the TLDs can be set up as root for the respective country.

The FirstSpirit Cloud CDN includes further options like:

  • Deployments of FirstSpirit Cloud systems into an S3 Bucket (via module aws-services-s3)

  • Delivery of a S3 deployment for setting up error pages

  • Cache invalidation (also via module aws-services-s3)
    extension by forwarding of requests from wildcard (/*) to /index.html

  • Securing deployments via Basic Auth

  • Custom redirects (in combination with module aws-services-url redirect)

  • Media Delivery for CaaS Content

10.2. Error pages

Currently the FirstSpirit Cloud CDN supports the following error pages (S3 Bucket) only. Error pages can be configured/entered in FirstSpirit.

  • HTTP 403 /error-pages/403.html

  • HTTP 404 /error-pages/404.html

10.3. Redirects

For various reasons it can be useful to set up redirects. However, since these cannot be taken into account via the CDN caching, but are mirrored via the FirstSpirit content, it is necessary to use the module aws-services-url redirect.

The following redirects are currently supported:

  • HTTP 301 Moved Permanently

  • HTTP 302 Found (Moved Temporarily)

Redirects can be configured/entered in FirstSpirit.

11. Downtime for maintenance

Every month there is a scheduled down time for the maintenance and installation of a new software update for your FirstSpirit Cloud Environment. The down time is scheduled to deploy the updates between 6 am and 8 am UTC.

  • All users will get informed of any down time via email at least seven days upfront.

  • Urgent Security Patches can be rolled-out immediately and regardless of the patchday.

  • There are no Patch Days or Down Times in December.

Down time/schedule information

Table 6. Schedule information
FirstSpirit™ Cloud instance Date

Production

Last Wednesday of the month

Development |Quality Assurance

Second to last Wednesday of the month

Table 7. Timezones
Timezone Time

UTC Coordinated Universal Time

6 am to 8 am

CET Central European Time
Berlin, Rome, Amsterdam

7 am to 9 am

CEST Central European Summer Time
Berlin, Rome, Amsterdam

8 am to 10 am

12. ContentConnect Integrations

FirstSpirit offers the possibility to integrate 3rd-party applications. The following subchapters describe three of the most frequently used online services and provide further information about them.

12.1. ContentConnect for Salesforce

ContentConnect for Salesforce Commerce Cloud integrates Cloud-based e-commerce technology into FirstSpirit, thus enabling editors to combine product information with editorial content. Using the proven FirstSpirit user interface, editors can access product data, create customized content and preview the final web page before it is published.

For further information please have a look at ContentConnect for Salesforce.

12.2. FirstSpirit Connect for SAP Commerce Cloud

ContentConnect for SAP Commerce Cloud permits convenient searches from within the FirstSpirit editing interface for products in the external product information management (PIM) systems. Currently, the ContentConnect for SAP Commerce Cloud module is designed for the hybris solution, but the generic approach of the module also allows the project-specific connection to other e-commerce and PIM systems.

For further information please have a look at FirstSpirit Connect for SAP Commerce Cloud.

12.3. ContentConnect for Spryker Commerce OS

ContentConnect for Spryker allows editors to combine product information with editorial content and deliver it via Spryker. This allows product data to be accessed directly via the FirstSpirit user interface and enables the integration for the editor to individually design all content. The website can be checked via a preview function, before publication.

For further information please have a look at ContentConnect for Spryker Commerce OS.

13. Our Support Services

13.1. Technical Support - Availability

Our Technical Support is available from Monday to Friday (except on federal holidays), between 9.00 am and 6.00 pm.

13.2. High Availability - 24/7 Support

Our 24/7 Support may apply if you agreed on this in your software maintenance agreement.

13.3. Priority

When submitting a support request you are able to assign a priority. This priority is to be in accordance with the service categories. The priority you choose will be checked for reasonability by the Technical Support and may be changed. If you do not assign a priority we automatically assume an average priority.

For more information please have a look at Priorities & Service Categories.

14. Customer Success Management

Your Success Management Team…​

  • is your first & main point of contact moving forward from the very beginning

  • is your advisor for all questions about FirstSpirit new Features, Roadmaps, Feedback…​

  • will contact you in a proactive & regular manner during & after On-Boarding

  • will ensure that you’re receiving the tools & support needed to achieve your goals

What you also need to know is:

  • Our service is an inclusive service and offered to our Cloud Customers only.

  • While your Success Management Team will contact you proactively, our Technical Support will most likely react on your request. However, both teams will provide you with useful and reliable support.

If you have additional feedback or any questions, please feel free to contact us at csm@e-spirit.com.

Our Team is always at your disposal.

We wish you much success with FirstSpirit Cloud.

General Cloud Documentation is a product of e-Spirit AG, Dortmund, Germany.
Only a license agreed upon with e-Spirit AG is valid for using the module.

16. Help

The Technical Support of the e-Spirit AG provides expert technical support covering any topic related to the FirstSpirit™ product. You can get and find more help concerning relevant topics in our community.

17. Disclaimer

This document is provided for information purposes only. e-Spirit may change the contents hereof without notice. This document is not warranted to be error-free, nor subject to any other warranties or conditions, whether expressed orally or implied in law, including implied warranties and conditions of merchantability or fitness for a particular purpose. e-Spirit specifically disclaims any liability with respect to this document and no contractual obligations are formed either directly or indirectly by this document. The technologies, functionality, services, and processes described herein are subject to change without notice.