A newer version of this documentation is available: View the Latest Version

Service Description - Pacemaker Order Export 3.x

Technical Component Informationen

Company

TechDivision GmbH

Name

Pacemaker Order Export

Version

3.x

Web

https://pacemaker.met.tdintern.de/components-pacemaker-order-export/v3.x/index.html

Open Source

License

Proprietary

Pricing

n/a

Adobe Commerce Version

>= 2.4.4

PHP Version

>= 7.4

General

Although Magento already has a self-contained order document functionality, exporting orders to a third-party system (ERP, OMS) is often necessary.

On these systems, orders get processed, and stock levels are adjusted.

Pacemaker Order Export is part of Pacemaker Enterprise Edition and includes the generation and processing logic for exporting purchase orders.

The Pacemaker Order Export component uses the Pacemaker Process Pipelines framework and enhances it with the following core features:

Magento website-based order export
Scheduled, asynchronous export with the Pacemaker Process Pipelines Framework
Configuration and filtering of orders to get exported
Extensible export format with templates or code-technical extension points
Extensible export logic to connect to various third-party systems
Configuration and formatting of order items of the order for the export
Functional configuration of inventory reservation resolution from Magento MSI

Feature Overview

Function	Description
Pacemaker Extension/Integration	As part of Magento 2 Enterprise Edition (EE), the Pacemaker Order Export component exports orders from the Pacemaker Process Pipelines Framework.
Pacemaker Order-Export Pipeline	The order export gets performed using a particular dynamic pipeline. This Pipeline has up to five steps to process and export the order Configuration options can set the steps themselves
Controllable export of orders	Using configurations, you can set (date, website, status) which orders should get considered for the export.
Standard Export-Template	With configuration, a minimal standard template for export gets provided.
Adjustable Export Template	The specified default template can be customized and extended in the Magento backend with a Twig editor.
Extensibility of the export templates	The architecture/implementation makes it possible to program and register your templates to use them for order export.
Standard file system transport adapter	The configuration provides the standard transport adapter for the order export. That contains creating a file with the order data in the configurable directory of the file system.
Expandability of the transport adapters	The architecture/implementation is designed to program and register custom adapters and use them for order export (e.g., for APIs).
Configurable response adapter	Offers the possibility of extending the export configuration with a response check.
Configurable notification adapter	Creates the possibility of extending the export configuration with a customer notification.
Configurable r reservation handling	Creates the possibility to configure Magento MSI inventory reservation based on the order export steps.
Export status information in Magento backend	The detailed order view in the Magento backend displays information related to the export status and date.

Function

Description

Pacemaker Extension/Integration

As part of Magento 2 Enterprise Edition (EE), the Pacemaker Order Export component exports orders from the Pacemaker Process Pipelines Framework.

Pacemaker Order-Export Pipeline

The order export gets performed using a particular dynamic pipeline.

This Pipeline has up to five steps to process and export the order
Configuration options can set the steps themselves

Controllable export of orders

Using configurations, you can set (date, website, status) which orders should get considered for the export.

Standard Export-Template

With configuration, a minimal standard template for export gets provided.

Adjustable Export Template

The specified default template can be customized and extended in the Magento backend with a Twig editor.

Extensibility of the export templates

The architecture/implementation makes it possible to program and register your templates to use them for order export.

Standard file system transport adapter

The configuration provides the standard transport adapter for the order export. That contains creating a file with the order data in the configurable directory of the file system.

Expandability of the transport adapters

The architecture/implementation is designed to program and register custom adapters and use them for order export (e.g., for APIs).

Configurable response adapter

Offers the possibility of extending the export configuration with a response check.

Configurable notification adapter

Creates the possibility of extending the export configuration with a customer notification.

Configurable r reservation handling

Creates the possibility to configure Magento MSI inventory reservation based on the order export steps.

Export status information in Magento backend

The detailed order view in the Magento backend displays information related to the export status and date.

Dynamic Order Export Pipeline

The Pacemaker Order Export component uses the Pacemaker Process Pipelines framework. A pipeline gets created for the export of an order.

It’s generated based on the set configurations with a minimum of 2 and a maximum of 5 steps.

The following steps take care of the creation steps:

Transformation
Transmission/export
(optional) response check
(optional) reservation resolution
(optional) customer notification
Each of these steps is configurable and extensible by adapters

Reservation resolution

In the Magento standard, the inventory reservation gets resolved on delivery (delivery bill) or cancellation through Magento MSI.

With the Pacemaker Order Export component, depending on the setting, the reservation could already be resolved when exporting the order.

Magento’s default will get bypassed if configured, and no resolution will get performed when creating delivery bills.

Expandability / Extension Points

The component offers many concepts and also code-based extension points to extend and customize the order export or the included and used adapters.

see, how to extend the order export: https://pacemaker.met.tdintern.de/components-pacemaker-order-export/v3.x/extend/index.html

What is included in the license price?

Major/Minor Updates
Security Updates
Bugfixes

What the component cannot do

The component does not offer any standardized connections to third-party systems.
- Customizations and extensions are possible using the respective adapters
Only purchase orders can get exported with the component
- Imports or status updates do not take place
It is not possible to export or import other sales documents, such as delivery bills

Requirement for use

To use the Components Order Export in Adobe Commerce, the following points must get observed:

Contract
Technical conditions

Glossary

Term	Description
Pipeline	THe Pipeline is the chaining of commands.
Step	A step is understood to be a chain link within a pipeline.
Transform-Adapter / Export-Template	This configuration option is extendable by extension points and is responsible for transforming the order information.
Twig	Twig is a template engine for the PHP programming language. The Twig syntax was influenced by the template engine Jinja and the Django framework. See https://twig.symfony.com/
Transport-Adapter	The configuration option is extendable using extension points and is responsible for sending the order information to an endpoint
Response-Adapter	The configuration option is extendable using extension points and is responsible for the optional response check of the endpoint.
Notification-Adapter	The configuration option is extendable using extension points and is responsible for the optional notification function to the customer.

Term

Description

Pipeline

THe Pipeline is the chaining of commands.

Step

A step is understood to be a chain link within a pipeline.

Transform-Adapter / Export-Template

This configuration option is extendable by extension points and is responsible for transforming the order information.

Twig

Twig is a template engine for the PHP programming language.
The Twig syntax was influenced by the template engine Jinja and the Django framework.
See https://twig.symfony.com/

Transport-Adapter

The configuration option is extendable using extension points and is responsible for sending the order information to an endpoint

Response-Adapter

The configuration option is extendable using extension points and is responsible for the optional response check of the endpoint.

Notification-Adapter

The configuration option is extendable using extension points and is responsible for the optional notification function to the customer.