flowRef (FlowRef)

block this flow while executing another flow, with the current payload from this flow passed to the new flow. The new flow will execute in its own context, and when complete, will return its results back to this flow. However, the return type of this processor is a FlowRefResult, so if you want to use the result, follow this processor with an adoptFlowRefResults processor

Class names

scala: code.data.FlowRefScannable
javascript: code_data_FlowRefScannable

Aliases

Input type

Output type

Config

{"categories":[{"defaultCollapsed":true,"fields":["flowOrchestratorFuncConfig","includeStateFunc","includeStateFuncConfig"],"name":"advanced"},{"defaultCollapsed":true,"fields":["testData","testDataTransformFunc","assertionFunc"],"name":"Testing"}],"fieldName":"flowRef","fields":[{"default":null,"fieldName":"flowRef.name","hidden":false,"hideLabel":false,"name":"name","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"flowRef","fieldName":"flowRef.classPath","hidden":false,"hideLabel":false,"name":"classPath","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":1,"fieldName":"flowRef.threadPoolSize","hidden":false,"hideLabel":false,"name":"threadPoolSize","readonly":false,"renderStrategies":[],"type":"I","validators":[]},{"default":null,"fieldName":"flowRef.flowOrchestratorFunc","hidden":false,"hideLabel":false,"name":"flowOrchestratorFunc","readonly":false,"renderStrategies":[],"type":"Js","validators":[]},{"default":"","fieldName":"flowRef.storePayloadAtKey","hidden":false,"hideLabel":false,"name":"storePayloadAtKey","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":true,"fieldName":"flowRef.overrideConsoleLevel","hidden":false,"hideLabel":false,"name":"overrideConsoleLevel","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":false,"fieldName":"flowRef.discardResults","hidden":false,"hideLabel":false,"name":"discardResults","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"categories":[],"fieldName":"flowRef.includeStateFuncConfig","fields":[{"choice":"default","default":{"choice":"default","config":{}},"fieldName":"flowRef.includeStateFuncConfig.advancedJsConfig","hidden":false,"hideLabel":false,"name":"advancedJsConfig","readonly":false,"renderStrategies":[],"type":"CHOICE","types":{"default":{"categories":[],"fieldName":"flowRef.includeStateFuncConfig.advancedJsConfig.defaultConfig","fields":[],"hidden":true,"hideLabel":true,"name":"defaultConfig","readonly":false,"renderStrategies":[],"type":"O"},"overridden":{"categories":[],"fieldName":"flowRef.includeStateFuncConfig.advancedJsConfig.overriddenConfig","fields":[{"default":["--language=es6"],"fieldName":"flowRef.includeStateFuncConfig.advancedJsConfig.overriddenConfig.engineStartupParameters","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"flowRef.includeStateFuncConfig.advancedJsConfig.overriddenConfig.engineStartupParameters.engineStartupParameters","hidden":false,"hideLabel":false,"name":"engineStartupParameters","readonly":false,"renderStrategies":[],"type":"S","validators":[]},"name":"engineStartupParameters","readonly":false,"renderStrategies":[],"type":"A"},{"default":false,"fieldName":"flowRef.includeStateFuncConfig.advancedJsConfig.overriddenConfig.preProcessPrune","hidden":false,"hideLabel":false,"name":"preProcessPrune","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":false,"fieldName":"flowRef.includeStateFuncConfig.advancedJsConfig.overriddenConfig.preProcessSyntaxCompile","hidden":false,"hideLabel":false,"name":"preProcessSyntaxCompile","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":["_"],"fieldName":"flowRef.includeStateFuncConfig.advancedJsConfig.overriddenConfig.extraLibraries","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"flowRef.includeStateFuncConfig.advancedJsConfig.overriddenConfig.extraLibraries.extraLibraries","hidden":false,"hideLabel":false,"name":"extraLibraries","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["_"],"displayOverride":{},"rule":"choices","unenforced":false}]},"name":"extraLibraries","readonly":false,"renderStrategies":[],"type":"A"},{"default":"nashorn","fieldName":"flowRef.includeStateFuncConfig.advancedJsConfig.overriddenConfig.engine","hidden":false,"hideLabel":false,"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":"includeStateFuncConfig","readonly":false,"renderStrategies":[],"type":"O"},{"default":null,"fieldName":"flowRef.flowOrchestrator","hidden":false,"hideLabel":false,"name":"flowOrchestrator","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"return true;","fieldName":"flowRef.includeState","hidden":false,"hideLabel":false,"name":"includeState","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"flowRef.testDataTransformFunc","hidden":false,"hideLabel":false,"name":"testDataTransformFunc","readonly":false,"renderStrategies":[],"type":"Js","validators":[]},{"default":"${generatedId}","fieldName":"flowRef.id","hidden":false,"hideLabel":false,"name":"id","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":false,"fieldName":"flowRef.runOnThreadpool","hidden":false,"hideLabel":false,"name":"runOnThreadpool","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":null,"fieldName":"flowRef.testData","hidden":false,"hideLabel":false,"name":"testData","readonly":false,"renderStrategies":[],"type":"Jv","validators":[]},{"default":null,"fieldName":"flowRef.assertionFunc","hidden":false,"hideLabel":false,"name":"assertionFunc","readonly":false,"renderStrategies":[],"type":"Js","validators":[]},{"categories":[],"fieldName":"flowRef.flowOrchestratorFuncConfig","fields":[{"choice":"default","default":{"choice":"default","config":{}},"fieldName":"flowRef.flowOrchestratorFuncConfig.advancedJsConfig","hidden":false,"hideLabel":false,"name":"advancedJsConfig","readonly":false,"renderStrategies":[],"type":"CHOICE","types":{"default":{"categories":[],"fieldName":"flowRef.flowOrchestratorFuncConfig.advancedJsConfig.defaultConfig","fields":[],"hidden":true,"hideLabel":true,"name":"defaultConfig","readonly":false,"renderStrategies":[],"type":"O"},"overridden":{"categories":[],"fieldName":"flowRef.flowOrchestratorFuncConfig.advancedJsConfig.overriddenConfig","fields":[{"default":["--language=es6"],"fieldName":"flowRef.flowOrchestratorFuncConfig.advancedJsConfig.overriddenConfig.engineStartupParameters","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"flowRef.flowOrchestratorFuncConfig.advancedJsConfig.overriddenConfig.engineStartupParameters.engineStartupParameters","hidden":false,"hideLabel":false,"name":"engineStartupParameters","readonly":false,"renderStrategies":[],"type":"S","validators":[]},"name":"engineStartupParameters","readonly":false,"renderStrategies":[],"type":"A"},{"default":false,"fieldName":"flowRef.flowOrchestratorFuncConfig.advancedJsConfig.overriddenConfig.preProcessPrune","hidden":false,"hideLabel":false,"name":"preProcessPrune","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":false,"fieldName":"flowRef.flowOrchestratorFuncConfig.advancedJsConfig.overriddenConfig.preProcessSyntaxCompile","hidden":false,"hideLabel":false,"name":"preProcessSyntaxCompile","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":["_"],"fieldName":"flowRef.flowOrchestratorFuncConfig.advancedJsConfig.overriddenConfig.extraLibraries","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"flowRef.flowOrchestratorFuncConfig.advancedJsConfig.overriddenConfig.extraLibraries.extraLibraries","hidden":false,"hideLabel":false,"name":"extraLibraries","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["_"],"displayOverride":{},"rule":"choices","unenforced":false}]},"name":"extraLibraries","readonly":false,"renderStrategies":[],"type":"A"},{"default":"nashorn","fieldName":"flowRef.flowOrchestratorFuncConfig.advancedJsConfig.overriddenConfig.engine","hidden":false,"hideLabel":false,"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":"flowOrchestratorFuncConfig","readonly":false,"renderStrategies":[],"type":"O"},{"default":null,"fieldName":"flowRef.orchestrationTimeout","hidden":false,"hideLabel":false,"name":"orchestrationTimeout","readonly":false,"renderStrategies":[],"type":"L","validators":[]},{"default":true,"fieldName":"flowRef.runWhenEmpty","hidden":false,"hideLabel":false,"name":"runWhenEmpty","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":true,"fieldName":"flowRef.synchronous","hidden":false,"hideLabel":false,"name":"synchronous","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":[],"fieldName":"flowRef.flowsToPin","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"flowRef.flowsToPin.flowsToPin","hidden":false,"hideLabel":false,"name":"flowsToPin","readonly":false,"renderStrategies":[],"type":"S","validators":[]},"name":"flowsToPin","readonly":false,"renderStrategies":[],"type":"A"}],"hidden":false,"hideLabel":false,"label":"Processor Configuration","name":"flowRef","readonly":false,"renderStrategies":[],"type":"O"}