Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

fh-wfm-workflow

0.2.7 • Public • Published

FeedHenry WFM workflow Coverage Status

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

  • Backend services
  • Frontend services

Client-side usage

Topic Subscriptions

wfm:workflows:create

Description

Creating a new Workflow

Example
var parameters = {
  workflowToCreate: {
    //A Valid JSON Object
  },
  //Optional topic unique identifier.
  topicUid: "uniquetopicid"
}
 
mediator.publish("wfm:workflows:create", parameters);

wfm:workflows:read

Description

Read a single Workflow

Example
var parameters = {
  id: "workflowId",
  //Optional topic unique identifier.
  topicUid: "uniquetopicid"
}
 
mediator.publish("wfm:workflows:read", parameters);

wfm:workflows:update

Description

Update a single Workflow

Example
var parameters = {
  workflowToUpdate: {
    ...
    id: "workflowId"
    ...
  },
  //Optional topic unique identifier.
  topicUid: "uniquetopicid"
}
 
mediator.publish("wfm:workflows:update", parameters);

wfm:workflows:remove

Description

Remove a single Workflow

Example
var parameters = {
  id: "workflowId",
  //Optional topic unique identifier.
  topicUid: "uniquetopicid"
}
 
mediator.publish("wfm:workflows:remove", parameters);

wfm:workflows:list

Description

List All Workflows

Example
var parameters = {
  //Optional topic unique identifier.
  topicUid: "uniquetopicid"
}
 
mediator.publish("wfm:workflows:list", parameters);

Published Topics

The following topics are published by this module. Developers are free to implement these topics subscribers, or use a module that already has these subscribers implement (E.g. the raincatcher-sync module).

Topic Description
wfm:sync:workflows:create Create a new item in the sync workflows collection
wfm:sync:workflows:update Update an existing item in the sync workflows collection
wfm:sync:workflows:list List all items in the sync workflows collection
wfm:sync:workflows:remove Remove an existing item from the sync workflows collection
wfm:sync:workflows:read Read a single item from the sync workflows collection
wfm:sync:workflows:start Start the sync process for sync workflows collection
wfm:sync:workflows:stop Stop the sync process for sync workflows collection
wfm:sync:workflows:force_sync Force a sync cycle from client to cloud for sync workflows collection

Topic Subscriptions

Topic Description
done:wfm:sync:workflows:create A workflow was created in the workflows dataset
error:wfm:sync:workflows:create An error occurred when creating an item in the workflows dataset.
done:wfm:sync:workflows:update A workflow was updated in the workflows dataset
error:wfm:sync:workflows:update An error occurred when updating an item in the workflows dataset.
done:wfm:sync:workflows:list A list of the items in the workflows dataset completed
error:wfm:sync:workflows:list An error occurred when listing items in the workflows dataset.
done:wfm:sync:workflows:remove A workflow was removed from the workflows dataset
error:wfm:sync:workflows:remove An error occurred when removing an item in the workflows dataset.
done:wfm:sync:workflows:read A item was read correctly from the workflows dataset
error:wfm:sync:workflows:read An error occurred when reading an item in the workflows dataset.
done:wfm:sync:workflows:start The sync process started for the workflows dataset.
error:wfm:sync:workflows:start An error occurred when starting the workflows dataset.
done:wfm:sync:workflows:stop The sync process stopped for the workflows dataset.
error:wfm:sync:workflows:stop An error occurred when stopping the workflows dataset sync process.
done:wfm:sync:workflows:force_sync A force sync process completed for the workflows dataset.
error:wfm:sync:workflows:force_sync An error occurred when forcing the sync process for the workflows dataset.

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'}
    ]
  }
 

Keywords

Install

npm i fh-wfm-workflow

DownloadsWeekly Downloads

0

Version

0.2.7

License

MIT

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar