How to Define the Summary Field in a Pipeline

Defining the summary field in a pipeline allows you to consolidate numeric values from cards into a KPI displayed in the header, making it easier to track important metrics in real time. Follow the steps below to configure it.

1st Step: Accessing the Pipelines Module

In the upper left side menu, click “Pipelines” and open the pipeline you want to adjust.

2nd Step: Opening the Pipeline Settings

1. Click “Module Settings”, represented by the “(...)” icon in the upper right corner.
2. The “Update Pipeline” modal will be displayed, showing options for name, stages, and fields.

3rd Step: Understanding the Summary Field

The Summary Field acts as a real-time aggregator of a numeric custom field across all cards in the pipeline.

• Consolidates values (e.g., revenue or quantities) into a header indicator.
• Supports only numeric fields; other field types are not displayed.
• Updates whenever a card is created, moved, or updated.

4th Step: Configuring the Summary Field in the UI

1. In the “Update Pipeline” modal, open the “Summary Field” dropdown located next to the pipeline name.
2. Select the numeric custom field you want to aggregate (e.g., “Budget”, “Price”).
3. Click “Save” to apply the configuration.

Note:

• If no options are available in the dropdown, first create a Custom Field of type Number or Currency in the “Fields” tab.

5th Step: Verifying the Summary KPI

1. After saving, check the pipeline header: the aggregated value will appear next to the name.
2. Move or update a card with a value in the selected field to see the indicator recalculated.

Best Practices:

• Choose relevant numeric fields for business KPIs such as sales, costs, or hours.
• Test in a staging environment before applying in production to validate aggregation.
• Document the use of the Summary Field in your internal wiki, including its name and purpose.
• Periodically review whether the field still reflects the intended metric.

Conclusion:

You have learned how to define the summary field of a pipeline in octapipe, from configuring it in the interface to verifying the real-time KPI. If you have any questions, contact our support team.