Stored Configuration Reporting and Update Tool

• Welcome to the Configuration Reporting and Update Tool!

  This tool has 2 buttons to use: "Run Report" and "Update Presets". They are designed to be run in succession. Once you receive a fully valid report from "Run Report", then you should proceed with "Update Presets".

  Run Report

  This button runs a report against all of the datatables stored in the org that have a name ending in "Presets".

  The report expects all Presets datatables to contain the following 2 columns. Other columns are acceptable, but these must be present:

  • Name - This is the name of the configuration in a given row (e.g. "Default", "Best Seller", etc)
  • configurationId - This is the Threekit-generated Id for a configuration. Typically generated using the staging embed "Share" button. If this column does not contain a valid Threekit generated configuration Id, the report will fail.

  Once the report pulls all of those datatables, it searches for each table's corresponding catalog item tagged with "type-family" and "latest". It finds those catalog items by searching the catalog item metadata for _presetsDatatableId. It matches the preset datatable to that Id. If no matching catalog item with proper tags and metadata is found for a presets datatable, the report fails.

  If all presets datatables find matching catalog items, the tool will search all configurations stored in the configurationId column of each datatable against the existing assets in the org that exist in the configuration hierarchy of the latest catalog item version. It will classify each configuration in 1 of 3 ways:

  • VALID - If the catalog item's stored configuration contains catalog items that all exist in the latest catalog version, then the configuration is marked VALID.
  • INVALID - If the catalog item's stored configuration contains ANY catalog items that do not exist in the latest catalog version, then the configuration is marked INVALID.
  • LEGACY - If the catalog item's stored configuration contains ANY catalog items referenced via a hardcoded Id, then the configuration is marked LEGACY to denote it was created using the old way of generating/storing configurations.

  After the report finishes, it prints results to the screen and stores a .csv file for the user to download. The latest version of this .csv is available via the "Download Latest Report" link above.

  Once your report returns all VALID, then you are ready to run the Update Presets button.

  Update Presets

  This button runs against all Presets datatables and will either add or update the activeConfigurationId column with a new configuration Id for each row.

  The tool will take the dynamic references stored in the configurationId column configuration and generate a configuration based in hardcoded Threekit Option Ids using the latest versions of assets stored during the catalog upload. These hardcoded Id configurations are quicker for retrieval on the front end.

  Once the button finishes running the updates, a message will show to the user. And, the datatables can be checked to confirm the newest activeConfigurationIds are present.