NexCommand AINexCom Knowledge Base
Field reference

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.

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: 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

  1. Open Server Script from System Admin → Platform Settings, or use ERP Search.
  2. Filter the list and open the relevant record. To add a record, use Add/New when your role provides that action.
  3. 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.
  4. Save the record and address validation messages. Reload and verify the saved values and relationships.
  5. 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.

FieldType / behaviorHow to use it
Script Typescript_typeSelect
Required
Choose one of the configured list values. Status fields may be controlled by the record workflow.
Available choices
  • DocType Event
  • Scheduler Event
  • Permission Query
  • API
  • Workflow Task
Reference Document Typereference_doctypeLink
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_frequencySelect
Optional
Choose one of the configured list values. Status fields may be controlled by the record workflow.
Available choices
  • All
  • Hourly
  • Daily
  • Weekly
  • Monthly
  • Yearly
  • Hourly Long
  • Daily Long
  • Weekly Long
  • Monthly Long
  • Cron
Cron Formatcron_formatData
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_eventSelect
Optional
Choose one of the configured list values. Status fields may be controlled by the record workflow.
Available choices
  • Before Insert
  • Before Validate
  • Before Save
  • After Insert
  • After Save
  • Before Rename
  • After Rename
  • Before Submit
  • After Submit
  • Before Cancel
  • After Cancel
  • Before Discard
  • After Discard
  • Before Delete
  • After Delete
  • Before Save (Submitted Document)
  • After Save (Submitted Document)
  • Before Print
  • On Payment Authorization
  • On Payment Paid
  • On Payment Failed
  • On Payment Charge Processed
  • On Payment Mandate Charge Processed
  • On Payment Mandate Acquisition Processed
API Methodapi_methodData
Optional
Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Allow Guestallow_guestCheck
Optional
Enable or disable the named option only when it matches the intended record behavior.
Module (for export)moduleLink
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

DisableddisabledCheck
Optional
Enable or disable the named option only when it matches the intended record behavior.
ScriptscriptCode
Required
Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment.
Enable Rate Limitenable_rate_limitCheck
Optional
Enable or disable the named option only when it matches the intended record behavior.
Request Limitrate_limit_countInt
Optional
Enter a whole-number value.
Time Window (Seconds)rate_limit_secondsInt
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.