app-workflow_engine Schemas

On this page:

jobMetricsDocument

{ "definitions": {}, "$schema": "http://json-schema.org/draft-07/schema#", "$id": "jobMetricsDocument", "type": "object", "title": "Job metrics schema", "properties": { "_id": { "$ref": "wfEngineCommon#/definitions/mongoObjectId" }, "workflow": { "$id": "#/properties/workflow", "type": "object", "title": "Automation the job was started on.", "properties": { "name": { "$id": "#/properties/workflow/properties/name", "type": "string", "title": "Name of the automation the job was started on", "examples": [ "exampleAutomationName" ] }, "_id": { "$id": "#/properties/workflow/properties/_id", "type": "string", "pattern": "^[0-9a-f]{24}$", "title": "Automation objectId the job was started on", "examples": [ "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ] } } }, "preAutomationTime": { "$id": "#/properties/preAutomationTime", "type": "integer", "title": "Pre automation time of automation", "description": "Time (milliseconds) automation would have taken someone to complete without using IAP.", "examples": [ 5000, 250000 ] }, "metrics": { "$id": "#/properties/metrics", "type": "array", "title": "Weekly aggregate metrics", "description": "Aggregate job metrics collected on a weekly basis", "items": { "type": "object", "properties": { "jobsComplete": { "$id": "#/properties/metrics/properties/jobsComplete", "type": "integer", "title": "Jobs complete for automation", "description": "Total number of jobs complete for automation for the week starting at startDate.", "minimum": 0, "examples": [ 10, 40 ] }, "totalRunTime": { "$id": "#/properties/metrics/properties/totalRunTime", "type": "integer", "title": "Total run time for automation", "description": "Total run time (milliseconds) of jobs complete for automation for the week starting at startDate.", "minimum": 0, "examples": [ 200, 700 ] }, "totalManualTime": { "$id": "#/properties/metrics/properties/totalManualTime", "type": "integer", "title": "Total manual time for automation", "description": "Total time (milliseconds) spent working manual a task for automation for the week starting at startDate.", "minimum": 0, "examples": [ 200, 700 ] }, "slaTargetsMissed": { "$id": "#/properties/metrics/properties/slaTargetsMissed", "type": "integer", "title": "Sla targets missed for automation.", "description": "Total number of sla targets that were missed for an automation for the week starting at startDate.", "minimum": 0, "examples": [ 5, 10 ] }, "startDate": { "$id": "#/properties/metrics/properties/startDate", "type": "string", "title": "Start DateTime of metric collection", "description": "Metrics are collected on a weekly interval, starting at startDate", "examples": [ "2018-08-02T15:56:12.912Z", "2019-09-06T12:52:24.933Z" ] } }, "required": [ "jobsComplete", "totalRunTime", "totalManualTime", "slaTargetsMissed", "startDate" ] } } }, "required": [ "_id", "workflow", "metrics" ] }