prooph/link-processor-proxy

Processor proxy for prooph LINK

v0.2.0 2015-05-10 13:24 UTC

This package is auto-updated.

Last update: 2021-09-16 19:38:29 UTC


README

Processor proxy for prooph LINK

HTTP Process Trigger

The processor proxy module offers a way to start a process via http request.

Collect Data Trigger

To use this endpoint the process should be startable via a collect-data workflow message. What you need to do is send a POST request to the prooph.link/processor_proxy/api/collect_data_triggers route defined in your prooph LINK application. By default this route name resolves to the URI /prooph/link/processor-proxy/api/collect-data-triggers.

Request

The POST request should have a JSON body containing following structure:

{
  "collect_data_trigger" : {
    "processing_type" : "Processing\Type\Type"
  }
}

As you can see the root key "collect_data_trigger" contains only a "processing_type" definition. The type should point to the Processing\Type\Type implementation that should be collected by the first task of the process.

Response

The service respond with a status code 201 and without a body. Instead the header includes a Location pointing to a message information service with the UUID of the generated workflow message. The message information service provides detailed information about the status of the message, the triggered process and potentially occurred errors.

Message Service

GET Message

  • GET /prooph/link/processor-proxy/api/messages[/:id] (route: prooph.link/processor_proxy/api/messages)

Get information about the message identified by its UUID.

Messagebox

  • POST /prooph/link/processor-proxy/api/messages (route: prooph.link/processor_proxy/api/messages)

The message service provides the possibility to receive a service bus message which is then passed to the workflow engine. The endpoint is mostly used when a sub process or workflow message handler should be triggered via http. In this case the main workflow processor can send a workflow message via the psb-http-dispatcher to this endpoint.

Support

Contribution

You wanna help us? Great! We appreciate any help, be it on implementation level, UI improvements, testing, donation or simply trying out the system and give us feedback. Just leave us a note in our google group linked above and we can discuss further steps.

Thanks, your prooph team