Create system_overview.md

websites/docs/src/content/docs/en/getting_started/system_overview.md

@@ -0,0 +1,105 @@
+# System Overview
+
+
+Ballerine is a risk management platform for performing all types of risk flows and processes. To do so, Ballerine provides the risk modules needed to build custom risk flows. You can use all modules, combinations of some modules, or just one module to perform a desired risk process.
+
+For example: 
+- **Build a full KYB flow** using data collection flow, 3rd party vendors, risk rules, and the case management. 
+- **Build a simple KYC** using 3rd party vendors, risk rules, and the case management. 
+- **Build a simple digital form** using data collection flow. 
+- **Manually review documents** using the case management.
+-  Etc.
+
+### Example flow using Ballerine's modules
+
+<img title="Example workflow" alt="Example workflow" src="https://uploads-ssl.webflow.com/62a3bad46800eb4715b2faf1/669ea9cfe853bf03be6dcbc3_Workflow%20example.png">
+
+
+
+## Workflows
+A workflow is the engine that orchestrates the different steps of a risk flow, and how they should interact with each other.
+Every workflow is a definition of a flow, made out of Ballerine's different modules.
+Whenever a risk flow ("Customer Onboarding" for example) starts, the workflow that is assigned to that risk flow initiates and controls which module should be in use and when.
+
+**Learn more about workflows**
+
+ [Understanding workflows technology](websites/docs/src/content/docs/en/learn/workflows_technology.md)
+
+ [Creating a workflow](websites/docs/src/content/docs/en/learn/creating_a_workflow.md)
+
+ [Configuring a workflow](websites/docs/src/content/docs/en/learn/configuring_a_workflow.md)
+
+ [Invoking a workflow / creating a case](websites/docs/src/content/docs/en/learn/invoking_a_workflow.md)
+
+
+## Collection Flows
+Ballerine's collection flow module enables you to collect information and documents from you end users, using customizable, white-label digital forms.
+All of the steps and inputs are fully customizable, to enable building different types of flows.
+
+**Learn more about collection flows**
+
+[Creating a collection flow](websites/docs/src/content/docs/en/learn/creating_a_collection_flow)
+
+[Configuring a collection flow](websites/docs/src/content/docs/en/learn/configuring_a_collection_flow.md)
+
+[Changing the collection flow design](websites/docs/src/content/docs/en/learn/changing_the_collection_flow_design.md)
+
+
+<img title="Collection Flow" alt="Collection Flow" src="https://uploads-ssl.webflow.com/62a3bad46800eb4715b2faf1/669eacfd54f5c71e9c9edb85_Collection%20flow%20example.png">
+
+
+
+
+## Rules Engine
+The Rules Engine applies risk rules to assign risk scores, present risk indicators, and automate decisions within workflows. It encompasses transition rules, risk calculation, and alerting mechanisms.
+
+**Learn more about the rule engine**
+
+[Making a rule affect a workflow state](websites/docs/src/content/docs/en/learn/adding_rules_and_affect_workflows.md)
+[Calculation Risk Scores](websites/docs/src/content/docs/en/learn/calculating_risk_scores.md)
+
+## Case Managment
+The Case Management module provides a user interface for manual decision-making processes, such as approving, rejecting, or requesting re-submission of cases. It offers customizable layouts and information presentation, allowing users to efficiently handle and review cases. 
+
+**Learn more about case management**
+
+[Overview of case management](websites/docs/src/content/docs/en/learn/case_management_overview.md) 
+
+[Using the case management dashboard](websites/docs/src/content/docs/en/learn/using_the_case_management_dashboard.md) 
+
+[Add and Customize Workflows in the Case Management](websites/docs/src/content/docs/en/learn/add_and_customize_workflows_in_the_case_management.md)
+
+
+<img title="Case Management" alt="Case Management" src="https://uploads-ssl.webflow.com/62a3bad46800eb4715b2faf1/669eb373c7708310d2b4ac61_Case%20managment%20example.png">
+
+## Unified API
+
+Ballerine's unified API is integrated with third-party vendors, APIs, and data sources to enhance functionality and capabilities.
+
+**Learn more about the unified API**
+
+[Adding a 3rd Party check to a workflow]() 
+
+## Child Workflows
+Child workflows allow for the generation and activation of extra side workflows (for example: generating multiple KYC flows for the UBOs provided mid-flow, or an extra KYB process for a parent company) and enable complex, nested processes within the main workflows.
+
+**Learn more about child workflows**
+
+[Adding a child workflow to your workflow](websites/docs/src/content/docs/en/learn/adding_a_3rd_party_check_to_a_workflow.md)
+
+## Plugins
+
+Ballerine's plugins enables deep integration with your existing systems, allowing for functionalities such as triggering flows through your CRM, integrating with pre-existing vendors, and displaying their information within Ballerine's platform.
+
+**Learn more about plugins**
+
+[Using Plugins](websites/docs/src/content/docs/en/learn/plugins.mdx) 
+
+
+## Webhooks
+Webhooks in Ballerine allow for real-time communication and integration with external systems. They enable the system to send automated messages or information to other systems as events occur within Ballerine.
+
+**Learn more about webhooks**
+
+[Using webhooks](websites/docs/src/content/docs/en/learn/how_to_use_webhooks.md)  
+

websites/docs/src/content/docs/en/learn/add_and_customize_workflows_in_the_case_management.md

@@ -0,0 +1,273 @@
+# Add and Customize Workflows in the Case Management
+
+## Customizing case management workflows
+
+To customize your case management to show your various workflows, add filters.
+Filters render your different workflows as case queues you can access via the case management
+
+### Adding Filters
+
+To create a new filter (essentially a queue in the case management system), you can use the API endpoint.
+
+```POST /api/v1/workflow-definition/{id}/copy```
+
+This will return a list of existing filters, which you can use as a reference for creating new ones.
+
+### Create a New Filter
+
+To create a new filter, make a POST request to the following endpoint:
+
+```POST /api/v1/external/filters```
+
+**Request Body:**
+
+You will typically need to adjust fields such as workflowDefinitionId, entity, and other relevant parameters. Below is an example request body for creating a new filter:
+
+```
+{
+  "name": "Till Businesses Onboarding Basic Demo (US)",
+  "entity": "businesses",
+  "query": {
+    "where": {
+      "businessId": {
+        "not": null
+      },
+      "workflowDefinitionId": {
+        "in": [
+          "clyxemn21000bru85vr9f0b5f"
+        ]
+      }
+    },
+    "select": {
+      "id": true,
+      "tags": true,
+      "state": true,
+      "status": true,
+      "context": true,
+      "assignee": {
+        "select": {
+          "id": true,
+          "lastName": true,
+          "avatarUrl": true,
+          "firstName": true
+        }
+      },
+      "business": {
+        "select": {
+          "id": true,
+          "email": true,
+          "address": true,
+          "website": true,
+          "industry": true,
+          "createdAt": true,
+          "documents": true,
+          "legalForm": true,
+          "updatedAt": true,
+          "vatNumber": true,
+          "companyName": true,
+          "phoneNumber": true,
+          "approvalState": true,
+          "businessPurpose": true,
+          "numberOfEmployees": true,
+          "registrationNumber": true,
+          "dateOfIncorporation": true,
+          "shareholderStructure": true,
+          "countryOfIncorporation": true,
+          "taxIdentificationNumber": true
+        }
+      },
+      "createdAt": true,
+      "assigneeId": true,
+      "workflowDefinition": {
+        "select": {
+          "id": true,
+          "name": true,
+          "config": true,
+          "version": true,
+          "definition": true,
+          "contextSchema": true,
+          "documentsSchema": true
+        }
+      },
+      "childWorkflowsRuntimeData": true
+    }
+  },
+  "projectId": "till_default"
+}
+
+```
+
+
+
+<img title="Case Management" alt="Case Management" src="https://uploads-ssl.webflow.com/62a3bad46800eb4715b2faf1/669ed579568cee8d639bcaf1_filters_api.gif">
+
+### Customizing a case’s initial attributes
+
+You can customize the "Create Case" form in the Case Management application by modifying the workflow definition. Follow these steps to tailor the input fields for your case creation:
+
+1. **Navigate to the Dashboard:**
+Go to the **"Workflow Definitions"** tab in the dashboard.
+2. **Inspect and Edit a Workflow:**
+Select the workflow you want to customize and click on it to inspect its details. Click the "Edit" button next to the "Definition" JSON.
+3. **Modify the Initial State:**
+Within the workflow definition, the initial state will contain the schema for the workflow invocation form. Edit this schema to specify the fields and data required for the form.
+
+> ### Example Schema:
+> Here is an example of a workflow definition's initial state that includes a schema for an email input field:
+>     
+>     
+> The provided JSON configuration for the "Create Case" form is composed of two main parts: `uiSchema` and `dataSchema`. These components define both the user interface layout and the data structure requirements for initiating a workflow. Here's a detailed explanation of the structure:
+> 
+> **`meta` Object**
+> 
+> The `meta` object encapsulates the entire configuration, containing both `uiSchema` and `dataSchema`.
+> 
+> **`inputSchema` Object**
+> 
+> Within the `meta` object, the `inputSchema` object contains two key sub-objects: `uiSchema` and `dataSchema`.
+> 
+> **`uiSchema`**
+> 
+> The `uiSchema` defines how the form fields should be presented to the user. It specifies titles, labels, visibility, and the order of fields.
+> 
+> - **Field Titles and Labels:** Customize how each field is labeled in the UI.
+>     - Example: `"ui:title": "Entity ID (As represented in your system)"` sets the display title for the `id` field.
+> - **Field Visibility:** Control whether a field is shown or hidden.
+>     - Example: `"hidden": true` hides the `type` field.
+> - **Field Order:** Specify the order in which fields should appear.
+>     - Example: `"ui:order": ["email", "firstName", "lastName"]` defines the display order of the nested fields within `mainRepresentative`.
+> 
+> **Structure Example:**
+> 
+```json
+"uiSchema": {
+  "id": {
+    "ui:title": "Entity ID (As represented in your system)"
+  },
+  "data": {
+    "ui:label": false,
+    "companyName": {
+      "ui:title": "Company Name"
+    },
+    "companyType": {
+      "ui:title": "Company Type"
+    },
+    "additionalInfo": {
+      "ui:label": false,
+      "mainRepresentative": {
+        "email": {
+          "ui:title": "Email"
+        },
+        "lastName": {
+          "ui:title": "Last Name"
+        },
+        "ui:label": false,
+        "ui:order": [
+          "email",
+          "firstName",
+          "lastName"
+        ],
+        "firstName": {
+          "ui:title": "First Name"
+        }
+      }
+    }
+  },
+  "type": {
+    "hidden": true
+  }
+}
+
+```
+> 
+> **`dataSchema`**
+> 
+> The `dataSchema` defines the structure of the data, including types, required fields, and nested properties.
+> 
+> - **Data Types:** Specify the type for each field (e.g., `string`, `object`).
+>     - Example: `"type": "string"` defines the `id` field as a string.
+> - **Required Fields:** Indicate which fields are mandatory.
+>     - Example: `"required": ["id", "type", "data"]` makes `id`, `type`, and `data` required fields.
+> - **Nested Properties:** Define the structure of nested objects.
+>     - Example: `data` is an object containing further nested objects like `additionalInfo` and `mainRepresentative`.
+> 
+> **Structure Example:**
+
+```
+"dataSchema": {
+  "type": "object",
+  "required": [
+    "id",
+    "type",
+    "data"
+  ],
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "data": {
+      "type": "object",
+      "required": [
+        "companyName",
+        "additionalInfo"
+      ],
+      "properties": {
+        "companyName": {
+          "type": "string"
+        },
+        "companyType": {
+          "type": "string"
+        },
+        "additionalInfo": {
+          "type": "object",
+          "required": [
+            "mainRepresentative"
+          ],
+          "properties": {
+            "mainRepresentative": {
+              "type": "object",
+              "required": [
+                "firstName",
+                "lastName",
+                "email"
+              ],
+              "properties": {
+                "email": {
+                  "type": "string",
+                  "format": "email"
+                },
+                "lastName": {
+                  "type": "string"
+                },
+                "firstName": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "type": {
+      "type": "string",
+      "default": "business"
+    }
+  }
+}
+
+```
+
+### Putting It All Together
+
+The complete configuration uses `uiSchema` to define how the form fields should appear and `dataSchema` to define the underlying data structure and validation requirements. This ensures that the "Create Case" form is both user-friendly and captures all necessary information accurately.
+
+By customizing these schemas, you can control both the presentation and the structure of the data for workflow initiation, ensuring that your workflows have the correct context and data right from the start.
+
+5. **Form Rendering:**
+When the "Create Case" form is rendered in the Case Management application, it will display the input fields based on this schema. The data entered in these fields will then be used as the context for the workflow.
+6. **Example Use Case:**
+For a workflow that starts with some form of communication to an end user, such as sending an email, ensure that the initial state schema includes an email field. This allows the workflow to gather the necessary email address at the point of invocation.
+
+By following these steps, you can ensure that the "Create Case" form in the Case Management application is customized to capture all the necessary information for your workflows, ensuring smooth and accurate data flow into the workflow context.
+
+<img title="Case Management" alt="Case Management" src="https://uploads-ssl.webflow.com/62a3bad46800eb4715b2faf1/669edf5ca06dd3edff5a19b7_Jul-23-2024%2000-23-34.gif">

websites/docs/src/content/docs/en/learn/adding_a_3rd_party_check_to_a_workflow.md

@@ -0,0 +1,3 @@
+# Adding a 3rd Party check to a workflow
+
+To add a 3rd party check using Ballerine's unified API, please contact Ballerine at [email protected].

websites/docs/src/content/docs/en/learn/adding_a_child_workflow_to_your_workflow.md

@@ -0,0 +1 @@
+# Adding a child workflow to your workflow

websites/docs/src/content/docs/en/learn/adding_a_plugin_to_your_workflow.md

@@ -0,0 +1 @@
+# Adding a plugin to your workflow

websites/docs/src/content/docs/en/learn/adding_or_configuring_a_rule.md

@@ -0,0 +1 @@
+# Adding/configuring a rule