Recorder
How to use Recorder in Platform Settings: access, working steps, fields, related records and troubleshooting.
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.
Before you start
Review the current settings or existing records and prepare the information needed for the change.
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 Recorder 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 |
|---|---|---|
Pathpath | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Number of Queriesnumber_of_queries | Int Optional | Enter a whole-number value. |
Time in Queriestime_in_queries | Float Optional | Enter a numeric value using the required unit and precision. |
Number of Eventsnumber_of_events | Int Optional | Enter a whole-number value. |
Methodmethod | Select Optional | Choose one of the configured list values. Status fields may be controlled by the record workflow.Available choices
|
CMDcmd | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Timetime | Datetime Optional | Record the date and time in the configured system/user time zone. |
Durationduration | Float Optional | Enter a numeric value using the required unit and precision. |
Apps Involvedapps_involved | Data Optional · Read-only | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Timelinetimeline | Table Optional · Read-only | Ordered timeline of document lifecycle methods and doc_events handlers that ran during this request, attributed to the app(s) that hook them. Linked record: Recorder Event |
Request Headersrequest_headers | Code Optional | Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment. |
Form Dictform_dict | Code Optional | Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment. |
Suggested Indexessuggested_indexes | Table Optional | Disclaimer: These indexes are suggested based on data and queries performed during this recording. These suggestions may or may not help. Linked record: Recorder Suggested Index |
SQL Queriessql_queries | Table Optional | Add the relevant child rows and review required columns, quantities and references before saving. Linked record: Recorder Query |
cProfile Outputprofile | Code Optional · Read-only | Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment. |
Child tables
Timeline — child-row fields
| Field | Type / behavior | How to use it |
|---|---|---|
Methodlabel | Data Optional · Read-only | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
DocTyperef_doctype | Data Optional · Read-only | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Documentref_name | Data Optional · Read-only | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Appsapps | Data Optional · Read-only | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Queriesqueries | Int Optional · Read-only | Enter a whole-number value. |
Duration (ms)duration | Float Optional · Read-only | Enter a numeric value using the required unit and precision. |
Raw Methodmethod | Data Optional · Read-only | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Depthdepth | Int Optional · Read-only | Enter a whole-number value. |
Sequenceseq | Int Optional · Read-only | Enter a whole-number value. |
Handlershandlers | Small Text Optional · Read-only | Provide concise contextual information relevant to the record. Avoid unrelated personal or confidential data. |
Suggested Indexes — child-row fields
| Field | Type / behavior | How to use it |
|---|---|---|
Tabletable | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Columncolumn | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
SQL Queries — child-row fields
| Field | Type / behavior | How to use it |
|---|---|---|
Indexindex | Int Optional | Enter a whole-number value. |
Queryquery | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Durationduration | Float Optional | Enter a numeric value using the required unit and precision. |
Exact Copiesexact_copies | Int Optional | Enter a whole-number value. |
Normalized Querynormalized_query | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Normalized Copiesnormalized_copies | Int Optional | Enter a whole-number value. |
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.