glysade.datafxndef.schema.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://glysade.com/datafxndef.schema.json",
  "title": "Glysade Data Function Definition",
  "description": "Schema for the Glysade data function YAML file",
  "type": "object",
  "definitions": {
    "request":{
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "dataType": {
          "type": "string",
          "enum": [
            "boolean",
            "string",
            "binary",
            "integer",
            "float",
            "list(string)",
            "list(integer)",
            "list(float)"
          ]
        },
        "contentType": {
          "type": "string"
        },
        "data": {
          "type": [ "boolean", "integer", "double", "string", "array" ]
        },
        "selectorType": {
          "type": "string",
          "enum": [ "column", "table" ]
        },
        "field": {
          "type": "string",
          "enum": [ "structure", "atomSelection", "bondSelection" ]
        }
      },
      "required": [
        "id", "dataType"
      ]
    },
    "validationRule": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "numeric",
            "oneOrMoreRequired",
            "oneRequired",
            "range",
            "required",
            "structure"
          ]
        },
        "message": {
          "type": "string",
          "description": "Optional message to display if validation fails, overrides the default message"
        },
        "min": {
          "type": "number",
          "description": "Optional minimum value if validation rule type is 'range'"
        },
        "max": {
          "type": "number",
          "description": "Optional minimum value if validation rule type is 'range'"
        }
      },
      "required": [
        "type"
      ]
    },
    "sequenceTextAreaFileType": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Displayed text for sequence text area file type",
          "enum": ["Genbank", "FASTA", "Sequence string"]
        },
        "contentType": {
          "type": "string",
          "description": "Content type for sequence text area file type",
          "enum": ["chemical/x-genbank", "chemical/x-fasta", "chemical/x-sequence"]
        }
      },
      "required": ["name", "contentType"]
    },
    "control": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "enum": [
            "checkbox",
            "columnselect",
            "file",
            "hidden",
            "molecule",
            "radiogroup",
            "select",
            "sequencetextarea",
            "sketcher",
            "text",
            "textarea"
          ]
        },
        "tooltip": {
          "type": "string"
        },
        "validationRules": {
          "type": "array",
          "items": { "$ref": "#/definitions/validationRule" }
        }
      },
      "required": [
        "id",
        "type"
      ]
    },
    "labelControl": {
      "allOf": [
        {
          "$ref": "#/definitions/control"
        },
        {
          "type": "object",
          "properties": {
            "label": {
              "type": "string",
              "description": "Label that describes the field in the UI"
            }
          },
          "required": ["label"]
        }
      ]
    },
    "checkBoxControl": {
      "allOf": [
        {
          "$ref": "#/definitions/labelControl"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [ "checkbox" ]
            }
          }
        }
      ]
    },
    "columnSelectFilter": {
      "type": "object",
      "properties": {
        "dataType": {
          "oneOf": [
            {
              "type": "array",
              "items": {
                "type": "string",
                "enum": ["binary", "bool", "double", "decimal", "float", "int", "long", "string"]
              }
            },
            {
              "type": "string",
              "enum": ["binary", "bool", "double", "decimal", "float", "int", "long", "string"]
            }
          ]
        },
        "contentType": {
          "oneOf": [
            { "type": "array", "items": "string" },
            { "type": "string" }
          ]
        }
      },
      "required": ["dataType"]
    },
    "columnSelectControl": {
      "allOf": [
        {
          "$ref": "#/definitions/labelControl"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [ "columnselect" ]
            },
            "filters": {
              "type": "array",
              "items": { "$ref": "#/definitions/columnSelectFilter" },
              "description": "Optional set of filters that can reduce the columns displayed in the select box by data type and/or content type"
            },
            "multi": {
              "type": "boolean",
              "description": "Optional boolean when true allows users to select multiple columns"
            }
          }
        }
      ]
    },
    "fileType": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Description of the file type"
        },
        "contentType": {
          "type": "string",
          "description": "Optional content type for the file type"
        },
        "extension": {
          "type": "string",
          "description": "Extension for the file type must of the format *.smi, *.txt etc."
        }
      },
      "required": ["name", "extension"]
    },
    "fileControl": {
      "allOf": [
        {
          "$ref": "#/definitions/labelControl"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [ "file" ]
            },
            "fileTypes": {
              "type": "array",
              "items": { "$ref": "#/definitions/fileType" },
              "description": "Optional array of allowed file types"
            },
            "mode": {
              "type": "string",
              "enum": ["contents", "path"],
              "description": "Optional mode. Setting mode to 'contents' means the contents of the file are provided to the data function, 'path' means the path to the file or folder is provided to the data function. If not defined the default is 'contents'."
            },
            "pathType": {
              "type": "string",
              "enum": ["file", "folder"],
              "description": "Optional pathType. Setting pathType top 'file' means a path to a file must be chosen. 'folder' means the path to a directory or folder must be chosen. If not defined the default is 'file'"
            }
          }
        }
      ]
    },
    "hiddenControl": {
      "allOf": [
        {
          "$ref": "#/definitions/control"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [ "hidden" ]
            }
          }
        }
      ]
    },
    "moleculeControl": {
      "allOf": [
        {
          "$ref": "#/definitions/labelControl"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [ "molecule" ]
            },
            "molTypes": {
              "type": "array",
              "items": { "$ref": "#/definitions/fileType" },
              "description": "Optional array of allowed molecule types"
            },
            "tabs": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": ["sketcher", "paste", "file"]
              }
            },
            "sketcherContentType": {
              "type": "string",
              "description": "Optional content type for molecule retrieved from the sketcher tab of the molecule control. If not defined, default is 'chemical/x-mdl-molfile'."
            }
          },
          "required": ["molTypes"]
        }
      ]
    },
    "selectItem": {
      "type": "object",
      "properties": {
        "text": {
          "type": "string",
          "description": "Text displayed to the user in the select/radio UI control"
        },
        "value": {
          "type": ["string", "integer", "double" ],
          "description": "Value for the selected item in the select/radio UI control"
        }
      },
      "required": ["text", "value"]
    },
    "radioGroupControl": {
      "allOf": [
        {
          "$ref": "#/definitions/labelControl"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [ "radiogroup" ]
            },
            "radios": {
              "type": "array",
              "items": { "$ref": "#/definitions/selectItem" }
            }
          },
          "required": ["radios"]
        }
      ]
    },
    "selectControl": {
      "allOf": [
        {
          "$ref": "#/definitions/labelControl"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [ "select" ]
            },
            "multi": {
              "type": "boolean"
            },
            "options": {
              "type": "array",
              "items": { "$ref": "#/definitions/selectItem" }
            }
          },
          "required": ["options"]
        }
      ]
    },
    "sequenceTextAreaControl": {
      "allOf": [
        {
          "$ref": "#/definitions/labelControl"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [ "sequencetextarea" ]
            },
            "height": {
              "type": "integer"
            },
            "fileTypes": {
              "type": "array",
              "items": { "$ref": "#/definitions/sequenceTextAreaFileType" },
              "description": "Allowed sequence file formats. The contentType in the request should be set to one of the contentTypes defined in this list.",
              "minItems": 1
            }
          },
          "required": ["fileTypes"]
        }
      ]
    },
    "sketcherControl": {
      "allOf": [
        {
          "$ref": "#/definitions/labelControl"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [ "sketcher"]
            }
          }
        }
      ]
    },
    "textControl": {
      "allOf": [
        {
          "$ref": "#/definitions/labelControl"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [ "text" ]
            }
          }
        }
      ]
    },
    "textAreaControl": {
      "allOf": [
        {
          "$ref": "#/definitions/labelControl"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [ "textarea" ]
            },
            "height": {
              "type": "integer"
            }
          }
        }
      ]
    },
    "inputField": {
      "type": "object",
      "properties": {
        "control": {
          "anyOf": [
            { "$ref": "#/definitions/checkBoxControl" },
            { "$ref": "#/definitions/columnSelectControl" },
            { "$ref": "#/definitions/fileControl" },
            { "$ref": "#/definitions/hiddenControl" },
            { "$ref": "#/definitions/moleculeControl" },
            { "$ref": "#/definitions/radioGroupControl" },
            { "$ref": "#/definitions/selectControl" },
            { "$ref": "#/definitions/sequenceTextAreaControl" },
            { "$ref": "#/definitions/sketcherControl" },
            { "$ref": "#/definitions/textControl" },
            { "$ref": "#/definitions/textAreaControl" }
          ]
        },
        "request": {
          "oneOf": [
            {
              "type": "array",
              "items": {
                "$ref": "#/definitions/request"
              }
            },
            {
              "$ref": "#/definitions/request"
            }
          ]
        }
      },
      "required": [ "control", "request" ]
    },
    "outputField": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Optional output field name. If not defined the output field name will be taken from the source of the output field."
        },
        "id": {
          "type": "string",
          "description": "Column, table or input field request ID"
        },
        "source": {
          "type": "string",
          "enum": ["column", "table", "inputField"]
        },
        "type": {
          "type": "string",
          "enum": ["default", "molecule", "sequence", "filter"]
        }
      },
      "required": [ "id", "source", "type" ]
    },
    "tag": {
      "type": "object",
      "properties": {
        "text": {
          "type": "string",
          "description": "Text displayed in the tag"
        },
        "color": {
          "type": "string",
          "description": "Optional color for the tag"
        }
      },
      "required": ["text"]
    }
  },
  "properties": {
    "id": {
      "description": "The unique identifier for a data function definition (should be an UUID)",
      "type": "string"
    },
    "name": {
      "description": "Human readable name for the data function",
      "type": "string"
    },
    "description": {
      "description": "Human readable description for the data function",
      "type": "string"
    },
    "category": {
      "description": "Dot separated list of strings used to create tree-like structure of data function definitions e.g chemistry.2D.structure",
      "type": "string"
    },
    "serviceName": {
      "description": "Unique service name for the data function, no spaces are allowed",
      "type": "string"
    },
    "executorId": {
      "description": "Type of executor used to execute the data function",
      "type": "string",
      "enum": [
        "Glysade.CPythonDataFxn",
        "Glysade.CSharpDataFxn",
        "Glysade.PipelinePilotDataFxn",
        "Glysade.KnimeDataFxn"
      ]
    },
    "serviceUri": {
      "description": "Service URI description",
      "type": "string"
    },
    "version": {
      "description": "Version number for the data function definition in the format major.minor.revision e.g. 1.2.0",
      "type": "string"
    },
    "script": {
      "description": "Optional Python script executed by data functions that have the executorId = Glysade.CPythonDataFxn",
      "type": "string"
    },
    "ironPython": {
      "description": "Optional IronPython script executed by the data function after execution used to configure Spotfire visuals",
      "type": "string"
    },
    "allowedClients": {
      "description": "Optional array defining whether the data function can execute on the 'Analyst' or 'WebPlayer' Spotfire environments. If not defined the default is both.",
      "type": "array",
      "items": {
        "type": "string",
        "enum": ["Analyst", "WebPlayer"]
      },
      "minItems": 1,
      "maxItems": 2
    },
    "limitBy": {
      "description": "Optional value defining the limit by behavior of the data function. If not defined the default is 'none'.",
      "type": "string",
      "enum": [
        "none",
        "filteredRows",
        "markedRows",
        "both"
      ]
    },
    "maximumOutputColumns": {
      "description": "Optional value defining the maximum number of columns generated by the data function. If not defined the default is 10.",
      "type": "integer",
      "default" : 10
    },
    "maximumOutputTables": {
      "description": "Optional value defining the maximum number of data tables generated by the data function. If not defined the default is 1.",
      "type": "number",
      "default" : 1
    },
    "updateBehavior": {
      "description": "Optional value defining whether the data function updates automatically when data table data changes or manually. If not defined, the default is 'automatic'.",
      "type": "string",
      "enum": [ "automatic", "manual" ]
    },
    "chemistryFunction": {
      "description": "Optional boolean representing whether this data function definition replaces a legacy chemistry data function. If not defined the default is false.",
      "type": "boolean"
    },
    "tkid": {
      "description": "Optional string representing whether the ID of the chemistry toolkit used in the replacement of a legacy chemistry data function.",
      "type": "string"
    },
    "assembly": {
      "description": "Optional value representing the assembly where Glysade.CSharpDataFxn are run",
      "type": "string"
    },
    "inputFields": {
      "type": "array",
      "items": { "$ref": "#/definitions/inputField" },
      "description": "Input fields defining expected data function input and UI"
    },
    "outputFields": {
      "type": "array",
      "items": { "$ref": "#/definitions/outputField" },
      "description": "Optional output field defining expected data function result UI"
    },
    "tags": {
      "type": "array",
      "items": { "$ref": "#/definitions/tag" },
      "description": "Colored tags that can be used to further categorize data function definitions"
    },
    "demoUrl": {
      "description": "Optional URL for a demo video for the data function",
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "description",
    "category",
    "serviceName",
    "executorId",
    "serviceUri",
    "version",
    "inputFields"
  ]
}