sartography
/
spiff-arena
mirror of https://github.com/sartography/spiff-arena.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
spiff-arena/docs/dev/how_to_build_a_connector.md

1.3 KiB
Raw Blame History

How to build a connector

While existing connectors like connector-http are very flexible, you may choose to build a connector for a specific use case.

To get an idea of what you are in for, take a look at existing connectors:

And there are many more connectors.

A connector can implement many commands. Commands are also known as operators in the SpiffWorkflow frontend properties panel user interface. Like the above examples, you will want to inherit from the ConnectorCommand class. You will see that there are two important functions that your command class must implement:

  • __init__
  • run

Code introspection is used based on the implementation of the __init__ method to determine which parameters should be allowed in the properties panel. The run method is where the actual work is done (send HTTP request, etc).

If you end up writing a connector, please consider contributing it back to the community and please consider contributing to this documentation. Thank you!