Reporting and Data Export (RDE) Configuration Parameters

When installing or updating Reporting and Data Export (RDE), use the parameters below in config.yaml.

Component Name

rateddataexport

Common Parameters

Parameter Default value
javaopts -XX:MinRAMPercentage=30.0 -XX:MaxRAMPercentage=70.0 -XX:MetaspaceSize=96m -XX:MaxMetaspaceSize=256m
db_secret bss-db
mindbpoolsize 1
maxdbpoolsize 16
jdbcconnectionparams ?sslmode=prefer&ApplicationName=rateddataexport
alerts_enabled false
resources.requests.cpu 500m
resources.requests.memory 1024Mi
resources.limits.cpu 4
resources.limits.memory 6Gi
rde_db_secret rateddataexport-db
rdedsport RDE database port
rdemindbpoolsize 1
rdemaxdbpoolsize 16
rdejdbcconnectionparams ?sslmode=prefer&ApplicationName=rateddataexport
oss_db_secret oss-db
ossdsport OSS database port
ossmindbpoolsize 1
ossmaxdbpoolsize 16
ossjdbcconnectionparams ?sslmode=prefer&ApplicationName=rateddataexport

Specific Parameters

Parameter Default value Description
proxyhost   The proxy server IP address.
proxyport   The proxy server port.
azconnstr   The Azure Storage connection string (if you use Azure Storage to store reports).
sftp_host   The SFTP server IP address (if you use an SFTP volume to store reports).
sftp_directory   The path to the directory to save reports.
sftp_port   The SFTP server port (if you use an SFTP volume to store reports).
sftp_login   The SFTP server login (if you use an SFTP volume to store reports).
sftp_password   The SFTP server password (if you use an SFTP volume to store reports).
dstimezone Europe/Berlin The time zone set on OSS. Use the region-based zone ID format area/city. For example: Europe/Moscow, America/New_York. For the full list of time zones, please refer to IANA Time Zone Database.
dslogin   The login to connect to the BSS database (if the BSS database is hosted outside your CloudBlue Commerce Kubernetes cluster).
dspassword   The password to connect to the BSS database (if the BSS database is hosted outside your CloudBlue Commerce Kubernetes cluster).
dsdbname   The BSS database name (if the BSS database is hosted outside your CloudBlue Commerce Kubernetes cluster).
dshost   The BSS database server IP address (if the BSS database is hosted outside your CloudBlue Commerce Kubernetes cluster).
result_set_fetch_size 1000 Note: This parameter is available only in RDE version 3.12 or later.
The number of rows that can be retrieved at once from the database. If an RDE request to the database returns 50,000 rows, they will be processed in batches, each consisting of 1000 rows.
sftp_download_block_size 20971520 bytes (20 MB)

Note: This parameter is available only in RDE version 3.12 or later.

The maximum size of a block that can be downloaded through SFTP. If the report file exceeds the specified number, it will be downloaded in several batches. The downloaded file will include all the batches.

azure_upload_block_size 5242880 bytes (5 MB)

Note: This parameter is available only in RDE version 3.12 or later.

The maximum size of a block that can be uploaded to Azure. If, for example, the report size is 100 MB, and the specified value is 5 MB, the report will be uploaded in 20 chunks.

xlsx_max_row_size 250,000 rows

Note: This parameter is available only in RDE version 3.12 or later.

The maximum number of rows that a report file can include. If, for example, the report file includes 500,000 rows and the specified value is 250,000, then the report will be split into two files and zipped.

xlsx_force_zip_files false

Note: This parameter is available only in RDE version 3.12 or later.

The parameter that indicates whether to zip report files or not. If set to true, the report files will always be zipped. Otherwise, only reports split into several files will be zipped.

persistence.enabled true

Note: This parameter was added in RDE version 3.12.28.

This parameter enables persistence for the component. If RDE fails to upgrade to the latest version with an error that relates to NFS share, set this parameter to false in the config.yaml file.

psadsport 5432 Port for connection to the native integration report storage.
psamindbpoolsize 1 Minimum number of database instances for native integration reports.
psamaxdbpoolsize 16 Maximum number of database instances for native integration reports.

Sample config.yaml

Default config.yaml:

---
components:
  rateddataexport: {}

Typical config.yaml:

---
components:
  a8n-config: {}
  oss:
    bssEnabled: true
  rateddataexport: {}

How to Obtain the Current config.yaml from CloudBlue Commerce

When updating CloudBlue Commerce components, you may need to obtain the current config.yaml.

To obtain the current config.yaml from CloudBlue Commerce, on a machine with kubectl, execute the following request:

kubectl -n NAMESPACE get secret config-yaml-backup -o "jsonpath={.data['config\.yaml']}" | base64 -d

Note: NAMESPACE is the namespace of your CloudBlue Commerce installation.
To find it, execute the following command:
kubectl describe svc oss-proxy | grep namespace

How to View the Deployment Parameters with Default Values for the Component Version You Want to Install (values.yaml)

To view the deployment parameters with default values (values.yaml) for the component version you want to install, run the following command from the machine with kubectl:

helm show values <component_name_for_config.yaml> --version <component_version> --username <username_for_deployment_repository> --password <username_for_deployment_repository> --repo <a_link_to_repository_with_CloudBlue Commerce_components>

For username and password to the deployment repository, please contact your Technical Account Manager.

Related Topics

CloudBlue, an Ingram Micro business, uses cookies to improve the usability of our site. By continuing to use this site and/or logging in you are accepting the use of these cookies. For more information, visit our Privacy Policy.