PriceFX Accelerate Agents

https://knowledge.pricefx.com/
Admin
PriceFX Accelerate Agents is a suite of intelligent pricing and sales governance agents that detect...
Tokens:2,223,980
Snippets:37,006
Trust Score:9.8
Update:5 months ago
Show doc for...
Tokens:
Raw
### Minimal Optimization Engine Parameters

Source: https://knowledge.pricefx.com/configuration-engineer-knowledge-base/reference/optimization-reference/engines/optimization-engine/trigger-parameters-optimization-engine.md

This example shows the essential parameters required to start an Optimization Engine job. It includes the 'stop_condition' with 'max_steps' and the 'problem' description.

```Groovy
def oe_parameters = [
        stop_condition: [
                max_steps : 10000,
        ],
        problem : out.ProblemDescription,
]

```

--------------------------------

### Actual System Interaction Request Example

Source: https://knowledge.pricefx.com/integrationmanager-documentation/components/pfx-rest-component/methods/pfx-rest-system.md

Demonstrates the GET request made to the target system API after successful authentication, including the endpoint URL, authorization header, and other headers derived from the configuration.

```http
------------REQUEST--------------
>> GET https://pricefx.crm4.dynamics.com/api/data/v9.1
>> Headers: java.net.http.HttpHeaders@9ddcbccd { {Authorization=[Bearer eyJ...w1g], Content-Type=[application/json], OData-MaxVersion=[4.0], OData-Version=[4.0], Prefer=[return=representation]} }
>> Timeout: PT20S
>> Autodecode: false
>> disableStreamCache: false
```

--------------------------------

### Example Route for Getting Local Inventory

Source: https://knowledge.pricefx.com/integrationmanager-documentation/components/pfx-google-shopping-component/pfx-google-shopping-batch-localinventory.md

This example shows a complete Apache Camel route for getting local inventory from Google Shopping. It starts from 'direct:start', calls the batch endpoint, logs the response, and ends at 'mock:end'.

```xml
<route>
      <from uri="direct:start"/>
      <to uri="pfx-google-shopping:batch?entity=localinventory&amp;applicationName=pfx_test&amp;secretFileName=''' + fileWithKey.absolutePath + '''"/>
      <log message="${body}"/>
      <log message="Google shopping called!"/>
      <to uri="mock:end"/>
    </route>
```

--------------------------------

### Start the Application

Source: https://knowledge.pricefx.com/technical-delivery-roles/quality-assurance-knowledge-base-home/quality-assurance-at-pricefx-core-concepts-and-practices/qa-journey-in-pricefx/qa-methodology/qa-on-the-project/using-cypress/installation.md

Deploy the application locally by running 'npm start' in the terminal. This command typically builds and serves the application, making it accessible via a local URL.

```bash
npm start
```

--------------------------------

### Product Configuration Example

Source: https://knowledge.pricefx.com/accelerators-documentation-2/latest/accelerators/accelerate-insights-dashboards/technical-user-reference-insights-dashboards/architecture-components-insights-dashboards/insights-configuration-tables-insights-dashboards/parameter-tables-insights-dashboards/configurations-insights-dashboards.md

Example JSON structure for configuring product data, including source mapping and hierarchy definition.

```json
{
  "product": "ProductId",
  "sourceName": "DMDS.Product",
  "productHierarchy": [
    "BusinessUnit",
    "ProductGroup",
    "Brand",
    "Competitiveness",
    "SubProductGroup",
    "ProductLine"
  ],
  "productAttributes": [],
  "enableProductSource": true
}
```

--------------------------------

### GET Request Example

Source: https://knowledge.pricefx.com/technical-delivery-roles/integration-engineer-knowledge-base-home/features-integrationmanager/pricefx-custom-components/pfx-rest.md

This example demonstrates how to perform an HTTP GET request to an external API using the pfx-rest component. It utilizes a named connection for authentication and specifies the target URI.

```APIDOC
## GET /api/v1/products

### Description
Performs an HTTP GET request to retrieve product data from an external API.

### Method
GET

### Endpoint
pfx-rest:get?connection=myRestConn&uri=/api/v1/products

### Parameters
#### Query Parameters
- **connection** (string) - Required - The name of the pre-configured connection to use for authentication and base URL.
- **uri** (string) - Required - The specific endpoint path for the GET request.

### Request Example
```xml
<route id="restGet">
    <from uri="direct:fetchData"/>
    <to uri="pfx-rest:get?connection=myRestConn&amp;uri=/api/v1/products"/>
</route>
```

### Response
#### Success Response (200)
- The response body will contain the data returned by the external API, typically in JSON or XML format.
```

--------------------------------

### Fetch with SQL and Pagination Example

Source: https://knowledge.pricefx.com/integrationmanager-documentation/components/pfx-api-component/pfx-api-fetch.md

Demonstrates fetching data using an inline SQL query and applying pagination with `startRow` and `endRow` parameters.

```xml
<route>
        <from uri="direct:fetchFiltered"/>
        <to uri="pfx-api:fetch?objectType=P&amp;sql=SELECT sku, attribute1 WHERE attribute2 > 100 ORDER BY sku ASC&amp;startRow=0&amp;endRow=1000"/>
    </route>
```

--------------------------------

### Get Start Date for Rebates

Source: https://knowledge.pricefx.com/configuration-engineer-knowledge-base/how-to/rebates-howto/how-to-configure-rebates.md

Retrieves the start date entered by the user. This is a prerequisite for defining rebate periods.

```Groovy
DateUserEntry("StartDate")
```

--------------------------------

### Fetch with Distinct Results Example

Source: https://knowledge.pricefx.com/integrationmanager-documentation/components/pfx-api-component/pfx-api-fetch.md

Example of fetching only distinct values for a specified field, useful for getting unique entries.

```xml
<route>
        <from uri="direct:fetchDistinct"/>
        <to uri="pfx-api:fetch?objectType=P&amp;filter=myFilter&amp;valueFields=attribute1&amp;distinctResults=true"/>
    </route>
```

--------------------------------

### Get Help with Packaging Tool

Source: https://knowledge.pricefx.com/configuration-engineer-knowledge-base/tools/packaging-tool/quick-start-with-packaging-tool.md

Run the tool without any arguments to display the help message and available commands.

```bash
pfxpackage
```

--------------------------------

### Page Configuration Example

Source: https://knowledge.pricefx.com/configuration-engineer-knowledge-base/reference/internal-linking-reference/contextual-action-button.md

Example of how to configure the 'page' field to display the button on specific pages.

```JSON
"page": ["dashboardPage", "actionPage"]
```

--------------------------------

### pfx-rest GET Request Example

Source: https://knowledge.pricefx.com/integrationmanager-documentation/components/pfx-rest-component.md

This route performs an HTTP GET to a specified URI using a named connection for base URL and authentication.

```xml
<route id="restGet">
        <from uri="direct:fetchData"/>
        <to uri="pfx-rest:get?connection=myRestConn&amp;uri=/api/v1/products"/>
    </route>
```

--------------------------------

### Example JSON API Response

Source: https://knowledge.pricefx.com/technical-delivery-roles/quality-assurance-knowledge-base-home/quality-assurance-at-pricefx-core-concepts-and-practices/qa-test-automation/automation-types/cypress-end-to-end-tests/api-testing-with-cypress.md

This is an example of a JSON response from a Pricefx API GET request, detailing a lookup table's properties.

```json
{
    "typedid": "IM.LI",
    "label": "Di6 - Sales Region Mapping",
    "validafter": "2000-08-01",
    "status": "ACTIVE",
    "simulationSet": null,
    "valuetype": "**szsz**",
    "userregedit": "o16 (dit)"
}
```

--------------------------------

### Fetching with SQL and Pagination Example

Source: https://knowledge.pricefx.com/integrationmanager-documentation/components/pfx-api-component/pfx-api-fetch.md

An example route showing how to fetch data using an inline SQL query and specifying pagination parameters.

```APIDOC
## Fetch with SQL and Pagination Example

### Description
Fetches data using an inline SQL query and applies pagination.

### Method
N/A (Component URI)

### Endpoint
pfx-api:fetch?objectType=P&sql=SELECT sku, attribute1 WHERE attribute2 > 100 ORDER BY sku ASC&startRow=0&endRow=1000

### Parameters
#### Query Parameters
- **objectType** (string) - Required - The type of object to fetch.
- **sql** (string) - Required - The SQL-like query string.
- **startRow** (integer) - Optional - The starting row index for pagination.
- **endRow** (integer) - Optional - The ending row index for pagination.
```

--------------------------------

### Install Maven on Windows

Source: https://knowledge.pricefx.com/integrationmanager-documentation/integration-engineer-s-cookbook/prerequisites-for-developing-on-local-machines/install-maven-and-add-pricefx-repository.md

Instructions for downloading, extracting, and setting up Maven on a Windows machine. This includes setting environment variables for Maven.

```powershell
$mavenUrl = "https://dlcdn.apache.org/maven/maven-3/3.9.6/binaries/apache-maven-3.9.6-bin.zip"
$downloadPath = "C:\\Program Files\\apache-maven-3.9.6-bin.zip"
$extractPath = "C:\\Program Files\\apache-maven-3.9.6"

Invoke-WebRequest -Uri $mavenUrl -OutFile $downloadPath
Expand-Archive -Path $downloadPath -DestinationPath "C:\\Program Files\\"

# Set environment variables
[System.Environment]::SetEnvironmentVariable("MAVEN_HOME", $extractPath, [System.EnvironmentVariableTarget]::Machine)
[System.Environment]::SetEnvironmentVariable("PATH", $env:PATH + ";" + $extractPath + "\\bin", [System.EnvironmentVariableTarget]::Machine)

# Verify installation
Write-Host "Maven installation verified:"
mvn -version
```

--------------------------------

### Get Item Start Date

Source: https://knowledge.pricefx.com/configuration-engineer-knowledge-base/how-to/rebates-howto/how-to-configure-rebates.md

Retrieves the start date from the current item, parsing it into a Date object. Defaults to the current date if not found.

```Groovy
return (api.currentItem()?.startDate) ? api.parseDate("yyyy-MM-dd",api.currentItem().startDate) : new Date()
```

--------------------------------

### Example: Advanced Optimization Engine Parameters

Source: https://knowledge.pricefx.com/configuration-engineer-knowledge-base/reference/optimization-reference/engines/optimization-engine/trigger-parameters-optimization-engine.md

This example demonstrates how to configure advanced parameters for the Optimization Engine, including execution mode, criticality profiling, and output prefix.

```Groovy
[ 
        stop_condition: [
                max_steps        : maxSteps,
                disable_auto_stop: !autoStop,
        ] + (maxDurationMinutes != null && maxDurationMinutes > 0 ? [max_duration: "PT${maxDurationMinutes}M"] : [:]),
        problem       : problem,
        advanced      : [
                execution_mode: "optimization",
                profiling     : [
                        criticality : [
                                enabled     : true,
                                flushPeriod : advancedParameters.CriticalityProfilingFlushPeriod as Integer,
                                samplePeriod: advancedParameters.CriticalityProfilingSamplePeriod as Integer,
                        ]
                ],
                io            : [
                        outputsPrefix: optim.OPTIMIZATION_OUTPUTS_PREFIX,
                ],
        ]
]
```

--------------------------------

### Get NotificationApi Object

Source: https://knowledge.pricefx.com/configuration-engineer-knowledge-base/reference/cross-enterprise/notifications/notifications-technical-user-reference.md

How to obtain the NotificationApi object to start building notifications.

```APIDOC
## Get NotificationApi Object

### Description
Obtain the `NotificationApi` object to initiate the process of creating and sending notifications. This object provides a builder-like pattern.

### Method
```java
api.notificationApi()
```

Refer to the Java documentation for more details: <https://developer.pricefx.eu/pricefx-api/groovy/master/net/pricefx/server/dto/calculation/notification/NotificationApi.html>
```

--------------------------------

### Example Maven Settings File (PFX Employee)

Source: https://knowledge.pricefx.com/integrationmanager-documentation/integration-engineer-s-cookbook/prerequisites-for-developing-on-local-machines/install-maven-and-add-pricefx-repository.md

A complete example of a Maven settings.xml file for Pricefx employees, including server credentials and repository configurations for default, SmartGWT, and Pricefx internal repositories.

```xml
<?xml version="1.0"?>
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
    	<servers>
		<server>
			<id>Pricefx maven artifacts</id>
			<username>your_username</username>
			<password>your_password</password>
		</server>
		<server>
			<id>pricefx.internal</id>
			<username>your_username</username>
			<password>your_password</password>
		</server>
	</servers>
    <profiles>
        <profile>
            <id>default</id>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
            <repositories>
                <repository>
                    <id>Default repo</id>
                    <url>http://repo1.maven.org/maven2</url>
                    <snapshots>
                        <enabled>false</enabled>
                    </snapshots>
                    <releases>
                        <enabled>true</enabled>
                    </releases>
                </repository>
                <repository>
                    <id>SmartGWT official repo</id>
                    <url>http://www.smartclient.com/maven2</url>
                    <snapshots>
                        <enabled>false</enabled>
                    </snapshots>
                    <releases>
                        <enabled>true</enabled>
                    </releases>
                </repository>
                <repository>
                    <id>pricefx.internal</id>
                    <url>https://maven.pricefx.eu</url>
                    <snapshots>
                        <enabled>true</enabled>
                    </snapshots>
                    <releases>
                        <enabled>true</enabled>
                    </releases>

```

--------------------------------

### Get NotificationApi Object

Source: https://knowledge.pricefx.com/configuration-engineer-knowledge-base/reference/cross-enterprise/notifications/notifications-technical-user-reference.md

Obtain the NotificationApi object to start building notifications. This is the entry point for all notification-related operations.

```java
api.notificationApi()
```

--------------------------------

### Get Local Inventory

Source: https://knowledge.pricefx.com/integrationmanager-documentation/components/pfx-google-shopping-component/pfx-google-shopping-batch-localinventory.md

This example demonstrates how to retrieve local inventory data by calling the `pfx-google-shopping:batch` endpoint with the `entity` set to `localinventory`.

```APIDOC
## Get Local Inventory

### Description
Retrieves local inventory data.

### Method
POST (implied by the use of `<to uri="pfx-google-shopping:batch?..."/>` which typically involves sending data in the body)

### Endpoint
pfx-google-shopping:batch

### Parameters
#### Query Parameters
- **entity** (string) - Required - Must be set to `localinventory`.
- **applicationName** (string) - Optional - Application name for Google Shopping API.
- **secretFileName** (string) - Optional - Name of a file which contains secrets for authentication.

### Request Body
(The request body is expected to contain the inventory data, often processed by a Groovy script as shown in the deprecation notice example.)

### Request Example
```xml
<setBody>
	<groovy>[entries: body]</groovy>
</setBody>
<to uri="pfx-google-shopping:batch?entity=localinventory&amp;applicationName={{google.api.ie.appName}}&amp;secretFileName={{google.api.ie.secretFileName}}"/>
```

### Response
#### Success Response (200)
- **body** (string) - The response body containing the result of the local inventory retrieval.

#### Response Example
```xml
<log message="${body}"/>
```
```

--------------------------------

### Navigate to Project Folder

Source: https://knowledge.pricefx.com/technical-delivery-roles/quality-assurance-knowledge-base-home/quality-assurance-at-pricefx-core-concepts-and-practices/qa-journey-in-pricefx/qa-methodology/qa-on-the-project/using-cypress/installation.md

Use the 'cd' command to navigate into the specific project folder you created.

```bash
cd GITRepo
```

--------------------------------

### Configure External JWT Authentication

Source: https://knowledge.pricefx.com/pricefx-unity-documentation/administration-and-data-setup/administration/configuration/advanced-configuration-options/advanced-configuration-options-full-list.md

Configures authentication via an external JSON web token. Refer to the linked guide for detailed setup instructions.

```json
{
  "externalJWTConfiguration": {
    "enabled": true,
    "issuer": "your_issuer_here",
    "audience": "your_audience_here",
    "jwkUrl": "your_jwk_url_here"
  }
}
```

--------------------------------

### Basic Insert

Source: https://knowledge.pricefx.com/integrationmanager-documentation/components/pfx-sql-component/pfx-sql-insert.md

This example demonstrates a basic insert operation into the 'products' table using the 'myDb' data source. It fetches data using 'pfx-api:fetch' and then inserts it.

```APIDOC
## pfx-sql:insert

### Description
Inserts data into a specified SQL table.

### Method
POST (implied by the nature of insert operations and the component's design)

### Endpoint
pfx-sql:insert?table=products&dataSource=myDb

### Parameters
#### Query Parameters
- **table** (String) - Required - Target database table.
- **dataSource** (String) - Optional - Name of the Spring DataSource bean. Defaults to 'dataSource'.

### Request Example
```xml
<route id="insertToDb">
    <from uri="timer://export?repeatCount=1"/>
    <to uri="pfx-api:fetch?objectType=P&amp;filter=allProducts"/>
    <to uri="pfx-sql:insert?table=products&amp;dataSource=myDb"/>
</route>
```

### Response
(Details not provided in source, typically indicates success or failure of the insert operation)
```

--------------------------------

### Initialize Project with NPM

Source: https://knowledge.pricefx.com/technical-delivery-roles/quality-assurance-knowledge-base-home/quality-assurance-at-pricefx-core-concepts-and-practices/qa-test-automation/onboarding-with-cypress.md

Use this command to initialize a new Node.js project if one does not exist. This is a prerequisite for installing Cypress with npm.

```bash
npm init -y
```

--------------------------------

### Query Elasticity Table Names

Source: https://knowledge.pricefx.com/accelerators-documentation-2/latest/accelerators/multifactor-elasticity-accelerator/technical-user-reference-optimization-multifactor-elasticity.md

This example shows how to use the `query_results` evaluation type to get the names of the output tables for elasticity factors and fallback elasticities.

```APIDOC
## Query Elasticity Table Names

### Description
Retrieves the names of the tables that store elasticity factor data and fallback elasticity data.

### Method
`evaluate`

### Parameters
- `type`: (string) - Required - Specifies the type of information to query. Use 'elasticity' to get table names.

### Request Example
```groovy
api.model("myModel").evaluate("query_results", ['type':'elasticity'])
```

### Response
#### Success Response
- **ElasticityFactorsTableName** (string) - The name of the table containing elasticity curve parameter data.
- **ElasticityFallbackTableName** (string) - The name of the table containing fallback elasticity data.
```

--------------------------------

### Fetching All Products Example

Source: https://knowledge.pricefx.com/integrationmanager-documentation/components/pfx-api-component/pfx-api-fetch.md

An example route demonstrating how to fetch all products using a named filter bean.

```APIDOC
## Fetch All Products Example

### Description
This route fetches all products using the `pfx-api:fetch` component with a predefined filter.

### Method
N/A (Component URI)

### Endpoint
pfx-api:fetch?objectType=P&filter=allProductsFilter
```

--------------------------------

### Batch Read with Inline Count

Source: https://knowledge.pricefx.com/integrationmanager-documentation/components/pfx-odata2-component/pfx-odata2-read.md

This example demonstrates how to perform a batch read operation, fetching entities in batches and utilizing the '$inlinecount=allpages' option to get the total count.

```APIDOC
## pfx-odata2://read Batch Read with Inline Count

### Description
Performs a batch read of entities, retrieving the total count of records using '$inlinecount=allpages' and then processing records in batches.

### Method
GET (implied by odata2://read)

### Endpoint
pfx-odata2://read

### Query Parameters
- **entity** (string) - Required - The entity to read from.
- **$skip** (integer) - Required for batching - The number of records to skip for the current batch.
- **$top** (integer) - Required for batching - The number of records to retrieve per batch.
- **$inlinecount** (string) - Optional - Set to 'allpages' to include the total count of records.
- **connection** (string) - Required - The connection alias to use.

### Request Example (Initial Count)
```xml
<to uri="pfx-odata2://read?entity=A_CreditMemoRequest&$skip=0&$top=0&$inlinecount=allpages&connection=cognitus"/>
```

### Request Example (Batch Processing)
```xml
<setHeader headerName="$top"><constant>4</constant></setHeader>
<setHeader headerName="$skip"><groovy>exchange.getProperty('CamelLoopIndex', 0, Integer) * headers.$top.toInteger()</groovy></setHeader>
<to uri="pfx-odata2://read?entity=A_CreditMemoRequest&connection=cognitus"/>
```

### Response
#### Success Response (200)
- **PfxOpenData2.$inlinecount** (integer) - The total number of records available (when $inlinecount=allpages is used).
- **body** (array) - An array of entity records for the current batch.
```

--------------------------------

### Loading a Resource with Options

Source: https://knowledge.pricefx.com/integrationmanager-documentation/components/pfx-resources-component/pfx-resources-load.md

This example demonstrates loading a resource named 'schema' and setting the output to the exchange header.

```APIDOC
## pfx-resources:load

### Description
Loads a selected resource in the exchange body or header so that it can be used in other components.

### Method
POST (inferred from 'to' usage in Camel)

### Endpoint
pfx-resources:load

### Parameters
#### Query Parameters
- **name** (string) - Required - Name of the resource to load.
- **setToHeader** (boolean) - Optional - Determines whether to put the output value to the exchange header ('pfx-resources-data-output') or not. Defaults to false.

### Request Example
```xml
<route>
  <from uri="direct:test4"/>
  <to uri="pfx-resources:load?name=schema&amp;setToHeader=true"/>
  <to uri="mock:result4"/>
</route>
```

### Response
#### Success Response (200)
- The loaded resource data, either in the exchange body or header depending on `setToHeader`.
```

--------------------------------

### Check for Pricefx Deployment Templates

Source: https://knowledge.pricefx.com/configuration-engineer-knowledge-base/guides/accelerate-agents/configuration-guide/7-enable-auto-deployment-of-component-folders.md

Verify if your `.gitlab-ci.yml` file includes the Pricefx deployment templates. If it starts with these lines, component folders are already auto-deployed, and you can skip this guide.

```yaml
include:
  - project: 'public-tools/build-templates'
```

--------------------------------

### Get Multi-line Text Input in Input Generation Mode (Groovy)

Source: https://knowledge.pricefx.com/configuration-engineer-knowledge-base/quick-reference/user-inputs-quick-reference/text.md

Retrieves a multi-line text input configuration during input generation. This is useful for dynamic input setup.

```Groovy
api.inputBuilderFactory()
            .createTextUserEntry('text', )
            .getInput()
```

--------------------------------

### Install Maven on Linux/macOS

Source: https://knowledge.pricefx.com/integrationmanager-documentation/integration-engineer-s-cookbook/prerequisites-for-developing-on-local-machines/install-maven-and-add-pricefx-repository.md

Follow these steps to download, extract, and configure Maven on Unix-like systems. Ensure you set up the necessary environment variables.

```bash
wget https://dlcdn.apache.org/maven/maven-3/3.9.6/binaries/apache-maven-3.9.6-bin.zip
unzip apache-maven-3.9.6-bin.zip
sudo mv apache-maven-3.9.6 /opt/maven
sudo ln -s /opt/maven/bin/mvn /usr/local/bin/mvn
export MAVEN_HOME=/opt/maven
export PATH=$MAVEN_HOME/bin:$PATH
```
Tokens:
Raw