onBoot (On Boot)

An on boot triggerer executes an orchestration when the Flow server starts. If multiple on boot triggerers exist, there is no expectation of order. The orchestration executed is passed a payload containing only the current timestamp of its invocation.

class names

scala: code.data.OnBootTriggererFactory
javascript: code_data_OnBootTriggererFactory

aliases

boot onStartup startup

start type

code.data.Datum

end type

config

{"categories":[{"defaultCollapsed":true,"fields":["poolSize","sharedPoolName","streamType","mutualReentranceKey","nonReentrant","killOnStop","orchestrationTimeout","orchestratorName","env","isRunning","runOnlyOnHosts","runOnlyOnRanks","runOnlyOnRoles","deepDiagnostics","startupPriority"],"name":"Advanced Run Configuration"}],"fieldName":"onBoot","fields":[{"default":null,"fieldName":"onBoot.runOnlyOnRanks","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"onBoot.runOnlyOnRanks.runOnlyOnRanks","hidden":false,"hideLabel":false,"name":"runOnlyOnRanks","readonly":false,"renderStrategies":[],"type":"I","validators":[]},"name":"runOnlyOnRanks","readonly":false,"renderStrategies":[],"type":"A"},{"default":null,"fieldName":"onBoot.name","hidden":false,"hideLabel":false,"name":"name","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"onBoot","fieldName":"onBoot.classPath","hidden":false,"hideLabel":false,"name":"classPath","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"onBoot.bundle","hidden":false,"hideLabel":false,"name":"bundle","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"onBoot.mutualReentrancyKey","hidden":false,"hideLabel":false,"name":"mutualReentrancyKey","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"collecting","fieldName":"onBoot.streamType","hidden":false,"hideLabel":false,"name":"streamType","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["collecting","eager","forgetful"],"displayOverride":{},"rule":"choices","unenforced":false}]},{"default":false,"fieldName":"onBoot.deepDiagnostics","hidden":false,"hideLabel":false,"name":"deepDiagnostics","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":null,"fieldName":"onBoot.runOnlyOnRoles","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"onBoot.runOnlyOnRoles.runOnlyOnRoles","hidden":false,"hideLabel":false,"name":"runOnlyOnRoles","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["frontend","backend","viewer"],"displayOverride":{},"rule":"choices","unenforced":false}]},"name":"runOnlyOnRoles","readonly":false,"renderStrategies":[],"type":"A"},{"default":"","fieldName":"onBoot.description","hidden":false,"hideLabel":false,"name":"description","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"bindingHint":"the size of the threadpool. If this is set to a positive number, this trigger will use a dedicated threadpool. If this is set to zero or less, it will use the default shared threadpool.","canReference":true,"default":null,"fieldName":"onBoot.poolSize","hidden":false,"hideLabel":false,"label":"threadpool size","name":"poolSize","readonly":false,"renderStrategies":[],"type":"I","validators":[]},{"default":false,"fieldName":"onBoot.nonReentrant","hidden":false,"hideLabel":false,"name":"nonReentrant","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":null,"fieldName":"onBoot.orchestratorName","hidden":false,"hideLabel":false,"name":"orchestratorName","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"bindingHint":"If this trigger is set to use a dedicated threadpool (using the poolSize attribute), then this name will override which threadpool this trigger uses. By default, triggers using dedicated threadpools will use a threadpool each, but if you set multiple triggers with the same name and pool size, they will share that pool.","canReference":true,"default":null,"fieldName":"onBoot.sharedPoolName","hidden":false,"hideLabel":false,"label":"shared threadpool","name":"sharedPoolName","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"${generatedId}","fieldName":"onBoot.id","hidden":false,"hideLabel":false,"name":"id","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"bindingHint":"This is the order of startup when multiple stateful behaviours are being started at the same time. This is usually when a recipe is being run, or a bundle is being loaded, but is especially relevant when the server is being started.","default":1200,"fieldName":"onBoot.startupPriority","hidden":false,"hideLabel":false,"name":"startupPriority","readonly":false,"renderStrategies":[],"type":"I","validators":[{"max":2048.0,"min":950.0,"rule":"numberRange"}]},{"default":null,"fieldName":"onBoot.runOnlyOnHosts","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"onBoot.runOnlyOnHosts.runOnlyOnHosts","hidden":false,"hideLabel":false,"name":"runOnlyOnHosts","readonly":false,"renderStrategies":[],"type":"S","validators":[]},"name":"runOnlyOnHosts","readonly":false,"renderStrategies":[],"type":"A"},{"default":false,"fieldName":"onBoot.isRunning","hidden":false,"hideLabel":false,"name":"isRunning","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":false,"fieldName":"onBoot.killOnStop","hidden":false,"hideLabel":false,"name":"killOnStop","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"canReference":false,"default":180000,"fieldName":"onBoot.orchestrationTimeout","hidden":false,"hideLabel":false,"label":"Orchestration Timeout","name":"orchestrationTimeout","readonly":false,"renderStrategies":[{"config":{"precision":3,"timeUnit":"ms"},"type":"valueAsTimeSpan"}],"type":"L","validators":[]},{"default":"statefulBehaviour","fieldName":"onBoot.type","hidden":false,"hideLabel":false,"name":"type","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"onBoot.env","hidden":false,"hideLabel":false,"name":"env","readonly":false,"renderStrategies":[],"type":"S","validators":[]}],"hidden":false,"hideLabel":false,"label":"Triggerer Configuration","name":"onBoot","readonly":false,"renderStrategies":[],"type":"O"}