Public Release Note - IOM Connector 5.0

1 Introduction

The IOM Connector is a set of cartridges that allows data exchange and communication between Intershop Commerce Management and Intershop Order Management. It is an extension (or "service") module for the Intershop Commerce Management. As such, it requires a base version against which it can be deployed. The table below describes the version dependencies between those entities.

1.1 Dependency Version Information


IOM ConnectorIntershop Commerce Management B2XIntershop Order Management
Version5.0.77.9.+2.2.x

Below you find some general information about IOM Connector - both technical and business.

In a nutshell, Intershop set up with IOM Connector will affect the following:

  1. Orders placed in the e-commerce shop will be routed to IOM.
  2. Order history, available in My Account section, will show real-time IOM data of orders' statuses.
  3. Order return will be available as feature in said section.
  4. Order Details will contain a field that presents information about the Order Documents and Notes.

Intershop Commerce Management B2X features such as order approval or additional order information are fully compatible with IOM Connector. Orders will be exported to IOM only if the corresponding approval processes are completed. In addition, any information stored to the order - such as message to merchant, cost center and project - will be exported as well.

As with any Intershop feature that connects ICM to another system, all features are realized using the Managed Services framework.

Intershop recommends to create and manage the IOM Services in the context of channels.

1.2 Glossary

TermDescription
ICMThe abbreviation for Intershop Commerce Management
IOMThe abbreviation for Intershop Order Management

1.3 Delivery

The component set f_iomconnector (IOM Connector) contains the following cartridges:

  • ac_iomconnector_common
  • ac_iomconnector_order
  • ac_iomconnector_inventory
  • ac_iomconnector_orderhistory
  • as_iomconnector
  • init_iomconnector
  • demo_iomconnector

There are also a few test and development cartridges:

  • ac_iomconnector_order_test
  • dev_iomconnector_reverse_service

1.4 References

2 Feature Overview

2.1 Integration

As mentioned before, the IOM Connector is to be set up alongside a standard ICM installation. It adds additional cartridges that define the following managed services:

  • IOM Order Service - Exports order data from ICM to IOM
  • IOM Order State Service - Changes the order history section in a way that the orders' statuses are fetched from IOM whenever the customer requests them
  • IOM Download Service - After customers request a return, they will be able to download, or directly print a return slip. This return slip can be downloaded from the link shown on the Prepare Return Documents page.
  • IOM Reverse Service - Ensures order cancellation is available to the customer (so customers can even print a return slip, which can be used for order returns)
  • IOM Inventory Service - Provides a way to obtain the inventory levels from Intershop Order Management to Intershop Commerce Management and perform product reservations 

IOM Connector - Systems  

2.2 Channels and Shops

Both ICM and IOM follow the same hierarchical concept of organizations that have expandable entities. These entities differ, however. In ICM one sales organization may have multiple channels, while in IOM one sales organization may have multiple shops.

Intershop recommends to consider channels and shops as synonyms in the context of this document and your setup. Although not the same, they are in close relation to each other.

As mentioned before, a couple IOM Services, although not mandatory, are to be created in the context of channel. This way you can ensure that the communication exchange between ICM and IOM is realized on the intended level.

IOM Connector - Channels

2.3 Communication

2.3.1 End Points

The services mentioned in the previous chapter are realized with web services. They are exchanging data between the two systems in a specific format, but they also need to be configured. Web services require an end point that is different for each of them. In the table below you can see the end points, with IOM server host/address shown as a placeholder.

ServiceEnd point
IOM Order Servicehttps://<iom-host>/webservices/OrderService/v1.2
IOM Order State Servicehttps://<iom-host>/webservices/OrderStateService/v1.0
IOM Download Servicehttps://<iom-host>/webservices/DownloadService/v1.0
IOM Reverse Servicehttps://<iom-host>/webservices/ReverseService/v1.0
IOM Inventory Servicehttps://<iom-host>/servlets/services/

2.3.2 Shop

When doing the configuration mentioned in the step above, you must also specify a shop. Usually, a channel in ICM represents a shop in IOM.

2.3.3 Authorization

Consumers of the services must authorize themselves to IOM before any data is processed - either as input or output. To realize this, you must create a user in IOM with permissions necessary for the operations performed by the service. An easy way to ensure this is to assign the ShopServiceClient role to the corresponding user. However, you may fine grain the permissions for each service as they all will need a user name/password combination.

Should you use prepared demo data (you do not if you do not know what this is) here are some prepared values:

Consumer Web-Serviceconsumer_ws
CompanyinSPIRED
Shop(s)inTRONICS
inTRONIC Business

2.3.4 Identifiers

Both systems exchange data so they need a common ground as a base for this communication. The following table shows the mappings between IOM and ICM:

IdentifierIOMICM
ProductShop's product IDChannel's product SKU
CustomerShop's customer No.Customer No.
OrderShop's order No.Order document No.

These identifiers must be identical for each item in both systems. For example, if an order with a line item that has the SKU 00910 is placed and then exported to IOM, the web services layer will report an error if the product with this product ID is not present in IOM.

2.4 Order Export

IOM Connector provides instruments that route any order placed from ICM to IOM. To use this feature, you must configure the order export (see Configure Order Export), which depends on an existing service configuration (see Configure IOM Order Service). As mentioned before, on the configuration page you may tweak the export settings, but we generally use on order creation trigger.

The look and feel and the business processes in the standard ICM is not altered in any way, but placed orders are routed to IOM.

Order confirmation in ICMOrder details in IOM

2.4.1 Extended B2B Features

Order approval and additional order information - works out of the box with order export to IOM. Orders are exported to IOM once they are approved by the responsible user(s) in the customer's organization. All approval and additional information details are exported to IOM upon order placement. They are accessible in the Attributes section.

2.4.2 Mapping

The table below lists the mapping of data exchanged between ICM and IOM.

ICMIOM
Order details
Order Document NumberShop Order ID
Creation DateSales Information / Order
Payment MethodPayment Method
Tax RateTax Rate
Order totalOrder total
Shipping Information
Shipping method IDCarrier
Invoice & Shipping Address
CompanyCompany
SalutationSalutation
First NameFirst Name
Last NameLast Name
Address 1Street
Address 2Address Suffix 1
Address 3Address Suffix 2
ZIP/Postal CodeZIP/Postal Code
CityCity
CountryCountry
PhonePhone
EmailEmail
Line Item Information
Product SKUShop product ID
QuantityQuantity
Tax RateTax Rate
PricePrice

Note

Shipping and Carriers are different in their nature. While the sales channels in ICM have shipping methods which are selectable by the customers, IOM "knows" about carriers that execute those shipping methods. For example, in the ICM one might have two shipping methods DHL Express and DHL Standard both of which are covered by single carrier DHL.

2.5 Order History

This feature is governed by the IOM Order State Service. Once this service is configured and activated, the order status information in My Account | Order History is provided in real time from the IOM.

My Account | Order HistoryOrder search in IOM

Real time means that order statuses are updated the moment they are updated in IOM. Thus any action taken in IOM, for example Confirmation of delivery, will be shown in ICM the moment when someone requests the Order History. In the table below lists the mapping between order statuses in the two systems.

Intershop Commerce ManagementIntershop Order Management
transmittedcommissioned
shippedshipped
in validationcheck failed
returnedreturned

2.6 Payment Statuses

The current status of the payment is very important for our customers. After an order is submitted, you can see information details in the Order History section. Click on view to show Order Details page with the Payment panel. This panel contains information about the payment status (Paid, Part Paid, Not Paid) and a progress bar:

PaidThe order is completely paid.
Part Paid The order is partially paid.
Not PaidThe order is not paid.

The progress bar shows what percentage of the order is already paid. The total amount of money to be paid can be seen in the line Open Invoiced Amount. If an order is completely paid, the customer sees a green progress bar with 100%, and the line Open Invoiced Amount states $ 0.

My Account -> Order History -> ViewOrder Invoice in IOM

2.7 Order Return

2.7.1 Return Line Items

Customers are able to trigger returns of orders. Once the order is shipped, and its delivery confirmation is tracked in IOM, its status is changed to shipped. From the Order History page, every order that has been shipped can be triggered for return by clicking the Return link. For each individual item, a return quantity and a reason can be specified. Return reasons are requested from IOM. For convenience the ICM provides a drop-down list to select a return reason.

Note

Activate service
The IOM Reverse Service needs to be configured and activated to use the Order Return feature.

2.7.2 Print the Return Slip

Once a return was requested the return slip can be download, or directly print a return slip. This return slip can be downloaded from the link shown on the Prepare Return Documents page.

Note

Activate service
The IOM Download Service needs to be configured and activated to download return documents.

2.7.3 Return Reasons REST API

Applicable return reasons are available via REST API - see IOM Connector 5.0 - REST API - Order Return Reasons.

2.8 Order Documents

This feature allows to display attached documents (note / information) on the Order Details page. The Order Document retrieval from the IOM has a cache handling mechanism that preserves the information for a given time interval. The ICM's Order Details page render process requests the IOM to report the number of documents attached to the very order. The badge on the right hand side of the View All link indicates the number of documents. Click View All to display a list of documents. The list shows information like: note type (invoice, credit , etc.), note creation date/time and a link for the document download.

A downloaded document/note should look like this:

The image below shows an example for a View All list:

Note

Active services and data
The features listed so far, namely Order History, Payment Statuses and Order Documents require a configured and activated IOM Order State Service. Order Returns additionally need the IOM Reverse Service in order to process returns.
While the IOM Order State Service is deactivated the according data will be taken from the locally set up database.

2.8.1 REST API

Information about an order's documents are also available via the IOM Connector REST API. For more detailed information please refer to:

2.9 Inventory Service

The main task of the Inventory Service is to check the product availability status for a particular product in the IOM. IOM Inventory Service works in real time, but at the same time it supports the caching of the results for a given time interval (e.g., 5 seconds). When the page with the customers desired product is open, the Inventory Service requests the IOM for an ATP (available to promise) status. If the product is available then the customer will see the button Add to Cart and a field to specify the desired quantity of the product. On the other hand, if the product is not available, a button with the text Notify me when available appears. Ensure to mark the checkbox Availability check on failure in the service configuration to guarantee the product availability will be at least checked in the local database, in case of a communication problem with the IOM system.

Note

Deactivate SimpleInventoryService
The SimpleInventoryService has to be deactivated if IOM Inventory Service should be used.

Example error with SimpleInventoryService  Expand source
[2017-09-27 10:41:31.362 +0100] ERROR localhost ES2 appserver0 [inSPIRED-inTRONICS_Business-Site] [-] com.intershop.component.mvc.internal.inventory.InventoryServiceResolverImpl [] [Storefront] [-igcxxhSVC0cx0GZqycdxxgt17cb0TXN_T4xWB9E] [ESIFAFnLcgUBAAB_-1-07] "ESIFAFnLcgUBAAB_-1-07" Only one adapter allowed to be executable of InventoryService, but 2 adapters found. 
System Information

3 New in IOM Connector 5.0

IOM Connector 5.0 now supports IOM Order Service v.1.2. The Reference Documentation can be found here Reference - IOM SOAP Web Services.

4 Setup


Managing and deploying the IOM Connector requires a continuous integration environment set up and configured as described in Cookbook - Setup CI Infrastructure.

4.1 Precondition

IOM Connector release package is available via Intershop's public Artifactory server. To add it to your release:

  1. Set up and configure CI - continuous integration - environment.
    See Cookbook - Setup CI Infrastructure for details.
    See Concept - Continuous Delivery Tools for basic information about Continuous Integration.
  2. Install Intershop Commerce Management matching the system requirements - see section Dependency Version Information.
  3. Knowledge of how to deploy to a test or production environment.
    The IOM Connector contains parts that are distributed as binary artifacts (see iomConnectorCartridges in the code example of section Configure the Assembly) and parts that are distributed as source (see productionCartridges in the code example of section Configure the Assembly), so they can be copied and modified easily in a project. You can retrieve the source cartridges from your repository server com.intershop.public.source.f_iomconnector
  4. As Deployment User: Download the latest version of the IOM Connector multiproject f_iomconnector.
    http://<your-reposerver:port>/nexus/content/repositories/components/com.intershop.public.source/f_iomconnector/<version>/zips/f_iomconnector-zip-src-<version>.zip
  5. Unzip and copy the multiproject contents to your project directory <projectHome>/projects/intershop-project/<myCustomComponentset> .

    Long path names on Windows

    On Windows certain tools have trouble dealing with path names longer than 255 characters. When in doubt, please use 7-Zip 15.12 to uncompress the source packages.

  6. Change build.gradle of selected cartridges to reference public libraries and implement customizations.

    CartridgeReference to changeNew line
    ac_iomconnector_orderhistorycompile project(':ac_iomconnector_common')compile group: 'com.intershop.services.iomconnector', name: 'ac_iomconnector_common'
    compile project(':ac_iomconnector_order')compile group: 'com.intershop.services.iomconnector', name: 'ac_iomconnector_order'
    compile group: 'com.intershop.responsive', name: 'app_sf_responsive'compile project(':app_sf_responsive')
    as_iomconnectorcompile project(':ac_iomconnector_common')compile group: 'com.intershop.services.iomconnector', name: 'ac_iomconnector_common'
    compile project(':ac_iomconnector_order')compile group: 'com.intershop.services.iomconnector', name: 'ac_iomconnector_order'
    compile group: 'com.intershop.responsive', name: 'as_responsive_b2b'compile project(':as_responsive_b2b')
    demo_iomconnectorcompile project(':ac_iomconnector_common')compile group: 'com.intershop.services.iomconnector', name: 'ac_iomconnector_common'

  7. Change build.gradle of your project
    Add the provider of the IOM-Connector to the section versionRecommendation as ivy dependency.

    versionRecommendation {
    
        provider {
            // can be activated with a special version                      
    		ivy('IOMconnector',  'com.intershop.services.iomconnector:iomconnector-filter'){}
           …
        }
    }
  8. Re-publish your multiproject.

4.2 Configure the Assembly 

4.2.1 Preview Assembly

The public delivery contains the exemplary assembly inspired-connector.zip. It can be easily used for first look.

Note

The build.gradle is adjusted from the b2x assembly. Please check if all dependencies (incl. versions) are correct for the version of your assembly.

  1. Unpack inspired-connector.zip to your project root folder
  2. Delete the assembly folder used before (e.g. “inspired-b2x”) from the project
  3. Edit your projects build.gradle to use the “inspired-connector” as assemblyProject
  4. Publish and deploy

4.2.2 Production Assembly

For a production assembly add the IOM Connector by doing the following steps:

  1. Include the IOM Connector's cartridges into an existing assembly.

    • Open the file build.gradle of your assembly, add a list of IOM Connector's cartridges in assembly directive and include this list into the assembly's cartridges:

      build.gradle
      assembly {
      ...
      	cartridges {
              def iomConnectorCartridges = [
                  'ac_iomconnector_common',
                  'ac_iomconnector_order',
                  'ac_iomconnector_inventory',
                  'init_iomconnector'
              ]
              
              include (*(iomConnectorCartridges.collect {"com.intershop.services.iomconnector:$it"}), in:[development, test, production])
          
              def productionCartridges =
              [
      			'<your-cartridge1>',
      			'<your-cartridge2>',
                  'ac_iomconnector_orderhistory',
                  'as_iomconnector',
                  'demo_iomconnector'
              ]
      
              include (*(productionCartridges.collect {"<your-assembly-group>:$it"}), in:[development, test, production])		
      
              order = listFromAssembly('<your-assembly>') + storefrontCartridges + iomConnectorCartridges + productionCartridges + initCartridges + developerCartridges + testCartridges
          }
      ...
      }
    • In the same build.gradle file add add the following two cartridges to assemblyBuild.database .

      assembly {
          ...
      }
      
      assemblyBuild {
          database {
              inherit('<your-assembly>')
              initCartridges =
              [
                  'ac_iomconnector_common',
                  'demo_iomconnector',
                  'init_iomconnector'
              ]
          }
      }
  2. Alternatively, you can create a new assembly inheriting from an Intershop Commerce Management-based assembly.

    For details about creating a new assembly, see Recipe: Create a New Assembly Inheriting From an Existing Assembly.
  3. Exclude conflicting versions from the assembly build.
    Therefore add the following lines at end of build.gradle file of your assembly. If you already have defined configurations.all directive just enrich it with the excludes listed below.

    build.gradle
    configurations.all {
    	exclude group: 'stax', module: 'stax-api'
    }

  4. Create your ivy IOM Connector file for the binaries.
    The file name is .ivyIOMconnector.version

    ivyIOMconnector.version
    5.0.6


  5. Define a unique order sequence.

    Both Intershop Commerce Management and Intershop Order Management assign an unique identifier to any order placed in the corresponding system. These identifiers are often referred to as "order document number" or "order ID". In order to have a seamless integration between the two systems you must synchronize these identifiers. Since ICM has the "leading role" as the orders are created and submitted from customers in the web shop, system administrators need to apply an additional configuration to the order number generation.
    The IOM Connector requires an order number generation that provides unique order numbers for both systems.
    If you are deploying IOM Connector with ICM and IOM anew, in other words you have no orders placed in both systems, it is safe to skip this step. However, you may want to define unique order sequence just in case. All you need to do is to negotiate a starting number with all parties involved and then add a deployment step that alters /share/system/config/cluster/database.properties file, namely the property intershop.sequence.startsWith.

4.3 Deploy the Assembly

After creating and appropriately configuring the assembly, you must deploy it to the intended target environment.
For details about deploying an assembly, see Recipe: Run the Deployment (Initial Installation / Upgrade / Downgrade)

4.4 Initialize the Database

You must run a database initialization to use the IOM connector.

DBInit is required for the following cartridges:

  • ac_iomconnector_common
  • demo_iomconnector
  • init_iomconnector

To execute full database initialization use:

gradlew dbinit

To execute the database initialization use on selected set of cartridges:

dbinit -t=ac_iomconnector_common,demo_iomconnector,init_iomconnector

4.5 References

For details about managing assembly artifacts, see:

The IOM Connector requires additional post-deployment configuration steps. For details, refer to configurations page.

5 Configuration

In order to deploy the IOM Connector with the Intershop Commerce Management, you do not need to configure anything.

For a proper interaction of the two systems (IOM and ICM), however, some configuration is necessary. For more detailed information on how to do this, refer to Guide - ICM and IOM Configuration Tasks.

Additionally, in order to get the IOM working with the ICM 7.9 demo scenario (inSPIRED storefront) specific demo content needs to be uploaded into the IOM. The description and the content can be found here: Guide - IOM Demo Data Setup for IOM Connector

6 Limitations

6.1 Application Management

In the standard Intershop Commerce Management there is no way to enforce these rules without customization. You must implement a business rule and make sure that shop managers comply with it.
  • Use only one currency per application.
  • Use only one shipping method per order.
  • Do not use surcharges.
  • Use only promotions that affect line items, e.g., discounts on line item.

6.2 Product Information Management

Do not use warranties. Intershop Order Management currently does not support service product types.

6.3 Synchronize Order Numbers

Both Intershop Commerce Management and Intershop Order Management assign an unique identifier to any order placed in the corresponding system. These identifiers are often referred to as order document number or order ID. In order to have a seamless integration between the two systems you must synchronize these identifiers. Since ICM has the "leading role" as the orders are created and submitted from customers in the web shop, system administrators need to apply an additional configuration to the order number generation.

Intershop Commerce Management's server(s) should be turned off before the steps bellow are executed.

  1. Go to <server-installation-dir>/local/bin and execute environment.<bat|sh>.

    ./iomconnector/server/local/bin/environment.sh
  2. Go to <server-installation-dir>/local/tools/misc and execute ant export-sequence-info -f database.xml.

    [/iomconnector/server/local/tools/misc]# ant export-sequence-info -f database.xml
    Buildfile: /iomconnector/server/local/tools/misc/database.xml
    dbenvironment.environment.decrypt:
    dbenvironment.environment:
    environment:
    export-sequence-info:
          [sql] Executing commands
          [sql] 1 of 1 SQL statements executed successfully
          [sql] Executing commands
          [sql] 1 of 1 SQL statements executed successfully
    log:
         [echo] [02/17/2016 03:20:56 PM] The used enfinity specific sequence informations were successfully exported to file 'sequences-info.properties'.
    BUILD SUCCESSFUL
    Total time: 2 seconds
  3. In <server-installation-dir>/local/tools/misc open the newly generated file called sequences-info.properties.
    It looks like:

    #,LAST_NUMBER,INCREMENT_BY,SEQUENCE_NAME,DOMAIN_SPECIFIC,DOMAINNAME,IDENTIFIER
    #,51,10,SQHHBAQDGBYQAAAAFUCBLM4M0_,TRUE,inSPIRED-inTRONICS,SellerOrder.DocumentNo.NfsKAB1PpEUAAAFTFT89kGWR
    # Largest last_number is: SellerOrder.DocumentNo.NfsKAB1PpEUAAAFTFT89kGWR - inSPIRED-inTRONICS
    #intershop.sequence.blockSize  = 10
    #intershop.sequence.startsWith = 51

    Memorize or write down the number of intershop.sequence.startsWith and intershop.sequence.blockSize.

  4. Log into the IOM.
    Go to http://<iom-server-url>/bakery.omt/app/start and enter your user credentials.
  5. Click on Orders or perform an order search .
  6. Memorize or write down the biggest order number in the list.
  7. Define unused order sequence.
    You have a lot of options, but they all should comply to one rule - A new order sequence should be unique for both systems now and in the future.
    It is advised to just pick the bigger number between biggest order ID taken from IOM's orders list and the intershop.sequence.startsWith taken at step 3. You may also add a date prefix to the order number, or put a unique machine identifier, as long as it contains only numbers.
    In this example, ICM's order ID is 51 and IOM's - 20160128017063. Bigger one is 20160128017063. So add the value of intershop.sequence.blockSize to it - 20160128017063 + 10 = 20160128017073 - and then add 1. The end result is 20160128017074.
  8. Go to <server-installation-dir>/share/system/config/cluster, open the file database.properties.
  9. Remove # from line intershop.sequence.startWith= and change its value to the unused order sequence determined in step 7.

    ################################################################################
    ##
    ## Series (Sequence) Creation Options
    ##
    ##
    ## series numberPattern settings
    ##
    #intershop.sequence.numberPattern=00000000
    ##
    ## blockSize  - "increment by <n>"
    ## startsWith - "start with <n>"
    ## cacheSize  - "cache <n>" or "nocache" if <n> = 0
    ## orderFlag  - "order" if true or "noorder" if false
    ##
    #intershop.sequence.blockSize=50
    intershop.sequence.startsWith=20160128017074
    #intershop.sequence.cacheSize=0
    #intershop.sequence.orderFlag=true

7 Changelog

7.1 Version 5.0.7

7.1.1 Fixed Defects

  • Tax class mapping limited to three hardcoded tax classes - IS-29608
  • DuplicateException is handled as error and not as information - IOM-9164
  • Wrong Attribute length for "Name" in OrderPositionMapper - IS-29893

Disclaimer

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
Support Tickets