Skip to content

Fix ROI reporting docs: table names, file structure, and commands#435

Merged
toru-takahashi merged 3 commits into
treasure-data:masterfrom
ko47kmr:fix/roi-reporting-docs-update
Apr 13, 2026
Merged

Fix ROI reporting docs: table names, file structure, and commands#435
toru-takahashi merged 3 commits into
treasure-data:masterfrom
ko47kmr:fix/roi-reporting-docs-update

Conversation

@ko47kmr
Copy link
Copy Markdown
Contributor

@ko47kmr ko47kmr commented Apr 13, 2026

Summary

  • Fix table name inconsistencies across documentation: revenuerevenue_table, event_masterevents_master (matching actual table names created by the workflow)
  • Update project structure in top-level README to match actual file layout (old references to system_prompt.md, tools.yml, forms/ replaced with current Dashboard Viz/, knowledge_bases/, form_interfaces/)
  • Fix tdx agent push flag: -y-f (correct flag per CLI help)
  • Update workflow README: td workflow pushtdx wf push, add tdx.json creation step, add concrete tdx wf secrets set command
  • Clarify revenue_table setup: sample data generation is for testing only; production use requires user-provided actual conversion/revenue data
  • Allow independent setup of agent and workflow components (agent can be deployed without running the workflow if tables already exist)
  • Remove internal references not appropriate for external users
  • Fix event_masterevents_master in Japanese Knowledge Base specs

Files Changed

File Changes
roi_reporting/README.md Table names, file structure, setup steps, troubleshooting
agent/README.md -y-f (2 places)
agent/README_JA.md -y-f (2 places)
agent/knowledge_bases/OverallSummary_Spec_ja.md event_masterevents_master (3 places)
agent/knowledge_bases/CampaignDetails_Spec_ja.md event_masterevents_master (1 place)
workflows/reporting_agent/README.md CLI commands, tdx.json step, revenue table docs, remove internal ref

Test plan

  • Verify tdx agent push . -f works with updated README instructions
  • Verify all table names in docs match config.yaml definitions (events_master, revenue_table, daily_summary, email_events)
  • Verify project structure in README matches actual file listing

🤖 Generated with Claude Code

…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>
@ko47kmr ko47kmr requested a review from a team as a code owner April 13, 2026 10:02
Copilot AI review requested due to automatic review settings April 13, 2026 10:02
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_masterevents_master.
engage-box/roi_reporting/agent/knowledge_bases/CampaignDetails_Spec_ja.md Updates table reference event_masterevents_master.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread engage-box/roi_reporting/README.md Outdated
│ └── Campaign Details.yml
└── workflows/ # Data Preparation Workflows
└── reporting_agent/
├── tdx.json # Workflow project reference
Copy link

Copilot AI Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
├── tdx.json # Workflow project reference
├── tdx.json # User-created local workflow project file (not committed)

Copilot uses AI. Check for mistakes.
Comment on lines 116 to +119
| `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 |
Copy link

Copilot AI Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Kona (Koshi Nakamura) and others added 2 commits April 13, 2026 20:59
- 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>
@toru-takahashi toru-takahashi merged commit 716d609 into treasure-data:master Apr 13, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants