pfx-api:dataload
Trigger a named dataload job on Pricefx. Dataloads are pre-configured server-side jobs that can be invoked by type and label.
URI Format
pfx-api:dataload?param1=value1¶m2=value2
Parameters
|
Parameter |
Type |
Default |
Description |
|---|---|---|---|
|
dataloadType |
String |
-- |
Type of dataload to run. Identifies the dataload job category |
|
label |
String |
-- |
Label of the specific dataload job to trigger |
XML Route Examples
Trigger a named dataload job
<route>
<from uri="direct:runDataload"/>
<to uri="pfx-api:dataload?dataloadType=PRODUCT&label=DailyProductLoad"/>
</route>
Trigger a customer dataload job
<route>
<from uri="direct:runCustomerDataload"/>
<to uri="pfx-api:dataload?dataloadType=CUSTOMER&label=WeeklyCustomerSync"/>
</route>
Dataload as part of a scheduled pipeline
<route>
<from uri="cron:dailyLoad?schedule=0+6+*+*+*"/>
<to uri="pfx-api:dataload?dataloadType=PRODUCT&label=DailyProductLoad"/>
<to uri="pfx-api:products"/>
<to uri="pfx-api:refresh?targetName=MyDatamart"/>
</route>
Common Pitfalls
-
dataloadType and label are both needed: Both parameters work together to identify the specific dataload job on the Pricefx server. Omitting either may cause the job to not be found.
-
Job must exist on server: The dataload job identified by the combination of
dataloadTypeandlabelmust already be configured in the Pricefx partition. The API will return an error if the job does not exist. -
Difference from loaddata: The
dataloadmethod triggers a pre-configured server-side job, whileloaddatapushes data from Integration Manager into Pricefx. They serve different purposes. -
Long-running operation: Dataload jobs can take significant time depending on the data volume and server-side configuration. Plan your route timeouts accordingly.
-
No mapper support: Unlike
loaddata, thedataloadmethod does not accept amapperparameter because the data transformation is handled entirely on the server side.