Advanced Configuration Options - Full List

This section lists Advanced Configuration Options (also referred to as application properties) which you can use in Configuration.

You can sort this table either by Category (to see all options related to a specific area) or by Option (if you want to have the options listed alphabetically).

Category

Option

UI

Values

Description

Sales Compensation

activityLogCleanUpLastRunCompensation

datetime

A timestamp of the last run of the system job that deletes out-of-date events from the Activity Logs of Compensation Plan objects. The job runs automatically once a day and deletes UPDATE and UPDATE_INPUT type log entries from Compensation Plans whose lastUpdateDate is older than the number of days set in activityLogRetentionIntervalDaysCompensation. The purpose of the timestamp is that the job can skip Compensation Plans that haven’t been updated between the timestamp and the end of the retention interval because that logs have already been deleted. If this option is missing, all Compensation Plans unchanged for more than the retention interval are checked.

Agreements & Promotions

activityLogCleanUpLastRunContract

datetime

A timestamp of the last run of the system job that deletes out-of-date events from the Activity Logs of Agreements & Promotion objects. The job runs automatically once a day and deletes UPDATE and UPDATE_INPUT log entries from Agreements/Promotions whose lastUpdateDate is older than the number of days set in activityLogRetentionIntervalDaysContract. The purpose of the timestamp is that the job can skip Agreements/Promotions between the timestamp and the end of the retention interval because that logs have already been deleted. If this option is missing, all Agreements/Promotions unchanged for more than the retention interval are checked.

Quotes

activityLogCleanUpLastRunQuote

datetime

A timestamp of the last run of the system job that deletes out-of-date events from the Activity Logs of Quote objects. The job runs automatically once a day and deletes UPDATE and UPDATE_INPUT log entries from Quotes whose lastUpdateDate is older than the number of days set in activityLogRetentionIntervalDaysQuote. The purpose of the timestamp is that the job can skip Quotes between the timestamp and the end of the retention interval because that logs have already been deleted. If this option is missing, all Quotes unchanged for more than the retention interval are checked.

Rebates

activityLogCleanUpLastRunRebateAgreement

datetime

A timestamp of the last run of the system job that deletes out-of-date events from the Activity Logs of Rebate Agreement objects. The job runs automatically once a day and deletes UPDATE and UPDATE_INPUT log entries from Rebate Agreements whose lastUpdateDate is older than the number of days set in activityLogRetentionIntervalDaysRebateAgreement. The purpose of the timestamp is that the job can skip Rebate Agreements between the timestamp and the end of the retention interval because that logs have already been deleted. If this option is missing, all Rebate Agreements unchanged for more than the retention interval are checked.

Sales Compensation

activityLogRetentionIntervalDaysCompensation

number

Sets the number of days after which, if the Compensation Plan hasn’t been changed (time that has elapsed from lastUpdateDate), the activity log is cleaned up. The default value is 30.

Agreements & Promotions

activityLogRetentionIntervalDaysContract

number

Sets the number of days after which, if the Agreement/Promotion hasn’t been changed (time that has elapsed from lastUpdateDate), the activity log is cleaned up. The default value is 30.

Quotes

activityLogRetentionIntervalDaysQuote

number

Sets the number of days after which, if the Quote hasn’t been changed (time that has elapsed from lastUpdateDate), the activity log is cleaned up. The default value is 30.

Rebates

activityLogRetentionIntervalDaysRebateAgreement

number

Sets the number of days after which, if the Rebate Agreement hasn’t been changed (time that has elapsed from lastUpdateDate), the activity log is cleaned up. The default value is 30.

Miscellaneous

advancedDeleteConfirmationDialogThreshold

number

(Used in the Classic UI, now deprecated) Enables a safer 'Confirm delete' dialog where users confirm the deletion of a given number of items.

Miscellaneous

advancedFilterComboboxDisableAutosuggest

true / false

Allows you to switch off autocomplete behavior in filters. See How to Disable Autocomplete When Entering Values in Advanced Filters.

Price Grids

allowAutoDeletionOfSubmittedPGI

true / false

Allows you to have PGIs in Submitted status auto deleted when the corresponding product is no longer eligible for the LPG (as per the dynamic item filter criteria).

Quotes

allowConversionOfExpired

Configuration > Quoting General Settings

true / false

If set to true, you can convert a Quote to Deal when it is expired. See Quoting General Settings.

Entitlement

allowedLengthOfGroupsSelectionForOX

number

For PX and CX, there is a limit of 255 characters for user group strings combined together. If you need to select more user groups and/or they have very long names, use this option which specifies the maximum allowed group string length. 

Live Price Grids

allowLPGSubmitWithCritialAlert

true

Since 15.0 Live Price Grids cannot be submitted for approval if there is a critical alert on any row. If this option is set to true, Live Price Grids with critical errors are allowed to be submitted as before 15.0.

Note: Use this option only when you want to enable this functionality (value true). If you decide not use this functionality anymore, delete this option rather than setting it to false.

Price Grids

allowPGIFieldTypeChange

LPG setup > Parameters

true / false

If set to true, a column type in LPG can be changed. This is a global setting but it can also be set individually for each LPG. See How to Create and Configure New LPG.

Price Lists

allowPLSubmitWithCriticalAlert

true

Since 12.0 Price Lists cannot be submitted for approval if there is a critical alert on any row. If this option is set to true, Price Lists with critical errors are allowed to be submitted as before 12.0.

Note: Use this option only when you want to enable this functionality (value true). If you decide not use this functionality anymore, delete this option rather than setting it to false.

Calculations

allowSandboxLogging

true / false

If set to true, api.loginfo output is put into logs. See Logging and Debugging.

Backend

allowTrackingBE


true / false

If set to true, the backend login event is sent to Mixpanel in non-prod clusters.

Home page

alwaysShowMyPendingApprovals 

true / false

Shows the My Pending Approvals section on the Home page even if it is empty. See How to Make Home Panels Always Visible.

Home page

alwaysShowMyPendingCreationWorkflows

true / false

Shows the My Pending Creation Workflows section on the Home page even if it is empty. See How to Make Home Panels Always Visible.

Home page

alwaysShowMyToDos

true / false

Shows the My ToDo List section on the Home page even if it is empty. See How to Make Home Panels Always Visible.

Backend

asyncSubmitDCRThreshold

number

Sets the threshold (number of rows) from which a Data Change Request is submitted asynchronously. Enter 0 to force asynchronous submit for all DCRs. The default value is 100, meaning that DCRs with 100 or more changed rows are submitted asynchronously.

Backend

asyncSubmitRRGThreshold

number

Sets the threshold (number of Rebate Records in a group) from which a Rebate Record group is submitted asynchronously. The default value is 10, meaning that groups with 10 or more records are submitted asynchronously. Negative or zero value means that the submit is always asynchronous. If this option is not set, the submit is always synchronous.

Calculation

autoAlignResults

Configuration > General Settings

true / false

If enabled, results in the Calculation Results table are aligned depending on data type (money, number percentage to the right, text to the left).

If disabled (default), all results are aligned to the left.

Quotes

autoConvertQuotes 

Configuration > Quoting General Settings

true / false

Enables auto-conversion of a Quote from Offer to Deal.

Price Parameters

autogenerateKeysInPP 

true / false

Adds a unique ID to Price Parameters. See How to Assign a Unique Autogenerated ID to Price Parameters.

Price Lists, Price Grids

autoGroupCalculationResultsInDetailsView

true / false

Groups results by the Result Group in Calculation Details. See How to Group Calculation Results.

PX, CX, SX

autoLoadOX

Configuration > General Settings

true / false

If disabled, the Product / Customer / Seller Extension tables are not populated with data automatically after you open them but only after you click the Refresh icon.

Compensations

automaticallySelectAddedItemCompensations

Configuration > Sales Compensation General Settings

true / false

If set to true, a single line item added to the Compensation Plan will be automatically selected and all other currently selected items will be deselected. This only applies if the added item is added on the currently displayed page (in the case when the table has several pages). See Sales Compensation General Settings.

Price Lists

availableWorkStatus

Configuration > Agreements & Promotions Configuration

string

Defines your own values to represent work status. See Work Status Options.

Miscellaneous

baseUrl

Configuration > General Settings

string

Sets the base URL prefix under which this instance is reachable from the Internet. See General Settings.

CLIC

boschS3Warning

true / false

When set to true, the application shows a red Bosch-specific error message (instead of a broken link or generic error) if an attachment referenced by the shared attachment component cannot be found in the S3 bucket; the download request returns HTTP 400 in this case.

CLIC

boschS3WarningText

string

Optional. Custom text of the Bosch-specific error message displayed when boschS3Warning = true and the attachment file is missing in S3. If this property is empty, the fallback message "Please specify error message text in 'boschS3WarningText' property" is shown.

Quotes

calculableExcelExportUseStreamingWorkbook

true / false

If set to true, streaming export for quotes is enabled. By default it is disabled.

Price Lists

calculableObjectPreferredMapping

Configuration > Price Setting > Defaults for Price Lists and LPGs


Sets mapping between element names and attribute numbers. See Defaults for Price Lists and LPGs.

Sales Compensations

calculateNewCOImmediately

Configuration > Sales Compensation General Settings

true / false

If set to true, the Compensation Plan’s header logic is executed right after the Compensation is created (i.e., before the user can see it). See Sales Compensation General Settings.

Agreements & Promotions

calculateNewContractImmediately

Configuration > Agreements & Promotions General Settings

true / false

If set to true, the Agreement/Promotion's header logic is executed right after the Agreement/Promotion is created (i.e., before the user can see it). See Agreements & Promotions General Settings.

Quotes

calculateNewQuoteImmediately

Configuration > Quoting General Settings

true / false

If set to true, the Quote's header logic is executed right after the Quote is created (i.e., before the user can see it). See Quoting General Settings.

Rebate Agreements

calculateNewRBAImmediately

Configuration > Rebates General Settings

true / false

If set to true, the Rebate Agreement's header logic is executed right after the Rebate Agreement is created (i.e., before the user can see it). See Rebates General Settings.

Analytics

calendarFirstDayOfWeek

Configuration > Analytics > Analytics General Settings > First day of the week

1-7 (where 1 is Sunday and 7 is Saturday)

Sets the first day of the week for Calendar in the Analytics module. See Analytics General Setting.

Analytics

calendarMinimalDaysInFirstWeek

Configuration > Analytics General Settings

1..7

Sets the minimum number of days in the first week of the year to align calendar week numbering with Outlook and ISO 8601 standards. This value is used to mark the first fiscal week of the year in the Calendar DS. After setting the value, the Calendar DL must be executed. Afterwards, any REFRESH DL will use the updated calendar.

Analytics

queryApiUseDeprecatedPbOnlyV14

true / false

⚠️ Removed in version 16.0.

If set to true the QueryAPI functionality will be disabled in the Analytics module.

Charts

chartBandByColors


Defines the Band by color (available for Bubble and Scatter charts).

Charts

chartEmbeddedBoxplotSeriesColor

Configuration > Analytics > General Chart Settings


Defines a color for all Box Plot series which get embedded in another series. See General Chart Settings.

Charts

chartExceedThreshold

Configuration > Analytics > General Chart Settings

number

Defines the boost mode threshold for Highcharts. If the number of data points is higher than this value, the boost mode will be triggered to ensure good UI performance. As a consequence, some features, such as drilldown or exclude, will not be supported. Additionally, a warning message will be displayed on the screen to inform the user about this fact. The default value is 5000. See General Chart Settings.

Charts

chartHeatmapColors

Configuration > Analytics > General Chart Settings


Defines the min and max colors for the interpolated color axis in Heatmap charts. See General Chart Settings.

Charts

chartHighchartsTheme

Configuration > Analytics > General Chart Settings


Sets a global Highcharts theme definition which customizes fonts, colors and other rendering options. See General Chart Settings.

Charts

chartSeriesColors

Configuration > Analytics > General Chart Settings


Defines default colors for the chart's series. See General Chart Settings.

Charts

chartUseUTC

Configuration > Analytics > General Chart Settings

true / false

If set to true, the UTC time is used for axis scaling. See General Chart Settings.

Charts

chartWaterfallSeriesColors

Configuration > Analytics > General Chart Settings


Defines colors for the waterfall or waterfall comparison charts series. See General Chart Settings.

Claims

claimCreateFromContractLogic

Configuration > Channel Management

name of logic

Allows you to select a logic (of the Claim nature) that will populate a newly created Claim with data. See Channel Management Configuration.

Claims

claimCreateFromQuoteLogic

Configuration > Channel Management

name of logic

Allows you to select a logic (of the Claim nature) that will populate a newly created Claim with data. See Channel Management Configuration.

Claims

claimPrefix

string

Sets the Claims prefix in their name. The default is CL.

Approval Workflow

clicWorkflowByTargetDate

Configuration > General Settings

true / false

Determines the workflow logic validity date based on the item effective date. See General Settings.

Miscellaneous

cloudConvertToken 

Configuration > External Systems > CloudConvert


Token has to be added on the system partition level by Support/Ops to enable the PDF exports. See CloudConvert.

Miscellaneous

cloudConvertTokenUsageAgreed

Configuration > External Systems > CloudConvert

true / false

Shows if the CloudConvert service has been enabled for the partition. See CloudConvert.

Miscellaneous

clusterCacheKey

text

Can be used to have the same shared cache for two different partitions on the same cluster (both keys need to be specified the same) if those generated automatically by the system are deleted.

Miscellaneous

clusterKVKey


text

Similarly to clusterCacheKey, this setting allows for different partitions having access to the same KV store data.

Price Lists, Price Grids

commentHistory

Configuration > General Settings

true / false

If set to true, history of comments in Price Lists, Manual Price Lists and Live Price Grids is captured and displayed in the product details screen Comment History. See General Settings.

Analytics

commitTransactionBeforeDataLoad

true / false

If set to true, it changes the Analytics Calculation Data Load flow so that the transaction is committed before the Data Load runs, avoiding idle-in-transaction timeouts during long-running calculations.

Available from versions 15.3.14 and 16.1.1 and it is disabled by default; from version 17.0 it is always applied.

Sales Compensations

compensationAsyncThreshold


number

Sets the threshold (number of line items) from which a Compensation Plan is submitted, recalculated etc. asynchronously. Enter 0 to force asynchronous submit for all Compensation Plans. The default value is 100, meaning that Compensation Plans with 100 or more changed lines are submitted asynchronously. See Sales Compensation General Settings.

Sales Compensations

compensationPrefix

string

Sets the Compensation Plan’s prefix in their name. The default is CO.

Sales Compensations

compensationRecordPrefix

string

Sets the Compensation Record’s prefix in their name. The default is COR.

Sales Compensations

compensationRevisionFormat


string

Sets the format of document revision ID. The default is: $uniqueName$-REV-$revId$

Condion Records

conditionRecordLogicsWhenNoWorkflowDefined

-

JSON definition

The conditionRecordLogicsWhenNoWorkflowDefined is a map that specifies Condition Record Logic names for different entities. See Condition Records (Reference).

Miscellaneous

configuratorShowProgress

Configuration > General Settings

true / false

If set to true, it shows progress in a Configurator when it is recalculated. See General Settings.

Agreements & Promotions

contractAsyncThreshold

Configuration > Agreements & Promotions General Settings

number

Sets the number of Agreement/Promotion line items from which actions (submit, recalculate, etc.) are run asynchronously. Enter "0" to force asynchronous mode in all cases. The default value is 100, meaning that Agreements/Promotions with 100 or more changed lines are submitted asynchronously. See Agreements & Promotions General Settings.

Agreements & Promotions

contractPrefix

string

Sets the Agreement/Promotion's prefix in their name. The default is C.

Agreements & Promotions

contractRevisionFormat

string

Allows you to add a string of your choice between the Agreement/Promotion's unique name and the revision number.

The default value of this option is $uniqueName$-REV-$revId$.

Agreements & Promotions

contractsMassUpdateTemplates

Configuration > Agreement & Promotion Mass Update Templates

JSON definition

Defines templates for Agreement/Promotion mass update jobs. See Agreement & Promotion Mass Update Templates.

Quotes

copyCLICAttachments

true / false

If set to true, attachments are copied when duplicating a Quote. By default this is switched off. 

warning Deprecated since version 16.0. Use a JSON configuration parameter instead.

Analytics

copyLastUpdateDateOnFlush

true / false

Copies the last update date on flush to Data Source or Datamart.

Analytics

copyLastUpdateDateOnRefresh

true / false

Copies the last update date on refresh to Data Source or Datamart.

Miscellaneous

crm_config


JSON definition

Stores partition specific setup of Feature Flags. These values overrides the application default ones.

Miscellaneous

customerextension 

Configuration > Master Data

name of CX

Defines available customer extensions. See Customer Master Extensions.

warning  Do not edit directly.

Product

customerqueries

Classic: Configuration > PriceBuilder


Obsolete. Defines what customer related data from Analytics can be displayed in Product Detail View.

warning  Do not edit directly.

Miscellaneous

customerQueryCharts

Configuration > Product/Customer Detail View

JSON definition

Allows you to create a chart definition and thus to display data from Analytics as a portlet in the Customer Detail View. See Customer Query Chart Definition.

Custom Form

customFormPrefix

string

Sets the Custom Form’s prefix in their name. The default is CFO.


customFormRevisionFormat

string

Allows you to add a string of your choice between the Custom Form unique name and the revision number.

The default value of this option is $uniqueName$-REV-$revId$.

Custom Form

customFormUseMultiTabDocuments


true / false

If set to true, the Documents dynamic tab in Custom Forms behaves the same way in 12.0 as it did in 11.3, i.e., it contains two sub-tabs, Specific and Files. If set to false (or null), the Documents tab contains only the Files sub-tab.

This option is set to true during upgrade to 12.0 if there is an already existing configuration using the Documents dynamic tab in Custom Forms.

Miscellaneous

customSMTP

Configuration > External Systems


Stores the definition of connection to a SMTP server used for sending emails from Quotes, Agreements/Promotions and Rebate Agreements.

warning Do not edit the SMTP configuration here but use the SMTP Configuration page instead!

Master data

datasourceOptionsFetchLimit 

number

When using the option 'Restrict values by Data Source', you can configure how many items are displayed by default in a drop-down menu of such column. The default is 10 000. See Customize Columns.

warning  Not supported in Unity.

Miscellaneous

daysBeforeSendingPasswordExpirationEmailNotification 

Configuration > General Settings

number

Allows you to change the number of days before the expiry date when the email is sent. The default is 5 days. See General Settings.

DCR

dcrPrefix

string

Sets the Data Change Requests prefix in their name. The default is DCR.

Deal Plans (deprecated)

dealPlanPrefix

string

Sets the Deal Plans prefix in their name. The default is DP.

Deal Plans (deprecated)

dealPlanRoundPrefix

string

Sets the Deal Plan Rounds prefix in their name. The default is Round.

Miscellaneous

decoupleOX

Configuration > General Settings

true / false

Enables you to make product and customer extensions configuration independent from product and customer records. See General Settings.

Actions

defaultAITHeaderFormula

Configuration > Logics > Calculation Logic > Actions

name of logic

Defines a logic (of the nature actionItem) which is used for the default ActionItemType (for the field formulaName) when this default ActionItemType is created. This is can be used for migration from a Pricefx version without Action Items to version with Action Items.

Sales Compensations

defaultCOHeaderFormula

Configuration > Logics > Calculation Logic > Sales Compensation

name of logic

Defines a default calculation logic used at the compensation header level. See Compensation Plans Header Logics.

Sales Compensations

defaultCompensationTypeFilterFormula

Administration > Logics > Filter Logics > Compensation Plans - Condition Types

name of logic

Defines a default Condition Filter logic to be used for Compensation Plan when there is no such logic is defined for Compensation Plan Type.

Agreements & Promotions

defaultContractHeaderFormula

Administration > Logics > Header Logics

name of logic

Defines a calculation logic used at the contract header level. See Agreements & Promotions Header Logics.

Price Lists

defaultFormula

Administration > Logics > Generic Logic

name of logic

Defines a generic calculation logic. For details see Generic Logic.

Entitlement

defaultGroups

Configuration > Entitlements

JSON definition

Sets which objects will be assigned the same default user groups as the creator has. See Entitlements. Example:

JSON
{
    "quote" : true, 
    "contract" : true, 
    "rebateAgreement" : true, 
    "compensation" : false,
    "pricelist" : true, 
    "manualPricelist" : true, 
    "priceGrid" : false, 
    "simulation" : false, 
    "lookupTable" : false, 
    "dataChangeRequest" : false
}

Price Grids

defaultPGFormula

Configuration > Price Setting > Defaults for Price Lists and LPGs

name of logic

Defines a default calculation logic used for LPGs. See Defaults for Price Lists and LPGs.

Price Lists

defaultPLFormula

Configuration > Price Setting > Defaults for Price Lists and LPGs

name of logic

Defines a default logic used for Price Lists. See Defaults for Price Lists and LPGs.

Price Lists

defaultPLPreferenceInfo

Configuration > Price Setting > Defaults for Price Lists and LPGs

name of price list

Defines which Price List's view preference for the output columns will be used as a template and applied to all Price Lists without individual settings. See Defaults for Price Lists and LPGs.

Price Lists

defaultPLUserNotification

Configuration > Price Setting > Defaults for Price Lists and LPGs

email

Defines which user is notified when the calculation of a new Price List is completed. See Defaults for Price Lists and LPGs.

Quotes

defaultQuoteHeaderFormula

Administration > Logics > Header Logics

name of logic

Defines a calculation logic used at the Quote header level. See Quote Header Logics.

Rebate Agreements

defaultRAHeaderFormula

Configuration > Logics > Header Logics

name of logic

Defines a calculation logic used at the Rebate Agreement header level. See Rebate Agreements Header Logics.

Rebate Agreements

defaultRebateTypeFilterFormula

Administration > Logics > Filter Logics > Rebates - Condition Types

name of logic

Defines a default Condition Filter logic to be used for Rebate Agreement when there is no such logic is defined for Rebate Agreement Type.

Miscellaneous

defaultTextMatchStyle 

  • exact

  • startsWith

Switches between two types of behavior of simple filters: either they search for all entries which contain the string that you typed (startsWith) or they return search result that exactly matches your search string (exact). See How to Make the Simple Filter Search for Exact Values.

Miscellaneous

defaultTimezone


This option is deprecated, it was removed in Collins 5.0. 

Miscellaneous

defaultTimezoneId

Configuration > General Settings


Sets the default time zone (as an offset to GMT/UTC). For details see General Settings.

Analytics

disable1eq1_BE_PA

true / false

Obsolete. Handles compatibility of Classic and Unity filter definitions in case of an empty filter "1 : 1".

Optimization

disable1eq1_BE_PO

true / false

Obsolete. Handles compatibility of Classic and Unity filter definitions in case of an empty filter "1 : 1".

Miscellaneous

disable1eq1_Classic

true / false

Obsolete. Handles compatibility of Classic and Unity filter definitions in case of an empty filter "1 : 1".

Approval Workflow

disableAttachingAttachmentsOnSubmit

Configuration > My Workflows

true / false

If set to true, it is not possible to attach documents to workflow emails. For details see My Workflows (Configuration).

Calculation Flow

disableCFOnServiceRole


true / false

If set to true, creation of a dedicated pod for every Calculation Flow job is disabled. See Calculation Flow Management.

Miscellaneous

disabledAutoLogin

Configuration > General Settings

true / false

If set to true, automatic re-login of Web UI is disabled. For details see General Settings.

Common

disabledDocxDownload 

true / false

Allows you to hide the icon for downloading objects (e.g., Quotes, Agreements/Promotions) in the DOCX format. See How to Hide Download DOCX Icon.

Miscellaneous

disabledEmailProcessing


true / false

Disables sending emails.

Miscellaneous

disabledEventProcessing

Configuration > General Settings >

true / false

Disables sending events through HTTP (PUSH). Use it if you use the Pull method.

Miscellaneous

disableO365Login

Configuration > General Settings

true / false

Disables O365 support login, so that you can explicitly approve/grant access by non-partition users like root/support.

Miscellaneous

disablePasswordExpirationEmailNotifications 

Configuration > General Settings

true / false

If set to true, no email notifications about expiring password are sent. See General Settings.

Miscellaneous

disableRedisLogs

Configuration > General Settings

true / false

If enabled, the Log page will display the traditional log file as in previous releases (before Bijou 7.0). For details see General Settings.

Sales Compensation

disableSaveWhenCreationWorkflowIsFinishedCompensation

Configuration > Sales Compensation General Settings

true / false

If enabled, Compensation Plan is submitted automatically when document creation WF is finished. If the Compensation Plan is rejected in the approval process, the creation workflow is restarted at its last step allowing further work on the document. See Sales Compensation General Settings.

Agreements & Promotions

disableSaveWhenCreationWorkflowIsFinishedContract

Configuration > Agreements & Promotions General Settings

true / false

If enabled, Agreement/Promotion is submitted automatically when document creation WF is finished. If the Agreement/Promotion is rejected in the approval process, the creation workflow is restarted at its last step allowing further work on the document.

Quotes

disableSaveWhenCreationWorkflowIsFinishedQuote

Configuration > Quoting General Settings

true / false

If enabled, Quote is submitted automatically when document creation WF is finished. If the Quote is rejected in the approval process, the creation workflow is restarted at its last step allowing further work on the document.

Rebate Agreements

disableSaveWhenCreationWorkflowIsFinishedRBA

Configuration > Rebates General Settings

true / false

If enabled, Rebate Agreement is submitted automatically when document creation WF is finished. If the Rebate Agreement is rejected in the approval process, the creation workflow is restarted at its last step allowing further work on the document.

Excel Client

doNotInjectJWTInEC

true/false

If enabled, JSON web token is not injected into the Excel Client XLSM file.

Price Lists, Price Grids

doNotStoreGlobalsForDirtyPass

true / false

Disables storing the content of api.global in the transition between passes.

Note: This is only applies for cases where the first pass is non-distributed.

Excel Client

doNotUseLoaddataInECForPP

true / false

Disables the use of loaddata (bulkload) in Excel Client for Price Parameters. Bulk loading is much faster but always replaces the full row.

Price Lists, Price Grids

doNotUsePerProductFormulasInLists

true / false

When set to true, price list calculations and price grid calculations will use the calculation logic specified in the list configuration only and not the logic that might be defined in the product master (which usually overrides the list-defined logic).

Miscellaneous

emailRedirect

Configuration > General Settings

email 

Specifies an email address where all emails from the system are redirected. This can be useful for testing scenarios where sending emails to real users is not desired.

Agreements & Promotions

enableAPRecalculation

true / false

If set to true, enables the new Price Records table and behavior in Agreements & Promotions where Price Records are generated only by calculation instead of on approval. For details see Advanced Configuration Options (Contracts).

warning Deprecated since version 13.0

GenAI - Assistant

enableCopilot

The list of pages where you want the Pricefx Copilot to be active, separating each page with a semicolon (e.g., /dashboards;/pb/pricelists;).

This configuration determines the pages on which the Pricefx Copilot launch button will be available. For more information see Enable Pricefx Copilot Access from Any Page.

Common

enableCreationWorkflowForTypes

Configuration > My Workflows


Allows you to enable a document creation workflow for Quotes, Agreements/Promotions or Rebate Agreements. See My Workflows (Configuration)

GenAI - Assistant

enableDashboardAIAssistant

true / false

Enables Pricefx Copilot throughout the application.

Backend

enableDefaultSortInFindWithPaging


true / false

warning This option has been removed in version 16.0.

Sets the default sorting order when paging with the api.find() method. Ensures consistent ordering of the results. Default = true. See also Data Querying using api.find() and api.stream() | Prefer api.stream Over Using Paging.

Backend

enableDefaultSortInFetchWithPaging


true / false

warning This option has been removed in version 16.0.

Sets the default sorting order when paging fetched rows and ensures consistent ordering of the results. The default value is true.

Backend

enableExperimentalQueryApi


true / false

warning This option only exists in version 13.X.Y and has been removed since 14.0.

If set to true, enables the experimental QueryAPI for groovy logics.

For now, this feature is experimental and only meant to be used for testing and feedback purpose. The QueryAPI may evolve in next release and doesn't guarantee any future backward compatibility. DO NOT USE IN PRODUCTION CODE.

Entitlement

enableGridExportOnlyForDefinedUserGroups

Configuration > General Settings

name of user group

Allows you to define which user groups are allowed to download data from tables within the application (i.e., see the Download to XLS/PDF/DOC icon). To specify the groups, enter their names (case insensitive) separated by a comma.

If this option is not defined, everyone can export data.

If this option is enabled but no user group is defined, the export functionality is disabled for all the users.

Optimization

enableOptimizationEnginePage

Optimization > Optimization Engine

true / false

If set to true, the Optimization Engine page is available in the module menu.

warning Deprecated since version 12.0.

Optimization

enablePricingGuidance

-

true / false

If set to true, the deprecated Pricing Guidance is available in the Optimization module menu, otherwise it is not. It also hides user roles associated with Pricing Guidance. Available since version 12.0.

Quotes

enableSaveButtonForQuotes

Configuration > Quoting General Settings > Autosave

true / false

If set to true, Quotes are not saved automatically but must be saved by the user manually using the Save button.

Common

enableSubmitReasonForTypes

Configuration > My Workflows

array of strings

For Quotes, Agreements/Promotions, Rebate Agreements or Price Lists, you can allow users to optionally enter comments when they submit the document. See My Workflows (Configuration).

Miscellaneous

ESignature

Configuration > External Systems > E-Signature


warning  Do not modify. For details see E-Signature.

Miscellaneous

ESignatureAvailable

Configuration > External Systems > E-Signature


warning  Do not modify. For details see E-Signature

Miscellaneous

ESignatureUseSandbox

Configuration > External Systems > E-Signature


Allows you to add a DocuSign sandbox. For details see E-Signature.

Miscellaneous

eventEmail

Configuration > General Settings

email

Email address to which events from the current partition are published. When empty, emails with events are not generated. See General Settings.

Miscellaneous

eventHooksConfig


Makes the application do something on a specified event or a user action. Example:

JSON
[
    {
        "event" : "QUOTE_TO_DEAL_PRE",
        "label" : "Convert quote to deal pre-execute",
        "logicName" : "HookQuoteToDealPre"
    }
]

Miscellaneous

eventUrl

Configuration > General Settings


Sets the HTTP endpoint to which events from the current partition are published. See General Settings and Enable HTTP Events on Pricefx Server.

Miscellaneous

externalJWTConfiguration

JSON definition

Configures authentication via external JSON web token.

Price Lists, Price Grids

extraExportColumnsConfig

JSON definition

When downloading a Price List to Excel, this option expands one row matrices into individual columns.

Example
JSON
{"PLI": {"<PLI_COLUMN_NAME1>": ["<MATRIX_FIELD_LABEL1>","<MATRIX_FIELD_LABEL2>"],"<PLI_COLUMN_NAME2>": [...]}} 

Miscellaneous

extraNavigationHtml 

HTML code

Allows you to add a custom button to the main navigation bar, next to the logo. This button can lead to any URL of your choice. See How to Add Your Own Button to Navigation.

Calculation

filterGroovyClosureParameterType


true / false

Enforces conversion of Groovy closure type parameters to their respective Groovy types. It is set to true by default for newly created partitions on 10.0 servers. See Conversion of Groovy Closure Type Parameters to Groovy Types.

Quotes

firstRevisionId

string

If you have configured a custom Quote revision format (using the quoteRevisionFormat advanced configuration option), this option sets the number from which the revision ID count will start. The default value is 1.

Charts

flexChartTemplates

Configuration > Templates

JSON definition

Defines the FlexChart templates. See FlexChart Templates.

Entitlement

gridExportUserGroups

Configuration > General Settings

name of user group

Allows you to define which user groups (case-insensitive names separated by a comma) are allowed to download data from tables within the application. See General Settings.

Miscellaneous

gridMaxGroupByItems

Configuration > General Settings

number

Defines the maximum number of rows the Group By function in grids is performed for. If the number of rows exceeds the limit, grouping is disabled. The default limit is 1000. See General Settings.

Common

headerRefAfterSaveDisabled

Configuration > General Settings

true / false

Handles OBJREFs (object references) after Agreements / Promotions / Rebate Agreements / Compensation Plan are saved, revised and copied. If enabled, OBJREFs generation is left to a background job that will be scheduled immediately on save, new revision and copy. See General Settings.

Miscellaneous

hasAcceptedTermsOfUse


true / false

Controls the display of the Terms & Conditions (T&C) screen on user login. This option is intended to show the T&C screen only when its value is set to false. When a user accepts the conditions, the system sets hasAcceptedTermsOfUse AP to true. The setting is not stored per user but applies globally within the partition. Once one user accepts the Terms & Conditions, every user in the partition will no longer see the T&C screen.

Miscellaneous

hiddenPDEWidgets

Configuration > Product/Customer Detail View > Configure Product Detail View

name of portlet

Allows you to set which default portlets will and will not be available when users configure a Product Detail View. All items that you define here will not be available. See Configure Product Detail View.

Calculation Grids

hideCalculationGridsBasedOnUserGroups

Price Setting > Calculation Grids

true / false

If set to true, permissions are enforced based on the active User Group entitlements. Users will only be able to access objects they have permission for. If set to false or left unset, User Group entitlements are not applied.

When the User Group fields (User Group (Edit) and User Group (View Details)) are null or contain only empty strings, they act as wildcards, granting view access to the respective Calculation Grids.

Additionally, there is a special case involving the Override User Groups (USERGROUPOVERRIDE) role. This role takes precedence over standard User Group entitlements and allows specific users to override these permissions. Such users can access Calculation Grids regardless of whether their User Group matches that of the Calculation Grid. These users will have access even if the User Group does not match.

Multiple groups can be specified as a comma-separated list, e.g. "Channel AnalystCollaboration WF Group 2".

Sales Compensations

hideCompensationRecordsBasedOnUserGroups

true / false

If set to true, Compensation Records that a user group is not entitled to view are not displayed in the Compensation Record list at all. Available from 9.0.

Sales Compensations

hideCompensationsBasedOnUserGroups

true / false

If set to true, Compensations that a user group is not entitled to view are not displayed in the Compensation list at all. Available from 9.0.

Condion Records

hideConditionRecordSetsBasedOnUserGroups

Master Data > Condition Records

true / false

If set to true, this property restricts the visibility of the Condition Record Sets based on User Groups.

Agreements & Promotions

hideContractsBasedOnUserGroups

true / false

If set to true, Agreements/Promotions that a user group is not entitled to view are not displayed in the Agreements & Promotions list. Available from 10.2.

Customer Extensions

hideCXTablesBasedOnUserGroups

true / false

If set to true, Customer Extensions that a user group is not entitled to view are not displayed in the Category drop-down list on the Customer Extensions page and on the Configuration > Master Data > Customer Master Extension page.

Price Parameters

hidePPTablesBasedOnUserGroups

true / false

If set to true, Price Parameters are completely hidden for groups that are not entitled to see them. See Company Parameters.

Price Grids

hidePriceGridsBasedOnUserGroups

Price Setting > Live Price Grids

true / false

If set to true, permissions are enforced based on the active User Group entitlements. Users will only be able to access objects they have permission for. If set to false or left unset, User Group entitlements are not applied.

When the User Group fields (User Group (Edit) and User Group (View Details)) are null or contain only empty strings, they act as wildcards, granting view access to the respective Price Grids.

Additionally, there is a special case involving the Override User Groups (USERGROUPOVERRIDE) role. This role takes precedence over standard User Group entitlements and allows specific users to override these permissions. Such users can access Price Grids regardless of whether their User Group matches that of the Price Grid. These users will have access even if the User Group does not match.

Multiple groups can be specified as a comma-separated list, e.g. "Channel AnalystCollaboration WF Group 2".

Price Lists

hidePricelistsBasedOnUserGroups

Price Setting > Price Lists

true / false

If set to true, permissions are enforced based on the active User Group entitlements. Users will only be able to access objects they have permission for. If set to false or left unset, User Group entitlements are not applied.

When the User Group fields (User Group (Edit) and User Group (View Details)) are null or contain only empty strings, they act as wildcards, granting view access to the respective Price Lists.

Additionally, there is a special case involving the Override User Groups (USERGROUPOVERRIDE) role. This role takes precedence over standard User Group entitlements and allows specific users to override these permissions. Such users can access Price Lists regardless of whether their User Group matches that of the Price List. These users will have access even if the User Group does not match.

Multiple groups can be specified as a comma-separated list, e.g. "Channel AnalystCollaboration WF Group 2".

Product Extensions

hidePXTablesBasedOnUserGroups

true / false

If set to true, Product Extensions that a user group is not entitled to view are not displayed in the Category drop-down list on the Product Extensions page and on the Configuration > Master Data > Product Master Extension page.

Quotes

hideQuotesBasedOnUserGroups

true / false

If set to true, Quotes that a user group is not entitled to view are not displayed in the Quote list. Available from 10.2.

Rebates

hideRebateAgreementsBasedOnUserGroups

true / false

If set to true, Rebate Agreements that a user group is not entitled to view are not displayed in the Rebate Agreement list. Available from 10.2.

Rebates

hideRebateRecordsBasedOnUserGroups

true / false

If set to true, Rebate Records that a user group is not entitled to view are not displayed in the Rebate Record list. Available from 10.2.

Seller Extensions

hideSXTablesBasedOnUserGroups

true / false

If set to true, Seller Extensions that a user group is not entitled to view are not displayed in the Category drop-down list on the Seller Extensions page and on the Configuration > Master Data > Seller Master Extension page.

Miscellaneous

i18nClient__<partitionUniqueName>_<language>


JSON definition


Miscellaneous

i18nClient__<partitionUniqueName>_<language>_i18nCreator


JSON definition

Example:

JSON
{
    "messages" : [
        ["common_approve","Submit / Approve"]
    ],
    "partitionWideOverride" : false
}

Miscellaneous

inferMassEditRounding

Configuration > General Settings

true / false

If enabled, the number of decimal places is preselected in the Precision column of the mass edit dialog. See General Settings.

Live Price Grids

keepApprovedUnmatchedXPGI

-

true / false

If enabled, you can retain approved items in the Matrix LPG when still matched by the Dynamic item filter. See How to Retain Approved Items in Matrix LPG When Still Matched by Dynamic Filter.

Live Price Grids

allowLPGSubmitWithCriticalAlert

-

true / false

If set to false, user is not able to perform both Submit or Deny of the Price Grid Item
with critical alert. Submit is not allowed, but Deny is allowed.

Miscellaneous

languagesForMsgTemplates

Configuration > Templates > Message Templates

JSON definition

Defines languages available for selection in the locale drop-down. See Message Templates

Example:

{ "languages" : ["en","de"] }

Price Lists

mandatoryPLElements 

name of element

Makes specified Price List outputs mandatory. See How can I make Price List outputs mandatory?

Analytics

maxPATablesFetchLimit 

number

Sets a default limit for the number of columns that are displayed in Datamart and Data Source data tables. See Data Sources and Datamarts.

Optimization

modelRecordPrefix

string

Sets the Model Records prefix in their name. The default is MR.

Optimization

mo_FormUGTemplateLogic

string

Defines a calculation logic that automatically assigns user groups to newly created models.

Miscellaneous

msgTemplateDisabled

Configuration > Templates > Message Templates

true / false

Allows you to disable a particular message template type. See Message Templates

Live Price Grids

noAutomaticReApproveForLPG

true / false

If this options is present and set to true, LPG item’s workflow status is not allowed to be set to AUTO APPROVED nor APPROVED if it was approved before and then the value of the item changed. The item’s status in this case will be NOT APPROVED.

Rebates, Agreements & Promotions

objRefAfterSaveDisabled

Configuration > General Settings

true / false

Allows you to disable the creation of OBJREF tasks after an Agreement/Promotion or Rebate Agreement is saved or submitted. See General Settings.

Price Grids

omitCalculationResults

JSON definition

Allows you to disable storing data in Calculation Results (Active) and/or Calculation Results (Previous) columns in LPGs. It can be used for improving performance as disabling data storing to these columns makes the LPG items lighter in the database. When you disable storing, it applies only to items approved from the moment on. To apply this setting to previously created items (i.e., reset the results to null), recalculate them.

JSON
{
    "LPG":
    {
        "activeCalculationResults": true,
        "previousCalculationResults": true
    }
}

true = omitted (storing disabled), false = not omitted (storing enabled)

Miscellaneous

optimizeQueriesToExtensionTables

true / false

Fixes an issue with complex filters using multiple AND/OR groups in a product filter. Default: true (from 9.0). For details see Advanced Filter.

Application

others__customHeaderColor

Configuration > Appearance

string

Defines the application header color in hexadecimal format.

Application

others__customLogoUrl

Configuration > Appearance

string

Defines the URL of the page where the user will be taken after clicking the custom logo in the application header.

Application

others__customLogo

Configuration > Appearance

string

Base64 encoded logo added to the application header.

Analytics

paAutoLoadData

Configuration > Analytics General Settings

true / false

If disabled, data grids in Analytics (Data Feeds, Data Sources, Datamart, Simulations and Rollups) are not populated with data automatically after you open them but only after you click the Refresh icon. See Analytics General Settings.

Analytics

paDailyCurrencyConversionRates

Configuration > Analytics General Settings

true / false

Allows you to increase the speed of queries on a Datamart with a Currency Data Source with daily rates. If enabled, when loading data in the Currency DS, any gaps between rows for the same currency pairs are automatically filled by adding additional rows, so that there is one rate for each day. This is intended for customers that have frequent currency rate changes, but not quite daily. It should not be used for weekly or less frequent changes.

See Analytics General Settings.

Analytics

paDMFilterDropdownUsesUnderlyingDS

Configuration > Analytics General Settings

true / false

Obsolete. If enabled, filter dropdown queries on dimension fields in a Datamart are quicker because they are delegated to the underlying Data Source. See Analytics General Settings.

Analytics

paDmNoGroupAllAccess

Configuration > Analytics General Settings

true / false

If enabled, data in Data Sources with set data entitlements are visible also to users who are not members of any of the entitled user group. See Analytics General Settings.

Analytics

paShowHiddenFieldsInDataGrid

true / false

Obsolete. If set to true, hidden fields are shown (and queried) in Analytics data grids in the Classic UI. Default is false.

Analytics

paMaxFcFieldCountExemptions

-

JSON definition

This option contains a map that defines specific maximum field counts for individual sources that are permitted to exceed the default maximum number of fields.

The values for this option are automatically generated during upgrades by a migration script. They can be modified later on an individual basis for each data source.

The map is a JSON object that maps FC.sourceName (for example, DMF.<uniqueName>DMDS.<uniqueName>, or DM.<uniqueName>) to the maximum number of fields allowed for the corresponding Field Collection. Each entry represents an exemption that is specific to a particular Field Collection.

Example:

JSON
{
  "DMF.HighFieldCount": 130,
  "DMDS.HighFieldCount": 120,
  "DM.ExceedThresholdFieldCount": 210
}

For more information see Default Limits.

Miscellaneous

passwordExpiryDays 

Configuration > General Settings

number

Number of days when all passwords get expired. The default is that a value is not set which means "no expiry". See General Settings.

Analytics

paSortByNullHandling

  • asc_nulls_first_desc_nulls_first

  • asc_nulls_last_desc_nulls_first

  • asc_nulls_first_desc_nulls_last

  • default

  • asc_nulls_last_desc_nulls_first (The advised default since many releases and PostgreSQL default order.)

  • asc_nulls_first_desc_nulls_first

  • asc_nulls_first_desc_nulls_last

  • default (Effectively the same as the asc_nulls_first_desc_nulls_first.)

info Starting from version 15.0, the default setting for new partitions is configured to asc_nulls_last_desc_nulls_first.

Miscellaneous

passwordHistoryActive 

Configuration > General Settings

true / false

Determines whether to keep password history or not. By default it is disabled. See General Settings.

Miscellaneous

passwordHistoryCount

Configuration > General Settings

number

How many passwords are kept in history. The default is 0 which is essentially the same as no history at all. See General Settings.

Common

paToPbMappingCustomerId

Configuration > Analytics to Price Setting Mapping

Customer ID

When mapping the product key from Analytics to the Product key from Price Setting, it allows you to set the Customer ID. See Analytics to Price Setting Mapping. Example:

JSON
{
    "DM.TransactionsDM_Sales" : {
        "mapping" : "CustomerNumber"
    }, 
    DM.ClickstreamDM" : {
        "mapping" : null
    }
}

Common

paToPbMappingSKU

Configuration > Analytics to Price Setting Mapping

SKU

When mapping the product key from Analytics to the Product key from Price Setting, it allows you to set the SKU. See Analytics to Price Setting Mapping. Example:

JSON
{
    "DM.TransactionsDM_Sales" : {
        "mapping" : "ProductId"
    }, 
    "DM.ClickstreamDM" : {
        "mapping" : null
    }
}

Rebates

payoutRecordsConfiguration


Determines which attributes will be in your Payout Records and, in the logic, allows you to map payout record attributes to the corresponding original rebate record attributes. See Payout Records. Example:

JSON
{
    "validToFromStateTransitions" : {
        "Approved" : [ "Pending ],
        "Denied" : [ "Pending" ],
        "Paid" : [ "Approved" ]
    }
}

Dashboards,

Charts

pfxContextualAction_<actionName>


JSON definition

Creates a new action button on specified page - e.g. Analytics Chart or Dashboard.

Example:

JSON
{
   "name":"Create Action",
   "page":"dashboardPage",
   "contextLinking": {
        "targetPage":"newModelPage",
        ....
   }
}

Application

pfxExternalApp_<externalAppName>


JSON definition

Creates a new menu item in the External Apps menu in the application. This menu item will open the specified URL in an iframe within Pricefx front-end application.

Example:

JSON
{
  "name": "strategy-designer",
  "label": "Strategy Designer (Preview)",
  "url": "https://developer.pricefx.eu/visual-configuration/psp/0.1.5/",
  "businessRole": "StrategyDesigner",
  "configuration": {
    "advancedConfigurationStateEntry": "visual_configuration_psp_state",
    "strategyDefinitionTable": "StrategyDefinition",
    "strategySelectionTable": "GlobalStrategySelection",
    "priceSettingDimensionsTable": "PriceSettingDimensions",
    "priceListLogicName": "IndependentPriceListLogicBlockly",
    "groovyLibraryName": "CustomPricingStrategies"
  }
}

Price Grids

pgiDenialReasons

Configuration > Price Setting > Denial Reasons (LPG)

JSON definition

Allows you to predefine reasons for denial which are then shown to users who deny items in Live Price Grids. See Denial Reasons (LPG).

Example
JSON
{
    "denialReasonsOptional":false, 
    "displayOther":true, 
    "reasons":[
        "R1", 
        "R2", 
        "R3"
    ]
}

Optimization

poMCEnabled

true / false

No longer used. The closest similar option is enablePricingGuidance.

If set to true, Model Object / Model Class page in Optimization is enabled. If the option is not present, it is considered false.

Optimization

poMTEnabled

true / false

No longer used. The closest similar option is enablePricingGuidance.

If set to true, Model / Model Types / Optimization Engine pages in Optimization are enabled. If the option is not present, it is considered true.

Approval workflow

postStepLogicsWhenNoWorkflowDefined

JavaScript object

Allows you to run a Workflow Post Step Logic even when there is no workflow defined. This can be useful when you want to take advantage of the logic context built around the workflow, yet you do not need the approval workflow. See Workflow Post Step Logic. Example:

JSON
{ "pricegriditem" : "PostStepLogic_PriceGridItem" }

Price Parameters

PPDefaultKeyValue

string

Sets the default value for keys when changing the Matrix Type of the Price Parameter table from less columns to more columns.

Price Grids

priceGrid.eventBeforeRecalc 


true / false

Determines if the recalculation event for a price grid item contains the payload showing the item before or after the recalc.

Details: When a PG item is recalculated, an event is emitted. The event contains the item’s details as payload. In some cases it can be desirable that the event has the old details in its payload (as the new details can easily be retrieved by the event consumer and there can be sophisticated "delta" handling on the integration side). Other cases benefit from having the new item details (i.e. after new calculation) as payload as it saves the event consumer from querying the details separately. This option toggles between these two modes.

Price Grids

priceGridCancelPartialCalcsOnFullCalc

true / false

If set to true, a full LPG calculation cancels previously queued partial calculations. This behavior is applied to trackers in the "Waiting for dispatch" status.

Price Grids

priceGridItemOfNonexistentSkuAction


process / skip / invalidate / hard-delete

The options are:

  • process – Processes the item and shows an error in the line. This is the default value.
    ⚠️ This option causes the values to be recalculated according to the grid logic. This may mean that if the product had its own calculation logic, a different logic would be used, which may be unintentional. This is due to the fact that deleting the product also deletes the link between product and its product logic.

  • skip – Skips the item (and keeps old values).

  • invalidate – Invalidates the item.

  • hard-delete – Removes the item from the grid/list.

Price Grids

priceGridItemOmitMappedCalculationResults

true / false

If set to true, any results that are already mapped to LPG item attributes are omitted from allCalculationResults, so only unmapped results remain in that JSON field.

This option prevents LPG items to store both mapped attribute columns and the full allCalculationResults JSON, effectively duplicating data.

Price Grids

priceGridItemPrefix

string

Sets the Price Grid Items prefix in their name. The default is PGI.

Price Lists

pricelistLogics

Configuration > Price Setting > Defaults for Price Lists and LPGs

name of logic

Defines a list of logics (sub selection of all logics) available when creating Price Lists. Example:

JSON
[
    {
         "uniqueName" : "Chem-Pricing",
        "resultElementName":"ListPrice"
    }
]

Price Lists

pricelistTargetDateEditable

Configuration > General Settings

true / false

If set to true, it is possible to edit the target date even after the price list has been calculated and approved.

Product Extensions

productextension

Configuration > Master Data

name of PX

Defines available product extensions.

warning  Do not edit this option directly. Do not fetch it to a project as a property.

BoM Data

productBoMEntryBusinessKeys

Configuration > Master Data > Other

string

Defines business keys for BoM Data table. Comma-separated field names that should be treated as business keys.

Competition Data

productCompetitionBusinessKeys

Configuration > Master Data > Other

string

Defines business keys for Competition Data table. Comma-separated field names that should be treated as business keys.

Miscellaneous

productqueries

Classic: Configuration > PriceBuilder

JSON definition

Obsolete. Defines what product related data from Analytics can be displayed in Product Detail View (which is available from Price Lists, LPGs etc.).

Miscellaneous

productQueryCharts

Configuration > Product/Customer Detail View > Product Query Chart Definition

JSON definition

Specifies what data from Analytics to display as a portlet in the detail view of Product Master, Price List, Price List Simulations or Live Price Grid. See Product Query Chart Definition.

Product References

productXReferenceBusinessKeys

Configuration > Master Data > Other

string

Defines business keys for Product References table. Comma-separated field names that should be treated as business keys.

Common

publishingTemplates_<typeCode>

Configuration > Templates

JSON definition

Specifies Excel or Word templates used for publishing documents to XLSX, PDF or DOC formats. You need to specify the type by adding a suffix: "publishingTemplates_Q" (Q for quotes; others respectively). See Publishing Templates.

Miscellaneous

pwdComplexityRules

Configuration > General Settings

NAME
LOGIN_NAME
EMAIL
ALL_NUMBERS
ALL_UPPERCASE
ALL_LOWERCASE
REPEATING_CHARS
MINIMUM_6 (up to 16)
ONE_UPPERCASE
ONE_LOWERCASE
ONE_NUMBER
ONE_SYMBOL

Sets the complexity for passwords. For details see General Settings.

Example:

JSON
[ "MINIMUM_6", "ONE_UPPERCASE", "ONE_NUMBER" ]

Miscellaneous

pwnedPasswordCheck 

Configuration > General Settings

true / false

If set to true, checks a new password in the "Have I been pawned" online database against known stolen/broken passwords.

Quotes

quoteAddCustomerGroupInput

Configuration > Quoting

true / false

If set to true, the Customer Group user input field is shown in the Input Parameters on the Quote root level.

Quotes

quoteAddCustomerInput

Configuration > Quoting

true / false

If set to true, the Customer user input field is shown in the Input Parameters on the Quote root level.

Quotes

quoteApplyCustomerFilter

Configuration > Quoting

true / false

If set to true, users with a set up customer filter will see only Quotes created for those customers.

Quotes

quoteAsyncThreshold

Configuration > Quoting

number

Sets the threshold (number of line items) from which a Quote is submitted, recalculated, etc., asynchronously. Enter 0 to force asynchronous submission for all Quotes. The default value is 100, meaning that Quotes with 100 or more changed lines are submitted asynchronously. See Quoting General Settings.

Quotes

quoteApplyOwnQuotesFilter

Configuration > Quoting

true / false

If set to true, users will see only the Quotes that they have themselves created.

Quotes

quoteExpiryDateOffset

Configuration > Quoting

number

Sets up the number of days which will by default offset the respective date when creating a new Quote in Quoting. See Quoting General Settings

Quotes

quoteItemSelectorInputs 

JSON definition

Makes inputs which are displayed in the quote's Input Parameters section available to users in the product selector. See How to Add Inputs to Product Selector.

Example:

JSON
[
    {
        "name" : "Quantity",
        "label" : "Quote Quantity",
        "type" : "USERENTRY"
    }
]

Quotes

quotePrefix

string

Sets the Quotes prefix in their name. The default is P (due to backward compatibility).

Quotes

quoteProductRecommendationsConfig


JSON definition

Allows you to configure Product Recommendations Model. See Specific Model Type: Product Recommendations Model.

Quotes

quoteRevisionFormat

string

Allows you to add a string of your choice between the Quote unique name and the revision number.

The default value of this option is $uniqueName$-REV-$revId$.

Quotes

quotesMassUpdateTemplates

Configuration > Quoting > Quote Mass Update Templates

JSON definition

Defines templates on which Quote mass update jobs are based. See Quote Mass Update Templates. Example:

JSON
{
    "MassiveClusterChanges":{
        "isDefault":true, 
        "config":{
            "headerInputUpdateDefs":[
            ], 
            "inputUpdateDefs":[
            ], 
            "outputDefs":[
            ], 
            "inputDefs":[
            ], 
            "inputsLogic":"ClusterItemMassUpdate", 
            "headerInputsLogic":"ClusterMassUpdate", 
            "headerOverridesLogic":null, 
            "overridesLogic":null
        }
    }
}

Quotes

quotesReasons

Configuration > Quoting > Quote Reasons

JSON definition

Lists reasons displayed in Quotes when a user changes the quote status, e.g. from Offer to Lost. The user can then select a reason from this list. See Quote Reasons.

Quotes

quoteTargetDateOffset

Configuration > Quoting General Settings

number

Sets up the number of days which will by default offset the respective  target date when creating a new Quote in Quoting. See Quoting General Settings.

Rebates

rebateAgreementPrefix

string

Sets the Rebate Agreement prefix in their name. The default is R.

Rebates

rebateAsyncThreshold

Configuration > Rebates

number

Sets the threshold (number of line items) from which a Rebate Agreement is submitted, recalculated, etc., asynchronously. Enter 0 to force asynchronous submission for all Rebate Agreements. The default value is 100, meaning that Rebate Agreements with 100 or more changed lines are submitted asynchronously.

Rebates

rebateCharts

Configuration > Rebates

JSON definition

Allows you to display data from the Rebates module as a portlet in the detail view. See Rebate Chart Definition.

Rebates

rebateQueries

Classic: Configuration > Rebates

JSON definition

Obsolete. Defines what data from the Rebates module to display.

Rebates

rebateRecordPrefix

string

Sets the Rebate Records prefix in their name. The default is RR.

Rebates

rebateRevisionFormat

string

Allows you to add a string of your choice between the Rebate Agreement unique name and the revision number.

The default value of this option is $uniqueName$-REV-$revId$.

Sales Compensation

recalculateCompensationAfterLineItemsStructureModification

true / false

If set to true, Compensation Plans are automatically recalculated when line items are duplicated, deleted, moved or when a folder is added.

Agreements & Promotions

recalculateContractAfterLineItemsStructureModification

true / false

If set to true, Agreements/Promotions are automatically recalculated when line items are duplicated, deleted, moved or when a folder is added.

Quotes

recalculateQuoteAfterLineItemsStructureModification

true / false

If set to true, Quotes are automatically recalculated when line items are duplicated, deleted, moved or when a folder is added.

Rebates

recalculateRebateAgreementAfterLineItemsStructureModification

true / false

If set to true, Rebate Agreements are automatically recalculated when line items are duplicated, deleted, moved or when a folder is added.

Agreements & Promotions

recalculateAPOnAlwaysEditableChangeInWorkflowStatuses

array of strings

Allows you to determine if and when a change in an alwaysEditable field triggers document recalculation. Define an array of statuses in which recalculation will happen. Possible values are: SUBMITTED, APPROVED, NO_APPROVAL_REQUIRED. Default value (if this option is not set): [“SUBMITTED”, “APPROVED”].

Example:

["SUBMITTED", "APPROVED", "NO_APPROVAL_REQUIRED"] // Recalculate in all possible cases
[] // Never recalculate when alwaysEditable inputs changes

Sales Compensations

recalculateCompensationOnAlwaysEditableChangeInWorkflowStatuses

array of strings

Quotes

recalculateQuoteOnAlwaysEditableChangeInWorkflowStatuses

array of strings

Rebates

recalculateRebateAgreementOnAlwaysEditableChangeInWorkflowStatuses

array of strings

Price Grids

refreshPDEListOnUpdate

true / false

If set to true, the LPG detail view refreshes on update.

Rebates, Sales Compensations

rerenderInputsOnFetch

true / false

Reevaluates inputs in the syntax mode during fetching Rebate Records. See PFCD-5976.

Calculation

retainGlobalAlwaysOn

true / false

This is an equivalent of putting api.retainGlobal = true to every logic. It applies to the whole partition.

Sales Compensations

runCreationWorkflowOnCompensationSave

Configuration > Sales Compensation

true / false

If set to true, the creation workflow logic is executed right after an Compensation Plan is saved.

Agreements & Promotions

runCreationWorkflowOnContractSave

Configuration > Agreements & Promotions

true / false

If set to true, the creation workflow logic is executed right after an Agreement/Promotion is saved.

Quotes

runCreationWorkflowOnQuoteSave

Configuration > Quoting

true / false

If set to true, the creation workflow logic is executed right after a Quote is saved.

Rebates

runCreationWorkflowOnRebateAgreementSave

Configuration > Rebates

true / false

If set to true, the creation workflow logic is executed right after a Rebate Agreement is saved.

Miscellaneous

samlConfiguration 

Configuration > External Systems > SAML Configuration

JSON definition

Definition of all SAML configs.

warning  Edit it directly only if you know what you are doing.

Agreements & Promotions

saveAndCalculateNewContractImmediately

Configuration > Agreements & Promotions

true / false

If set to true, a new Agreement/Promotion is calculated immediately after saving.

Quotes

saveAndCalculateNewQuoteImmediately

Configuration > Quoting

true / false

If set to true, a new Quote is calculated immediately after saving.

Rebates

saveAndCalculateNewRBAImmediately 

Configuration > Rebates

true / false

If set to true, a new Rebate Agreement is calculated immediately after saving.

CLIC

sendEmailMaxCountInLastMinutes

-

number

Limits the number of clicmanager.sendemail endpoint calls in last X minutes (X is set by the sendEmailMinutesCountForThrottling option). Returns HTTP status code 429 if the number of requests is exceeded within the specified time window. The default value is 5.

CLIC

sendEmailMaxRecipients

-

number

Limits the number of recipients in one email that is sent via the clicmanager.sendemail endpoint. The default value is 20.

The HTTP status code 400 is returned if the number of recipients is exceeded.

CLIC

sendEmailMinutesCountForThrottling

-

number

Sets the time frame (in minutes) for counting requests sent via clicmanager.sendemail. The default value is 5.

Miscellaneous

sendEmailOnJSTFailure 

true / false

If set to true, you get notified of jobs which failed due to an error or timeout. See How to Get an Email Notification When a Background Job Fails.

Price Lists, Price Grids

shotgunThreshold


number

Sets a number describing how many items will be calculated in the distributed mode. The default value is 5000.

Price Grids

showDefaultPricingTypeInLivePriceGrid

true / false

If set to false, the Default Price Setting Type is not visible in the New Price Grid drop-down list.

Price Lists

showDefaultPricingTypeInPriceList

true / false

If set to false, the Default Price Setting Type is not visible in the New Price List drop-down list.

Analytics

silenceUnsupportedFilterError

true / false

The following filters are not supported in the Analytics module (PA):

  • EMPTY

  • NOT_EMPTY

  • SOME

  • ALL

  • NONE

By default, when the silenceUnsupportedFilterError is set to false or not used, the use of any of these unsupported filters in the Analytics module will result in a failure. This behavior is intentional, as unsupported filters are not processed. Using this option is strongly recommended.

If the silenceUnsupportedFilterError is set to true, these filters will be processed, but the correctness of the returned data may be highly questionable.

Price Grids

skipAutoApproveOnDirtyPGI 

true / false

If set to true, it suppresses autoApprove when an item is dirty. See Multi-pass Calculation of a Pricelist or LPG.

Common

skipRevisionRecalc_<typeCode>

true / false

If set to true, a new revision of Q/RBA/CT is not recalculated immediately. You need to specify the type by adding a suffix: "skipRevisionRecalc_Q" (Q for quotes; others respectively). See Quote Actions.

Note: If set to true, columns with inputs and outputs will not be included in the new revision as they haven’t been calculated yet.

Application

startPagePanels

Configuration > Home Page

name of portlet

Allows you to define at the partition level the list of portlets that will be displayed on the Home page.

Miscellaneous

tfaMandatory

Configuration > General Settings

true / false

If set to true, two-factor authentication is required for all users logging in to the application (directly, not via SSO). See General Settings.

CLIC

treatOnlyDirtyClicsOnCalculateDirty

true / false

Improves the performance of the Recalculate Changes endpoint. If set to true, limits JSON (de)serialization to dirty line items only instead of all line items, reducing response time. Default: false

Analytics

truncateDatamartOnNonIncRefresh

Analytics > Data Loads

true / false

DM Refresh can be run in two different modes:

  • Incremental mode - Only the DS data modified or added since the last DM refresh is loaded in the DM.

  • Non-incremental mode - All the source data is (re-)loaded in the DM. When the DM is already populated, a non-incremental refresh usually results in a costly merge of mostly the same data from the DSs into the DM. To prevent this, the DM is truncated first, resulting in a much faster load. But if a DM Truncate is performed before the DM Refresh, the DM can be without data for quite a long time (until the DM is fully populated again).

When truncateDatamartOnNonIncRefresh = true new solution here is to do the Truncate and Refresh in one and the same DB transaction, and let this be driven by the DL's incremental mode setting. To avoid disruptions in existing projects (even though it is strongly recommended that it should always be possible to rebuild a DM from its source data, there could be e.g., a Calculation DL that enriches the DM data once loaded and this DL may stop working after the full (non-incremental) DM refresh), the new non-incremental DM Refresh behavior is enabled only when an advanced setting 'truncateDatamartOnNonIncRefresh' is set to true.

Application

unityDialog

Classic: Configuration > General Settings

string

Obsolete. Allows to enter text for the welcome dialog, e.g., link to Unity UI or some announcements.

Application

unityDialogEnabled

Classic: Configuration > General Settings

true / false

Obsolete. If set to true, users are presented with a customizable welcome dialog after they log in.

Application

unityLinkEnabled

Classic: Configuration > General Settings

true / false

Obsolete. Allows you to promote the Unity UI enabled for this partition.

Common

updateHeaderRefInSyncAfterSaveDisabled

true / false

If set to true, during submit the system updates ObjRefs for header Customer Group right away on save (synchronously). See PFUN-8055.

Entitlement

useBinaryDataGroupRestriction 

true / false

If set to false, it turns off filtering on user groups and makes the response faster. See When adding attachment in QC on partition with thousands of user groups, I get error.

Quotes

usePersistedQuoteCalculation

true / false

If set to true, Persisted Quote Calculation Processor is used; otherwise QuoteCalculationProcessor is used.

Quotes

useResultNamesInExcelExport

true / false

If set to true, a Quote exported to Excel uses result names (not Labels) as column headers on the Data tab. For details see Quote Actions.

Integration

visualMappingConfig

Configuration > CRM Integration > Visual Mapping

JSON definition

Stands for CRM Integration Field Mapping (aka Visual Mapping). In frontend integration between a CRM application and Pricefx documents it represents the setup of CRM-to-Pricefx field mapping. See Visual Mapping.

Charts

waterfalltemplate

Configuration > Analytics > Default Waterfall (Classic)

JSON definition

Obsolete. Defines a system-wide default waterfall.

Approval workflow

wfDisabledTemplates


true / false

If set to true, document creation workflow templates are disabled. See Document Creation Workflow. Example:

JSON
{
    "approvalRequired" : true,
    "stepApproved" : true,
    "stepDenied" : true,
    "workflowApproved" : true,
    "approvalDelegated" : true,
    "creationWorkflowStepAssigned" : true,
    "creationWorkflowFinished" : true,
    "quoteConverted" : true,
    "pendingWorkflowsSummary" : true
}

Approval workflow

wfSummaryEmailDaily

Configuration > My Workflows

true / false

Determines if a summary email listing all the new pending approvals is sent or not.

Approval workflow

wfSummaryEmailFrequency

Configuration > My Workflows

number

Specifies an interval at the end of which a summary email listing all the new pending approvals is sent. This option is disabled if left empty.






Price Setting – Price Lists & Live Price Grids

autoGroupCalculationResultsInDetailsView

No (advanced property only)

boolean: true / false

Groups calculation results by Result Group in the Calculation Details view for Price Lists and Live Price Grids. When enabled, the Calculation Details screen shows grouped sections instead of a flat list of results.

Price Setting – Calculation Grid

calculationGrid.eventBeforeRecalc

No (advanced property only)

boolean: true / false

For Calculation Grids, controls whether the recalculation event payload contains the item state before (true) or after (false) recalculation, allowing integrations to choose between “old value” delta handling and direct “new value” consumption.

Core – Attachments & Document Conversion

cloudconvert_secretkey

No (Ops‑only / environment‑level)

text (secret token)

CloudConvert API secret key used for document conversion (for example, generating PDFs). Normally set by Cloud Engineering / Support, not via UI.

Price Setting – Price Lists & Live Price Grids

commentHistory

System Configuration > General Settings

boolean: true / false

If set to true, Price Lists, Manual Price Lists and Live Price Grids keep a history of comments and display it in the product details screen under Comment History. When false, only the latest comment is stored/shown.

Analytics – Data Manager / Flush

copyLastUpdateDateOnFLush

No (advanced property only)

boolean: true / false

Controls whether Flush operations in Analytics copy/synchronize the “last update” timestamp (for example lastUpdateDate) between staging and target tables. When true, the timestamp is preserved during Flush.

Custom Forms / Groovy API

customFormApiAlwaysAllowsObjectModification

No (advanced property only)

boolean: true / false

Restores legacy behaviour of api.customFormApi() so that update and recalculate operations on Custom Forms are allowed even in contexts that normally disallow object modification. Use only when you explicitly need the pre‑12.0 behaviour across multiple contexts.

Core – UI / List Defaults

defaultPageSize

No (advanced property only)

integer (number of rows, e.g. 50)

Sets the default number of rows per page for list‑style UIs (lists of Price Lists, LPGs, Contracts, etc.). Individual users can typically override this via personal UI settings; this property defines the partition‑wide default.

Platform / Authentication

disablePlatformLogin

No (advanced property only)

boolean: true / false

When enabled, logins initiated from Platform Manager (PfM) to this partition are blocked. Opening the partition from PfM should show a message like “Platform login is disabled; JWT was issued via platform; Access denied” instead of silently redirecting to the login screen. Direct logins to the partition remain available.

Analytics – Data Manager / Bulk Load

disableSafeNullsJoinsForNonAttributesInBulkload

No (advanced property only)

boolean: true / false

When false (default), bulk‑load operations for non‑attribute columns use additional “safe nulls” joins to avoid incorrect matches when join fields contain nulls. When set to true, these safeguards are disabled, which can improve performance but increases the risk of wrong joins when null values are present.

Analytics – Datamart Manager

dmmCalcItemsFromPreviousStep

No (advanced property only)

boolean: true / false

Controls whether Datamart Manager calculations are allowed to re‑use items from a previous step in a multi‑step process instead of reloading everything. When true, later steps can recalc only new/changed items, improving performance but making the dependency chain more complex.

Core – Calculation Engine

doNotStoreGlobalsForDirtyPass

No (advanced property only)

boolean: true / false

Disables storing the contents of api.global between passes in multi‑pass calculations. Applies only when the first pass is non‑distributed. Use to reduce the amount of data persisted between passes at the cost of not having globals restored in dirty passes.

Core – Object Extensions / UI

enableUserFilterOnObjectExtension

No (advanced property only)

boolean: true / false

Enables additional user‑level filtering on Object Extensions in list/detail UIs. When true, user filters can be applied directly to extension attributes; when false, filtering is limited to standard fields.

Price Setting – Price Lists & Live Price Grids

extraExportColumnsConfig

No (advanced property only)

JSON object

Configures which result‑matrix fields are exported as extra columns when downloading a Price List / LPG to Excel. Top‑level keys are PLI / XPLI (entity type); each defines result‑matrix columns that are flattened into dedicated Excel columns, for example: {"XPLI": {"LastTransaction": ["Last Price Paid","Last Price Paid Date",...]}}.

Core – Dashboards & Home Page

hideDashboardsBasedOnUserGroups

No (advanced property only)

boolean: true / false

If enabled, hides dashboards (Home‑page panels or Dashboard objects) from users who are not members of any of the dashboard’s allowed user groups. When false, dashboards may still be visible, relying instead on per‑widget data permissions.

Analytics – Data Manager / LoadData

loadDataSyncOnTargetTable

No (advanced property only)

boolean: true / false

Controls how Analytics LoadData writes into target DS/DM tables. When true, data is written synchronously and directly into the target table; when false, the default (often staging + merge or asynchronous) loading strategy is used for better scalability.

Core – Notifications / Messaging

msgTemplate

No (advanced property only)

text or small JSON configuration

Holds a default message template (for emails, notifications or workflow messages) used by one or more modules. The value is typically a template name or a compact JSON structure describing the template and its parameters.

Core – Integration / OAuth

oauthConfiguration

No (advanced property only)

JSON object

Stores global OAuth client configuration (client IDs, endpoints, scopes, etc.) for Pricefx when connecting to external systems via OAuth2/OpenID Connect. Usually managed by Support / Cloud Engineering rather than business users.

Core – Persistence / References

objRefAfterSaveDisabled

No (advanced property only)

boolean: true / false

Disables automatic “object reference” updates after save for certain objects. When true, post‑save logic that normally refreshes references (for example header/child typed IDs or cached references) is skipped. Intended for special migration/troubleshooting scenarios only.

Analytics – Datamarts

paAllowDMCalculatedFKInDM

No (advanced property only)

boolean: true / false

Allows a Data Mart to use foreign keys calculated in another DM as join keys or references. When false, such cross‑DM calculated FK references are blocked to keep schemas simpler; when true, more advanced chained DM designs are possible.

Analytics – Datamarts

paAllowDSCalculatedFKInDM

No (advanced property only)

boolean: true / false

Allows a Data Mart to use foreign keys calculated in Data Sources (DS) as join keys. Enable only when you deliberately design DMs to rely on DS‑level calculated key columns.

Analytics – Datamarts

paAllowNonDistributedDMMisalignment

No (advanced property only)

boolean: true / false

Permits certain non‑distributed DMs to be “misaligned” with respect to the distribution key used by other DMs/DSs. When false, stricter alignment rules are enforced; when true, irregular schemas are allowed, potentially at some performance or maintenance cost.

Analytics – Data Analyzer

paDataAnalyzerMaxRows

No (advanced property only)

integer (row limit, e.g. 100000)

Sets a hard limit on the number of rows that Data Analyzer queries may return or process. Used to protect the cluster from overly heavy ad‑hoc queries in Analytics.

Analytics – Index Maintenance

paDisableAutoIndexMaintenance

No (advanced property only)

boolean: true / false

Disables automatic index maintenance for Analytics DS/DM tables (for example periodic index create/rebuild/drop tasks). When true, index lifecycle must be managed explicitly (scripts or DBA operations).

Analytics – Query Engine

paDisableMaterializedCTE

No (advanced property only)

boolean: true / false

Prevents the Analytics SQL generator from using materialized Common Table Expressions (CTEs), forcing alternative query shapes instead. Can be used as a workaround for specific database/planner behaviours that handle materialized CTEs poorly.

Analytics – LoadData

paSkipDeduplicationOnLoadData

No (advanced property only)

boolean: true / false

When true, skips duplicate‑removal steps during LoadData operations in Analytics. This improves bulk‑load performance but allows duplicates into DS/DM tables; only enable when the upstream pipeline already guarantees uniqueness.

Analytics – Datamart Loader

paUseLegacyDatamartLoader

No (advanced property only)

boolean: true / false

Switches Analytics back to the legacy Datamart loading implementation instead of the newer optimized loader (for example, MERGE‑based). Intended as a compatibility fallback when a customer hits an edge‑case issue with the new loader.

Price Setting – Live Price Grids (LPG)

removeXPGIWithoutProduct

No (advanced property only)

boolean: true / false

Controls how matrix Price Grid items (XPGI) whose underlying product is missing are handled. When true, XPGI records without a valid product are automatically removed from the LPG; when false, such items remain and may appear as invalid rows requiring manual cleanup.

Formula & Strategy Designer / UI Inputs

rerenderInputsOnFetch

No (advanced property only)

boolean: true / false

When enabled, input definitions (for example in Formula Designer, Strategy Designer or Custom Forms) are re‑generated each time they are fetched instead of using cached metadata. Useful during development of dynamic input logic; slightly increases server workload on each open.

Sales Compensation

saveAndCalculateNewCompensationImmediately

No (advanced property only)

boolean: true / false

In Sales Compensation, determines whether a new Compensation document is calculated immediately after save (true) or created uncalculated so that users must trigger the calculation explicitly (false).

Custom Forms / Workflow Phases

saveAndCalculatePhasesNewCustomFormImmediately

No (advanced property only)

boolean: true / false

For phases based on Custom Forms, controls whether a newly created phase custom form is calculated immediately after it is saved. When false, the phase is created first and calculation must be triggered separately.

Master Data – Sellers & Seller Extensions

sellerextension

No (advanced property only)

text (Seller Extension unique name)

Specifies which Seller Extension is treated as the primary/active seller extension in certain modules (Quoting, Agreements, Sales Compensation, etc.). Typically contains the unique name of a Seller Extension configuration.

Price Setting – Price Lists & Live Price Grids

shotgunThreshold

No (advanced property only)

integer (number of items, e.g. 5000)

Sets the threshold of items above which Price List / LPG calculations run in distributed (“shotgun”) mode instead of non‑distributed mode, improving performance for large lists.

Quoting / Agreements – Revisions

skipRevisionRecalc_

No (advanced property only)

boolean: true / false

When true, skips automatic recalculation of revisions (for example quote or agreement revisions) in situations where new revisions would normally be recalculated automatically. Intended for high‑volume or specialized workflows where recalculation is orchestrated by separate jobs.

Core – Persistence / Header–Line Relationship

updateHeaderRefAfterSaveDisabled

No (advanced property only)

boolean: true / false

Disables automatic update of header references (for example denormalized header IDs or reference fields on line items / related objects) after a header object is saved. Useful for migrations or special operations where automatic reference refresh is undesirable.

Price Setting – Pricing Documents / Validation

validateInputsOnPrice

No (advanced property only)

boolean: true / false or mode enum

Controls whether strict input validation is performed during pricing calculations (Price Lists, LPG, simulations, etc.). When enabled, calculations run in a mode equivalent to strict validation (rejecting/flagging invalid inputs); when disabled, input handling is more lenient for backward compatibility or performance reasons.

Calculation Grids

calculationGridItemPrefix

– (advanced property only)

text (prefix, e.g. CGI- or similar)

Sets the prefix used in Calculation Grid item unique names, analogous to priceGridItemPrefix for LPG items. Affects how CG items are labeled/numbered in the database and UI.

Analytics – Calendar / Time Period

calendarThrowOnInvalidTimePeriod

– (advanced property only)

boolean: true / false

Controls how invalid time‑period strings are handled by calendar utilities used in Analytics (e.g. CalendarUtil.parseTimePeriod). When true (default), invalid time periods cause an exception to be thrown; when false, the legacy behaviour is kept, where some invalid values may return a DAY time period or null instead of failing explicitly.

Quotes, Agreements & Promotions – CLIC performance

clicHeaderInputJsonWarnLimitSizeInKB

– (advanced property only)

integer (size in kB, default 500)

Defines the warning threshold (in kB) for the size of the inputsJson field on CLIC headers (Quotes, Agreements, etc.). When the header is saved and inputsJson exceeds this size, a WARN log is written, e.g. “Limit 15 kB for inputsJson in CT‑123 exceeded…”. Helps detect pathological cases where very large JSON is persisted by logic or serialization issues.

Quotes, Agreements & Promotions – CLIC performance

clicHeaderOutputJsonWarnLimitSizeInKB

– (advanced property only)

integer (size in kB, default 500)

Same concept as clicHeaderInputJsonWarnLimitSizeInKB, but for the outputsJson field on CLIC headers. When a header is saved and outputsJson exceeds the configured size, a WARN log is emitted to highlight unusually large payloads.

Quotes, Agreements & Promotions – CLIC performance

clicLineItemInputJsonWarnLimitSizeInKB

– (advanced property only)

integer (size in kB, default 500)

Warning threshold (in kB) for inputsJson on CLIC line items. When a line item is saved and its inputsJson exceeds this size, a WARN log is written. Line‑item limits are cached to avoid repeatedly hitting the DB when many items are persisted.

Quotes, Agreements & Promotions – CLIC performance

clicLineItemOutputJsonWarnLimitSizeInKB

– (advanced property only)

integer (size in kB, default 500)

Warning threshold (in kB) for outputsJson on CLIC line items. Exceeding the limit when saving a line item logs a WARN entry to help identify over‑sized output payloads coming from logics.

Rebates / Condition Records

conditionRecordItemPrefix

– (advanced property only)

text (prefix, e.g. CRI-)

Sets the prefix for Condition Record item unique names, similarly to other …Prefix options (e.g. rebateRecordGroupPrefix for rebate record groups). Used when generating IDs for new condition record items.

Quotes, Agreements & Promotions – CLIC internals

contractTmpPrefix

– (advanced property only)

text (prefix, e.g. CTTMP-)

Prefix used for temporary Contract (CLIC) documents created during certain operations (e.g. autosave, try‑new flows, or background processing). Mainly internal but can be adjusted if you need a specific naming convention for temporary contract objects.

Application – Navigation / Help

customHelpUrl

– (advanced property only; typically via Feature Flags / crm_config)

text (URL)

Overrides the default Help / Documentation URL in the UI. When set, Help links in the application will open this custom URL instead of the standard Pricefx documentation entry point.

Application – Navigation / Login

customLogoutURL

– (advanced property only; typically via Feature Flags / crm_config)

text (URL)

Overrides the default logout redirect URL. After logging out of the Pricefx UI, users are redirected to this URL (for example, an SSO portal or corporate landing page) instead of the standard login page.

Agreements & Promotions

defaultContractTypeFilterFormula

Administration > Logics > Filter Logics > Agreements & Promotions > Condition Types

text (logic name)

Name of the default Condition Filter Logic to use for Agreements & Promotions when no condition‑type specific filter logic is defined on the Agreement/Promotion Type. Works analogously to the equivalents in Rebates and Sales Compensation.

CLIC – UI / Validation badges

persistValidationBadges

– (advanced property only)

boolean: true / false

Controls whether validation badges for CLIC line items are stored persistently in a dedicated table instead of only in viewState JSON. When true (new behaviour), validation results are persisted and can be queried/cleaned independently; when false, the legacy storage in viewState is used. Provided mainly as a feature flag / rollback switch for the new persistent implementation.

Price Grids – Storage optimisation

priceGridItemOmitMappedCalculationResults

– (advanced property only)

boolean: true / false

Controls whether mapped calculation results are removed from the allCalculationResults JSON stored on LPG items. When the property does not exist or is false, all calculation results (mapped + unmapped) are stored. When true, any result values already mapped to LPG columns are omitted from allCalculationResults, significantly reducing XPGI size for large LPGs.

Templates – Publishing (Contracts, Quotes, etc.)

publishingTemplates_

– (internal base name; use suffixed options)

internal prefix; use publishingTemplates_<typeCode>

Not a standalone option for configuration. This is the base prefix for typed options such as publishingTemplates_Q, publishingTemplates_CT, etc., which are already documented as publishingTemplates_<typeCode> and define Excel/Word templates for publishing documents to XLSX/PDF/DOC. Keep using the suffixed options; do not configure publishingTemplates_ directly.

Analytics – Query API

queryApiDisableDateOnlyFieldsStoredAsDateTimeConversion

– (advanced property only)

boolean: true / false

Feature flag for a QueryAPI fix that converts fields stored as date‑only but exposed as datetime. When false (default), the fix is enabled and such fields are converted consistently. When set to true, the conversion is disabled and the legacy behaviour is kept for backward‑compatibility in projects that depend on the old semantics.

Quotes – CLIC internals

quoteTmpPrefix

– (advanced property only)

text (prefix, e.g. QTTMP-)

Prefix used for temporary Quote (CLIC) documents created during certain operations (try‑new, autosave drafts, background processing, etc.). Mainly internal, but can be changed if a different naming convention for temporary quotes is needed.

Rebates – Rebate Record Groups

rebateRecordGroupPrefix

– (advanced property only)

text (prefix, default described in rebate docs)

Sets the prefix for Rebate Record Group names in Rebates, similar to how rebateAgreementPrefix or other …Prefix options control document IDs. Used when generating new rebate record groups.

Quotes & Agreements & Promotions – CLIC

saveAllOutputsFromTmpClic

– (advanced property only)

boolean: true / false

Controls a fix where, when saving a CLIC document (Quote / Contract, etc.), all outputs from the temporary CLIC are copied to the persisted object so that another user opening the document sees the same calculated outputs without recalculation. If the property is absent or true, the fix is applied; if explicitly set to false, the old behaviour (outputs not fully copied, second user sees “pre‑recalc” state) is restored for rollback.

Price Lists

enableMassActionsDuringPLCalculation

– (advanced property only)

boolean: true / false

Allow multiple mass edits to run in parallel.