Fix ROI reporting docs: table names, file structure, and commands#435
Conversation
…ands - Fix table name inconsistencies: revenue → revenue_table, event_master → events_master - Update project structure in top-level README to match actual file layout - Replace obsolete file references (system_prompt.md, tools.yml, forms/) with current structure (Dashboard Viz/, knowledge_bases/, form_interfaces/) - Fix tdx agent push flag: -y → -f (correct flag) - Update workflow README: td workflow push → tdx wf push, add tdx.json step - Clarify revenue_table setup: sample data is for testing only, production requires user-provided actual conversion/revenue data - Allow independent setup of agent and workflow components - Remove internal references (PS team, development status) - Fix event_master → events_master in Japanese KB specs (OverallSummary, CampaignDetails) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the ROI reporting documentation to match the current workflow/agent setup, table names, CLI commands, and repository file layout, removing internal-only references and clarifying how revenue data should be handled.
Changes:
- Standardize documented table names to match the workflow outputs (e.g.,
revenue_table,events_master). - Update setup instructions/CLI commands (e.g.,
tdx agent push ... -f,tdx wf push, workflow secret-setting guidance). - Refresh README project structure and clarify that workflow and agent setup can be done independently.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
engage-box/roi_reporting/workflows/reporting_agent/README.md |
Updates workflow setup steps/commands, adds tdx.json creation guidance, clarifies sample revenue behavior, removes internal note. |
engage-box/roi_reporting/README.md |
Aligns table names and project structure docs; clarifies independent setup paths. |
engage-box/roi_reporting/agent/README.md |
Fixes tdx agent push flag usage (-y → -f). |
engage-box/roi_reporting/agent/README_JA.md |
Same tdx agent push flag fix for Japanese README. |
engage-box/roi_reporting/agent/knowledge_bases/OverallSummary_Spec_ja.md |
Updates table reference event_master → events_master. |
engage-box/roi_reporting/agent/knowledge_bases/CampaignDetails_Spec_ja.md |
Updates table reference event_master → events_master. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| │ └── Campaign Details.yml | ||
| └── workflows/ # Data Preparation Workflows | ||
| └── reporting_agent/ | ||
| ├── tdx.json # Workflow project reference |
There was a problem hiding this comment.
The project structure tree lists workflows/reporting_agent/tdx.json, but that file is not present in the repository. Either add/commit the workflow tdx.json, or update this tree to indicate it’s user-created (as described in workflows/reporting_agent/README.md) rather than part of the checked-in layout.
| ├── tdx.json # Workflow project reference | |
| ├── tdx.json # User-created local workflow project file (not committed) |
| | `daily_summary` | Daily aggregated performance metrics | Workflow | | ||
| | `email_events` | Email event logs (deduplicated) | Workflow | | ||
| | `revenue` | Revenue attribution data | Workflow | | ||
| | `event_master` | Campaign/journey metadata | Workflow | | ||
| | `revenue_table` | Revenue attribution data | Workflow (sample) or user-provided | | ||
| | `events_master` | Campaign/journey metadata | Workflow | |
There was a problem hiding this comment.
This section says the tables are “to be created by the workflow”, but the revenue_table row indicates it may be user-provided. Consider rewording to “tables required to exist” (and then specify which ones the workflow creates vs. must be provided) to avoid a contradiction.
- Clarify tdx.json is user-created and not committed to repo - Fix contradictory table section heading to not imply all tables are workflow-created Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Summary
revenue→revenue_table,event_master→events_master(matching actual table names created by the workflow)system_prompt.md,tools.yml,forms/replaced with currentDashboard Viz/,knowledge_bases/,form_interfaces/)tdx agent pushflag:-y→-f(correct flag per CLI help)td workflow push→tdx wf push, addtdx.jsoncreation step, add concretetdx wf secrets setcommandrevenue_tablesetup: sample data generation is for testing only; production use requires user-provided actual conversion/revenue dataevent_master→events_masterin Japanese Knowledge Base specsFiles Changed
roi_reporting/README.mdagent/README.md-y→-f(2 places)agent/README_JA.md-y→-f(2 places)agent/knowledge_bases/OverallSummary_Spec_ja.mdevent_master→events_master(3 places)agent/knowledge_bases/CampaignDetails_Spec_ja.mdevent_master→events_master(1 place)workflows/reporting_agent/README.mdTest plan
tdx agent push . -fworks with updated README instructionsconfig.yamldefinitions (events_master,revenue_table,daily_summary,email_events)🤖 Generated with Claude Code