{ "$id": "job-common", "description": "Type definitions for all Job document formats.", "definitions": { "commonFieldNames": { "enum": [ "_id", "font_size", "type", "created", "last_updated", "createdVersion", "lastUpdatedVersion", "canvasVersion", "encodingVersion", "migrationVersion", "name", "description", "preAutomationTime", "sla", "decorators", "transitions", "status", "variables", "tags", "error", "warnings", "ancestors", "validationErrors", "namespace" ] }, "commonFields": { "type": "object", "properties": { "_id": { "$ref": "common#/definitions/ObjectIdLikeString" }, "font_size": { "type": "integer" }, "type": { "enum": [ "automation", "resource:action", "resource:compliance" ] }, "created": { "$ref": "common#/definitions/iso-date-string" }, "last_updated": { "$ref": "common#/definitions/iso-date-string" }, "createdVersion": { "type": "string", "pattern": "^\\d+\\.\\d+\\.\\d+(-\\d{4}\\.\\d+\\.\\d+(\\.\\d+)?)?$" }, "lastUpdatedVersion": { "type": "string", "pattern": "^\\d+\\.\\d+\\.\\d+(-\\d{4}\\.\\d+\\.\\d+(\\.\\d+)?)?$" }, "canvasVersion": { "enum": [ 1, 1.5, 2, 3 ] }, "encodingVersion": { "enum": [ 1 ] }, "migrationVersion": { "$ref": "common#/definitions/migrationVersion" }, "name": { "$ref": "common#/definitions/name" }, "description": { "oneOf": [ { "$ref": "common#/definitions/description" }, { "type": "null" } ] }, "preAutomationTime": { "type": "number" }, "sla": { "type": "number" }, "decorators": { "$ref": "#/definitions/decorators" }, "transitions": { "type": "object" }, "status": { "$ref": "#/definitions/jobStatus" }, "variables": { "type": "object" }, "tags": { "type": "array" }, "error": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "warnings": { "type": "array", "items": { "$ref": "#/definitions/warning" } }, "ancestors": { "oneOf": [ { "type": "array", "items": { "$ref": "common#/definitions/ObjectIdLikeString" } }, { "type": "null" } ] }, "validationErrors": { "type": "array", "items": { "$ref": "#/definitions/validationError" } }, "namespace": { "type": "object" } } }, "decorators": { "type": "array", "items": { "type": "object", "properties": { "type": { "const": "encryption" }, "pointer": { "type": "string", "format": "json-pointer" } } } }, "taskId": { "oneOf": [ { "enum": [ "workflow_start", "workflow_end", "error_handler" ] }, { "type": "string", "pattern": "^[0-9a-f]{1,4}$", "examples": [ "workflow_start", "e28f", "3a1f" ] } ] }, "taskLocation": { "enum": [ "Adapter", "Application", "Broker" ] }, "taskStatus": { "enum": [ "incomplete", "scheduled", "running", "complete", "canceled", "error", "failure", "paused" ] }, "jobStatus": { "enum": [ "error", "complete", "running", "canceled", "incomplete", "paused" ] }, "taskPreviousTransitions": { "type": "object", "properties": { "incomplete": { "type": "array", "items": { "$ref": "#/definitions/taskId" } }, "complete": { "type": "array", "items": { "$ref": "#/definitions/taskId" } }, "error": { "type": "array", "items": { "$ref": "#/definitions/taskId" } } } }, "taskOutgoingTransitionList": { "type": "object", "properties": { "task": { "$ref": "#/definitions/taskId" }, "type": { "$ref": "#/definitions/transitionType" } } }, "taskOutgoingTransitions": { "type": "object", "properties": { "success": { "type": "array", "items": { "$ref": "#/definitions/taskOutgoingTransitionList" } }, "failure": { "type": "array", "items": { "$ref": "#/definitions/taskOutgoingTransitionList" } }, "error": { "type": "array", "items": { "$ref": "#/definitions/taskOutgoingTransitionList" } } } }, "transitionType": { "enum": [ "standard", "revert", "loop" ] }, "transitionState": { "enum": [ "success", "failure", "error" ] }, "transitionTargets": { "type": "object", "properties": { "workflow_start": { "$ref": "#/definitions/transition" }, "workflow_end": { "$ref": "#/definitions/transition" }, "error_handler": { "$ref": "#/definitions/transition" } }, "patternProperties": { "^[0-9a-f]{1,4}$": { "$ref": "#/definitions/transition" } }, "additionalProperties": false }, "transition": { "type": "object", "properties": { "state": { "$ref": "#/definitions/transitionState" }, "type": { "$ref": "#/definitions/transitionType" } } }, "metricsCommon": { "type": "object", "properties": { "start_time": { "type": "number" }, "progress": { "type": "number", "minimum": 0, "maximum": 1 }, "end_time": { "type": "number" } } }, "taskPosition": { "type": "object", "properties": { "x": { "type": "number", "description": "Stores the x coordinate used by canvasType = 1 workflows" }, "y": { "type": "number", "description": "Stores the y coordinate used by canvasType = 1 workflows" }, "gridCoordinate": { "type": "object", "description": "Stores the coordinates used by canvasType = 2 workflows", "properties": { "x": { "type": "number" }, "y": { "type": "number" } } } } }, "taskBaseCommon": { "allOf": [ { "$ref": "#/definitions/taskPosition" }, { "type": "object", "properties": { "name": { "type": "string" }, "location": { "$ref": "#/definitions/taskLocation" }, "locationType": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "app": { "type": "string" }, "canvasName": { "type": "string" }, "displayName": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "variables": { "type": "object", "additionalProperties": false, "properties": { "incoming": { "type": "object" }, "outgoing": { "type": "object" }, "error": { "type": "string", "pattern": "" }, "decorators": { "$ref": "#/definitions/decorators" } } }, "deprecated": { "type": "boolean" }, "scheduled": { "type": "boolean" }, "matched": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "highlightString": { "type": "string" } } } }, "status": { "$ref": "#/definitions/taskStatus" }, "previous": { "$ref": "#/definitions/taskPreviousTransitions" }, "taskId": { "$ref": "#/definitions/taskId" }, "transitions": { "$ref": "#/definitions/taskOutgoingTransitions" }, "serverId": { "type": "string" }, "start_time": { "$ref": "common#/definitions/iso-date-string" }, "end_time": { "type": "number" }, "finish_state": { "$ref": "#/definitions/transitionState" }, "retrySettings": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "state": { "type": "array", "items": { "enum": [ "success", "error", "failure" ] } }, "autoRetry": { "type": "boolean" }, "limit": { "type": "integer", "minimum": 0 }, "delay": { "type": "integer", "minimum": 0 }, "count": { "type": "integer", "minimum": 0 }, "finishedRetrying": { "type": "boolean" } }, "additionalProperties": false } ] } } } ] }, "pendingTaskCommon": { "allOf": [ { "$ref": "#/definitions/taskPosition" }, { "type": "object", "properties": { "name": { "const": "pending" }, "summary": { "type": "string" }, "description": { "type": "string" } } } ] }, "manualTaskCommon": { "allOf": [ { "$ref": "#/definitions/taskBaseCommon" }, { "type": "object", "properties": { "type": { "const": "manual" }, "view": { "type": "string" } } } ] }, "automaticTaskCommon": { "allOf": [ { "$ref": "#/definitions/taskBaseCommon" }, { "type": "object", "properties": { "type": { "const": "automatic" }, "actor": { "oneOf": [ { "const": "Pronghorn" }, { "const": "job" }, { "$comment": "Job variable", "type": "string", "pattern": "^\\$var\\.job\\.[a-zA-Z_0-9]{1,}$" }, { "$comment": "Task reference", "type": "string", "pattern": "^\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" } ] } } } ] }, "operationTaskCommon": { "allOf": [ { "$ref": "#/definitions/taskBaseCommon" }, { "type": "object", "properties": { "type": { "const": "operation" }, "canvasName": { "not": { "const": "childJob" } } } } ] }, "childJobTaskCommon": { "allOf": [ { "$ref": "#/definitions/taskBaseCommon" }, { "type": "object", "properties": { "canvasName": { "const": "childJob" }, "loop": { "type": "object", "properties": { "atLeastOneComplete": { "type": "boolean" }, "finishedCount": { "type": "number" }, "isFinished": { "type": "object", "additionalProperties": false, "patternProperties": { "^[0-9a-fA-F]{24}$": { "type": "boolean" } } }, "outgoing": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "null" } ] } } } }, "childJobs": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "name": { "type": "string" }, "iteration": { "type": "number" } } } } } } ] }, "anyTaskCommon": { "oneOf": [ { "$ref": "#/definitions/pendingTaskCommon" }, { "$ref": "#/definitions/manualTaskCommon" }, { "$ref": "#/definitions/automaticTaskCommon" }, { "$ref": "#/definitions/operationTaskCommon" }, { "$ref": "#/definitions/childJobTaskCommon" } ] }, "startEndTaskCommon": { "allOf": [ { "$ref": "#/definitions/taskPosition" }, { "type": "object", "properties": { "status": { "$ref": "#/definitions/taskStatus" }, "previous": { "$ref": "#/definitions/taskPreviousTransitions" }, "transitions": { "$ref": "#/definitions/taskOutgoingTransitions" } } } ] }, "startTaskCommon": { "allOf": [ { "$ref": "#/definitions/taskPosition" }, { "type": "object", "properties": { "name": { "const": "workflow_start" }, "summary": { "const": "workflow_start" }, "taskId": { "const": "workflow_start" }, "metrics": { "type": "object", "properties": { "start_time": { "type": "number" }, "finish_state": { "$ref": "#/definitions/transitionState" } } } } } ] }, "endTaskCommon": { "allOf": [ { "$ref": "#/definitions/taskPosition" }, { "type": "object", "properties": { "name": { "const": "workflow_end" }, "summary": { "const": "workflow_end" }, "taskId": { "const": "workflow_end" }, "endTasks": { "$ref": "#/definitions/taskPreviousTransitions" }, "metrics": { "type": "object", "properties": { "end_time": { "type": "number" }, "run_time": { "type": "number" } } } } } ] }, "errorHandlerTaskCommon": { "allOf": [ { "$ref": "#/definitions/operationTaskCommon" }, { "type": "object", "properties": { "name": { "const": "childJob" } } } ] }, "taskCommon": { "type": "object", "properties": { "workflow_start": { "$ref": "#/definitions/startTaskCommon" }, "workflow_end": { "$ref": "#/definitions/endTaskCommon" }, "error_handler": { "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/errorHandlerTaskCommon" } ] } } }, "error": { "type": "object", "properties": { "task": { "oneOf": [ { "const": "job" }, { "$ref": "#/definitions/taskId" } ] }, "message": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "timestamp": { "type": "number", "description": "The time at which this error occurred, designated by a unix timestamp" } }, "examples": [ { "task": "f9a9", "message": { "code": 500, "message": { "apiVersion": "1", "method": "transformations.run", "error": { "code": 500, "message": "Missing one of the following required instances: arg2, arg1", "errors": [ {} ] } } }, "timestamp": 1627323002561 }, { "task": "job", "message": "Job has no available transitions. c841 could have led to the workflow end task, but did not. These tasks performed in a way that the end of the workflow could not be reached.", "timestamp": 1627323002574 } ] }, "warning": { "type": "object", "properties": { "task": { "$ref": "#/definitions/taskId" }, "name": { "$ref": "common#/definitions/name" }, "message": { "oneOf": [ { "type": "object" }, { "type": "string" } ] } } }, "validationError": { "type": "object", "properties": { "keyword": { "type": "string" }, "instancePath": { "type": "string" }, "schemaPath": { "type": "string" }, "params": { "type": "object" }, "message": { "type": "string" } } } } }
2023.2 (latest)