Search Link Field
erpnext.search_link
ActionCRM & salesconnection required
Calls the ERPNext API with the connection's credentials.
Run the same link-field lookup the ERPNext UI uses, returning each match's name with the description shown beside it.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- ERPNext
- Secret shape
- {"api_key": "…", "api_secret": "…"}
- Config it needs
- base_url, doctype
- Resolved by
- config.connection_id, else node.connection_id
Configuration
5 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
doctype The DocType to act on, spelled as ERPNext spells it (e.g. 'Sales Order'). Overrides the default DocType on the connection. | string | No | — | — | Customer |
text What the user typed; ERPNext matches it against the DocType's own search fields. | string | Yes | — | — | acme |
filters Frappe filters as a list of triples, e.g. [["status", "=", "Open"], ["grand_total", ">", 1000]]. Combined with AND. | array | No | — | — | — |
page_length How many suggestions to return. ERPNext returns 10 when empty. | number | No | 10 | 1–100 | — |
searchfield Match against this field instead of the DocType's configured search fields. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"doctype": "Customer",
"page_length": 10,
"text": "acme"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
doctype The DocType that was searched. | string | — |
text The text that was searched for. | string | — |
items The suggestions, each with value, label and description. | array | — |
count How many suggestions came back. | number | — |
{
"count": 0,
"doctype": "",
"items": [],
"text": ""
}See Search Link Field run in a workflow.
In a technical demo we add the ERPNext connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.