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 Intershop Commerce Management. As such, it requires a base version against which it can be deployed. The table below shows version dependencies between those entities.
Below you can find some general information about the IOM Connector - both technical and business related.
In summary, setting up Intershop with the IOM Connector has the following effects:
Extended B2B features such as order approval or additional order information are fully compatible with the IOM Connector. Orders will be exported to IOM only after the corresponding approval processes are completed. In addition, all information stored at 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.
IOM Connector | Intershop Commerce Management | B2B Extension Module | Intershop Order Management |
---|---|---|---|
1.0 | 7.5 | 1.2 | 2.0 |
2.0 | 7.6 | - | 2.1 |
3.0 | 7.7.2.3 | - | 2.1 |
5.0 | 7.9 | - | 2.2 |
6.0 | 7.10 | - | 2.9 |
6.3 | 7.10.17.2 | - | 2.15 |
6.4 | 7.10.20.1 | - | 3.1 |
6.5 | 7.10.30.2 | - | 3.1 |
7.0 | 7.10.31.2 | - | 3.1 |
Term | Description |
---|---|
ICM | The abbreviation for Intershop Commerce Management |
IOM | The abbreviation for Intershop Order Management |
Info
Do not use warranties. IOM has yet to support service product types.
Disable pack slip messaging, gift wrapping and messaging and desired delivery date. Those features can be turned on and off for each application in the system individually.
Info
Perform the following steps:
The following example shows how to disable shipping instructions for Standard Ground shipping:
To enable communication between IOM and ICM, a user with sufficient permissions is required. These permissions are described in the corresponding SOAP/REST API documentation. When configuring ICM managed services, those credentials will be used. Each time a service is called, an attempt is made to identify the ICM to the IOM by using these credentials.
See the documentation for further information:
The communication between ICM and IOM is realized by utilizing the managed service framework, see Concept - Managed Service Framework. As with any managed service, the following tasks must be performed for IOM-specific services to become operational:
Once the IOM-Connector is installed, step 1 and 2 can be done with scripts. Afterwards the configuration has to be entered manually into the individual managed services. Alternatively, you can also perform these steps completely manually.
Therefore refer to the ICM Online Help for basic information on how to enable a managed service and how to create a managed service configuration.
This information is also available as PDF, e.g., Intershop Commerce Management - Managing Online Shops. See chapter Operation and Maintenance section Services Management.
Note
This document assumes that the setup process of Intershop Commerce Management with IOM Connector extension and Intershop Order Management has been completed and both system are started.
With one exception, all of the managed services require the shop's name in order to function. The exception is IOM Inventory Service which requires the actual shop ID. In order to get the required information ask your IOM database admin to provide you with the result of the following query:
OmsDB=# select ID,name from "ShopDO";
The result should look similar to the one below:
id | name -------+-------------------- 0 | All Shops 1 | OMS internal Shop 10000 | inTRONICS 10001 | inTRONICS Business (4 rows)
When you configure one IOM Order Service, IOM Download Service, IOM Order State Service, IOM Reverse Service or IOM RMA Service enter the shop's name in the configuration field Shop Name, e.g. inTRONICS.
When configuring IOM Inventory Service, IOM Order Export Service or IOM Order History Service you must enter the actual shop ID, e.g. 10000, as configuration value of Shop ID.
IOM Order Export Service requires several technical attributes that must be configured. In general, they control the connection settings to the IOM. Ask your system administrator if you do not have them at hand. Those settings include:
Parameter | Description | Example |
---|---|---|
Endpoint | The URI of the IOM Order REST API. | https://<your-iom-server>/rest/order-service |
Username | An authorization combination against IOM. The IOM's user that is authenticated with these credentials must have the permission to use web services in IOM. | consumer_ws |
Password | !InterShop00! | |
Shop ID | The ID of the shop as used in the IOM. | 10000 |
Timeout | Requests to IOM consume time. This setting determines after how many milliseconds a given request will be aborted automatically. | 90000 |
Logging and Monitoring sections are inherited from the standard managed service configuration. You may skip them at the moment.
The IOM Order History Service requires several technical attributes that must be configured. In general, they control the connection settings to the IOM. Ask your system administrator if you do not have them at hand. Those settings include:
Parameter | Description | Example |
---|---|---|
Endpoint | The URI of the IOM Order REST API. | https://<your-iom-server>/rest/order-service |
Username | An authorization combination against IOM. The IOM's user that is authenticated with these credentials must have the permission to use web services in IOM. | consumer_ws |
Password | !InterShop00! | |
Shop ID | The ID of the shop as used in the IOM. | 10000 |
Timeout | Requests to IOM consume time. This setting determines after how many milliseconds a given request will be aborted automatically. | 90000 |
Logging and Monitoring sections are inherited from the standard managed service configuration. You may skip them at the moment.
Note
Deprecated since IOM Connector 6.3
Starting with IOM Connector 6.3 the new IOM Order Export Service is available. This service replaces the IOM order Service. Both services should not be active at the same time.
IOM Order Service requires several technical attributes that must be configured. In general, they control the connection settings to the IOM. Ask your system administrator if you do not have them at hand. Those settings include:
Parameter | Description | Example |
---|---|---|
Endpoint | The URI of the IOM order webservice. Since IOM Connector 5.0 use http://<myhost>/webservices/OrderService/v1.2 | http://<your-iom-server>/webservices/OrderService/v1.2 |
Username | An authorization combination against IOM. The IOM's user that is authenticated with these credentials must have the permission to use web services in IOM. | consumer_ws |
Password | !InterShop00! | |
Shop Name | The name of the shop as used in the IOM. | inTRONICS |
Timeout | Requests to IOM consume time. This setting determines after how many milliseconds a given request will be aborted automatically. | 90000 |
OrderMessageQueueHandlerConfig | ||
Enable the OrderMessageQueue | If set to true, the communication between IOM and ICM will be logged in the database. Database administrators can extract those records. | true |
Delete Non-Error records | If the communication operation completes with success, i.e., the order has exported successfully, enabling this option will trigger automatic deletion of this record. | true |
Log Request Messages on Error | Set to true to enable logging of errors to the system error log (usually located on the file system). | true |
Logging and Monitoring sections are inherited from the standard managed service configuration. You may skip them at the moment.
Note
Deprecated since IOM Connector 6.3
Starting with IOM Connector 6.3 the new IOM Order History Service is available. This service replaces the IOM Order State Service. Both services should not be active at the same time.
The IOM Order State Service requires several technical attributes that must be configured. In general, they control the connection settings to the IOM. Ask your system administrator if you do not have them at hand. Those settings include:
Parameter | Description | Example |
---|---|---|
Endpoint | The URI of the IOM order state webservice. | http://<your-iom-server>/webservices/OrderStateService/v1.0 |
Username | An authorization combination against IOM. The IOM's user that is authenticated with these credentials must have the permission to use web service in IOM. | consumer_ws |
Password | !InterShop00! | |
Shop Name | The name of the shop as used in the IOM. | inSPIRED |
Timeout | Requests to IOM consume time. This setting determines after how many milliseconds a given request will be aborted automatically. | 90000 |
Logging and Monitoring sections are inherited from the standard managed service configuration. You may skip them at the moment.
Configure at least the following properties for the IOM Download Service:
Parameter | Description | Example |
---|---|---|
Endpoint | The URI of the IOM download web service. | http://<your-iom-server>/webservices/DownloadService/v1.0 |
Username | Credentials for user authentication and authorization in IOM. The user must have the permission to use the service. | consumer_ws |
Password | !InterShop00! | |
Shop Name | The name of the shop as used in the IOM. | inTRONICS |
Timeout | Requests to IOM consume time. This setting determines after how many milliseconds the given request will be aborted automatically. | 90000 |
Logging and Monitoring sections are inherited from the standard managed service configuration. You may skip them at the moment.
Note
Deprecated since IOM Connector 6.3
Starting with IOM Connector 6.3 the new IOM RMA Service is available. This service replaces the IOM Reverse Service. Both services should not be active at the same time.
The IOM Reverse Service requires several technical attributes that must be configured. In general, they control the connection settings to the IOM. Ask your system administrator if you do not have them at hand. Those settings include:
Parameter | Description | Example |
---|---|---|
Endpoint | The URI of the IOM reverse web service. | http://<your-iom-server>/webservices/ReverseService/v1.0 |
Username | An authorization combination against IOM. The IOM's user that is authenticated with these credentials must have the permission to use web services in IOM. | consumer_ws |
Password | !InterShop00! | |
Shop Name | The name of the shop as used in the IOM. | inTRONICS |
Timeout | Requests to IOM consume time. This setting determines after how many milliseconds a given request will be aborted automatically. | 90000 |
Logging and Monitoring sections are inherited from the standard managed service configuration. You may skip them at the moment.
Note
Since IOM Connector 2.0
Configuring the IOM Inventory Service is only necessary when using the 2.0 Connector (or later) alongside with IOM 2.1 and ICM 7.6.
The IOM Inventory Service provides a way to communicate inventory levels from Intershop Order Management to Intershop Commerce Management. ICM and IOM exchange inventory information via HTTP and thus some necessary communication parameters must be established before the service is activated:
Parameter | Description | Example |
---|---|---|
IOM REST Services URL | Base URL of the IOM REST services. | http://<your-iom-server>/servlets/services/ |
Username | An authorization combination against IOM. The IOM's user that is authenticated with these credentials must have the permission to use web services in IOM. | consumer_ws |
Password | !InterShop00! | |
Shop ID | The ID of the shop as used in the IOM. Note You need the actual shop-ID for this service and not the name of the shop as provided for the other IOM Managed Services. | 10000 |
Configuration parameter | Description | |
Global cache | Enables caching of responses for 5 seconds | true |
Availability check on failure | If there is an error with service execution, e.g., network problems, configuration failure, it checks the "available" flag of a product instead. | true |
Configuration parameter | Description | |
Reservation Type | The reservation type:
| COMPLETE |
Reservation lifetime | The lifetime / validity of the stock reservation in seconds. Max value is 2147483647. Default is 10 minutes. | - |
After the IOM Inventory Service is configured, delete or unshare the standard Inventory Service.
If you do not unshare or delete the standard Inventory Serivce, you will put several processes at risk, since the system is unable to determine which inventory service to use.
Info
You might as well deactivate it, but since it is shared to the channel's application by default, the applications will still use it. Therefore it must be unshared from those applications or deleted altogether.
Note
Since IOM Connector 6.3
Configuring the IOM RMA Service is only necessary when using the 6.3 Connector (or later).
The IOM RMA Service requires several technical attributes that must be configured. In general, they control the connection settings to IOM. Ask your system administrator if you do not have them at hand. Those settings include:
Parameter | Description | Example |
---|---|---|
Endpoint | The URI of the IOM RMA REST service. | http://<your-iom-server>/rest/rma |
Username | An authorization combination against IOM. The IOM's user that is authenticated with these credentials must have the permission to use web service in IOM. | consumer_ws |
Password | !InterShop00! | |
Shop Name | The name of the shop as used in the IOM. | inTRONICS |
Timeout | Requests to IOM consume time. This setting determines after how many milliseconds a given request will be aborted automatically. | 90000 |
Logging and Monitoring sections are inherited from the standard managed service configuration. You may skip them at the moment.
Once IOM Order Export Service is configured and activated, the ICM order export has to be configured. Using this scenario will route orders to IOM.
As a prerequisite of this Configure IOM Order Service has to be completed.
In the Order Export section click New to create a new order export.
Enter Name, Description and select a Configuration Type, i.e. IOMOrderService.
The available options for Configuration Type depend directly on the created services of type IOM Order Services. I.e., you have as many options here as you have created services. It is recommended to manage only one service of a type in order to avoid confusion.
Click Apply.
Click Scheduling and configure when the order export should be triggered.
For example select On Order Creation to export the order immediately after it was captured.