Prefill

bench get-app https://github.com/s1dharthpv/prefill

[![Listed on Frappe Gems](https://frappegems.com/api/method/frappe_gems.seo.badge?app=s1dharthpv%2Fprefill)](https://frappegems.com/gems/apps/s1dharthpv/prefill)

# Prefill Save the values of a form as a preset, then fill a new form with it in one click. A preview shows exactly what will change before anything is filled. Example: you create the same customer's invoice every week. Fill it once, choose Menu > Save as Preset, and next week choose Presets > Apply a Preset on the new invoice. ## Screenshots [Watch the demo video](docs/demo/demo.mp4) (about one minute, no audio, with captions): save a preset with two dynamic dates, apply it, review the preview in both modes, and save. **Save a preset.** Fill a form, choose Menu > Save as Preset, and tick the fields and child tables to keep.  **Make a value dynamic.** Instead of a fixed date, the order date is always today and the due date is always 7 days later.  **Preview before anything changes.** On a new form, Presets > Apply a Preset opens a preview. The Priority already typed is kept, and empty fields and the child rows are ready to fill.  **Overwrite when you want to.** The same preview in overwrite mode also replaces the typed Priority. Untick any row you do not want.  **The form is filled, not saved.** Review it and save as usual, so every normal validation still runs.  **Settings.** A System Manager controls the master switch, Everyone sharing, limits and excluded DocTypes.  ## Requirements - Frappe v16 (Python 3.14) - No other app. Prefill works on standard DocTypes, including your own. A few kinds are left out (see below). ## Installation ```bash cd $PATH_TO_YOUR_BENCH bench get-app $URL_OF_THIS_REPO --branch main bench --site $YOUR_SITE install-app prefill ``` ## Using it **Save a preset.** Fill a form, then Menu > Save as Preset. Give it a title, choose who can use it (scope), and tick the fields and child tables to keep. Fields that have a value are ticked for you, including values the form filled in by itself, such as defaults and fields fetched from a customer. Untick what you do not want to repeat. Only ticked values are saved. **Dynamic values.** Under "Dynamic values (optional)" in the same dialog, pick a field and a value that is worked out each time the preset is applied, instead of saving a fixed one. It replaces the saved value of that field, ticked or not. Each value only appears for the fields it fits: | Value | Fits | Notes | |---|---|---| | Today | Date, Datetime | optional "days from today", positive or negative, up to 3650. On a Datetime field it fills midnight | | Now | Datetime | | | First day of this month, Last day of this month | Date | | | Current user | Data, or a Link to User | | | Default company | a Link to Company | the user's default company, else the site's default company; skipped with a reason if neither is set, or if the site has no Company DocType | Dynamic values work on the fields of the form itself, not on child table rows. **Apply a preset.** On a new or draft form, click Presets > Apply a Preset and pick one. A preview opens: - one row per field, with the current value, the preset value and a checkbox - "Fill empty fields only" (default) keeps what you typed; "Overwrite existing values" replaces it - "Append rows" (default) adds the preset's rows to a child table; "Replace rows" clears it first - rows that cannot be filled are greyed out with the reason (the linked record no longer exists, the option is gone, you cannot edit that field) Nothing is written until you click Apply, and applying only changes the form on screen. You then save the form as usual, so every normal validation runs. **Scope.** Private (only you), Shared (chosen users and roles, each with an optional "can edit"), or Everyone (off until a System Manager allows it in Form Presets Settings; if it is turned off later, existing Everyone presets stay with their owner and System Managers and other users stop seeing them). Presets are also listed under Form Preset in the Prefill app's sidebar. **Who can do what.** | | Owner | Shared user | Shared with "can edit" | Everyone scope | System Manager | |---|---|---|---|---|---| | See and apply | yes | yes | yes | yes | yes | | Edit title, description, values | yes | no | yes | no | yes | | Change scope or sharing | yes | no | no | no | yes | | Disable or enable | yes | no | no | no | yes | | Delete | yes | no | no | no | yes | On top of this, a user needs read permission on the target DocType to see or apply a preset (this includes the preset's own owner), create permission to save one, and write permission to change its values. System Managers see, apply, disable and delete every preset without that read check, but they still need create or write on the target DocType to save a preset or change its values. ## What is never saved or filled Password, Attach, Attach Image, Signature, Barcode, Geolocation, Image, Code, HTML, JSON and similar fields; read-only fields; fields filled from another field (fetch from); virtual fields; system fields (name, owner, docstatus and the like); and fields you do not have permission to read. Presets are not offered on core system DocTypes, User, Role and permission DocTypes, Single DocTypes, child tables (they are saved through their parent) and virtual DocTypes. A System Manager can exclude more DocTypes in Form Presets Settings. ## Settings Form Presets Settings (System Manager only): | Setting | Default | Meaning | |---|---|---| | Enabled | on | Turns the Presets buttons on or off for everyone | | Allow Everyone Scope | off | Lets presets be shared with every user | | Max Presets Per User | 200 | Cap checked when a preset is created | | Max Values Size (KB) | 64 | Cap on the saved values of one preset | | Excluded DocTypes | none | Added to the built-in exclusions | ## Limits - Desk only. There is no portal or website form support, and no mobile app. - Presets fill new and draft documents only. Submitted and cancelled documents are refused by the server, not just hidden in the interface. - A preset keeps plain values. It does not run expressions or templates. - Dynamic values are resolved on the server in the site's time zone when a preset is applied, and checked against the field type when it is saved. They are not offered for child table rows. - Some forms add rows or defaults of their own, for example a new invoice with one blank item row and a default tax row. "Append rows" leaves those in place: the blank row stays and can block saving, and a default row can appear twice. Choose "Replace rows" for such tables. - A field that the form recalculates from other fields, such as an invoice's due date from its payment terms, is overwritten by that logic, exactly as a manual edit would be. A preset cannot hold a value for it. - A Link field is filled only if the linked record still exists and you may read it (for a Link to a DocType, such as a party type, you must be able to read documents of that DocType). A Select is filled only if the option still exists. ## Data handling - Preset values can contain business data. They stay on your site: the app makes no external calls and sends no telemetry. - The app does not write values to logs, to the Error Log, or to document version history. Deleting a preset removes its values from the Deleted Document copy as well. - Requests the app rejects (bad input, no permission) end as normal validation errors, which Frappe does not copy to the Error Log (except on a site running in developer mode, where it logs them too). If an unexpected server error ever happens, Frappe itself records the request in the Error Log, as it does for any app, so treat the Error Log as sensitive. - Retention is up to you: delete presets you no longer need, and review who has Everyone or Shared access. - Admin checklist: keep Allow Everyone Scope off unless needed; review Excluded DocTypes for DocTypes holding sensitive data; review Form Preset records and their scope before offboarding a user. ## Development ```bash bench --site $YOUR_SITE set-config allow_tests true bench --site $YOUR_SITE run-tests --app prefill ``` Lint and format with `pre-commit` (ruff, eslint, prettier): ```bash cd apps/prefill pre-commit install ``` Frappe's [Semgrep rules](https://github.com/frappe/semgrep-rules) run in CI on pull requests and must stay at zero findings: ```bash git clone --depth 1 https://github.com/frappe/semgrep-rules.git frappe-semgrep-rules semgrep --config ./frappe-semgrep-rules/rules --config r/python.lang.correctness . ``` A browser smoke test of the whole save and apply flow lives in `ui_tests/smoke.py`; its header explains how to run it. CI: server tests run on every push to `develop` or `main` and on every pull request; linters run on every pull request. ## Support, privacy and terms - [Support](docs/SUPPORT.md) - [Privacy policy](docs/PRIVACY.md) - [Terms of use](docs/TERMS.md) ## License MIT. See `LICENSE`.