2021-05-10 17:38:15 +00:00
|
|
|
.. _index-cr-connect-workflow:
|
|
|
|
|
|
|
|
|
|
===================
|
|
|
|
|
CR Connect Workflow
|
|
|
|
|
===================
|
|
|
|
|
|
|
|
|
|
CR-Connect-Workflow is the backend for CR-Connect.
|
|
|
|
|
|
|
|
|
|
It has an `API` that takes requests from the front end,
|
|
|
|
|
and returns JSON responses.
|
|
|
|
|
|
|
|
|
|
There are SQLAlchemy database `models` for data persistence. We use a Postgres database.
|
|
|
|
|
|
|
|
|
|
It has `services` that offload most of the work for the API. These services can make calls to other services,
|
|
|
|
|
to SpiffWorkflow--our workflow engine, or to external data sources.
|
|
|
|
|
|
|
|
|
|
There are `scripts` which can be called from workflows. These scripts can call services or run standard Python.
|
|
|
|
|
They are a primary way of extending workflow capabilities.
|
|
|
|
|
|
2021-05-11 14:38:23 +00:00
|
|
|
.. image:: /_static/cr_connect_workflow.png
|
|
|
|
|
|
2021-05-10 20:10:57 +00:00
|
|
|
We will take a simple example of calling an external data source,
|
|
|
|
|
and use it to learn about the different parts of the CR Connect Workflow code base.
|
|
|
|
|
|
2021-05-10 17:38:15 +00:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
01_scripts
|
|
|
|
|
02_services
|
|
|
|
|
03_api
|
|
|
|
|
|
