processing-config-schema.json

{
  "type": "object",
  "layout": "tabs",
  "required": [
    "datasetMode"
  ],
  "allOf": [
    {
      "title": "Dataset mode",
      "x-i18n-title": { "fr": "Liste de jeux de données", "en": "Datasets" },
      "default": {
        "datasetMode": "list"
      },
      "properties": {
        "haveList": {
          "type": "boolean",
          "default": false,
          "layout": "none"
        }
      },
      "oneOf": [
        {
          "title": "List sheets",
          "x-i18n-title": { "fr": "Lister les différentes feuilles", "en": "List the available sheets" },
          "properties": {
            "datasetMode": {
              "type": "string",
              "const": "list",
              "title": "Action"
            }
          },
          "layout": {
            "children": [
              "datasetMode",
              {
                "markdown": "List the different sheets of your file before you can create or update datasets.",
                "x-i18n-markdown": {
                  "fr": "Listez les différentes feuilles de votre fichier avant de pouvoir créer des jeux de données ou les mettre à jour."
                }
              },
              {
                "markdown": "**Warning:** if you use a .zip file containing .xlsx files, only the first .xlsx file found will be used.",
                "x-i18n-markdown": {
                  "fr": "**Attention :** si vous utiliser un fichier .zip contenant des fichiers .xlsx, seul le premier .xlsx trouvé sera utilisé."
                }
              }
            ]
          }
        },
        {
          "title": "Create datasets",
          "x-i18n-title": { "fr": "Créer des jeux de données" },
          "properties": {
            "datasetMode": {
              "type": "string",
              "const": "create",
              "title": "Action"
            }
          },
          "layout": {
            "if": "parent.data.haveList",
            "children": [
              "datasetMode",
              {
                "markdown": "Select the sheets you want to add in the **File Sheets** tab.",
                "x-i18n-markdown": {
                  "fr": "Sélectionnez les feuilles que vous voulez ajouter dans l'onglet **Feuilles du fichier**."
                }
              }
            ]
          }
        },
        {
          "title": "Update datasets",
          "x-i18n-title": { "fr": "Mettre à jour des jeux de données" },
          "properties": {
            "datasetMode": {
              "type": "string",
              "const": "update",
              "title": "Action"
            },
            "datasets": {
              "type": "array",
              "title": "Datasets to update",
              "x-i18n-title": { "fr": "Jeux de données à mettre à jour" },
              "layout": {
                "listEditMode": "inline"
              },
              "items": {
                "type" : "object",
                  "layout" : [
                    {
                      "children": [
                        "dataset"
                      ],
                      "cols": 4
                    },
                    {
                      "children": [
                        "sheet"
                      ],
                      "cols": 4
                    },
                    {
                      "children": [
                        "forceUpdate"
                      ],
                      "cols": 3
                    }
                  ],
                "required": [
                  "dataset",
                  "sheet"
                ],
                "properties": {
                  "dataset": {
                    "type": "object",
                    "title": "Existing dataset",
                    "x-i18n-title": { "fr": "Jeu de données existant" },
                    "properties": {
                      "id": {
                        "type": "string",
                        "title": "Identifier",
                        "x-i18n-title": { "fr": "Identifiant" }
                      },
                      "href": {
                        "type": "string",
                        "title": "URL"
                      },
                      "title": {
                        "type": "string",
                        "title": "Title",
                        "x-i18n-title": { "fr": "Titre" }
                      }
                    },
                    "layout": {
                      "getItems": {
                        "url": "${context.dataFairUrl}/api/v1/datasets?q={q}&select=id,title&${context.ownerFilter}&${parent.parent.parent.parent.data.editableUpdate === true ? 'rest' : 'file'}=true",
                        "itemsResults": "data.results",
                        "itemTitle": "item.title",
                        "itemKey": "item.id"
                      }
                    }
                  },
                  "sheet": {
                    "type": "object",
                    "title": "Sheet",
                    "x-i18n-title": { "fr": "Feuille" },
                    "properties": {
                      "nb": {
                        "type": "integer",
                        "title": "Sheet identifier",
                        "x-i18n-title": { "fr": "Identifiant de la feuille" }
                      },
                      "name": {
                        "type": "string",
                        "title": "Sheet name",
                        "x-i18n-title": { "fr": "Nom de la feuille" }
                      }
                    },
                    "layout": {
                      "getItems": {
                        "expr": "parent.parent.parent.parent.data.sheets || []",
                        "itemsResults": "data",
                        "itemTitle": "item.name",
                        "itemKey": "item.nb"
                      }
                    }
                  },
                  "forceUpdate": {
                    "type" : "boolean",
                    "title": "Force schema update",
                    "x-i18n-title": { "fr": "Forcer la mise à jour du schéma" }
                  }
                }
              }
            }
          },
          "layout": {
            "if": "parent.data.haveList"
          }
        }
      ]
    },
    {
      "title" : "File sheets",
      "x-i18n-title": { "fr": "Feuilles du fichier" },
      "required": [
        "sheets"
      ],
      "layout": {
        "readOnlyPropertiesMode": "show",
        "children": [
          {
            "if": "!parent.data.sheets || parent.data.sheets.length === 0",
            "children": [
              {
                "markdown": "**No sheets detected**",
                "x-i18n-markdown": {
                  "fr": "**Aucune feuille détectée**"
                }
              }
            ]
          },
          {
            "if": "parent.data.sheets && parent.data.sheets.length > 0",
            "children": [
              {
                "markdown": "*To update the sheets, for example in the case of a new file, run the **list the available sheets** mode again.*",
                "x-i18n-markdown": {
                  "fr": "*Pour remettre à jour les feuilles, en cas de nouveau fichier par exemple, exécutez de nouveau le mode **lister les différentes feuilles**.*"
                }
              }
            ]
          },
          "addAllSheets",
          "tableHeader",
          "sheets"
        ]
      },
      "properties": {
        "addAllSheets": {
          "type": "boolean",
          "title": "Add all the sheets",
          "x-i18n-title": { "fr": "Ajouter toutes les feuilles" },
          "layout": {
            "if": "parent.parent.data.datasetMode === 'create'"
          }
        },
        "tableHeader": {
          "type": "object",
          "layout": [
            {
              "children": [
                "add"
              ],
              "cols": 1,
              "if": "parent.parent.parent.data.datasetMode === 'create' && parent.parent.data.addAllSheets !== true"
            },
            {
              "children": [
                "nb"
              ],
              "cols": 1
            },
            {
              "children": [
                "name"
              ],
              "cols": 4
            },
            {
              "children": [
                "lines"
              ],
              "cols": 2
            },
            {
              "children": [
                "titleEditable",
                "titleReadOnly"
              ],
              "cols": 4
            }
          ],
          "properties": {
            "add": {
              "type": "string",
              "title": "Add",
              "x-i18n-title": { "fr": "Ajouter" },
              "readOnly": true
            },
            "nb": {
              "type": "string",
              "title": "Number",
              "x-i18n-title": { "fr": "Numéro" },
              "readOnly": true
            },
            "name": {
              "type": "string",
              "title": "Sheet name",
              "x-i18n-title": { "fr": "Nom de la feuille" },
              "readOnly": true
            },
            "lines": {
              "type": "string",
              "title": "Nombre de lignes",
              "readOnly": true
            },
            "titleEditable": {
              "type": "string",
              "title": "Title of the corresponding dataset",
              "x-i18n-title": { "fr": "Titre du jeu de données correspondant" },
              "readOnly": true,
              "description": "By default, the dataset title corresponds to the sheet name",
              "x-i18n-description": { "fr": "Par défaut, le titre du jeu de données correspond au nom de la feuille" },
              "layout": {
                "if": "parent.parent.parent.parent.data.datasetMode === 'create'"
              }
            },
            "titleReadOnly": {
              "type": "string",
              "title": "Title of the corresponding dataset",
              "x-i18n-title": { "fr": "Titre du jeu de données correspondant" },
              "readOnly": true,
              "description": "By default, the dataset title corresponds to the sheet name",
              "x-i18n-description": { "fr": "Par défaut, le titre du jeu de données correspond au nom de la feuille" },
              "layout": {
                "if": "parent.parent.parent.parent.data.datasetMode !== 'create'"
              }
            }
          }
        },
        "sheets": {
          "type": "array",
          "title": " ",
          "layout": {
            "listEditMode": "inline",
            "listActions": []
          },
          "items": {
            "type": "object",
            "layout": [
              {
                "children": [
                  "add"
                ],
                "cols": 1,
                "if": "parent.parent.parent.data.datasetMode === 'create' && parent.parent.parent.data.addAllSheets !== true"
              },
              {
                "children": [
                  "nb"
                ],
                "cols": 1
              },
              {
                "children": [
                  "name"
                ],
                "cols": 4
              },
              {
                "children": [
                  "lines"
                ],
                "cols": 2
              },
              {
                "children": [
                  "titleEditable",
                  "titleReadOnly"
                ],
                "cols": 4
              }
            ],
            "properties": {
              "add": {
                "type": "boolean",
                "title": " "
              },
              "nb": {
                "type": "integer",
                "readOnly": true,
                "title": " "
              },
              "name": {
                "type": "string",
                "readOnly": true,
                "title": " "
              },
              "lines": {
                "type": "integer",
                "readOnly": true,
                "title": " "
              },
              "titleEditable": {
                "type": "string",
                "title": " ",
                "layout": {
                  "if": "parent.parent.parent.parent.data.datasetMode === 'create'"
                }
              },
              "titleReadOnly": {
                "type": "string",
                "title": " ",
                "readOnly": true,
                "layout": {
                  "if": "parent.parent.parent.parent.data.datasetMode !== 'create'"
                }
              }
            }
          }
        }
      }
    },
    {
      "title": "Parameters",
      "x-i18n-title": { "fr": "Paramètres" },
      "required": [
        "url"
      ],
      "properties": {
        "url": {
          "title": "Source URL",
          "x-i18n-title": { "fr": "URL source" },
          "type": "string",
          "description": "Supported protocols are HTTP and HTTPS; supported formats are .zip and .xlsx.",
          "x-i18n-description": { "fr": "Les protocoles supportés sont HTTP et HTTPS, les formats supportés sont .zip et .xlsx." }
        }
      }
    }
  ]
}