Server Script
How to use Server Script 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
Prepare the required information: Script Type, Script.
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 Server Script 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.
- 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 |
|---|---|---|
Script Typescript_type | Select Required | Choose one of the configured list values. Status fields may be controlled by the record workflow.Available choices
|
Reference Document Typereference_doctype | 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 |
Event Frequencyevent_frequency | Select Optional | Choose one of the configured list values. Status fields may be controlled by the record workflow.Available choices
|
Cron Formatcron_format | Data Optional | * * * * * ┬ ┬ ┬ ┬ ┬ │ │ │ │ │ │ │ │ │ └ day of week (0 - 6) (0 is Sunday) │ │ │ └───── month (1 - 12) │ │ └────────── day of month (1 - 31) │ └─────────────── hour (0 - 23) └──────────────────── minute (0 - 59) --- * - Any value / - Step values |
DocType Eventdoctype_event | Select Optional | Choose one of the configured list values. Status fields may be controlled by the record workflow.Available choices
|
API Methodapi_method | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Allow Guestallow_guest | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Module (for export)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 |
Disableddisabled | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Scriptscript | Code Required | Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment. |
Enable Rate Limitenable_rate_limit | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Request Limitrate_limit_count | Int Optional | Enter a whole-number value. |
Time Window (Seconds)rate_limit_seconds | 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.