Skip to main content

General Config Parameters

GENERAL CONFIGS​

The GENERAL_CONFIGS section contains a set of configuration parameters that apply globally to the APPEND process. These parameters are used to customize various aspects of the data append process. The syntax of these configs is as follows:

    "GENERAL_CONFIGS" : {
      "CONFIG_KEY 1": "VALUE",
      "CONFIG_KEY 2": "VALUE",
      "CONFIG_KEY 3": "VALUE",
    }

DOCS​

  • Description: The URL of the DecaSIM documentation where more information about this configuration parameter can be found.
  • Type: String

ASSOCIATED_ITEM_LOOKUP_FIELD​

  • Description: The name of the field in the DESIGN file that is used to look up associated items (e.g. products) when appending product-level data.
  • Type: String

BULK_APPEND_FLAG​

  • Description: A flag indicating whether to perform a bulk append operation. Set to True for bulk append, and False otherwise.
  • Type: Boolean

CUSTOMER_DEFINED_PAGE_START​

  • Description: The name of the customer-defined page start field in the DESIGN file.
  • Type: String

CUSTOMER_DEFINED_PAGE_END​

  • Description: The name of the customer-defined page end field in the DESIGN file.
  • Type: String

CUSTOMER_PROMO_FILE_FOLDER​

  • Description: The folder path where customer promo files are stored.
  • Type: String

DESIGN_FILE_TYPE_FOR_EQUIVALENCE_FILE_TYPE​

  • Description: The name of the design file type associated with equivalence file type operations.
  • Type: String
  • Description: The name of the design file type associated with performance data search operations.
  • Type: String
  • Description: The name of the design file type associated with historical search operations.
  • Type: String
  • Description: The name of the design file type associated with item properties search operations.
  • Type: String
  • Description: The name of the design file type associated with item tono search operations.
  • Type: String

INSTRUCTION_FIELD​

  • Description: The name of the field in the DESIGN file where instructions or notes can be stored for each record.
  • Type: String

MISSING_DATA_DEFAULT_VALUE​

  • Description: The default value used for missing data in the output file.
  • Type: String

OFFER_DATA_APPEND_FIELDS​

  • Description: A comma-separated list of fields to be added or updated in the DESIGN file from the source data files.
  • Type: String

OFFER_DETAIL_FIELD_NAME​

  • Description: The name of the field in the DESIGN file that contains the details of the offer being appended. This field will contain the values from the source data files.
  • Type: String

OFFER_ID_REQUIRED_RULE_COUNT​

  • Description: The number of rules that must be met before an offer ID is considered required.
  • Type: Integer

OUTPUT_OPTIONAL_LOGS​

  • Description: A flag indicating whether to output optional logs during the data append process. Set to True to output logs, and False otherwise.
  • Type: Boolean

PRODUCT_CODE_APPEND_FIELDS​

  • Description: A comma-separated list of fields to be added or updated in the DESIGN file from the source data files, specifically related to product codes.
  • Type: String

PRODUCT_DATABASE_FOLDER​

  • Description: The folder path where product database files are stored.
  • Type: String

PRODUCT_DATABASE_ITEM_PRODUCT_FAMILY_CODE​

  • Description: The name of the field in the product database that contains a code or identifier for each product family.
  • Type: String

PRODUCT_DATABASE_ITEM_CODE_KEY​

  • Description: The name of the field in the product database that contains the item code or identifier.
  • Type: String

PRODUCT_DATABASE_ITEM_DESCRIPTION_KEY​

  • Description: The name of the field in the product database that contains a description of each product.
  • Type: String

PRODUCT_DATABASE_ITEM_PRODUCT_FAMILY_KEY​

  • Description: The name of the field in the product database that contains the product family or category information.
  • Type: String

PRODUCT_DATABASE_GROUP_BY_FIELD​

  • Description: The name of the field in the product database that is used for grouping products when performing database queries.
  • Type: String

PRODUCT_DATABASE_SEARCH_TYPES​

  • Description: A comma-separated list of search types to be used when searching for product data in the product database (e.g. ITEM_DESC or PRODUCT_FAMILY_DESC).
  • Type: String

ROLL_BACK_CANDIDATE_VALUE​

  • Description: The value used for rolling back candidate fields in case no valid data is found.
  • Type: String

ROLL_BACK_DEFAULT_VALUE​

  • Description: The default value to use when rolling back a field that has no valid data.
  • Type: String

UNPARSED_ROWS​

  • Description: A flag indicating whether to allow unparsed rows in the output file. Set to True to allow unparsed rows, and False otherwise.
  • Type: Boolean

USE_DEFAULT_PRICE_SOURCE​

  • Description: A flag indicating whether to use the default price source instead of a custom one. Set to True to use the default price source, and False otherwise.
  • Type: Boolean

USE_LOGGER​

  • Description: A flag indicating whether to use a logger for logging events during the data append process. Set to True to use a logger, and False otherwise.
  • Type: Boolean

USE_REFACTORED_OFFER_ID​

  • Description: A flag indicating whether to use the refactored offer ID instead of the original one. Set to True to use the refactored ID, and False otherwise.
  • Type: Boolean

USE_JSON_CONFIGS​

  • Description: A flag indicating whether to use JSON configuration files instead of the default XML format. Set to True to use JSON, and False otherwise.
  • Type: Boolean