Skip to main content

System Configurator

The System Configurator window (Menu => System Admin => General Rules => System Rules) lets you define global parameters that are stored in the database. This way you can control program flow without changing code.

  • Parameters are defined in the format Name-Value.
  • Model class used: MSysConfig.
  • Entries are stored in the table AD_SysConfig.
  • Entries can be made in the Application Dictionary or as a normal user.
  • Examples in base/src/org/adempiere/pdf/Document.writePDF() and client/src/org/compiere/apps/AMenu.run(). In Document.writePDF(), for example, the PDF font can be set dynamically.

Usage example​

private final static String MY_GLOBAL_DB_VARIABLE = "VARIABLE_DEFINED_IN_DB";

String xxxx = MSysConfig.getValue(MY_GLOBAL_DB_VARIABLE, "");

if (xxxx != null && xxxx.trim().length() > 0)
    // ...

Available keys​

0-9​

2PACK_COMMIT_DDL​

If set to Y 2Pack tries to behave in PostgreSQL same as with Oracle - committing before and after DDL statements

2PACK_HANDLE_TRANSLATIONS​

Define if 2pack handle translations or not (legacy 2pack)

A​

ADDRESS_VALIDATION​

Enable address validation by country codes - separated by semicolons

AD_CHANGELOG_SAVE_UUID​

Save AD_ChangeLog.Record_UU, this is set by default to B to preserve disk space. Valid options are: B - just based UUID tables, A - always, U - just UUID, not ID

ALERT_SEND_ATTACHMENT_AS_XLS​

Alert processor send the attachments as XLS (N->plain text)

ALLOCATION_DESCRIPTION​

Define format for Allocation Description

ALLOW_APPLY_PAYMENT_TO_CREDITMEMO​

Allow applying payment to a credit memo

ALLOW_OVER_APPLIED_PAYMENT​

Allow a payment to be over applied to an invoice

ALLOW_REVERSAL_OF_RECONCILED_PAYMENT​

Define if the user is allowed to reverse a payment that was already reconciled

ALogin_ShowDate​

Show date field login

APPLICATION_DATABASE_VERSION​

Database version to show on login page

  • Values: defaults to select lastmigrationscriptapplied from ad_system
  • Reference: IDEMPIERE-2259

APPLICATION_DATABASE_VERSION_SHOWN​

Defines if database version must be shown on login page

  • Values: defaults to false if AD_System.SystemStatus = Production, otherwise defaults true
  • Reference: IDEMPIERE-2259

APPLICATION_HOST_SHOWN​

Defines if host must be shown on login page

  • Values: defaults to false if AD_System.SystemStatus = Production, otherwise defaults true
  • Reference: IDEMPIERE-2259

APPLICATION_IMPLEMENTATION_VENDOR​

Implementation vendor to show on login page

  • Values: defaults to "Supported by iDempiere community"
  • Reference: IDEMPIERE-2259

APPLICATION_IMPLEMENTATION_VENDOR_SHOWN​

Defines if implementation vendor must be shown on login page

APPLICATION_JVM_VERSION_SHOWN​

Defines if JVM version must be shown on login page

  • Values: defaults to false if AD_System.SystemStatus = Production, otherwise defaults true
  • Reference: IDEMPIERE-2259

APPLICATION_LOGIN_INFO_SHOWN​

Defines if this server is used for demo purposes, to show the login information at the left panel and provide quick fill of User/Password

APPLICATION_LOGIN_LEFT_PANEL_SHOWN​

Defines if the left panel is shown on login page, possible values Y=Yes (not collapsed), H=Hidden (collapsed), I=Invisible (not shown at all)

APPLICATION_MAIN_VERSION​

Main version to show on login page

APPLICATION_MAIN_VERSION_SHOWN​

Defines if app main version must be shown on login page

APPLICATION_OS_INFO_SHOWN​

Defines if OS info must be shown on login page

  • Values: defaults to false if AD_System.SystemStatus = Production, otherwise defaults true
  • Reference: IDEMPIERE-2259

APPLICATION_URL​

Server URL to generate zoom for a record. When empty, or using the value USE_HARDCODED, the system generates an URL with current protocol, server name, port, context

ATTACHMENT_SAVE_LIST_IN_AD_ATTACHMENTFILE​

This key defines if the list of attachment files is saved in the table AD_AttachmentFile

ATTACH_EMBEDDED_2PACK​

When processing automatically a 2Pack (plugin or external), this key defines if the zip file is attached to the corresponding AD_Package_Imp_Proc record, this can be useful for posterior reprocessing

ATTACH_NOTIFY_2PACK​

This key defines if the summary of the 2Pack must be attached to the corresponding Pack In record, the summary will have the name "error_yyyymmddhhmmss.log" or "result_yyyymmddhhmmss.log", depending if the Pack In failed or succeeded

AUTOMATIC_PACKIN_FOLDERS​

This key defines a folder, or a set of folders separated by semicolon (;). When starting the plugin org.adempiere.plugin.utils, it searches for new packins to apply present on these folders and applies them automatically

AUTOMATIC_PACKIN_INITIAL_DELAY​

Time in seconds that org.adempiere.plugin.utils waits before starting to process the AUTOMATIC_PACKIN_FOLDERS, this is useful in order to wait for the internal plugins to be processed first

AUTOMATIC_PACKIN_PROCESSING​

This key is used internally by the automatic application of 2Packs as a semaphore to indicate that another 2Pack is being applied, is not intended to be managed by user, but automatically managed by the system.

AUTOMATIC_PACKIN_RETRIES​

When applying automatically a 2Pack, this defines the number of retries to wait for the semaphore when other plugins are applying 2Packs, this is used in combination with AUTOMATIC_PACKIN_TIMEOUT

AUTOMATIC_PACKIN_TIMEOUT​

When applying automatically a 2Pack, this defines the waiting time to try to get the semaphore when other plugins are applying 2packs, this is used in combination with AUTOMATIC_PACKIN_RETRIES

AUTO_ASSIGN_ROLE_TO_CREATOR_USER​

This key defines if a role is assigned to the creator user when creating a new role

B​

BACKGROUND_JOB_ALLOWED​

Defines if reports as background jobs are allowed

BACKGROUND_JOB_BY_DEFAULT​

Defines if reports are executed as background job by default

BACKGROUND_JOB_MAX_IN_SYSTEM​

Maximum background reports running per system

BACKGROUND_JOB_MAX_PER_CLIENT​

Maximum background reports running per tenant

BACKGROUND_JOB_MAX_PER_USER​

Maximum background reports running per user

BANK_STATEMENT_POST_WITH_DATE_FROM_LINE​

By default bank statement post with date from header, when this is set to Y then it changes to post with date from line, it can cause accounting problems because two bank statement lines can fit in two different accounting periods

BPARTNER_QUICK_ENTRY_OPTIONAL_LOCATION_TABLES​

On the business partner quick entry window, the location is defined as mandatory, this configurator allows to define a list of tables where the Location is optional

C​

CALENDAR_ALTERNATE_TIMEZONE​

Alternate time zone to show in Calendar window. It can be defined as one zone or several zones separated by comma, as sample in Calendars.setTimezone. A zone is defined by a title =timezone, title is shown in the calendar, and the timezone must conform to timezone standard. If set empty (a whitespace) then no alternate timezone is shown.

  • Values: Default when not set: Pacific Time=PST
  • Reference: IDEMPIERE-832

CASH_AS_PAYMENT​

Record Cash as a Payment (True) or Cash Journal (False)

CHANGE_PASSWORD_MUST_DIFFER​

  • Reference: IDEMPIERE-374 Change password must be changed to be a form instead of a process

CHART_MIN_WIDTH_3_PERIOD​

Define the width where 3 periods fit in charts (using billboard)

CHART_MIN_WIDTH_6_PERIOD​

Define the width where 4 periods fit in charts (using billboard)

CHECK_CREDIT_ON_CASH_POS_ORDER​

Check credit on cash POS order

CHECK_CREDIT_ON_PREPAY_ORDER​

Check credit on prepay order

CKEDITOR_FILE_CONFIG​

Path to the config file of CKEditor

  • Values: defaults to /js/ckeditor/config.js
  • Reference: IDEMPIERE-6953

CKEDITOR_FILE_CONFIG_MIN​

Path to the minimum (ie when in mobile mode) config file of CKEditor

  • Values: defaults to /js/ckeditor/config-min.js
  • Reference: IDEMPIERE-6953

CLIENT_ACCOUNTING​

Enable client Accounting

  • Values: D - Disabled (default)
    Q - Queue (enabled to post by hand - queue documents for posterior processing)
    I - Immediate (immediate post)
  • Reference: FR 2857807

COPY_TENANT_BATCH_FLUSH_SIZE​

Copy Tenant feature now insert into batches, this configurator defines the batch size for the insert

CSV_EXPORT_SANITIZATION​

Enable CSV Export Sanitization

  • Values: Y - Sanitize CSV Exports (default) / N - do not sanitize
  • Scope: Tenant
  • Reference: IDEMPIERE-6844

D​

DASHBOARD_LAYOUT_ORIENTATION​

Change dashboard layout orientation

  • Values: C = Column (default/fallback)
    R = Row
  • Reference: IDEMPIERE-5389

DB_READ_REPLICA_NORMAL_MAX_ITERATIONS​

Number of iterations to try before giving up when trying to get a connection to read replica for reports

DB_READ_REPLICA_NORMAL_TIMEOUT_IN_MILLISECONDS​

Timeout in milliseconds to wait for the replica to sync for reports

DB_READ_REPLICA_URLS​

Pipe ( | ) separated list of JDBC URLs of read only replicas for reporting

  • Values: if empty (default) reporting from replica is not enabled
  • Reference: IDEMPIERE-3850

DEFAULT_COA_PATH​

Path for default Chart of Accounts

  • Values: $IDEMPIERE_HOME/data/import/AccountingDefaultsOnly.csv
  • Reference: IDEMPIERE-1685

DEFAULT_ENTITYTYPE​

Default value for Entity Type field in windows

DICTIONARY_ID_PASSWORD​

Developer password

DICTIONARY_ID_USER​

Developer username

DICTIONARY_ID_USE_CENTRALIZED_ID​

Assign the dictionary ID's from a centralized website reservation instead of sequences

DICTIONARY_ID_WEBSITE​

Website providing the ID reservation service for iDempiere

DOCACTIONBUTTON_SHOWACTIONNAME​

DPViews_ShowInfoAccount​

Defines if Info Account must be shown on Views dashboard

DPViews_ShowInfoSchedule​

Defines if Info Schedule must be shown on Views dashboard

E​

EMAIL_NOTIFY_2PACK​

This key defines an email or list of emails separated by comma (,). When defined the application of a 2Pack zip file (automatic or manual) will send a notification email to the emails on the list. This key can be configured by tenant and for System, the emails configured for System will be added to the list when processing a tenant.

EMAIL_SERVER_START_ENABLED​

Enable/disable the "Send Email" feature upon server startup

  • Values: defaults to true (send email)
  • Scope: System
  • Reference: IDEMPIERE-6421

EMAIL_SERVER_START_MAILTEXT_ID​

ID of the mail template to be used when sending the EMail when the server starts

  • Values: if not set the system will use the hardcoded content
  • Scope: System
  • Reference: IDEMPIERE-4063

EMAIL_SERVER_START_RECIPIENT​

Allow to override the recipient of the email sent when the server starts

  • Values: if not set the system will use what is defined in RequestEMail of System tenant
  • Scope: System
  • Reference: IDEMPIERE-4063

EMAIL_TEST_MAILTEXT_ID​

ID of the mail template to be used on the EMail Test process

  • Values: if not set the system simply uses the string "EMail Test"
  • Reference: IDEMPIERE-4359

ENABLE_PAYMENTBOX_BUTTON​

Defines if the payment button besides the payment rule is shown or not

ENABLE_SSO​

Defines if SSO is used in the system

ENABLE_SSO_IDEMPIERE_MONITOR​

Defines if SSO is used for the idempiereMonitor

ENABLE_SSO_OSGI_CONSOLE​

Defines if SSO is used for the OSGI console

EXPORT_BLOB_COLUMN_FOR_INSERT​

When exporting records as SQL insert, it defines if the BLOB columns are exported or not

F​

FEEDBACK_EMAIL_CC​

Comma separated list of carbon copy recipients for feedback EMail

FEEDBACK_EMAIL_TO​

Comma separated list of recipients for feedback EMail

FORCE_POSTING_PRIOR_TO_PERIOD_CLOSE​

Define if closing period with unposted documents is allowed, by default is forcing to post documents first

FORM_SQL_PROCESS_ALLOWED_KEYWORDS​

Commands allowed to execute in the form SQL Process

  • Values: default: ALTER, ANALYZE, COMMENT, CREATE, DELETE, DROP, GRANT, INSERT, REINDEX, REVOKE, SET, UPDATE, TRUNCATE, VACUUM
  • Reference: IDEMPIERE-5450

FORM_SQL_QUERY_ALLOWED_KEYWORDS​

Commands allowed to execute in the form SQL Query

FORM_SQL_QUERY_LOG_ISSUE​

Log queries executed in SQL Query form in AD_Issue table

FORM_SQL_QUERY_MAX_RECORDS​

Maximum number of records to query in SQL Query form

FORM_SQL_QUERY_TIMEOUT_IN_SECONDS​

Timeout in seconds for queries executed in SQL Query form

G​

GLOBAL_MAX_QUERY_RECORDS​

Defines the maximum number of records allowed to be loaded when opening a window, zero means no limit (not recommended)

  • Values: defaults to 100.000 records
  • Scope: Tenant
  • Reference: IDEMPIERE-6123

GLOBAL_MAX_REPORT_RECORDS​

Defines the maximum number of records allowed to be printed in a report, zero means no limit (not recommended)

  • Values: defaults to 100.000 records
  • Scope: Tenant
  • Reference: IDEMPIERE-6123

GRIDTABLE_INITIAL_COUNT_TIMEOUT_IN_SECONDS​

Defines the maximum number of seconds allowed for the initial count SQL to run when opening a window, zero means no limit (not recommended)

  • Values: defaults to 1 second
  • Scope: Tenant
  • Reference: IDEMPIERE-6123

GRIDTABLE_LOAD_TIMEOUT_IN_SECONDS​

Timeout in seconds to wait for complete gridtable load

H​

HTML_REPORT_MINIFY​

Defines the HTML of reports is minified

HTML_REPORT_THEME​

Name of optional theme for HTML reports on webui

I​

IBAN_VALIDATION​

This key defines if the system must apply IBAN validation for the fields IBAN on the different tables, like Bank Account, BP Bank Account, Payment, Payment Transaction. For countries where the IBAN is not used, or used for a different purpose, then is recommended to disable this flag

IDENTIFIER_SEPARATOR​

This defines the separator to be used in the generation of a display column for foreign fields

IMAGE_DB_STORAGE_SAVE_AS_ZIP​

Defines if the images are saved raw or zipped in the AD_Image table

INFO_PRODUCT_SHOW_PRODUCTS_WITHOUT_PRICE​

Defines if the products without price are also shown in the Info Product Window

Invoice_ReverseUseNewNumber​

  • Reference: IDEMPIERE-148 Allow reversal invoice to use DocNo^ instead of consuming an invoice #

J​

JASPER_SWAP_MAX_PAGES​

L​

LABEL_AUTOMATIC_COLOR​

Defines if a color is assigned automatically to labels/tags based on its name

LASTRUN_RECORD_COUNT​

Number of last run records to show on processes/reports

LDAP_TYPE​

  • Reference: IDEMPIERE-3861 Define LDAP Type: openldap - or any other value for the standard

LOCATION_MAPS_DESTINATION_ADDRESS​

LOCATION_MAPS_ROUTE_PREFIX​

LOCATION_MAPS_SOURCE_ADDRESS​

LOCATION_MAPS_URL_PREFIX​

LOCATION_MAX_CITY_ROWS​

  • Reference: FR 2794312 Location AutoComplete

LOGIN_HELP_URL​

  • Values: http://wiki.idempiere.org/{lang}/Login_Help
  • Reference: IDEMPIERE-77

LOGIN_PREFIX_SEPARATOR​

Prefix to use when specifying tenant on login

LOGIN_SELECT_ROLE_HELP_URL​

  • Values: https://wiki.idempiere.org/{lang}/Login_Select_Role_Help
  • Reference: IDEMPIERE-5463

LOGIN_SHOW_RESETPASSWORD​

LOGIN_WITH_TENANT_PREFIX​

Specify Tenant on Login. WARNING! In order to use this feature you need to configure a login prefix for every tenant that is going to use this feature (or for all tenants in case the Force option is configured). (N)o / (A)llow / (F)orce

M​

MAIL_DONT_SEND_TO_ADDRESS​

For test systems you can set up this key to avoid sending unwanted messages. If combined with MAIL_SEND_BCC_TO_ADDRESS, then it will send messages just to the configured address

MAIL_SEND_BCC_TO_ADDRESS​

You can register an e-mail address and all the outgoing mails from iDempiere will be sent BCC there

MAIL_SEND_BCC_TO_FROM​

When enabled the outgoing mails from iDempiere will be sent BCC to the originating user

MAIL_SEND_CREDENTIALS​

The credentials for sending email (user/password) are taken from: U-User/C-Client/S-System

  • Reference: IDEMPIERE-722 Make email credentials configuration more flexible

MAIL_SMTP_CONNECTIONTIMEOUT​

Timeout in milliseconds to wait for SMTP connection, -1 leaves the java default

MAIL_SMTP_TIMEOUT​

Timeout in milliseconds to send an email

MAIL_SMTP_WRITETIMEOUT​

Timeout in milliseconds to wait for writing on SMTP connection, -1 leaves the java default

MAX_ACTIVITIES_IN_LIST​

Max number of activities in list

MAX_RESULTS_PER_SEARCH_IN_DOCUMENT_CONTROLLER​

Max number of results per search in menu/document controller

MAX_ROWS_IN_TABLE_COMBOLIST​

Max number of rows allowed to be loaded in a combo list

  • Values: defaults to 10000, max allowed is 50000
  • Reference: IDEMPIERE-5534

MAX_TEXT_LENGTH_ON_GRID_VIEW​

When showing long strings in grid view, the system shows the first N characters defined here and then an ellipsis (...)

Milliseconds of wait to run the infoupdater class on the menu window (just for swing)

  • Values: integer milliseconds default 60000
  • Reference: FR 1717125

MESSAGES_AT_TENANT_LEVEL​

Defines if messages can be translated at tenant level (See Messages at Client Level)

MFA_NTP_TIMEOUT_IN_MILLISECONDS​

NTP Timeout in case the TOTP mechanism check the time against an NTP server

  • Values: By default 5000 milliseconds (5 seconds)
  • Reference: IDEMPIERE-4782

MFA_REGISTERED_DEVICE_EXPIRATION_DAYS​

Default number of days when a device registered expires

MFG_ValidateCostsDifferenceOnCreate​

MFG_ValidateCostsOnCreate​

MONITOR_INITIAL_WAIT_FOR_CLUSTER_IN_SECONDS​

Defines a waiting time before starting the idempiereMonitor page to allow the cluster server to start

MONITOR_MAX_WAIT_FOR_CLUSTER_IN_SECONDS​

Defines the max waiting time to allow the cluster server to start before giving up

MROLE_GETDEFAULT_RETURNS_NULL_WHEN_NO_CONTEXT​

When looking for default role in context before login (in java code) a null role is returned, setting this to false is not recommended and is just for backward compatibility with legacy code that requires receiving System (0) role in this case

MSEQUENCE_GETNEXT_TIMEOUT​

Timeout in seconds for getting the next sequence from AD_Sequence table

O​

OAUTH2_USE_ACCESS_TOKEN_UPN_ON_MICROSOFT_PROVIDER​

When checking OAuth2 credentials with microsoft, sometimes the user email information is sent in the access_token in upn field, this is to obtain the preferred_username from the upn field

OAUTH2_USE_ID_TOKEN_PREF_USERNAME_ON_MS_PROVIDER​

When checking OAuth2 credentials with microsoft, sometimes the user email information is sent in the access_token in preferred_username field, this is to obtain the preferred_username from the preferred_username field

ORDER_COLUMNS_TO_COPY_TO_NOT_COMPLETED_INVOICES​

Comma separated list of columns to be copied when changing an order to not completed invoices

  • Values: Defaults to Description, POReference, PaymentRule, C_PaymentTerm_ID, DateAcct - can be defined at organization level
  • Reference: IDEMPIERE-5893

P​

PAYMENT_OVERWRITE_DOCUMENTNO_WITH_CHECK_ON_PAYMENT​

On Payment window, for payments overwrite the document number with the check number when tender type check

PAYMENT_OVERWRITE_DOCUMENTNO_WITH_CHECK_ON_RECEIPT​

On Payment window, for receipts overwrite the document number with the check number when tender type check

PAYMENT_OVERWRITE_DOCUMENTNO_WITH_CREDIT_CARD​

On Payment window overwrite the document number with the credit card number when tender type credit card

PAYMENT_SELECTION_MANUAL_ASK_INVOKE_GENERATE​

Defines if Generate Payment Selection must be called at the end of Payment Selection Manual

PDF_FONT_DIR​

Path to additional font use in report, making it available for PDF export

ProductUOMConversionRateValidate​

Enable/disable validation -> The Product UoM needs to be the smallest UoM - Multiplier must be > 0

ProductUOMConversionUOMValidate​

Enable/disable validation -> Select the Product UoM as the From Unit of Measure

PROJECT_ID_PASSWORD​

Developer password

PROJECT_ID_PROJECT​

The name of the project

PROJECT_ID_USER​

Developer username

PROJECT_ID_USE_CENTRALIZED_ID​

Assign the non-dictionary ID's for tables with entity type from a centralized website reservation instead of sequences

PROJECT_ID_WEBSITE​

Website providing the ID reservation service for the project

Q​

QUICKFORM_PAGE_SIZE​

The page size for the quick form feature

  • Values: Client configurable, defaults to 20
  • Reference: IDEMPIERE-4157

R​

READ_TABLES_NOT_IN_TABLE_ACCESS_INCLUDE_LIST​

Y/N -> N role has no access to other tables that is not part of the include list, Y to allow read only access to tables not in the include list (You still can use the Role Table Access Exclude feature to change it to no access for specific set of tables)

REAL_TIME_POS​

RecentItems_MaxSaved​

RecentItems_MaxShown​

REPORT_LOAD_TIMEOUT_IN_SECONDS​

Maximum number of seconds allowed for the SQL of a report to get the data

  • Values: defaults to 120 seconds
  • Scope: Tenant
  • Reference: IDEMPIERE-6123

REPORT_SWAP_MAX_ROWS​

S​

SECURITY_DASHBOARD_LEGACY_KEY_WARNING​

D/Y/N - D Disable the warning, otherwise Y/N are managed automatically by the system

SHIPPING_DEFAULT_WEIGHT_PER_PACKAGE​

  • Reference: Ticket #1001758: FedEx & UPS

SSO_SELECT_ROLE​

Defines if the role panel must be shown when login with SSO

SSO_SHOW_LOGINPAGE​

This setting controls whether the standard iDempiere login page is displayed when Single Sign-On (SSO) is enabled.

  • Y: When SSO is enabled, the system displays the standard login page along with the SSO login option. Users can log in either using iDempiere username/password or SSO authentication.
  • N: When SSO is enabled, the system only displays the SSO login option. The standard iDempiere username/password login is not shown, and users must authenticate using SSO.

STANDARD_REPORT_FOOTER_TRADEMARK_TEXT​

Define the system information to show on report footer

START_VALUE_BPLOCATION_NAME​

Define the start value for C_BPartner_Location.Name

  • 0 - City
  • 1 - City + Address1
  • 2 - City + Address1 + Address2
  • 3 - City + Address1 + Address2 + Region
  • 4 - City + Address1 + Address2 + Region + ID
  • Values: possible values = 0,1,2,3,4 -> default 0
  • Reference: FR 2582181

SWING_LOGIN_ALLOW_REMEMBER_ME​

Enable remember me feature on swing

  • Values: U - User
    P - User and password (default)
    N - None
  • Reference: FR 2893090

SWING_OVERRIDE_TEXT_AREA_BEHAVIOUR​

  • Reference: IDEMPIERE-320 Make Swing CTextArea consistent with ZK

SYSTEM_INSERT_CHANGELOG​

Keep change log for inserts: Y - Yes, N - No, K - just the key _ID

SYSTEM_IN_MAINTENANCE_MODE​

Defines if system is in maintenance mode, just advanced roles can login

SYSTEM_NATIVE_SEQUENCE​

Use db system sequences instead of ad_sequence

  • Values: Y/N defaults to N

T​

TAX_LOOKUP_SERVICE​

Defines the default tax lookup service (implementing the ITaxLookup interface)

  • Values: defaults to org.adempiere.base.DefaultTaxLookup
  • Reference: IDEMPIERE-5056

TOP_MARGIN_PIXELS_FOR_HEADER​

This sysconfig is optional, not required, code assumes 222 as the pixels to reserve for header space, made configurable as the number of pixels can depend on the theme

  • Reference: IDEMPIERE-581 Store divider location for window per user

TRACE_ALL_TRX_CONNECTION_GET​

When trying to find the point of a DB connection leak, the iDempiere monitor page can help showing the point where the connection has been opened or used. By default it shows an approximate, not the exact last point where a connection was used last time. Turning this key to Y will show the exact last usage helping to identify the exact line of code where the connection leak is happening. However, use it carefully, as setting this key to Y impacts adversely the performance.

TRX_AUTOSET_DISPLAY_NAME​

When enabled it automatically set the class and method from the caller for the methods createTrxName() or createTrxName(null). However, use it carefully, as setting this key to Y can impact performance adversely.

U​

UPLOAD_TEMP_FILENAME_PREFIX​

Prefix temporary filename for uploaded media

USER_LOCKING_MAX_ACCOUNT_LOCK_MINUTES​

USER_LOCKING_MAX_INACTIVE_PERIOD_DAY​

USER_LOCKING_MAX_LOGIN_ATTEMPT​

USER_LOCKING_MAX_PASSWORD_AGE_DAY​

USER_LOCKING_PASSWORD_NOTIFY_DAY​

Days to notify user about upcoming force of changing password

USER_PASSWORD_HASH​

This is set automatically when you execute the Convert Passwords to Hashes process

  • Values: default N
  • Scope: System
  • Reference: IDEMPIERE-347 passwords hash

USER_PASSWORD_HASH_ALGORITHM​

SHA-512 / Argon2 / PBKDF2 - defined when you execute the Convert Passwords to Hashes process

USE_EMAIL_FOR_LOGIN​

USE_ESC_FOR_TAB_CLOSING​

Define if tabs can be closed with the Esc key (additional to the Alt+X shortcut)

V​

VALIDATE_MATCHING_PRODUCT_ON_SHIPMENT​

Defines if at shipment time the shipment line is validated to match the product on the order line

  • Values: Client configurable, defaults to true
  • Reference: IDEMPIERE-5029

VALIDATE_MATCHING_TO_ORDERED_QTY​

Defines if MatchPO must validate against ordered qty

W​

WEBUI_LOGOURL​

URL for the logo in zkwebui

  • Values: resource or url, defaults to images/header-logo.png - just used if ZK_LOGO_SMALL is empty

X​

XLSX_EXPORT_USE_FAST_METHOD​

Y/N - Exporting to XLSX consumes too much memory, even with the possibility to crash the server, setting this configurator to N uses a better export method that doesn't consume so much resources, the drawback is that autoSizeColumn is not available

Z​

ZK_ADVANCE_FIND_FILTER_COLUMN_LIST​

Change column and operator list to editable combobox with auto complete

  • Values: Client configurable, defaults to false
  • Reference: IDEMPIERE-4865

ZK_AUTO_SAVE_CHANGES​

Auto save changes on windows (no need to press the Save button)

  • Values: Client configurable, defaults to false, since version 10
  • Reference: IDEMPIERE-5202

ZK_AUTO_SAVE_TABS_EXCLUDED​

Comma separated list of AD_Tab_ID or AD_Tab_UU value, tabs in the list will be excluded from the effect of the ZK_AUTO_SAVE_CHANGES flag

  • Values: Client configurable, since version 10
  • Reference: IDEMPIERE-5202

ZK_BROWSER_ICON​

Icon to use for browser on zkwebui

  • Values: defaults to /theme/[ZK_THEME]/images/icon.png
  • Reference: FR 2790994

ZK_BROWSER_TITLE​

Title to show in browser

ZK_BUTTON_STYLE​

Defines the style to show buttons: text, image or both

  • Values: (I)mage only, (T)ext only and (IT) - image + text (defaults to I)
  • Reference: IDEMPIERE-800

ZK_DASHBOARD_CALENDAR_REQUEST_DISPLAY_MODE​

To configure the requests to be displayed in the calendar:

  • C = Created By
  • S = Sales Rep
  • U = User/Contact

By default, it is set to CSU, it will display the requests in the calendar if the logged in user is the Sales Rep, User/Contact or Created By. Set it to SU if you would like to show requests where the Sales Rep or User/Contact is the logged in user.

ZK_DASHBOARD_PERFORMANCE_REFRESH_INTERVAL​

Milliseconds of wait to run the goal update for performance indicators

ZK_DASHBOARD_REFRESH_INTERVAL​

Milliseconds of wait to run the dashboard refresh on zk webui client

  • Values: integer milliseconds default 60000
  • Reference: FR 2486831

ZK_DECIMALBOX_PROCESS_DOTKEYPAD​

Defines if numeric entry must treat the dot keypad as decimal separator on language

ZK_DESKTOP_CLASS​

package+classname of zk desktop class
possible values:

  • org.adempiere.webui.desktop.DefaultDesktop
  • org.adempiere.webui.desktop.NavBarDesktop
  • org.adempiere.webui.desktop.NavBar2Desktop
  • org.adempiere.webui.desktop.TabbedDesktop

or any custom class you implement to manage your desktop

  • Values: package+classname defaults to org.adempiere.webui.desktop.DefaultDesktop

ZK_DESKTOP_HEADER_BACKGROUND_COLOR​

Defines the background color to show on the header, this is useful to differentiate test and development environments from production.

  • Values: default is defined by theme in desktop.css.dsp
  • Reference: IDEMPIERE-6413

ZK_DESKTOP_HEADER_MESSAGE_VALUE​

Defines the Search Key of a message to show on the desktop header, this is useful to differentiate test and development environments from production. But also can be used to show a message to users.

ZK_DESKTOP_SHOW_HOME_BUTTON​

When Y, add Home toolbar button for desktop client (This is an existing feature for mobile client)

  • Values: Y/N type Client level System Config entry, default to Y
  • Reference: IDEMPIERE-4949

ZK_DESKTOP_SHOW_TAB_LIST_BUTTON​

When Y, add toolbar button to show a list of open tabs for desktop client (This is an existing feature for mobile client)

  • Values: Y/N type Client level System Config entry, default to Y
  • Reference: IDEMPIERE-4949

ZK_DESKTOP_TAB_AUTO_SHRINK_TO_FIT​

  • When Y, ZK_DESKTOP_SHOW_TAB_LIST_BUTTON is always on regardless of the actual value of ZK_DESKTOP_SHOW_TAB_LIST_BUTTON
  • When Y, tab scroll button is made hidden, you have to use the tab list dropdown to select tab that's not visible.
  • When Y, tab will be auto shrink to fit more tabs on screen (similar to how Chrome tabs work).
  • Values: Y/N type Client level System Config entry, default to N
  • Reference: IDEMPIERE-4949

ZK_DESKTOP_TAB_MAX_TITLE_LENGTH​

Set the maximum length of desktop tab title/label

  • Values: Integer type Client level System Config entry, default to 30
  • Reference: IDEMPIERE-4949

ZK_ERROR_MSG_LIFETIME_MILLISECONDS​

Lifetime for the popup error message on windows. Setting to zero will make the popup stay open and requires manual closing

  • Values: Integer type Client level System Config entry, default to 3500 (3.5 seconds)
  • Reference: IDEMPIERE-5300

ZK_FIELD_LABEL_ABOVE_INPUT​

Y/N - in zkwebui positions the labels above the fields

ZK_FIELD_MOBILE_LABEL_ABOVE_INPUT​

Y/N - in zkwebui mobile positions the labels above the fields

ZK_FIELD_MOBILE_SMALL_WIDTH_LABEL_ABOVE_INPUT​

Y/N - in zkwebui defines if the label has a small width

  • Values: default Y for mobile when width < 500px
  • Scope: Tenant
  • Reference: IDEMPIERE-6502

ZK_FLAT_VIEW_MENU_TREE​

Defines if the menu tree is shown as flat

This key can change the format that is used on the dates on footer of reports

This key allows to change the message that is shown on report footers

ZK_GRID_AFTER_FIND​

Set the default value for setting the tab in grid view when the Find panel closes. This value can be overwritten using user preferences (see Force Grid Mode When Find Panel Closes for more details)

ZK_GRID_AUTO_HIDE_EMPTY_COLUMNS​

When Y, auto hide a grid column if it is with empty content for all rows of current page

  • Values: Client level, default to N (false)
  • Reference: IDEMPIERE-4835

ZK_GRID_EDIT_MODELESS​

  • Y -> grid view will enter in edit mode
  • N -> grid view will default as readonly, user have to click on the currently selected row or press enter key to enter edit mode
  • Values: Y/N - Default Y (enter in edit mode)
  • Reference: FR 2688854

ZK_GRID_MOBILE_AUTO_HIDE_EMPTY_COLUMNS​

Y/N - Defines the default for the auto-hide empty columns on grid for windows. This can be overridden by the user using grid customization

  • Values: default Y on mobile, N on desktop
  • Scope: Tenant
  • Reference: IDEMPIERE-6502

ZK_GRID_MOBILE_EDITABLE​

Disable AD Window grid view edit mode

ZK_GRID_MOBILE_EDIT_MODELESS​

Same as ZK_GRID_EDIT_MODELESS, but this definition just applies for mobile screens

ZK_GRID_MOBILE_LINE_BREAK_AS_IDENTIFIER_SEPARATOR​

Use line break to replace identifier separator

ZK_GRID_MOBILE_MAX_COLUMNS​

The max number of columns to show in grid view on mobile screens

ZK_GRID_MOBILE_SHOW_CURRENT_ROW_INDICATOR​

Hide current row indicator for mobile

ZK_GRID_VIEW_USE_DEFER_RENDERING​

Defer row rendering for grid view, should give faster paging response

  • Values: Client configurable, defaults to false
  • Reference: IDEMPIERE-4519

ZK_INFO_AUTO_COLLAPSED_PARAMETER_PANEL​

When set to Y, info window will auto collapse the parameter panel if query returns >= 1 records

  • Values: Client configurable, defaults to false
  • Reference: IDEMPIERE-5743

ZK_INFO_AUTO_HIDE_EMPTY_COLUMNS​

Set this to Y to turn on the auto hide feature system wide or tenant wide

  • Values: Client configurable, defaults to false
  • Reference: IDEMPIERE-4841

ZK_INFO_MOBILE_AUTO_COLLAPSED_PARAMETER_PANEL​

Y/N - just for mobile: When set to Y, info window will auto collapse the parameter panel if query returns >= 1 records

  • Values: default Y on mobile, on desktop defaults to ZK_INFO_AUTO_COLLAPSED_PARAMETER_PANEL
  • Scope: Tenant
  • Reference: IDEMPIERE-6502

ZK_INFO_MOBILE_AUTO_HIDE_EMPTY_COLUMNS​

Y/N - Defines the default for the auto-hide empty columns on grid for INFO windows. This can be overridden by the user using grid customization

  • Values: default Y on mobile, on desktop defaults to ZK_INFO_AUTO_HIDE_EMPTY_COLUMNS
  • Scope: Tenant
  • Reference: IDEMPIERE-6502

ZK_INFO_NUM_PAGE_PRELOAD​

Number of pages pre-loaded into cache, actual has ZK_INFO_NUM_PAGE_PRELOAD * 2 + 1 pages in cache (ZK_INFO_NUM_PAGE_PRELOAD previous pages, ZK_INFO_NUM_PAGE_PRELOAD next pages and current page)

ZK_INFO_QUERY_TIME_OUT​

This is to configure the query timeout for info window (in seconds)

  • Values: Client configurable, defaults 120 (2 minutes), zero means no timeout
  • Reference: IDEMPIERE-4628

ZK_LOGIN_ALLOW_CHROME_SAVE_PASSWORD​

Defines if the password field on login page allows to be saved in chrome

ZK_LOGIN_ALLOW_REMEMBER_ME​

Enable remember me feature on zkwebui

  • Values: U - User (default)
    P - User and password
    N - None
  • Reference: FR 2893090

ZK_LOGO_LARGE​

URL for large logo in zkwebui

  • Values: defaults to images/logo.png
  • Reference: SVN rev 9197

ZK_LOGO_SMALL​

URL for small logo in zkwebui

ZK_MAX_ATTACHMENT_PREVIEW_SIZE​

Max size for an attachment to be previewed

  • Values: Client configurable, defaults to 1048576 (1MB)
  • Reference: IDEMPIERE-1117

ZK_MAX_UPLOAD_SIZE​

  • Scope: Tenant
  • Reference: IDEMPIERE-763 Maximum size for File Upload

ZK_MOBILE_PAGING_SIZE​

Same as ZK_PAGING_SIZE, but this setting applies for mobile screens

ZK_PAGING_DETAIL_SIZE​

Default paging size for the detail records in zk webui. The format of ZK_PAGING_DETAIL_SIZE is a list of components separated by semicolon ( ; ). The first component is the wide default, next components are exceptions defined as pair of tab:size - where tab can be AD_Tab_ID, AD_Tab_UU or AD_TableName

ZK_PAGING_SIZE​

Default paging size for grid view in zk webui

ZK_REPORT_FORM_OUTPUT_TYPE​

Type of output in zkwebui for reports of type form, possible values are PDF, HTML, XLS

ZK_REPORT_JASPER_OUTPUT_TYPE​

ZK_REPORT_ONLY_PRINTFORMAT_LINKEDTO_REPORTVIEW​

Defines if the list of print formats is filtered by the report view, or just the table

ZK_REPORT_TABLE_OPEN_IN_NEW_TAB​

Enable open tabular report on same tab instead open new

ZK_REPORT_TABLE_OUTPUT_TYPE​

Type of output in zkwebui for reports of type table, possible values are PDF, HTML, XLS

ZK_ROOT_FOLDER_BROWSER​

Indicates the root for zk folder browser

  • Values: server folder - if not set, or -2 defaults to Server Adempiere Home
  • Reference: c2072ab

ZK_SEARCH_AUTO_COMPLETE_MAX_ROWS​

Max records for Search autocomplete

  • Values: Client configurable, defaults to 500
  • Reference: IDEMPIERE-4651

ZK_SEARCH_AUTO_COMPLETE_TIMEOUT​

Defines the timeout in seconds for the autocomplete feature

ZK_SEQ_DEFAULT_VALUE_PANEL​

Allows to configure the sequence of finding a default value on info panel, input parameter panel

  • Values: "1" means from special case
    "2" means from sql default
    "3" means from default logic
    "4" means user preference
    "5" means from system preference
    "6" means preference for field lie down at panel as process parameter, info parameter,...
    "7" means data-type default
    default value is "623"
  • Reference: IDEMPIERE-2296

ZK_SESSION_FINGERPRINT_CHECK_ACCEPT_LANGUAGE​

Checks the Accept-Language header for fingerprinting of session. Accepted values are N/W/L/S - N-Do Nothing / W-Log a Warning in logs / L-Log a Severe in logs and AD_Issue / S-Stop the execution, logout the user

ZK_SESSION_FINGERPRINT_CHECK_IP​

Checks the IP address for fingerprinting of session. Accepted values are N/W/L/S - N-Do Nothing / W-Log a Warning in logs / L-Log a Severe in logs and AD_Issue / S-Stop the execution, logout the user

  • Values: default L (Log Severe)
  • Scope: System
  • Reference: IDEMPIERE-6809

ZK_SESSION_FINGERPRINT_CHECK_USER_AGENT​

Checks the User-Agent header for fingerprinting of session. Accepted values are N/W/L/S - N-Do Nothing / W-Log a Warning in logs / L-Log a Severe in logs and AD_Issue / S-Stop the execution, logout the user

ZK_SESSION_FINGERPRINT_ENABLED​

Enable/disable the fingerprinting of sessions. Y/N - N disables completely the fingerprinting (not recommended)

ZK_SESSION_SAVE_JSESSIONID​

Y/N - defines if the jsessionid is saved in AD_Session.WebSession

ZK_SESSION_SAVE_USER_AGENT​

Y/N - defines if the User Agent from the browser is saved in MFA_RegisteredDevice.Help, Feedback attachment, AD_Session.Description or added to context as #UserAgent

ZK_SESSION_TIMEOUT_IN_SECONDS​

ZK session timeout

  • Values: if not set the timeout is taken from web.xml file
  • Reference: IDEMPIERE-2110

ZK_THEME​

Theme to use on zkwebui

  • Values: defaults to "default"
  • Reference: FR 2790994

ZK_THEME_USE_FONT_ICON_FOR_IMAGE​

Flag to indicate if using icon themes

ZK_THUMBNAIL_IMAGE_HEIGHT​

Height of thumbnail image for info window and grid view

ZK_THUMBNAIL_IMAGE_WIDTH​

Width of thumbnail image for info window and grid view

ZK_TOOLBAR_SHOW_MORE_VERTICAL​

Define if the "More" toolbar buttons are shown vertical or as an extended toolbar

  • Values: Client configurable, defaults to true
  • Reference: IDEMPIERE-4499

ZK_USE_PDF_JS_VIEWER​

Y - Use pdf.js viewer for pdf, N - use browser default viewer for pdf

  • Values: Client configurable, defaults to true
  • Reference: IDEMPIERE-4497

ZOOM_ACROSS_QUERY_TIMEOUT​

Timeout in seconds for the count queries ran when pushing the button Zoom Across