<
FirstSpirit Cloud, First steps
Documentation

First steps with FirstSpirit Cloud


Getting started

Welcome to FirstSpirit Cloud, our Software as a Service (SaaS) environment. This document guides you through the first steps with FirstSpirit.

Sign up

During the provisioning process, we create initial users with user-manager rights for you. Moving forward, you will be able to independently create and manage new users (see User Management). For technical issues, reach out to our Customer Support.

For more information see Our support services.

User management

FirstSpirit Cloud utilizes Keycloak to manage users, an open-source solution from the Red Hat company, for handling digital identities and permissions.

You can create and manage accounts through the Keycloak interface within FirstSpirit Cloud. To engage in user management, a user with the role user-manager is required. If you would like to manage your users independently, please let us know.

For more information see Cloud User Management.

Sign in

How to activate your account:

  • Open the URL https://accounts.e-spirit.cloud/.
  • Enter your email address (all lowercase), which represents your FirstSpirit user name (e.g myemailaddress@crownpeak.com).
    → You will receive an email to set your password.

Make sure to check your spam folder, just in case the confirmation email got delivered there instead of your inbox.

  • Set your password and make sure that no German Umlaut is used.

After changing the password no further email will be sent!

Help @ Crownpeak

If you encounter any technical issues, please contact our Customer Support Team via our Support Portal by creating a ticket. This portal allows you to checl and track the status of your tickets.

For more information see Our support services.

Your FirstSpirit environments

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. All content that is published is saved here.

New projects

To create a new project, open a Customer Support ticket with the following information:

  • Project name (defined by you; e.g. myProject)
  • In which environment the project is to be created (Dev/QA/Prod)
  • Which roles/user shall have access to this project

For more information see Roles & permissions.

Module development

To develop custom modules for your FirstSpirit project, you will require a module development pipeline. To request the creation of such a pipeline, create a ticket with our Customer Support. Ensure that you provide the following information:

  • Build tool (Gradle by default; ask for Maven if required)
  • Meaningful repository name (e.g. "CRM-Integration” or “PIM Report")

For more information see Developing Modules in the Cloud.

System URLs

Below you find the most important URLs for your FirstSpirit Cloud environment.

FirstSpirit landing page & stages

Access your FirstSpirit environments using the 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

Developer URLs

Build-Pipeline & Logging

Logging GUI

https://<customer>-logging.e-spirit.hosting

Git-Repository

https://git.e-spirit.hosting

You need to login to Bitbucket with your technical customer name.

Bamboo

https://ci.e-spirit.hosting

Artifactory

https://artifactory.e-spirit.hosting

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

CloudFront URLs & configuration (S3 deployment)

The following is only relevant if you have purchased hosting as a services.
Development (Dev)

Target Platform S3 Bucket

<customer>dev.e-spirit.cloud

Base URL

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

CloudFront Distribution ID

<CloudFront Distributions ID Dev>

Quality Assurance (QA)

Target Platform S3 Bucket

<customer>qa.e-spirit.cloud

Base URL

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

CloudFront Distribution ID

<CloudFront Distributions ID QA>

Production (Prod)

Target Platform S3 Bucket

<customer>prod.e-spirit.cloud

Base URL

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

CloudFront Distribution ID

<CloudFront Distributions ID Prod>


Roles & permissions

Default groups

The following is a list of default groups. This is best practice advice and can be used or extended according to individual needs.

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: can transfer templates (Page Templates, Section Templates, etc.) from one stage to another.

Groups for stages

Users must be added to a group to be able to access stages:

  • <customer>-users-dev
  • <customer>-users-qa
  • <customer>-users-prod

For more information see Template Distribution.

Delivery strategy

Presently 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 employed for the pull strategy and embedded in its own applications (utilizing a hybrid approach).

For further information see CDN Documentation.

Caas Connect

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

Content as a Service (hereafter referred to as CaaS) provides companies with the agility necessary for their customer communication. It facilitates the provision of content fragments, using an interface for their retrieval. This ensures that data can be reused indefinitely without requiring any additional implementation effort. Publishing to a targeted channel is no longer necessary. In accordance with the best-of-breed philosophy, the design and composition of presented content are completely detached from FirstSpirit. This approach enhances independence, flexibility, and speed in project implementation.

CaaS consists of the CaaS Platform providing a service (API) reachable from the internet for retrieval and a module (CaaS Connect) running on the FirstSpirit Server that automatically syncs editorial data to the CaaS platform.

CaaS URLs

To retrieve data for a specific project, refer to the module configuration for the corresponding CaaS URLs.

CaaS API Keys

To use CaaS, API keys are required for authorization. The API keys below provide read and write access for all CaaS projects of your Dev/QA/Prod environment. They can also be used to create additional API keys.

Additional project specific API keys will be created once you add the CaaS Connect Project App to the project. The responsible project administrator has access to these keys via the CaaS Connect Project UI in the ServerManager. Use only these API keys to access the API for querying or writing data from custom applications.

API keys should not be disclosed! If an API key is leaked make sure to create a new API key and remove the old key. To minimize the impact of breaches, use project specific API keys without write access, if appropriate.

Frontend library and demo PWA

We strongly recommend the use of our JavaScript Content API Library, which is an interface handling data coming from the FirstSpirit CaaS and the Navigation Service which facilitates application development using CaaS. The library is available on GitHub. There you will also find an example PWA that we provide to demonstrate how to use this library.


Navigation Service

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

Navigation Service offers a solution for the headless world by seamlessly integrating a dynamic mapping between a navigation route and the corresponding content behind it. To access the Navigation Service, use the URLs provided in the UI of the Navigation Service Module (see Navigation Service: Module Documentation).

The CaaS Frontend Library includes means to communicate with the Navigation Service. This is demonstrated in the example PWA.

For further information see Navigation Service.

SmartSearch URLs & credentials

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

Development (Dev) & Quality Assurance (QA)

Launch-Pad

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

Cockpit

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

API-GW

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

User

<smartSearchUsername>

Password

<smartSearchPassword>

Production (Prod)

Launch-Pad

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

Cockpit

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

API-GW

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

User

<smartSearchUsername>

Password

<smartSearchPassword>


Digital Quality Management (DQM)

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

Crownpeak Digital Quality Management (DQM) is a unified solution to manage digital policies and standards across your entire web presence. Using DQM, organizations can improve accessibility compliance, SEO, brand equity, and the overall user experience of their websites (see Product Overview for full details).

As a SaaS platform, DQM scans a website and analyzes the content and code used on the website for quality issues. Users can access the Crownpeak DQM platform to see the results of this analysis and make the necessary corrections to improve their websites across a wide range of quality criteria.


TranslationStudio

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

TranslationStudio represents the next level of translation management. TranslationStudio, powered by AI, offers out-of-the-box TMS (Translation Memory System) connectors such as Across, memoQ, and many more.

As described in the TranslationStudio documentation, it is possible to configure a mail server to receive notifications, such as error messages and more. Note that this functionality is not activated by default. If you wish to enable this functionality, create a ticket with our Customer Support. Alternatively, if you prefer to use your own mail server, provide the required information as specified in the documentation in your support ticket.

For more information see TranslationStudio.

Formcentric Webforms

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

Formcentric Webforms (formerly Monday) form management allows you to create a unique customer experience in almost no time and build a meaningful digital connection with your customer. This allows you to expand your web presence with professional HTML forms that perfectly fit your overall design. The form manager helps you create forms quickly and easily in an editorial interface that you are already familiar with.

You can find editorial user manuals and technical information here.


Connect for Commerce

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

Connect for Commerce is a module that allows FirstSpirit to be connected to any e-commerce system. To facilitate a smooth beginning to your experience with Connect for Commerce, we provide a reference project.

For more information see Connect for Commerce API.
The reference project is optimized for use with Omnichannel Manager and CaaS Connect, meaning the project does not deliver a preview without the appropriate development work.

If you would like a demo project to test FirstSpirit, contact our Customer Support.


FirstSpirit Cloud documentation

For more information about module development, Build-Pipeline, deployment, etc. have a look at FirstSpirit Cloud Documentation.


Patch day & maintenance

Every four weeks, a scheduled patch day involves downtime for the maintenance and installation of new software updates in your FirstSpirit Cloud Environment. The downtime is scheduled to deploy updates. For further information see the schedule information below:

  • All users are informed of scheduled down times at least seven days in advance via email.
  • All users are informed once the Patch Day installation is complete.
  • Urgent security patches will be rolled out immediately and can fall outside of the Patch Day schedule.
  • For e-commerce customers, there will not be any Patch Days or scheduled downtimes close to Black Friday and Cyber Monday.
  • There are no Patch Days or scheduled downtimes in December.

Downtime calendar

FirstSpirit Cloud Instance Date
Productionsee FirstSpirit Cloud Maintenance Window Schedule
Development | Quality Assurancesee FirstSpirit Cloud Maintenance Window Schedule

Timezone Time
CET Central European Time
Berlin, Rome, Amsterdam
7 am to 9 am

Training

Crownpeak offers a range of training programs for your team, from developers to project managers and editors. We offer standardized and customized training options depending on your individual needs. You can register online for our Product Training.

For further information contact training@crownpeak.com.

Product Office Hours

Our interactive online Product Office Hours take place every 2 months and offer exciting insights into a variety of topics. These can include live demos and presentations of new features and releases, Q&A sessions with the product management team, insights into the world of Crownpeak, industry news, customer success stories, and much more! You will receive an email invitation before each event.

For additional information, check our Community page.

Our support services

Create a ticket via our Support Portak

Sign up to the Support Portal where you can create and track your support tickets.

Customer Support availability

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

High availability - 24/7 support

Depending on your software maintenance agreement level, our 24/7 support may be accessible to you.

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 see Priorities & Service Categories.

Customer Success Management

Your Success Management Team…​

  • is your first and main point of contact moving forward.
  • is your advisor for all questions about FirstSpirit, such as new features, roadmaps, feedback, etc.
  • will contact you regularly and proactively during and after on-boarding.
  • is interested in understanding your business and therefore coordinates regular calls with you.
  • is your internal advocate to address your feedback, requests, and goals within Crownpeak.
  • is financially and contractually responsible and is thus your contact for questions on these topics.
  • will ensure that you receive the tools and support needed to achieve your goals!
  • While your Success Management Team will contact you proactively, our Customer Support will most likely react to your request. However, both teams will provide you with useful and reliable support.

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

Our Team is always at your disposal.

We wish you much success with FirstSpirit Cloud!