workflow

README

workflow

Goomba workflow engine.

Badges

Install

go get github.com/goombaio/workflow

You can also update an already installed version:

go get -u github.com/goombaio/workflow

Example of use

// Create a Workflow
workflow1 := workflow.NewWorkflow("My Workflow", "This is an example of workflow")

License

Copyright (c) 2018 Goomba project Authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Documentation

Overview

Package workflow implements a workflow engine that manages business processes.

A workflow consists of an orchestrated and repeatable pattern of business activity enabled by the systematic organization of resources into processes that transform data and process information.

Internally, single workflow is described as a graph, a directed acyclic graph or DAG.

Example

workflow1 := workflow.NewWorkflow("My Workflow", "This is an example of workflow")

Index

• type Workflow
  • func NewWorkflow(name string, description string) *Workflow

Types

type Workflow

type Workflow struct {
	// Unique ID for this workflow engine.
	// Used for traceability, metrics, monitoring, etc ...
	ID uuid.UUID

	// Name of this workflow engine.
	Name string

	// Description of this worflow and its purpose.
	Description string
	// contains filtered or unexported fields
}

Workflow type represents a workflow engine.

func NewWorkflow

func NewWorkflow(name string, description string) *Workflow

NewWorkflow creates a new workflow engine given a name and description.

It generates an unique internal ID which will be used to identify this concrete workflow engine among others in order to support traceability, metrics, monitoring, etc ...

The workflow is defined by a graph, a directed acyclic graph or DAG. This graph will describe the inner processes belonging to it.