Public Release Notes - Omni-Channel Services Toolset Version 1.2

1 Introduction

Welcome to the Omni-Channel Services Toolset 1.2.

Intershop's Omni-Channel Services Toolset (OCST) is a collection of frameworks that enable fast, standardized development of business web apps like the Intershop Contact Center. Based on open-source technologies, the OCST is decoupled from the Intershop 7/Intershop Commerce Management core platform and uses the REST API (as part of the Synaptic Commerce API) to access data and commerce functionality.

The Contact Center is a reference implementation for the Omni-Channel Services Toolset and can be used by contact center agents to solve the customers' problems and assist them while shopping.

This document provides important product information, including version information and dependencies. It also outlines the basic setup and configuration steps.

1.1 What's New

1.1.1 New Features

  • Cost center assignment for B2B orders is now possible with the quick order feature
  • Support of new address handling

1.1.2 Fixed Bugs

Key Summary Updated P Status Resolution

1.2 Version Information and Dependencies

This delivery and the accompanying documentation are valid for the following combinations of software versions:

IntershopOmni-Channel Services Toolset

The package contains the component set f_ocst which includes the following cartridges:

  • app_contactcenter: OCST and reference implementation Contact Center
  • docu_ocst: The sources for the OCST documentation

1.3 Sources

To build own applications based on the Omni-Channel Services Toolset, the sources of the reference implementation as well as the source for the documentation and the demo assembly are provided:

  • http://<your-reposerver:port>/nexus/content/repositories/ishrepo/com.intershop.public.source/f_ocst/1.2.1/zips/

1.4 References

2 Setup

2.1 Prerequisites

Adding the Contact Center to your Intershop 7 system assumes the following requirements:

  • A running Intershop 7.8 installation that matches the system requirements
  • An assembly to which the Contact Center cartridges can be added, either a self defined or one of the Intershop samples
  • Knowledge of how to add the delivered artifacts to the continuous integration environment
  • Knowledge of how to deploy to a test or production environment


For details about using the CI infrastructure, see Cookbook - Setup CI Infrastructure.

2.2 Add the Omni-Channel Services Toolset to an Assembly

The Omni-Channel Services Toolset requires an Intershop 7.6 based installation. All setup steps described below are based on the assembly used for this installation, which is referred to as<ASSEMBLY>. Also the required Gradle files (build.gradle, deploy.gradle) should be already part of this assembly

  1. Define a host type for the Omni-Channel Services Toolset web application by adding the following host type to build.gradle:

    assembly {
        // Define the Omni-Channel Services Toolset hosttype 
        hostTypes { 
        	contactcenter { 
        		include ( 
    			) { 
    				transitive = false 
    			} includeLocal = true } 
  2. The version of the used OCST has to be added to the = 1.2.1
  3. To deploy the Omni-Channel Services Toolset the used host type needs to be configured. See Cookbook - Deployment Tools ICM 7.8 | Recipe: Configure the Deployment for more details. As an example, to deploy within the same Tomcat as the Intershop 7 system, add the following lines to the deploy.gradle:

    apply plugin: com.intershop.deploy.assembly.TargetPlugin
    apply plugin: com.intershop.deploy.resources.ResourceDeploymentPlugin
    apply plugin: com.intershop.deploy.intershop.TomcatPlugin
    deployment {
    	if (target.includeLocal) {
    		// if hostType == ALL (development) add a map as contactcenter extension
    		// containing the default values for the REST APIs
    		if ( == 'all' &&
    		!tomcat.instances.any { it.ext.has 'contactcenter' }) {
    			def host = "https://${webadapter.hostname}:${webadapter.securePort}"
    			tomcat.instances.find().ext.contactcenter = [
    			webshopRestURIBase: "$host/INTERSHOP/rest/WFS/",
    			contactcenterRestURI: "$host/INTERSHOP/rest/WFS/ContactCenter/-",
    			contactcenterRestURIBase: "$host/INTERSHOP/rest/WFS/"


    For details about adding custom deployment logic to an assembly, see Recipe: Add Custom Deployment Logic to an Assembly.

2.3 Configure the Contact Center for a Production Deployment

If the Contact Center is deployed within the development environment, no additional settings are necessary. The file f_contactcenter/app_contactcenter/deployment/deploy.gradle ensures that the placeholders in the URIs are replaced during deployment.

If you only want to install an assembly with the Contact Center using settings.gradle, the URIs must be configured manually. To do this, change the file settings.gradle to configure the Contact Center:

tomcat {
	instances {
		appserver0 {
			ext.contactcenter = [
				webshopRestURIBase:       'https://[HOSTNAME]:[SECURE_PORT]/INTERSHOP/rest/WFS/',
				contactcenterRestURIBase: 'https://[HOSTNAME]:[SECURE_PORT]/INTERSHOP/rest/WFS/',
				contactcenterRestURI:     'https://[HOSTNAME]:[SECURE_PORT]/INTERSHOP/rest/WFS/ContactCenter/-'


Server name

To ensure the web application can work with the REST API, it is very important to set the host name to the public host name of your server. This is necessary because the REST API will generate links for the client application to request created resources.

This can be done in the settings.gradle:

deploymentBootstrap {
        appserver {
            hostname = 'your.public.hostname'

3 Limitations

3.1 Available Payment Methods

On delivery the Contact Center supports only the following payment methods:

  • Cash on Delivery
  • Direct Debit Transfer
  • Invoice


The list of available payment methods can be configured. See Recipe: Configure the Available Payment Methods. To support payment methods which need the input of additional values (e.g., credit card), the demo application must be extended to support this.


The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources