Skip to content

Commit 553010b

Browse files
reshmabidikarreshmabidikar
committed
Delete src/main/resources/README and update reports/README with accurate list of reports
1 parent 5ec323a commit 553010b

7 files changed

Lines changed: 44 additions & 40 deletions

File tree

‎reports/README.md‎

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ This script installs all necessary database DDLs and creates KillBill analytics
1212
- [Environment Variables](#environment-variables)
1313
- [Script Behavior](#script-behavior)
1414
- [Examples](#examples)
15-
- [License](#license)
15+
- [Reports List](#reports_list)
16+
1617

1718
---
1819

@@ -126,8 +127,39 @@ export MYSQL_PASSWORD=mysecret
126127
./setup_reports.sh
127128
```
128129

129-
---
130-
131-
## License
130+
## Reports List
131+
132+
The script creates the following reports:
133+
134+
|Report Name| Underlying Report Table |Report Description|
135+
|--|---------------------------------------|--|
136+
| [accounts_summary](accounts_summary/README.md) | report_accounts_summary |Provides an account summary. Provides details like account balance, account status, currency, etc.|
137+
| [active_by_product_term_monthly](active_by_product_term_monthly/README.md) | report_active_by_product_term_monthly |Compute (at the end of each month) the total number of active subscriptions per product and billing period.|
138+
| [bundles_summary](bundles_summary/README.md) | report_bundles_summary |Provides a subscription bundle summary. Provides details like CTD, plan name, price, for the base subscription in a bundle.|
139+
| [cancellations_daily](cancellations_daily/README.md) | report_cancellations_daily |Compute the total number of cancellations per day per phase.|
140+
| [chargebacks_daily](chargebacks_daily/README.md) | report_chargebacks_daily |Compute the total value (in the reference currency) of chargebacks per day per currency.|
141+
| [conversion-total-dollar-amount](conversion-total-dollar-amount/README.md) | report_conversion-total-dollar-amount |Compute (monthly) the total revenue from subscriptions converting out of trial, grouped by tenant and billing period.|
142+
| [invoice_aging](invoice_aging/README.md) | report_invoice_aging |This report lists all customer invoice aging with remaining balances, breaking them into standard aging buckets and converting amounts to USD for easy comparison.|
143+
| [invoice_aging_no_payment](invoice_aging_no_payment/README.md) | report_invoice_aging_no_payment |This report lists all customer invoices with no payments recorded, categorizing outstanding amounts into standard aging buckets and converting balances into USD for comparison.
144+
|
145+
| [invoice_credits_daily](invoice_credits_daily/README.md) | report_invoice_credits_daily |Total of invoice credits per tenant, per currency and per day.|
146+
| [invoice_credits_monthly](invoice_credits_monthly/README.md) | report_invoice_credits_monthly |Report of all invoice credits from the previous month, showing amounts in both original currency and USD equivalents.|
147+
| [invoice_item_adjustments_daily](invoice_item_adjustments_daily/README.md) | report_invoice_item_adjustments_daily |Total of invoice item adjustments per tenant, per currency and per day.|
148+
| [invoice_item_adjustments_monthly](invoice_item_adjustments_monthly/README.md) | report_invoice_item_adjustments_monthly |Report of all invoice item adjustments from the previous month, showing amounts in both original currency and USD equivalents.|
149+
| [invoice_items_monthly](invoice_items_monthly/README.md) | report_invoice_items_monthly |Report of all invoice items from the previous month, showing amounts in both original currency and USD equivalents.|
150+
| [invoices_balance_daily](invoices_balance_daily/README.md) | report_invoices_balance_daily |Compute the total sum of invoices balance (in the reference currency) per invoice created day.
151+
|
152+
| [invoices_daily](invoices_daily/README.md) | report_invoices_daily |Compute the total invoice amount charged (in the reference currency) per day per currency.|
153+
| [invoices_monthly](invoices_monthly/README.md) | report_invoices_monthly |Report of all invoices from the previous month, showing amounts in both original currency and USD equivalents.|
154+
| [mrr_daily](mrr_daily/README.md) | report_mrr_daily |Computes the total active MRR (monthly recurring revenue), broken down both by product and as a tenant-wide total (ALL) for each tenant and each day.|
155+
| [new_accounts_daily](new_accounts_daily/README.md) | report_new_accounts_daily |Compute the total amount of new accounts created per day for each tenant.|
156+
| [overdue-states-count-daily](overdue-states-count-daily/README.md) | report_overdue-states-count-daily |Count of overdue states per tenant and per day.|
157+
| [payments_monthly](payments_monthly/README.md) | report_payments_monthly |Report of all payments from the previous month, showing amounts in both original currency and USD equivalents.|
158+
| [payments_summary](payments_summary/README.md) | report_payments_summary |Provides payment summary. Provides details like payment_id, amount, etc.|
159+
| [payments_total_daily](payments_total_daily/README.md) | report_payments_total_daily |Compute the total value (in the reference currency) of payments per day per currency.|
160+
| [refunds-monthly](refunds-monthly/README.md) | report_refunds-monthly |Report of all refunds from the previous month, showing amounts in both original currency and USD equivalents.|
161+
| [refunds_total_daily](refunds_total_daily/README.md) | report_refunds_total_daily |Compute the total value (in the reference currency) of refunds per day per currency for each tenant.|
162+
| [subscribers-vs-non-subscribers](subscribers-vs-non-subscribers/README.md) | report_subscribers-vs-non-subscribers |Compute the total number of active (i.e. with at least one active subscription) and non-active accounts per tenant.|
163+
| [trial-starts-count-daily](trial-starts-count-daily/README.md) | report_trial-starts-count-daily |Count of new trial subscriptions per tenant, per day and per product.|
164+
| [trial-to-no-trial-conversions_daily](trial-to-no-trial-conversions_daily/README.md) | report_trial-to-no-trial-conversions_daily |Count of subscriptions converting from trial to non-trial per tenant per day.|
132165

133-
This script is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).

reports/mrr/README.md renamed to reports/mrr_daily/README.md

File renamed without changes.

reports/mrr/daily-mrr.png renamed to reports/mrr_daily/daily-mrr.png

File renamed without changes.

reports/mrr/report_mrr_daily.ddl renamed to reports/mrr_daily/report_mrr_daily.ddl

File renamed without changes.

reports/mrr/v_report_mrr_daily.ddl renamed to reports/mrr_daily/v_report_mrr_daily.ddl

File renamed without changes.

‎reports/reports_setup.sh‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -111,22 +111,22 @@ fi
111111
# Create all Killbill reports
112112
create_all_reports() {
113113
declare -a reports=(
114-
"report_accounts_summary|Account Summary|TABLE|report_accounts_summary|refresh_report_accounts_summary"
114+
"accounts_summary|Account Summary|TABLE|report_accounts_summary|refresh_report_accounts_summary"
115115
"active_by_product_term_monthly|Active Subscriptions|TIMELINE|report_active_by_product_term_monthly|refresh_report_active_by_product_term_monthly"
116-
"report_bundles_summary|Bundles Summary|TABLE|report_bundles_summary|refresh_report_bundles_summary"
117-
"cancellations_count_daily|Cancellations Daily|TIMELINE|report_cancellations_daily|refresh_report_cancellations_daily"
116+
"bundles_summary|Bundles Summary|TABLE|report_bundles_summary|refresh_report_bundles_summary"
117+
"cancellations_daily|Cancellations Daily|TIMELINE|report_cancellations_daily|refresh_report_cancellations_daily"
118118
"chargebacks_daily|Chargebacks Daily|TIMELINE|report_chargebacks_daily|refresh_report_chargebacks_daily"
119-
"conversions_daily|Conversions Daily|TIMELINE|report_conversions_daily|refresh_report_conversions_daily"
119+
"conversion-total-dollar-amount|Conversions Daily|TIMELINE|report_conversions_daily|refresh_report_conversions_daily"
120120
"invoice_aging|Invoice Aging|TABLE|report_invoice_aging|refresh_report_invoice_aging"
121-
"invoice_aging_no_pmt|Invoice Aging No Payments|TABLE|report_invoice_aging_no_payment|refresh_report_invoice_aging_no_payment"
121+
"invoice_aging_no_payments_monthly|Invoice Aging No Payments|TABLE|report_invoice_aging_no_payment|refresh_report_invoice_aging_no_payment"
122122
"invoice_credits_daily|Invoice Credits Daily|TIMELINE|report_invoice_credits_daily|refresh_report_invoice_credits_daily"
123-
"invoice_credits_Monthly|Invoice Credits Monthly|TABLE|report_invoice_credits_monthly|refresh_report_invoice_credits_monthly"
123+
"invoice_credits_monthly|Invoice Credits Monthly|TABLE|report_invoice_credits_monthly|refresh_report_invoice_credits_monthly"
124124
"invoice_item_adjustments_daily|Invoice Item Adjustments Daily|TIMELINE|report_invoice_item_adjustments_daily|refresh_report_invoice_item_adjustments_daily"
125125
"invoice_item_adjustments_monthly|Invoice Item Adjustments Monthly|TABLE|report_invoice_item_adjustments_monthly|refresh_report_invoice_item_adjustments_monthly"
126126
"invoice_items_monthly|Invoice Items Monthly|TABLE|report_invoice_items_monthly|refresh_report_invoice_items_monthly"
127127
"invoices_balance_daily|Invoice Balance|TIMELINE|report_invoices_balance_daily|refresh_report_invoices_balance_daily"
128128
"invoices_daily|Invoices Daily|TIMELINE|report_invoices_daily|refresh_report_invoices_daily"
129-
"invoice_monthly|Invoices Monthly|TABLE|report_invoices_monthly|refresh_report_invoices_monthly"
129+
"invoices_monthly|Invoices Monthly|TABLE|report_invoices_monthly|refresh_report_invoices_monthly"
130130
"mrr_daily|MRR|TIMELINE|report_mrr_daily|refresh_report_mrr_daily"
131131
"new_accounts_daily|New Accounts Daily|TIMELINE|report_new_accounts_daily|refresh_report_new_accounts_daily"
132132
"overdue_states_count_daily|Overdue States Count|TIMELINE|report_overdue_states_count_daily|refresh_report_overdue_states_count_daily"

‎src/main/resources/reports/README.md‎

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)