Introduction
Intershop 7 (since IS 7.4 CI) is delivered with tools that can be used to build, assemble, upgrade, downgrade, deploy and undeploy software components.
The present document is intended as a quick start guide for consultants and developers for a quick project setup. The procedures described are based on Intershop 7.9 and 7.10 in combination with Intershop Gradle Tools 2.11.x.
Note
The activities described in this document are intended to give a rough overview of the setup steps. The document helps to get a first impression of the functionalities of the Intershop platform and the "look and feel" when developing applications.
Be aware that this quick guide neither describes the quickest solution for many developers, nor do the approaches mentioned here meet the requirements of a full-scale project setup.
To set up a development environment, please follow the Cookbook - Setup CI Infrastructure guide instead, which focuses on creating a reusable infrastructure for multiple developers.
For more detailed information on how to create a complete CI Infrastructure, please refer to Cookbook - Setup CI Infrastructure.
For more detailed information on deploying Intershop 7 instances, please refer to Cookbook - Deployment Tools ICM 7.9.
Glossary
| Term | Description |
|---|---|
| Nexus | Sonatype Nexus - an artifact repository server |
| Gradle | A build automation tool that builds upon the concepts of Apache Ant and Apache Maven |
References
- Cookbook - Deployment Tools ICM 7.9 - The Cookbook describes how to use the component-oriented deployment for Intershop Commerce Management 7.9 based on Gradle 2.11.
- Concept - Gradle Deployment Tools - This Concept describes how to use the component-oriented deployment based on Gradle. This includes the deployment of Intershop 7 and all custom solutions that are created with the Gradle-based build and assembly process.
- Concept - Continuous Delivery Tools (valid to 7.10) - Intershop 7 (since IS 7.4 CI) is delivered with tools that can be used to build, assemble, upgrade, downgrade, deploy and undeploy software components. These tools are designed to implement very flexible continuous delivery processes. This document targets developers and administrators who want to get an overview of the entire tool chain. It introduces the high level concept of these particular phases of the overall continuous software delivery process.
- Cookbook - Setup CI Infrastructure - This Cookbook describes in full detail how to create the required CI infrastructure. This document provides detailed examples based on Jenkins as CI server and Subversion for version control. In addition, the Cookbook describes how to set up the required users and permissions.
- Overview - System Requirements - This document lists all System Requirements for Intershop Commerce Suite version 7.9.
- Reference - CI Dependencies of Intershop Commerce Management - This document describes the connection between Intershop Commerce Management (ICM) releases and their according Intershop Gradle Tools releases.
Preconditions
- Accessible database scheme
- Installed Oracle database client
- Installed 64-bit Oracle JDK 1.8 or higher and an environment variable
JAVA_HOMEpointing to this JDK installation - Installed Java Cryptography Extension (JCE) Unlimited Strength in the JDK
- ojdbc7.jar file
- ucp.jar file
- ons.jar file
- Valid Intershop contract (Contract ID) and license.xml
- A Deployment User for deployment and application start (must be the same)
Version Control
The present document does not mention any version control system. Nevertheless you should be aware of the advantages of version control systems.
The Cookbook - Setup CI Infrastructure outlines how to use Apache Subversion to achieve this.
Automation with CI Server
A CI server is perhaps not absolutely necessary to perform the tasks for your setup. However, build automation, automated deployment and self-testing builds are essential for a continuous integration strategy.
The more detailed Cookbook - Setup CI Infrastructure illustrates how to use Jenkins to achieve this.
User and Access Rights
This Quick Guide does not describe any user management neither for the artifact repository server nor for the version control system nor for a CI server.
Note
Make sure to apply restricted user credentials, particularly when it is intended to make one of the above mentioned systems or the repository server itself available on the internet.
Please refer to the documentation of the according system to get more information on how to do that.
Install Nexus
- Download Sonatype Nexus.
- Install Sonatype Nexus. See Getting Started on the Sonatype Support website for more information.
Configure Nexus
Once Nexus is installed properly, the repositories have to be configured.
See Configure Artifact Repository Server.
Provide License
Plan the distribution of the license file, e.g., create a folder:
| Linux | /opt/intershop/license |
|---|---|
| Windows | C:\intershop\license |
The deployment user should have read-access to this location, because the path of the license file must be specified later in the environment.properties file. The license.xml file itself is copied to $IS_SHARE/system/license during deployment.
Note
Create Sources for CI Setup
Get the Intershop Template
Download the latest version of the bootstrap package for the CI setup via your browser.
Note
It is also possible to create an own clone of the Git repository, see https://github.com/IntershopCommunicationsAG/intershop-cisetup-template.git.
- Unzip the contents or clone the Git repository to a directory of your choice, e.g., ProjectHome.
Edit build.gradle file of the Intershop CI-Setup Template
For more detailed information see
- Create Sources From Intershop Templates
- GitHub IntershopCommunicationsAG/intershop-cisetup-template
- GitHub IntershopCommunicationsAG/intershop-cisetup-plugin
Execute the Intershop CI Setup Source Creation
- Ensure you have installed a valid JDK and set
Java_Homecorrectly. - As Deployment User, open a command line from <ProjectHome>/intershop-cisetup-template-master/ .
Execute:
./gradlew intershopCISetupAll
This initially creates all directories and files needed for your setup.
Create the Corporate Artifacts
This section only provides shortened working steps. For more detailed information please refer to the recipe Setup CI Build for Corporate Artifacts in the Cookbook - Setup CI Infrastructure.
- As Deployment User: Go to <ProjectHome>/devops/gradle/corporate-distribution.
Open a command line and execute:
gradlew publish -PrepoUserName=<deployment user> -PrepoUserPasswd=<deployment user password> -PreleaseURL=<URL for release publishing>
- Copy Oracle jdbc7.jar, ons.jar and ucp.jar to <ProjectHome>/projects/oracleDriver/3rd_oracle/build/oracleLibs/jars .
Go to <ProjectHome>/projects/oracleDriver/3rd_oracle.
Open a command line and execute:
Windowsgradlew publish -PrepoUserName=<deployment user> -PrepoUserPasswd=<deployment user password> -PreleaseURL=<URL for release publishing>
Set Up the Responsive Starter Store
The standard assemblies of the Intershop Commerce Management Suite do not provide any storefront functionalities and/or content. Nevertheless Intershop provides a full grown Responsive Starter Store including the whole view layer with a responsive content model and demo content.
For more detailed information please refer to the recipe Set Up Project Based on the Responsive Starter Store in the Cookbook - Setup CI Infrastructure.
Deploy a Server
These steps deploy the server from the current assembly build process.
- Navigate to <ProjectHome>/projects/ <ProjektName> / <YourAssembly>/target/samples and copy the file environment.properties.sample to <ProjectHome>/projects/ <ProjektName> / <YourAssembly>.
- Rename the file environment.properties.sample to environment.properties
Adapt the environment.properties according to your OS and define the database connection parameters, used ports and interfaces.
Note
When using Linux OS, make sure you configure separate multicast ports for each messaging channel.
Some older Linux distributions have an issue with multicast configurations on the same port and different IPs.
As Deployment User: Open a command line from <ProjectHome>/projects/ <ProjektName> / and execute:
gradle_environment.[bat|sh]
Build and deploy:
gradlew deployServer
- Navigate to your server directory <ProjectHome>/projects/<ProjektName>/build/server/local/tools/dbinit/bin.
As administrator/with root privileges open a command line and execute:
dbsetup.[bat|sh]
More information about the automated, script-based setup can be found here: Guide - Setup Oracle XE as Intershop Development Database.
For the installation of Oracle database drivers see also: Support Article - Deployment Stops While Looking for Oracle 19 Drivers
As Deployment User: Open a command line from <ProjectHome>/projects/ <ProjektName> / and execute:
gradlew dbinit
As administrator/with root privileges: Open a command line from <ProjectHome>/projects/ <ProjektName> / build/server/postInstall and execute the post-install script:
------------------------------------------------------------------------------------ To finish the deployment please execute the following scripts as administrator / with root privileges: /folder/postInstall/installServices.sh ------------------------------------------------------------------------------------
Use installServices.bat if using Windows OS.Start the application server.
Note
Once source code is added via a component or component set to the assembly, the build processes have to be executed.
Refer to Cookbook - Gradle Build Tools for more detailed information on how to do this.