Components

Components

Integration Manager provides a set of custom Apache Camel components that expose Pricefx-specific functionality as Camel URIs. These components are used inside route XML files and follow the standard Camel URI pattern:

component-name:operation?param1=value1&param2=value2

All components are available out of the box — no additional Maven dependencies required in your integration project.


Core Components

These are the components you will use in almost every integration:

Component

URI Prefix

Description

pfx-api

pfx-api:method

The primary Pricefx API component. Load data, fetch records, integrate (upsert), delete, truncate, flush datamarts, calculate, and 30+ other operations. Producer-only.

pfx-csv

pfx-csv:marshal / pfx-csv:unmarshal

Marshal Java maps/lists to CSV text, or parse CSV text into a list of maps. Used for reading CSV files before loading and for writing export results to CSV.

pfx-excel

pfx-excel:read / pfx-excel:write

Read data from Excel files (.xlsx) into a list of maps, or write data to Excel. Supports sheet selection, header rows, and column mapping.

pfx-event

pfx-event:...

Consume Pricefx platform events (e.g., PADATALOAD_COMPLETED, CALCULATION_COMPLETED_CFS) to trigger routes reactively.


Integration Components

For connecting to external systems:

Component

URI Prefix

Description

pfx-rest

pfx-rest:...

HTTP/REST client for calling external APIs. Supports GET, POST, PUT, DELETE with configurable headers, authentication, and response handling.

pfx-sftp

pfx-sftp:...

SFTP file transfer — read files from remote SFTP servers or write files to them. Built on Apache Camel's SFTP component with IM connection support.

pfx-sql

pfx-sql:...

Execute SQL queries against external databases. Supports SELECT (returns list of maps) and DML (INSERT, UPDATE, DELETE). Requires a JDBC connection bean.

pfx-smtp / pfx-smtps

pfx-smtp:...

Send emails via SMTP (plain) or SMTPS (TLS).

pfx-odata2

pfx-odata2:...

OData v2 consumer for SAP and other OData-compatible systems.

pfx-gp

pfx-gp:...

Greenplum database integration.

pfx-google-shopping

pfx-google-shopping:...

Google Shopping feed integration.

google-storage

google-storage:...

Google Cloud Storage — read and write files to GCS buckets.


Data Processing Components

For transforming and validating data within routes:

Component

URI Prefix

Description

pfx-json

pfx-json:...

JSON marshalling and unmarshalling. Parse JSON strings into maps/lists or serialize Java objects to JSON.

pfx-xml

pfx-xml:...

XML processing — parse XML documents, extract values with XPath, and produce XML output.

pfx-validator

pfx-validator:...

Validate incoming data against rules or schemas before processing.


Utility Components

Component

URI Prefix

Description

pfx-config

pfx-config:...

Access and manipulate IM configuration properties at runtime.

pfx-info

pfx-info:...

Retrieve information about the running IM instance (version, environment, etc.).

pfx-io

pfx-io:...

File I/O utilities for reading and writing local files within the IM instance.

pfx-resources

pfx-resources:...

Access resource files bundled with the integration project (e.g., templates, static data).

pfx-filepreview

pfx-filepreview:...

Generate file previews (PDF, image thumbnails) from documents.


Usage in Routes

All components are used as Camel endpoint URIs in route XML files:

XML
<routes xmlns="http://camel.apache.org/schema/spring">
    <route id="myRoute">
        <from uri="file:{{input.path}}"/>
        <to uri="pfx-csv:unmarshal?delimiter=,"/>
        <to uri="pfx-api:loaddata?objectType=P&amp;mapper=productMapper"/>
    </route>
</routes>

See Routes for full route XML patterns and pfx-api Component for the complete API operation reference.