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.

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.

• Creating a Script
  • Example Script
    • Goal
    • Setup
    • Example
    • Explanation
    • Next
  • Example Workflow
  • Running Workflow
• Building a Service
  • Tutorial Service
  • Modify Script
• Adding an API Endpoint
  • Define API Endpoint
    • Definition
    • Schema
    • Python Code
  • Get Cards
    • get_cards
  • Endpoints
• Exceptions and Error Handling
  • ApiError
    • Definition
    • Usage
  • Helper Methods
    • from_task
    • from_task_spec
  • Example Usage
    • Using from_task
    • Call ApiError directly
  • ApiErrorSchema
  • Unhandled Exceptions
  • More
• Writing Tests
  • Layout
  • Examples
    • Hello World
    • Test a Script
    • Email Script
    • Calling the API
    • Mocking Data
• Data Models
  • SQL Alchemy
    • Setup
    • Example
    • Usage
  • Serialization
  • Migrations
    • Layout
    • Revisions
    • Migrations