Authentication Properties (All Operations)
These connection properties are defined once and apply to every operation performed by this node instance.
| Property | Required | Description |
|---|
Host | Required | The full URL to the Elasticsearch cluster. Examples: https://localhost:9200 (local), https://my-cluster.es.io (Elastic Cloud). Must include the protocol and port if non-standard. |
Username | Required | Elasticsearch username. For Elastic Cloud clusters, this is typically elastic. |
Password | Required | Password for the specified username. Store this in BizFirst Credentials Manager — never hard-code in workflow expressions. |
IgnoreSSL | Optional | Boolean. Default: false. When true, skips TLS certificate validation. Use only for self-signed certificates in development or testing environments. Never enable in production. |
ConnectTimeout | Optional | Integer (milliseconds). Default: 30000 (30 seconds). Maximum time to wait when establishing a connection to the Elasticsearch cluster. |
RequestTimeout | Optional | Integer (milliseconds). Default: 60000 (60 seconds). Maximum time to wait for a query or index operation to complete. Increase for large aggregation or bulk index operations. |
document/create
| Property | Required | Description |
|---|
IndexName | Required | The name of the Elasticsearch index to write the document into. Index will be created automatically if it does not exist (using Elasticsearch's dynamic mapping). |
DocumentId | Optional | Custom document ID string. If left empty, Elasticsearch auto-generates a unique ID. Use a predictable ID (e.g. a database row ID) if you need idempotent upserts. |
Fields | Required | JSON object of the document fields and values to index. Example: {"title":"My Doc","price":29.99,"tags":["new","sale"]}. |
Bulk | Optional | Boolean. Default: false. When true, uses the Elasticsearch Bulk API. Required when Documents is provided. More efficient for batch writes. |
Documents | Optional | JSON array of document objects. Used when Bulk is true. Each element should be a complete document field object (without Bulk API action headers — the node handles those automatically). |
SimplifyResponse | Optional | Boolean. Default: false. When true, strips Elasticsearch metadata (_shards, _seq_no, etc.) from the response, returning only _id, _index, result, and _version. |
document/get
| Property | Required | Description |
|---|
IndexName | Required | The index containing the document to retrieve. |
DocumentId | Required | The exact _id of the document to fetch. Supports BizFirst expressions (e.g. {{ vars.doc_id }}). |
document/getMany
| Property | Required | Description |
|---|
IndexName | Required | The index to query. |
Query | Optional | Elasticsearch Query DSL JSON object. If omitted, returns all documents (match_all). Example: {"match":{"status":"active"}}. Pass the query clause value, not a full request body. |
Limit | Optional | Integer. Maximum number of documents to return per page. Ignored when ReturnAll is true. |
ReturnAll | Optional | Boolean. Default: false. When true, paginates automatically using the Elasticsearch scroll API to return all matching documents regardless of index size. |
Simplify | Optional | Boolean. When true, returns only the _source content of each hit, without _id, _score, or other metadata fields. |
document/search
| Property | Required | Description |
|---|
IndexName | Required | The index (or comma-separated list of indices, or wildcard pattern) to search. |
Query | Required | Full Elasticsearch search request body as a JSON object. Must include at minimum a query key. Can also include sort, _source, highlight, aggs, and other top-level search parameters. |
Aggregations | Optional | JSON aggregation block to merge into the request body. Merged with any aggs key inside Query. Useful when the aggregation is built dynamically by a previous node. |
Limit | Optional | Integer. Number of hits to return. Maps to size in the Elasticsearch request. Ignored when ReturnAll is true. |
ReturnAll | Optional | Boolean. When true, uses the scroll API to page through all matching results. Note: aggregations are computed on the full dataset regardless of this setting. |
Simplify | Optional | Boolean. When true, returns only _source per hit, omitting score and metadata. |
Elasticsearch Query DSL: The Query field for document/search accepts a complete Elasticsearch request body. You can use any valid query type: match, multi_match, term, terms, range, bool (with must/should/must_not/filter), fuzzy, wildcard, nested, geo_distance, and more. Sort by any field, highlight matches, and request only specific _source fields.
document/update
| Property | Required | Description |
|---|
IndexName | Required | The index containing the document to update. |
DocumentId | Required | The _id of the document to update. |
Fields | Required | JSON object of fields to update. Only the specified fields are modified; all other fields in the document are preserved. Example: {"status":"shipped","shipped_at":"2026-05-23T14:00:00Z"}. |
Upsert | Optional | Boolean. Default: false. When true, creates the document with the specified Fields if it does not already exist, instead of returning an error. |
document/delete
| Property | Required | Description |
|---|
IndexName | Required | The index containing the document to delete. |
DocumentId | Required | The _id of the document to permanently delete. |
index/create
| Property | Required | Description |
|---|
IndexName | Required | The name of the new index to create. Index names must be lowercase and cannot contain spaces or special characters except hyphens and underscores. |
Mappings | Optional | JSON mapping definition object. Defines field types, analyzers, and settings for the index schema. Example: {"properties":{"title":{"type":"text","analyzer":"english"},"price":{"type":"float"}}}. |
Settings | Optional | JSON settings object. Controls index-level settings such as number_of_shards, number_of_replicas, and custom analyzers. Example: {"number_of_shards":1,"number_of_replicas":1}. |
index/get
| Property | Required | Description |
|---|
IndexName | Required | The name of the index to retrieve. Returns the index's mappings, settings, aliases, and current statistics (document count, storage size). |
index/getMany
No additional properties required beyond the standard authentication fields. Returns an array of all indices accessible to the configured user, including name, health, status, document count, and primary store size.
index/delete
| Property | Required | Description |
|---|
IndexName | Required | The name of the index to permanently delete. All documents in the index are destroyed. This action cannot be undone. |
index/delete is irreversible: Deleting an index removes all documents and the index definition permanently. There is no recycle bin or undo. Ensure the correct index name is passed — use a variable with type-checking rather than a hard-coded string in automated workflows.
