timer

README

tibco-timer

This trigger provides your flogo application the ability to schedule a flow via scheduling service

Installation

flogo add trigger github.com/TIBCOSoftware/flogo-contrib/trigger/timer

Schema

Outputs and Endpoint:

{
  "outputs": [
    {
      "name": "params",
      "type": "params"
    },
    {
      "name": "content",
      "type": "object"
    }
  ],
  "endpoint": {
    "settings": [
      {
        "name": "repeating",
        "type": "string"
      },
      {
        "name": "notImmediate",
        "type": "string"
      },
      {
        "name": "startDate",
        "type": "string"
      },
      {
        "name": "hours",
        "type": "string"
      },
      {
        "name": "minutes",
        "type": "string"
      },
      {
        "name": "seconds",
        "type": "string"
      }
    ]
  }
}

Example Configurations

Triggers are configured via the triggers.json of your application. The following are some example configuration of the Timer Trigger.

Only once and immediate

Configure the Trigger to run a flow immediately

{
  "triggers": [
    {
      "name": "tibco-timer",
      "settings": {
      },
      "endpoints": [
        {
          "actionType": "flow",
          "actionURI": "embedded://myflow",
          "settings": {
            "repeating": "false"
          }
        }
      ]
    }
  ]
}

Only once at schedule time

Configure the Trigger to run a flow at a certain date/time. "startDate" settings format = "mm/dd/yyyy, hours:minutes:seconds"

{
  "triggers": [
    {
      "name": "tibco-rest",
      "settings": {
        "port": "8080"
      },
      "endpoints": [
        {
          "actionType": "flow",
          "actionURI": "embedded://myflow",
          "settings": {
            "repeating": "false",
            "startDate" : "05/01/2016, 12:25:01"
          }
        }
      ]
    }
  ]
}

Repeating

Configure the Trigger to run a flow repeating every hours|minutes|seconds. If "notImmediate" set to true, the trigger will not fire immediately. In this case the first execution will occur in 24 hours. If set to false the first execuction will will occur immediately.

{
  "triggers": [
    {
      "name": "tibco-rest",
      "settings": {
        "port": "8080"
      },
      "endpoints": [
        {
          "actionType": "flow",
          "actionURI": "embedded://myflow",
          "settings": {
            "repeating": "true",
            "notImmediate": "true",
            "hours": "24"
          }
        }
      ]
    }
  ]
}

Repeating with start date

Configure the Trigger to run a flow at a certain date/time and repeating every hours|minutes|seconds

{
  "triggers": [
    {
      "name": "tibco-rest",
      "settings": {
        "port": "8080"
      },
      "endpoints": [
        {
          "actionType": "flow",
          "actionURI": "embedded://myflow",
          "settings": {
            "repeating": "true",
            "startDate" : "05/01/2016, 12:25:01",
            "hours": "64"
          }
        }
      ]
    }
  ]
}

Documentation

Index

• func NewFactory(md *trigger.Metadata) trigger.Factory
• type PrintJob
  • func (j *PrintJob) Run() error
• type TimerFactory
  • func (t *TimerFactory) New(config *trigger.Config) trigger.Trigger
• type TimerTrigger
  • func (t *TimerTrigger) Init(runner action.Runner)
  • func (t *TimerTrigger) Metadata() *trigger.Metadata
  • func (t *TimerTrigger) Start() error
  • func (t *TimerTrigger) Stop() error

Functions

func NewFactory

func NewFactory(md *trigger.Metadata) trigger.Factory

NewFactory create a new Trigger factory

Types

type PrintJob

type PrintJob struct {
	Msg string
}

func (*PrintJob) Run

func (j *PrintJob) Run() error

type TimerFactory

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

TimerFactory Timer Trigger factory

func (*TimerFactory) New

func (t *TimerFactory) New(config *trigger.Config) trigger.Trigger

New Creates a new trigger instance for a given id

type TimerTrigger

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

func (*TimerTrigger) Init

func (t *TimerTrigger) Init(runner action.Runner)

Init implements ext.Trigger.Init

func (*TimerTrigger) Metadata

func (t *TimerTrigger) Metadata() *trigger.Metadata

Metadata implements trigger.Trigger.Metadata

func (*TimerTrigger) Start

func (t *TimerTrigger) Start() error

Start implements ext.Trigger.Start

func (*TimerTrigger) Stop

func (t *TimerTrigger) Stop() error

Stop implements ext.Trigger.Stop