Connection Module

The Connection Module in Scorport is designed to seamlessly integrate internal and external services into your strategies. It allows you to create connections to APIs, internal Scorport engines, and other data sources, ensuring your strategies are dynamic and versatile. This module also enables strategies to consume and utilize these connections for calculations, decision-making, and outputs.


What Is the Connection Module?

The Connection Module serves as a bridge between your strategies and external or internal systems. It provides tools to:

  • Integrate external APIs or third-party services.
  • Use a Scorport-generated engine as part of another strategy.
  • Define and manage characteristics of connections.
  • Test connections to ensure they function correctly within your workflows.

Connections are fully integrated into the Strategy Designer, where they can be consumed as elements in calculations or displayed in outputs.


Key Features

  1. API Connections:

    • Connect external APIs to bring in real-time data or push calculated results to external systems.
    • Define API characteristics, such as endpoints, request methods, headers, and payload structures.
  2. Engine Connections:

    • Use a Scorport-generated engine as part of a larger strategy.
    • Enable hierarchical strategy workflows where one strategy feeds into another.
  3. Dynamic Characteristics:

    • Define and manage characteristics of each connection within the module.
    • Include parameters like data types, response formats, or custom calculations.
  4. Testing and Validation:

    • Test each connection within the module to verify its accuracy and reliability.
    • Debug and refine connection settings before integrating them into strategies.
  5. Seamless Strategy Integration:

    • Add connection elements to strategies to consume data or provide calculated outputs.
    • Use connection data dynamically in calculations or display it as part of output elements.

How It Works

Step 1: Create a Connection
  • Open the Connection Module from the dashboard.
  • Create a new connection by choosing one of the following types:
    • API: Connect to external services via APIs.
    • Engine: Integrate an internal Scorport engine into another strategy.
Step 2: Define Connection Characteristics
  • Set up characteristics for the connection:
    • For APIs: Configure endpoints, request methods, headers, payloads, and authentication details.
    • For Engines: Specify the input data required and expected output format.
Step 3: Test the Connection
  • Use the Test feature to validate the connection.
  • Ensure data is being sent and received correctly.

Step 4: Save and Use in Strategy

  • Save the connection configuration.
  • Add the connection element to your strategy in the Strategy Designer.

Using Connections in Strategies

  1. Integration in Strategy Designer:

    • Drag and drop the connection element into your strategy workflow.
    • Specify how the connection will be consumed:
      • For Calculations: Use the connection as part of calculations.
      • For Outputs: Include the connection results in output elements.
  2. Dynamic Usage:

    • Connections can serve as:
      • Input elements: Feeding data into calculations or decision logic.
      • Output elements: Displaying results for external consumption.

Example Scenarios

API Connection
  • Use Case: Fetch real-time credit scores from an external service.
  • Setup:
    • Configure the API endpoint and authentication.
    • Map the response data to variables in the strategy.
  • Outcome: The strategy consumes the credit score data dynamically for decision-making.
Engine Connection
  • Use Case: Use an internal engine to process data as part of a larger workflow.
  • Setup:
    • Create a connection to the engine and define its input/output parameters.
    • Map the engine’s outputs to variables in the strategy.
  • Outcome: The engine’s results are integrated seamlessly into the strategy’s calculations.

Benefits of the Connection Module

  1. Flexibility:

    • Connect to any internal or external service, enabling highly dynamic strategies.
  2. Scalability:

    • Use Scorport engines hierarchically, integrating them into larger, more complex workflows.
  3. Accuracy:

    • Test and validate connections before integrating them into strategies.
  4. Efficiency:

    • Use connections to automate data flow, reducing manual intervention.

The Connection Module in Scorport empowers businesses to build robust, interconnected strategies by integrating data and services dynamically.