Field reference

Report

How to use Report in Platform Settings: access, working steps, fields, related records and troubleshooting.

System AdminUpdated 12 October 2026Configuration-aware guidance

Purpose and access

Review platform defaults and dependencies within the administrator’s authority. Record the reason and tested impact of changes. Authentication, session settings and security-sensitive configuration need a controlled change process.

This page is a record page in System Admin → Platform Settings. Use the link above to open the configured destination; permissions are checked by the destination service.

ERP links open in a new tab. Sign in with your own account; record visibility, actions and approval authority follow your assigned permissions. Screens can differ by company and configuration.

Before you start

Prepare the required information: Report Name, Ref DocType, Is Standard, Report Type.

Confirm the company, party, dates, units and source references that apply. Select existing links carefully and check for an existing record before creating a duplicate.

Working steps

Open Report from System Admin → Platform Settings, or use ERP Search.
Filter the list and open the relevant record. To add a record, use Add/New when your role provides that action.
Complete the editable fields described below. Required fields and validation conditions must be satisfied; read-only values are set by the system or their source records.
Add the required child rows. Review each row’s identifiers, linked records and values, using the child-table field reference below.
Save the record and address validation messages. Reload and verify the saved values and relationships.
Use any additional workflow actions only when the record and your role provide them. Saving this record does not automatically complete a related transaction or external action.

Field reference

These fields come from the installed ERP definition. Hidden fields and password inputs are omitted. Additional conditions, custom scripts and workflow rules can make a field required or read-only in a particular context.

Field	Type / behavior	How to use it
Report Name`report_name`	Data Required	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Ref DocType`ref_doctype`	Link Required	Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: DocType
Reference Report`reference_report`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Is Standard`is_standard`	Select Required	Choose one of the configured list values. Status fields may be controlled by the record workflow. Available choices No Yes
Module`module`	Link Optional	Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: Module Def
Report Type`report_type`	Select Required	Choose one of the configured list values. Status fields may be controlled by the record workflow. Available choices Report Builder Query Report Script Report Custom Report
Letter Head`letter_head`	Link Optional	Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: Letter Head
Add Total Row`add_total_row`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Disabled`disabled`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Prepared Report`prepared_report`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Snapshot Report`snapshot_report`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Disable Prepared Report Automation`disable_prepared_report_automation`	Check Optional	If checked, Prepared Report will not be enabled automatically on slow runs.
Add Translate Data`add_translate_data`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Timeout (In Seconds)`timeout`	Int Optional	Specify a custom timeout, default timeout is 1500 seconds
Doctype To Sync`doctype_to_sync`	Table Optional	Add the relevant child rows and review required columns, quantities and references before saving. Linked record: Doctype To Sync
Filters`filters`	Table Optional	Add the relevant child rows and review required columns, quantities and references before saving. Linked record: Report Filter
Columns`columns`	Table Optional	Add the relevant child rows and review required columns, quantities and references before saving. Linked record: Report Column
Query`query`	Code Optional	Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment.
Script`report_script`	Code Optional	Filters will be accessible via filters . Send output as result = [result] , or for old style data = [columns], [result]
Javascript`javascript`	Code Optional	JavaScript Format: frappe.query_reports['REPORTNAME'] = {}
JSON`json`	Code Optional · Read-only	Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment.
Roles`roles`	Table Optional	Add the relevant child rows and review required columns, quantities and references before saving. Linked record: Has Role

Child tables

Doctype To Sync — child-row fields

Field	Type / behavior	How to use it
DocType`doc_type`	Link Optional	Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: DocType

Filters — child-row fields

Field	Type / behavior	How to use it
Label`label`	Data Required	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Fieldtype`fieldtype`	Select Required	Choose one of the configured list values. Status fields may be controlled by the record workflow. Available choices Check Currency Data Date Datetime Dynamic Link Float Fold Int Link Select Time
Fieldname`fieldname`	Data Required	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Mandatory`mandatory`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Wildcard Filter`wildcard_filter`	Check Optional	Will add "%" before and after the query
Options`options`	Small Text Optional	Provide concise contextual information relevant to the record. Avoid unrelated personal or confidential data.
Default`default`	Small Text Optional	Provide concise contextual information relevant to the record. Avoid unrelated personal or confidential data.

Columns — child-row fields

Field	Type / behavior	How to use it
Fieldname`fieldname`	Data Required	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Label`label`	Data Required	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Fieldtype`fieldtype`	Select Required	Choose one of the configured list values. Status fields may be controlled by the record workflow. Available choices Check Currency Data Date Datetime Duration Dynamic Link Float Fold Int Link Select Time
Options`options`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Width`width`	Int Optional	Enter a whole-number value.

Roles — child-row fields

Field	Type / behavior	How to use it
Role`role`	Link Optional	Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: Role

Troubleshooting

Not permitted: verify the account, role and source-document permission. Do not share an administrator login.
Missing record or address: inspect the relevant Link or Dynamic Link fields; a matching title alone does not establish a relationship.
Cannot save or change status: review required fields, read-only values, document status and the configured approval transition.
Unexpected report or portal result: review company/date filters, source-document submission and the approved party or Employee link.

Was this useful?

Report

Purpose and access

Before you start

Working steps

Field reference

Child tables

Troubleshooting

Related pages