Pricefx Backend Server - Paloma 17.3.0-SNAPSHOT API

Welcome to the documentation for the Pricefx Groovy API, a flexible solution for configuring the Pricefx system.

Using the Groovy language you can manipulate data, create and read user inputs, lookup data, execute logics, and much more within the given Pricefx partition.

Public Groovy API

This is the entry point to Pricefx Groovy API. With the Public Groovy API (accessible via the binding variable "api"), you have access to a wide range of methods for Pricefx configuration.

Knowledge Base

For more insights on how to use the Groovy API, visit the Pricefx Knowledge Base. It contains getting started guides, how-to tutorials, and practical usage examples for the Pricefx API configuration.

Best Practices

Enhance the project performance and stability, along with writing logics effectively. Read about code conventions, adopt functional practices, and employ performance practices to optimize and streamline your code.

Pricefx Studio

Install, setup, and learn how to use Pricefx Studio IntelliJ IDEA plugin. Pricefx Studio helps you improve productivity when developing calculation logics during project implementation.

Examples (internal access only)

Requires internal access permissions! As the current Groovy API documentation does not yet provide examples for some methods, you can also search for code snippets via gitgrep.pricefx.eu.

Configuration Engineer Knowledge Base

Pricefx Core Developer Guides, How Tos, Q&A forum, Best Practices and Reference available in the Configuration Engineer Knowledge Base.

Pricefx Training Portal

Register for learning paths, instructor-led training, or certification exams via Pricefx Training Portal.

Code Quality

Employ the code quality plugin to ensure compliance with Pricefx standards.

Pricefx REST API Documentation

In case you need to perform an HTTP call, you can find the desired endpoint and request/response examples in our REST API documentation.

Release Notes

Check out Pricefx Release Notes to stay informed about the latest development.

Cheat Sheets

• Groovy Cheat sheet
• Logic Types Cheat sheet

Pricefx Unity Documentation

Documentation for the Pricefx Unity user interface.

Versions

The version of Groovy currently used for the Pricefx configuration and the Java version used on the backend.

Groovy	2.4.21
JDK	21

Packages

Package	Description
com.flaptor.hist4j	A histogram that adapts its buckets to the distribution of the data.
com.googlecode.genericdao.search	Filters that restrict which objects a search returns.
net.pricefx.common.api	The value sets that the published Groovy API shares across modules.
net.pricefx.common.api.chart	The value vocabulary of a chart definition.
net.pricefx.common.api.pa	The field typing of Analytics data.
net.pricefx.common.apibuilder.calculationflowaction	Builders for the actions that a Calculation Flow logic schedules.
net.pricefx.common.apibuilder.chart	Fluent builders for chart definitions rendered by the Pricefx user interface.
net.pricefx.common.apibuilder.clicoll	The builder and the helper that every document header logic shares.
net.pricefx.common.apibuilder.compensation	The header logic builder for Compensation Plans.
net.pricefx.common.apibuilder.contract	The header logic builder for Contracts, with its helper and its structure object.
net.pricefx.common.apibuilder.customform	The header logic builder for Custom Forms.
net.pricefx.common.apibuilder.pricingplan	Builders that create Pricing Plan objects from a logic.
net.pricefx.common.apibuilder.quote	The header logic builder for Quotes, with its helper and its structure object.
net.pricefx.common.apibuilder.rebateagreement	The header logic builder for Rebate Agreements, the template builder, and their helpers.
net.pricefx.common.apihelper.conditionrecord	Writing Condition Records from a Condition Record logic.
net.pricefx.common.dto	Defining approval workflows, and chaining background jobs.
net.pricefx.common.dto.creationworkflow	Defining the creation workflow of a document.
net.pricefx.common.util	Date and time-period helpers behind the Analytics calendar.
net.pricefx.domain	Domain objects that Pricefx logics receive from and pass to Groovy API calls.
net.pricefx.formulaengine	Formula engine interfaces exposed to Groovy logics.
net.pricefx.formulaengine.forms	The Forms 2.0 API for building dynamic forms from a Form logic.
net.pricefx.formulaengine.optimization	Model contexts of the price optimization module.
net.pricefx.formulaengine.scripting	Root package of the public Groovy API available to Pricefx logics.
net.pricefx.formulaengine.scripting.inputbuilder	Builders for logic inputs (user entries and context parameters).
net.pricefx.formulaengine.scripting.portlets	Portlet result types rendered by dashboards.
net.pricefx.formulaengine.scripting.queryapi	The Query API, the unified Groovy API for reading data from Pricefx.
net.pricefx.formulaengine.scripting.queryapi.tables	Typed table descriptors of the Query API.
net.pricefx.server.dto	Typed records that describe price list items, product references and tiered values.
net.pricefx.server.dto.calculation	The objects a calculation logic returns to format, display or configure its results.
net.pricefx.server.dto.calculation.dashboard	Embedding one dashboard in another, so that the embedded one reacts to events.
net.pricefx.server.dto.calculation.notification	Sending notifications to users and user groups.
net.pricefx.server.protocol	A forward-only cursor over a query result.
net.pricefx.service	Summary queries that aggregate the items of a Simulation.
net.pricefx.workflowengine	The state of a document's approval workflow, as the user interface shows it.