Table of Contents

Message Types

Generic message types

Learn-pages related to this topic show basic example XML-message for testing purposes. Guidance, explanation of basics and further information can be found in our e-learning about Integration with the standard.

A message type can be found on the page Data Integration Message Type List. You can create a new message type by clicking the New button to tailor the message type to your needs.

All of our generic message types are designed to handle one main object per message, typically a Document. This ensures clarity and consistency across different message types. Here's how it works:

  • Single Object per Message: Each message contains one primary object. For example:
    • A single Document within an RCV-Receipt message.
    • A single CustomerItem within an RCV-MMD message.
  • Header Bound Limitation: The message structure is "header bound," meaning the main object (e.g., a Document) can include multiple related sub-objects. This allows you to encapsulate detailed information within a single message. To prevent operational errors, never use multiple Document tags.

Transport Protocol

Protocol Description
HTTP (XML/JSON) Supports sending and receiving data in XML or JSON format over HTTP. The field Transport Location must contain the endpoint URL (for example, https://example.com/api/v1). Configure the Processing Type as needed (e.g., Direct).
File Storage Allows storing and retrieving files from a configured storage service. Use the File Storage Services page to define your storage configuration. The field Transport Location must reference the configured File Storage Service (for example, MyStorageService).

Tip

On the field Transport Location, Username, and Password you can use different values per Environment (e.g., PROD, RAPP, TEST).