Git Product home page Git Product logo

raincatcher-workflow's Introduction

FeedHenry WFM workflow

This module contains a workflow model representation and its related services :

  • Backend services
  • Frontend services
  • Frontend UI templates

Client-side usage

Client-side usage (via broswerify)

Setup

This module is packaged in a CommonJS format, exporting the name of the Angular namespace. The module can be included in an angular.js as follows:

angular.module('app', [
, require('fh-wfm-workflow')
...
])

Integration

Angular controller

A sync manager must first be initialized using the workflowSync.createManager(). This can be placed, for instance, in the resolve config of a ui-router controlled application.

resolve: {
  workflowManager: function(workflowSync) {
    return workflowSync.createManager();
  }
}

For a more complete example, please check the demo portal app.

workflowSync API

These workflowSync API methods all return Promises:

workflowSync method Description
workflowSync.manager.list list all workflows
workflowSync.manager.create(workflow) create a workflow
workflowSync.manager.read(workflowId) read a workflow
workflowSync.manager.update(workflow) update a workflow

workflow directives

Name Attributes
workflow-progress stepIndex, workflow
workflow-step step, workflow
workflow-result workflow, result
workflow-form value
workflow-step-form workflow, step, forms
workflow-step-detail step

Usage in an express backend

Setup

The server-side component of this WFM module exports a function that takes express and mediator instances as parameters, as in:

var express = require('express')
  , app = express()
  , mbaasExpress = mbaasApi.mbaasExpress()
  , mediator = require('fh-wfm-mediator/lib/mediator')
  ;

// configure the express app
...

// setup the wfm workflow sync server
require('fh-wfm-workflow/server')(mediator, app, mbaasExpress);

Server side events

the module broadcasts, and listens for the following events

Listens for Responds with
wfm:workflow:list done:wfm:workflow:list
wfm:workflow:read done:wfm:workflow:read
wfm:workflow:update done:wfm:workflow:update
wfm:workflow:create done:wfm:workflow:create

Integration

Check this demo cloud application

workflow data structure example

  {
    id: 1338,
    title: 'App forms',
    steps: [
      {code: 'identification', name: 'Identification', formId: '56c1fce7c0a909d74e823317'},
      {code: 'signoff', name: 'Signoff', formId: '56bdf252206b0cba6f35837b'}
    ]
  }

raincatcher-workflow's People

Contributors

andresgalante avatar bleathem avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.