JOEY PINTO

Software Engineer

Usage Instructions:

Follow these instructions if you want to annotate your project and import it as a library.

  1. Download the latest stable release with dependencies from https://github.com/pintojoey/workflow_designer/releases
  2. Include the Jar file in your project using Maven, or add it to the classpath
  3. Identify the classes you want to include in the workflow designer and annotate the classes and variables with annotations from the Workflow Designer library.
  4. Export your project as a jar with dependencies, Use Maven-shader plugin if you need extensive environment resource support.
  5. Clone and run the project https://github.com/pintojoey/workflow_designer_server.git
  6. Go to localhost:8680
  7. Upload the Jar files with the package name you want to search for reflections and submit
  8. Right Click on the canvas, a menu popups up with the detected blocks and use them to draw
  9. Join blocks using your pointer
  10. Click on Schedule workflow to run the workflow.

Build from Soure:

Use these instructions to setup the project locally and start contributing.

  1. Clone and build the project https://github.com/pintojoey/workflow_designer.git
  2. Use mvn install to install the workflow_designer (annotations) library to your local maven repository
  3. Clone and build the project https://github.com/pintojoey/workflow_designer_server.git
  4. Configure your settings by copying the config.properties.template into config.properties and add your own settings.
  5. Use mvn package to build the project and mvn jetty:run to start the Jetty server.

OR

Build using Docker

  1. Create a folder by the name “config” and add all configuration files to it. Make sure to include a copy of config.properties into the folder
  2. Get a copy of the Dockerfile in the same location as the config folder
  3. To Build Docker Image:  ‘docker build –no-cache -t workflow_designer/ server .’
  4. The ‘.’ at the end passes the current context to docker and is important to copy config files
  5.  To Run: ‘docker run -ti -p8680:8680  workflow_designer/server’

Running Workflow Examples

  1. Clone and build the project https://github.com/pintojoey/workflow_designer_samples.git
  2. This project has 3 sample projects with the WorkflowDesigner Annotations that you can run on the server.
  3. To run any of these projects, run mvn package on the project you wish to run.
  4. This should create the jar-with-dependencies artefact in the target folder.
  5. The default port for the Jetty server is 8680, open localhost:8680 in a browser.
  6. At the bottom of the screen use the browser button to browse for the jar with dependencies.
  7. In the package text box enter the package to search for annotations.
  8. Click submit.
  9. Once the file is uploaded, use the right mouse click in the canvas region.
  10. The blocks detected from the jar will be available in the menu segregated by family.
  11. Choose a block type to create a block
  12. Draw lines between the output and input parameters of blocks.
  13. Use the first button on the top right to change the property values.
  14. You can also open/save a workflow using the buttons provided.
  15. Once all inputs are configured, Click on Schedule Workflow.
  16. The outputs produced by each block should be available on the block itself.