flow

README

Flows is a simple process flow action for the Project Flogo Ecosystem

Flogo Flow

Flogo Flow is one of the primary actions of the Project Flogo Ecosystem. It is a process flow engine that can be used to connect activities together to create complex application logic. This proces engine can be used to create code-free applications or for application integration and orchestration projects.

Getting Started

We’ve made building process flows as easy as possible. Develop your flows using:

• A simple, clean JSON-based DSL
• Golang API

See the sample below of flow that logs its inputs (for brevity, the triggers and metadata of the resource has been omitted). Also don’t forget to check out the examples in the repo.

{
    "tasks": [
      {
        "id": "log_1",
        "name": "Log 1",
        "activity": {
          "ref": "#log",
          "input": {
            "message": "=$flow.in"
          }
        }
      },
      {
        "id": "log_2",
        "name": "Log 2",
        "activity": {
          "ref": "#log",
          "input": {
            "message": "second log message"
          }
        }
      }
    ],
    "links": [
      {
        "from":"log_1",
        "to":"log_2"
      }
    ]
}

Try out the example

Firstly you should install the install the Flogo CLI.

Next you should download our aggregation example log-flogo.json.

We'll create a our application using the example file, we'll call it myApp

$ flogo create -f log-flogo.json myApp

Now, build it...

$ cd myApp/
$ flogo build

Activities

Flogo Flows also provides some activities to assist in complex flow creation.

• Subflow : This activity allows you start another flow within the existing flow.

Additional Documentation

To learn more about the model you should checkout the Flow Model doc.

License

Flogo source code in this repository is under a BSD-style license, refer to LICENSE

Documentation

Index

• Constants
• func Version() string
• type ActionFactory
  • func (f *ActionFactory) Initialize(ctx action.InitContext) error
  • func (f *ActionFactory) New(config *action.Config) (action.Action, error)
• type FlowAction
  • func (fa *FlowAction) IOMetadata() *metadata.IOMetadata
  • func (fa *FlowAction) Info() *action.Info
  • func (fa *FlowAction) Metadata() *action.Metadata
  • func (fa *FlowAction) Run(ctx context.Context, inputs map[string]interface{}, ...) error
• type Settings

Constants

const (
	StateRecordingMode = "stateRecordingMode"
	// Deprecated
	RtSettingStepMode     = "stepRecordingMode"
	RtSettingSnapshotMode = "snapshotRecordingMode"
)

Functions

func Version

func Version() string

Version will return the flow release version

Types

type ActionFactory

type ActionFactory struct {
	// contains filtered or unexported fields
}

func (*ActionFactory) Initialize

func (f *ActionFactory) Initialize(ctx action.InitContext) error

func (*ActionFactory) New

func (f *ActionFactory) New(config *action.Config) (action.Action, error)

type FlowAction

type FlowAction struct {
	// contains filtered or unexported fields
}

func (*FlowAction) IOMetadata

func (fa *FlowAction) IOMetadata() *metadata.IOMetadata

func (*FlowAction) Info

func (fa *FlowAction) Info() *action.Info

func (*FlowAction) Metadata

func (fa *FlowAction) Metadata() *action.Metadata

Metadata get the Action's metadata

func (*FlowAction) Run

func (fa *FlowAction) Run(ctx context.Context, inputs map[string]interface{}, handler action.ResultHandler) error

Run implements action.Action.Run

type Settings

type Settings struct {
	FlowURI string `md:"flowURI,required"`
}