getFlowHistory (GetFlowHistory)

Takes a FlowHistoryQuery uses every populated field in it to query all available flow statuses returning the results in a FlowHistoryQueryResponse. Please note that flow statuses expire, and empty collections are a valid response from this stream processor.

Class names

scala: code.model.flows.processors.state.GetFlowHistoryScannable
javascript: code_model_flows_processors_state_GetFlowHistoryScannable

Aliases

Coercions

RequiredFields: {
}
OptionalFields: {
after or
flowEndedAfter or
afterEnd or
finishedAFter
used to define
flowEndedAfter
before or
flowEndedBefore or
beforeEnd or
finishedBefore
used to define
flowEndedBefore
startedAfter or
flowStartedAfter or
triggerStartedAfter
used to define
flowStartedAfter
startedBefore or
flowStartedBefore or
triggerStartedBefore
used to define
flowStartedBefore
inTheLast
used to define
inTheLast
ids or
orchIds or
orchIdentities or
orchestrationIds
used to define
orchestrationIds
orchestrators or
names or
orchestratorNames or
orchNames or
flowNames or
flows
used to define
orchestratorNames
}

Config

{"bindingHint":"Retrieves all flow statuses associated with populated query params in FlowHistoryQuery. Please note that flow statuses expire, and empty collections are a valid response from this stream processor.","categories":[{"defaultCollapsed":true,"fields":["testConfig"],"name":"Testing"}],"fieldName":"getFlowHistory","fields":[{"default":null,"fieldName":"getFlowHistory.name","hidden":false,"hideLabel":false,"name":"name","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"${generatedId}","fieldName":"getFlowHistory.id","hidden":false,"hideLabel":false,"name":"id","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"getFlowHistory","fieldName":"getFlowHistory.classPath","hidden":false,"hideLabel":false,"name":"classPath","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"canReference":false,"default":null,"fieldName":"getFlowHistory.testConfig","hidden":false,"hideLabel":false,"itemType":{"categories":[{"defaultCollapsed":true,"fields":["testData","testDataTransformFuncJsFuncConfiguration","assertionFuncJsFuncConfiguration"],"name":"Advanced"}],"fieldName":"getFlowHistory.testConfig.testConfig","fields":[{"default":null,"fieldName":"getFlowHistory.testConfig.0.testConfig.name","hidden":false,"hideLabel":false,"name":"name","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"flowTestConfigs","fieldName":"getFlowHistory.testConfig.0.testConfig.classPath","hidden":false,"hideLabel":false,"name":"classPath","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"bindingHint":"A Javascript function that defines the input for the test. Unit tests can operate with no assertion func meaning that this field is also the only required configuration for a test to run. Item refers to any user input through the form defined in testData","default":null,"fieldName":"getFlowHistory.testConfig.0.testConfig.testDataTransformFunc","hidden":false,"hideLabel":false,"label":"testDataTransformFunc","name":"testDataTransformFunc","prefix":"function(item, payload){","readonly":false,"renderStrategies":[],"suffix":"}","type":"Js","validators":[]},{"default":"","fieldName":"getFlowHistory.testConfig.0.testConfig.id","hidden":false,"hideLabel":false,"name":"id","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"bindingHint":"<div>\n A JSON field used to define a user input form using the FLOW data types system, for details see the guide <a href=\"/static/docs/?q=/static/docs/tutorials/Data%2520Type%2520Guide.html\">Here</a>. When a user runs a test their answers to the form will be sent to testDataTransformFunc as the argument 'item' with a type of JValue.\n </div>","default":null,"fieldName":"getFlowHistory.testConfig.0.testConfig.testData","hidden":false,"hideLabel":false,"label":"testData","name":"testData","readonly":false,"renderStrategies":[],"type":"Jv","validators":[]},{"bindingHint":"<div>\n A Javascript function that enables unit testing on the stream processor it is attached to, the assertionFunc should return true to represent a test passing and false if the test should fail. See code.data.Payload in flow docs for details on how to access stream items on the payload or the Unit testing tutorial\n <a href=\"/static/docs/?q=/static/docs/tutorials/Unit%2520Testing.html\">here</a>.\n </div>","default":null,"fieldName":"getFlowHistory.testConfig.0.testConfig.assertionFunc","hidden":false,"hideLabel":false,"label":"assertionFunc","name":"assertionFunc","readonly":false,"renderStrategies":[],"type":"Js","validators":[]},{"categories":[],"fieldName":"getFlowHistory.testConfig.0.testConfig.testDataTransformFuncJsFuncConfiguration","fields":[{"bindingHint":"Choose whether this JsFunc uses the server default configuration for the Javascript engine settings or if it should have its own advanced configuration. defaultConfig is recommended.","choice":"default","default":{"choice":"default","config":{}},"fieldName":"getFlowHistory.testConfig.testConfig.testDataTransformFuncJsFuncConfiguration.advancedJsConfig","hidden":false,"hideLabel":false,"label":"advancedJsConfig","name":"advancedJsConfig","readonly":false,"renderStrategies":[],"type":"CHOICE","types":{"default":{"categories":[],"fieldName":"getFlowHistory.testConfig.testConfig.testDataTransformFuncJsFuncConfiguration.advancedJsConfig.defaultConfig","fields":[],"hidden":true,"hideLabel":true,"name":"defaultConfig","readonly":false,"renderStrategies":[],"type":"O"},"overridden":{"categories":[],"fieldName":"getFlowHistory.testConfig.testConfig.testDataTransformFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig","fields":[{"bindingHint":"Configure arguments to pass into the engine for highly advanced users.","default":["--language=es6"],"fieldName":"getFlowHistory.testConfig.testConfig.testDataTransformFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.engineStartupParameters","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"getFlowHistory.testConfig.testConfig.testDataTransformFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.engineStartupParameters.engineStartupParameters","hidden":false,"hideLabel":false,"name":"engineStartupParameters","readonly":false,"renderStrategies":[],"type":"S","validators":[]},"label":"engineStartupParameters","name":"engineStartupParameters","readonly":false,"renderStrategies":[],"type":"A"},{"bindingHint":"Determines if the engine will be recreated after cleanup or if it will be recreated the next time it is needed.","default":false,"fieldName":"getFlowHistory.testConfig.testConfig.testDataTransformFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.recreateEngineAfterCleanup","hidden":false,"hideLabel":false,"label":"recreateEngineAfterCleanup","name":"recreateEngineAfterCleanup","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"bindingHint":"The idle time in milliseconds before an engine is cleaned up. Idle time is the time between executions of the jsFunc on this engine.","default":300000,"fieldName":"getFlowHistory.testConfig.testConfig.testDataTransformFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.engineIdleCleanup","hidden":false,"hideLabel":false,"label":"engineIdleCleanup","name":"engineIdleCleanup","readonly":false,"renderStrategies":[],"type":"L","validators":[]},{"bindingHint":"Determines if the body of the jsFunc will be pre processed and optimised to only include the libraries which are being used. If false all Flow js libraries will be included and performance will be negtiavely impacted.","default":true,"fieldName":"getFlowHistory.testConfig.testConfig.testDataTransformFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.preProcessPrune","hidden":false,"hideLabel":false,"label":"preProcessPrune","name":"preProcessPrune","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"bindingHint":"Determines if the engine is created when the flow is loaded into memory or when the jsFunc is first required.","default":false,"fieldName":"getFlowHistory.testConfig.testConfig.testDataTransformFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.createEngineOnCreation","hidden":false,"hideLabel":false,"label":"createEngineOnCreation","name":"createEngineOnCreation","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"bindingHint":"Determines if the body of the jsFunc will be pre compiled and evaluated for syntax errors. When users attempt to save this flow errors will be displayed and any changes with errors will not be saved.","default":false,"fieldName":"getFlowHistory.testConfig.testConfig.testDataTransformFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.preProcessSyntaxCompile","hidden":false,"hideLabel":false,"label":"preProcessSyntaxCompile","name":"preProcessSyntaxCompile","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"bindingHint":"Configure what additional non-flow libraries are being made available to this jsFunc.","default":["_"],"fieldName":"getFlowHistory.testConfig.testConfig.testDataTransformFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.extraLibraries","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"getFlowHistory.testConfig.testConfig.testDataTransformFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.extraLibraries.extraLibraries","hidden":false,"hideLabel":false,"name":"extraLibraries","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["_"],"displayOverride":{},"rule":"choices","unenforced":false}]},"label":"extraLibraries","name":"extraLibraries","readonly":false,"renderStrategies":[],"type":"A"},{"bindingHint":"The number of times an engine will be used before it is cleaned up and replaced with a new instance. This assumes the engine is always idle for less time than configured in engineIdleCleanup.","default":50000,"fieldName":"getFlowHistory.testConfig.testConfig.testDataTransformFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.engineMaxExecutions","hidden":false,"hideLabel":false,"label":"engineMaxExecutions","name":"engineMaxExecutions","readonly":false,"renderStrategies":[],"type":"I","validators":[]},{"bindingHint":"Configure which engine jsFuncs will be processed with.","default":"nashorn","fieldName":"getFlowHistory.testConfig.testConfig.testDataTransformFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.engine","hidden":false,"hideLabel":false,"label":"engine","name":"engine","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["nashorn"],"displayOverride":{},"rule":"choices","unenforced":false}]}],"hidden":false,"hideLabel":true,"name":"overriddenConfig","readonly":false,"renderStrategies":[],"type":"O"}},"validators":[]}],"hidden":false,"hideLabel":false,"name":"testDataTransformFuncJsFuncConfiguration","readonly":false,"renderStrategies":[],"type":"O"},{"categories":[],"fieldName":"getFlowHistory.testConfig.0.testConfig.assertionFuncJsFuncConfiguration","fields":[{"bindingHint":"Choose whether this JsFunc uses the server default configuration for the Javascript engine settings or if it should have its own advanced configuration. defaultConfig is recommended.","choice":"default","default":{"choice":"default","config":{}},"fieldName":"getFlowHistory.testConfig.testConfig.assertionFuncJsFuncConfiguration.advancedJsConfig","hidden":false,"hideLabel":false,"label":"advancedJsConfig","name":"advancedJsConfig","readonly":false,"renderStrategies":[],"type":"CHOICE","types":{"default":{"categories":[],"fieldName":"getFlowHistory.testConfig.testConfig.assertionFuncJsFuncConfiguration.advancedJsConfig.defaultConfig","fields":[],"hidden":true,"hideLabel":true,"name":"defaultConfig","readonly":false,"renderStrategies":[],"type":"O"},"overridden":{"categories":[],"fieldName":"getFlowHistory.testConfig.testConfig.assertionFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig","fields":[{"bindingHint":"Configure arguments to pass into the engine for highly advanced users.","default":["--language=es6"],"fieldName":"getFlowHistory.testConfig.testConfig.assertionFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.engineStartupParameters","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"getFlowHistory.testConfig.testConfig.assertionFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.engineStartupParameters.engineStartupParameters","hidden":false,"hideLabel":false,"name":"engineStartupParameters","readonly":false,"renderStrategies":[],"type":"S","validators":[]},"label":"engineStartupParameters","name":"engineStartupParameters","readonly":false,"renderStrategies":[],"type":"A"},{"bindingHint":"Determines if the engine will be recreated after cleanup or if it will be recreated the next time it is needed.","default":false,"fieldName":"getFlowHistory.testConfig.testConfig.assertionFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.recreateEngineAfterCleanup","hidden":false,"hideLabel":false,"label":"recreateEngineAfterCleanup","name":"recreateEngineAfterCleanup","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"bindingHint":"The idle time in milliseconds before an engine is cleaned up. Idle time is the time between executions of the jsFunc on this engine.","default":300000,"fieldName":"getFlowHistory.testConfig.testConfig.assertionFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.engineIdleCleanup","hidden":false,"hideLabel":false,"label":"engineIdleCleanup","name":"engineIdleCleanup","readonly":false,"renderStrategies":[],"type":"L","validators":[]},{"bindingHint":"Determines if the body of the jsFunc will be pre processed and optimised to only include the libraries which are being used. If false all Flow js libraries will be included and performance will be negtiavely impacted.","default":true,"fieldName":"getFlowHistory.testConfig.testConfig.assertionFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.preProcessPrune","hidden":false,"hideLabel":false,"label":"preProcessPrune","name":"preProcessPrune","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"bindingHint":"Determines if the engine is created when the flow is loaded into memory or when the jsFunc is first required.","default":false,"fieldName":"getFlowHistory.testConfig.testConfig.assertionFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.createEngineOnCreation","hidden":false,"hideLabel":false,"label":"createEngineOnCreation","name":"createEngineOnCreation","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"bindingHint":"Determines if the body of the jsFunc will be pre compiled and evaluated for syntax errors. When users attempt to save this flow errors will be displayed and any changes with errors will not be saved.","default":false,"fieldName":"getFlowHistory.testConfig.testConfig.assertionFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.preProcessSyntaxCompile","hidden":false,"hideLabel":false,"label":"preProcessSyntaxCompile","name":"preProcessSyntaxCompile","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"bindingHint":"Configure what additional non-flow libraries are being made available to this jsFunc.","default":["_"],"fieldName":"getFlowHistory.testConfig.testConfig.assertionFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.extraLibraries","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"getFlowHistory.testConfig.testConfig.assertionFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.extraLibraries.extraLibraries","hidden":false,"hideLabel":false,"name":"extraLibraries","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["_"],"displayOverride":{},"rule":"choices","unenforced":false}]},"label":"extraLibraries","name":"extraLibraries","readonly":false,"renderStrategies":[],"type":"A"},{"bindingHint":"The number of times an engine will be used before it is cleaned up and replaced with a new instance. This assumes the engine is always idle for less time than configured in engineIdleCleanup.","default":50000,"fieldName":"getFlowHistory.testConfig.testConfig.assertionFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.engineMaxExecutions","hidden":false,"hideLabel":false,"label":"engineMaxExecutions","name":"engineMaxExecutions","readonly":false,"renderStrategies":[],"type":"I","validators":[]},{"bindingHint":"Configure which engine jsFuncs will be processed with.","default":"nashorn","fieldName":"getFlowHistory.testConfig.testConfig.assertionFuncJsFuncConfiguration.advancedJsConfig.overriddenConfig.engine","hidden":false,"hideLabel":false,"label":"engine","name":"engine","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["nashorn"],"displayOverride":{},"rule":"choices","unenforced":false}]}],"hidden":false,"hideLabel":true,"name":"overriddenConfig","readonly":false,"renderStrategies":[],"type":"O"}},"validators":[]}],"hidden":false,"hideLabel":false,"name":"assertionFuncJsFuncConfiguration","readonly":false,"renderStrategies":[],"type":"O"}],"hidden":false,"hideLabel":false,"name":"testConfig","readonly":false,"renderStrategies":[],"type":"O"},"name":"testConfig","readonly":false,"renderStrategies":[],"type":"A"}],"hidden":false,"hideLabel":false,"label":"getFlowHistory","name":"getFlowHistory","readonly":false,"renderStrategies":[],"type":"O"}