TrackScript

1 Minute to read

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Used to track status of an executing script

Key	Value(s)	Description
method	"TrackScript"	Tracks status of an executing script
scriptId	"madeupscriptID"	scriptID - this is manually set when calling ExecuteStoredScript
statusOnly	true/false

Use TrackScript in conjunction with ExecuteStoredScript:

{
  "method": "ExecuteStoredScript",
  "scriptId": "madeupscriptid0001",
  "name": "Regression Reports",
  "targetProject": "RegressionDB"
   "projectName":"RegressionDB"
}


{
  "method": "TrackScript",
  "scriptId": "madeupscriptid0001",
  "statusOnly":true,
}

The following is an example of a TrackScript response with statusOnly = true:

{
  "result": {},
  "currentPos": 4,
  "callingProject": "BikeData2",
  "targetProject": "BikeData2",
  "cancelled": false,
  "failed": false,
  "runOK": true,
  "hasError": false,
  "complete": true,
  "lifeTime": 0,
  "runTime": 0,
  "executed": true,
  "errors": [],
  "millis": 1,
  "projectEpoch": 638223390449064890,
  "method": "TrackScript"
}

The following is an example of a TrackScript response with statusOnly = false:

{
  "result": {
    "script": [
      {
        "method": "Defines",
        "detail": "",
        "state": "Not Started",
        "time": "",
        "errors": []
      },
      {
        "method": "Backup",
        "detail": "",
        "state": "Complete",
        "time": "0.04",
        "errors": []
      },
      {
        "method": "IF",
        "detail": "",
        "state": "Not Started",
        "time": "",
        "errors": []
      },
      {
        "method": "Audit",
        "detail": "%BackupPathAndFile_Audit%",
        "state": "Complete",
        "time": "0.33",
        "errors": []
      },
      {
        "method": "ENDIF",
        "detail": "",
        "state": "Not Started",
        "time": "",
        "errors": []
      }
    ]
  },
  "currentPos": 4,
  "callingProject": "BikeData2",
  "targetProject": "BikeData2",
  "cancelled": false,
  "failed": false,
  "runOK": true,
  "hasError": false,
  "complete": true,
  "lifeTime": 0,
  "runTime": 0,
  "executed": true,
  "errors": [],
  "millis": 0,
  "projectEpoch": 638223390449064890,
  "method": "TrackScript"
}

Was this article helpful?

What's Next

Test