📊 Report : Analysis of completion rates by category, relative to number of attributes and mandatory attributes

In a nutshell

This job allows you to export a report of completion rates by category, relative to number of attributes and mandatory attributes. The report also presents best practices and how your data structure is positioned in relation to these best practices.

📥 Download the latest version of this jobs.

⌛ Time to setup: 5 minutes.

Result

• Each bubble: A category
• Size of the bubble: Total number of products within the category
• Color of the bubble: Completion rate of attributs within the category
• X Axis: Total number of common and specific attributs
• Y Axis: Percentage of mandatory attributs regarding the total number of common and specific attributs

Setup

1. Download the last version of this job, available here
2. Update the file job.json by replacing all elements below:

• TODO_TABLE_KEY: The table key (in export items and export table)
• TODO_CLASSIFICATION_KEY: The classification key of the classification that must be analysed
• TODO_CONDITIONAL_FORMATTING_KEY: The conditional formatting key of the conditional formatting that must be used
• TODO_STATUS_KEY: The status key representing invalid data
• TODO_SCREEN_KEY: The screen key
• TODO_OUTPUT: output file name, best pratice: account_compliance_screen.html

{
  "schema": "1.0",
  "key": "report_taxonomy_completion_by_category_attributs_mandatory_attributes",
  "title": "Rapport: Analyse de la complétion de donnée par catégories, attributs et attributs obligatoires",
  "tasks": [
    {
      "name": "table-export-items",
      "taskReferenceName": "table_export_items",
      "description": "Export all items",
      "optional": false,
      "type": "SUB_WORKFLOW",
      "inputParameters": {
        "tableKey": "TODO_TABLE_KEY",
        "mode": "ALL",
        "fileName": "items.xml"
      }
    },
    {
      "name": "table-export-schema",
      "taskReferenceName": "table_export_schema",
      "description": "Export table schema",
      "optional": false,
      "type": "SUB_WORKFLOW",
      "inputParameters": {
        "tableKey": "TODO_TABLE_KEY",
        "mode": "ACTIVE",
        "fileName": "table.xml"
      }
    },
    {
      "name": "file-transformation-xslt",
      "taskReferenceName": "file_transformation_xslt_metrics",
      "description": "Calculate metrics and generate json",
      "optional": false,
      "type": "SUB_WORKFLOW",
      "inputParameters": {
        "mode": "FILE",
        "file": "${table_export_schema.output.file}",
        "params": [
          {
            "name": "items_url",
            "select": "${table_export_items.output.file}"
          },
          {
            "name": "classification",
            "select": "'TODO_CLASSIFICATION_KEY'"
          },
          {
            "name": "conditional_formatting",
            "select": "'TODO_CONDITIONAL_FORMATTING_KEY'"
          },
          {
            "name": "status",
            "select": "'TODO_STATUS_KEY'"
          },
          {
            "name": "screen",
            "select": "'TODO_SCREEN_KEY'"
          }
        ],
        "xslt": "file://assets/metrics.xslt",
        "fileName": "result.json"
      }
    },
    {
      "name": "file-transformation-xslt",
      "taskReferenceName": "file_transformation_xslt_html",
      "description": "Generate html report",
      "optional": false,
      "type": "SUB_WORKFLOW",
      "inputParameters": {
        "mode": "FILE",
        "file": "file://assets/empty.xml",
        "params": [
          {
            "name": "metrics_url",
            "select": "${file_transformation_xslt_metrics.output.file}"
          },
          {
            "name": "index_url",
            "select": "file://assets/index.html"
          }
        ],
        "xslt": "file://assets/html.xslt",
        "fileName": "TODO_OUTPUT.html"
      }
    }
  ],
  "outputParameters": {
    "report": "${file_transformation_xslt_html.output.file}"
  }
}