Flor is a Ruby workflow engine.
It interprets a language describing "workflows". They can be thought of long-running programs meant for orchestrating work among participants [in workflows].
Here are a few entry points into the documentation:
If you have any question feel free to ask in, well, the issue tracker.
- blocks.md - flor blocks vs Ruby blocks
- cancelling.md - cancelling or killing an execution or part of it
- chaining.md - piping/chaining procedure calls
- common_attributes.md - attributes common to all procedures
- domains.md - the flor domain layering system
- fragments.md - (fragments of documentation to be moved later on)
- glossary.md - flor terms with short explanations
- hooks.md - hooking pieces of code to react on flor execution events
- language.md - discussing the flor language
- launching.md - launching flor executions from Ruby or by inserting launch messages in the flor database
- messages.md - the messages whose back and forth make up flor executions
- multi_instance.md - flor instances collaborating to process executions across Ruby processes
- node.md - each flor procedure is backed by a node
- nodes.md - flor nodes and their interactions
- on_cancel.md - tying "on cancel" handlers to flor nodes
- on_error.md - tying "on error" handlers to flor nodes
- on_receive.md - tying "on receive" handlers to flor nodes
- on_timeout.md - tying "on timeout" handlers to flor nodes
- patterns.md - flor in the light of the workflow patterns
- patterns__control_flow.md - workflow control flow patterns
- patterns__data.md - workflow data patterns
- patterns__exception_handling.md - workflow exception handling patterns
- patterns__resource.md - workflow resource patterns
- re_applying.md - cancelling part of an execution to force it to a new definition tree
- recipes.md - good/best practices
- signalling.md - sending a signal to an execution (to trigger a reaction)
- storage_callbacks.md - setting callbacks after storage insert/update/delete
- strings.md - dealing with strings in the flor language
- tags.md - the
tag:attribute and its uses - tasks.md - handing tasks to gangers and taskers
- traps.md - setting event traps in flor definitions
- variables.md - the flor language and variables
- procedures/ - documentation directory for flor procedures
- services/ - pieces of documentation about flor services
- quickstart0/ - flor one file quickstart
- quickstart1/ - flor quickstart with a flor directory tree