Ledgers
LedgersA ledger is a table of numbers that you can save in a case, and access in forms.
Definitions:
- A ledger is another can be viewed as a type of case property
- A ledger is a table of numbers saved to your case
- Rows of the table are products
- Columns of the table are the any numbers you want to track But unlike the case property the ledgers can be update directly in the form-builder with the transactions.
- The row of the ledger is called an "entry" and corresponds to a product id.
- The column of a ledger is called a "section":
- You can create your own section when creating a ledger (stock, balance, price, order amounts ...)
- A ledger is readable individually, you can access the stock legder
- You can define as many sections as you want for a ledger.
- Some section ids, such as consumption (which store the average monthly consumption) are reserved by the application.
- The number saved for each row and column is called a "quantity":
- The quantities of a ledger are of integer type. Decimals are not supported.
Do you want to use a ledger?
- You are a community health worker who manages ORS, zinc, and vitamins
- You are building an app to track shipments of products over time
- You are building an app to track orders/requisitions of products over time
- You want to track the number of Rapid Diagnostic Tests (RDTs) at a facility over time
- You want to make a sandwich shop app that tracks how much money 50 different clients owe you
Transactions
A transaction allow you to save and update numbers in a ledger.
...
- Balance: set the ledger quantity to a specific value
- Receive: increment the ledger quantity by a specific value
- Dispense: decrement the ledger quantity by a specific value
- Transfer: decrement the ledger quantity by a specific value on a case A & increment the ledger quantity by a specific value on a case B
PS:Good to know !!!
- Transactions are atomic – so if your phone shuts down mid-transfer, things don’t get lost.
- Transactions are also resolved meaningfully. In CommCare, if 2 phones increments the same number, whichever phone writes last wins. In CommCare Supply, the increments are summed.
