@celigo/api-specs 0.2.80 → 0.2.82
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/ai-agent.yml +55 -20
- package/dist/export.yml +147 -743
- package/dist/flow.yml +55 -20
- package/dist/tool.yml +169 -750
- package/package.json +1 -1
- package/schemas.json +2 -2
package/dist/tool.yml
CHANGED
|
@@ -6033,11 +6033,21 @@ components:
|
|
|
6033
6033
|
can read them. Extracts do NOT read the raw application
|
|
6034
6034
|
response — they evaluate against the platform's canonical
|
|
6035
6035
|
per-record envelope: for lookups (`type: "export"`) that is
|
|
6036
|
-
`{"statusCode", "data": [<result records>], "errors"}
|
|
6037
|
-
|
|
6038
|
-
|
|
6039
|
-
|
|
6040
|
-
|
|
6036
|
+
`{"statusCode", "data": [<result records>], "errors"}`
|
|
6037
|
+
where `data` holds the records AFTER the export's own
|
|
6038
|
+
`transform` and output `filter`, so paths must start from
|
|
6039
|
+
`data` and name transformed fields by their transformed
|
|
6040
|
+
name (e.g. `data[0].name`) — a lookup result field
|
|
6041
|
+
written without the `data` prefix resolves to nothing;
|
|
6042
|
+
for imports it is `{"id", "statusCode", "ignored",
|
|
6043
|
+
"_json", ...<body fields flattened>}`, so use `id`,
|
|
6044
|
+
`_json.<path>`, or the body field itself at the root
|
|
6045
|
+
(`orderNumber` and `_json.orderNumber` read the same
|
|
6046
|
+
value). An extract may be a Handlebars expression over
|
|
6047
|
+
the same envelope (`{{data.0.name}}`,
|
|
6048
|
+
`{{#if data.length}}found{{/if}}`; dot indexes only; a
|
|
6049
|
+
string result); there is no `record` object in this
|
|
6050
|
+
context, so `{{record.…}}` renders nothing.
|
|
6041
6051
|
properties:
|
|
6042
6052
|
fields:
|
|
6043
6053
|
type: array
|
|
@@ -6047,15 +6057,20 @@ components:
|
|
|
6047
6057
|
properties:
|
|
6048
6058
|
extract:
|
|
6049
6059
|
type: string
|
|
6060
|
+
x-celigo-agent:
|
|
6061
|
+
- handlebars
|
|
6050
6062
|
description: |
|
|
6051
6063
|
Path within the canonical response envelope to
|
|
6052
6064
|
copy the value from (`data[0].x` / `data.0.x`
|
|
6053
|
-
for lookups; `id
|
|
6054
|
-
imports)
|
|
6065
|
+
for lookups; `id`, `_json.<path>` or the
|
|
6066
|
+
flattened body field `<path>` for imports), or
|
|
6067
|
+
a Handlebars expression over that envelope (dot
|
|
6068
|
+
indexes inside `{{ }}`, never a `record.` root).
|
|
6055
6069
|
examples:
|
|
6056
6070
|
- data[0].customer.name
|
|
6057
6071
|
- data.0.fields.Product Name
|
|
6058
6072
|
- id
|
|
6073
|
+
- '{{#if data.length}}found{{else}}missing{{/if}}'
|
|
6059
6074
|
generate:
|
|
6060
6075
|
type: string
|
|
6061
6076
|
description: |
|
|
@@ -34238,13 +34253,20 @@ components:
|
|
|
34238
34253
|
`netsuite.skipGrouping: true` — without it the run fails with `[search_not_sorted]`).
|
|
34239
34254
|
distributed:
|
|
34240
34255
|
type: object
|
|
34256
|
+
x-celigo-ai-guidance:
|
|
34257
|
+
- |-
|
|
34258
|
+
A real-time listener is an export with top-level `type: distributed` and
|
|
34259
|
+
`netsuite.type: distributed`. Saving it creates a user event script deployment on the
|
|
34260
|
+
record type that runs after submit, so records arrive only when NetSuite saves one and
|
|
34261
|
+
`POST /v1/exports/preview` cannot sample it.
|
|
34241
34262
|
properties:
|
|
34242
34263
|
recordType:
|
|
34243
34264
|
type: string
|
|
34244
34265
|
description: |-
|
|
34245
|
-
NetSuite record type the
|
|
34246
|
-
|
|
34247
|
-
|
|
34266
|
+
NetSuite record type the listener is deployed on, as its lowercase script ID
|
|
34267
|
+
(`customer`, `salesorder`, `customrecord_<scriptid>`) — never the display name or a
|
|
34268
|
+
custom record's numeric internal ID. Types the platform's record-type catalog marks
|
|
34269
|
+
`doesNotSupportRTExport` cannot host a listener and are not offered in the UI.
|
|
34248
34270
|
examples:
|
|
34249
34271
|
- customer
|
|
34250
34272
|
- invoice
|
|
@@ -34256,23 +34278,9 @@ components:
|
|
|
34256
34278
|
- creditmemo
|
|
34257
34279
|
x-celigo-ai-guidance:
|
|
34258
34280
|
- |-
|
|
34259
|
-
|
|
34260
|
-
|
|
34261
|
-
|
|
34262
|
-
- |-
|
|
34263
|
-
## EXAMPLES:
|
|
34264
|
-
- "customer"
|
|
34265
|
-
- "invoice"
|
|
34266
|
-
- "salesorder"
|
|
34267
|
-
- "itemfulfillment"
|
|
34268
|
-
- "vendorbill"
|
|
34269
|
-
- "employee"
|
|
34270
|
-
- "purchaseorder"
|
|
34271
|
-
- "creditmemo"
|
|
34272
|
-
- |-
|
|
34273
|
-
## IMPORTANT NOTES:
|
|
34274
|
-
- Must be lowercase script ID, not the display name
|
|
34275
|
-
- Custom record types use format "customrecord_scriptid"
|
|
34281
|
+
Take the value from the `recordTypes` metadata catalog row's `scriptId`, lower-cased:
|
|
34282
|
+
custom records and lists carry NetSuite's numeric internal ID in `id` and the script
|
|
34283
|
+
ID in `scriptId`, so `id` is wrong for them. Skip rows with `doesNotSupportRTExport: true`.
|
|
34276
34284
|
executionContext:
|
|
34277
34285
|
type: array
|
|
34278
34286
|
description: |-
|
|
@@ -34280,34 +34288,10 @@ components:
|
|
|
34280
34288
|
fires the export only when it occurs in one of the listed contexts.
|
|
34281
34289
|
x-celigo-ai-guidance:
|
|
34282
34290
|
- |-
|
|
34283
|
-
|
|
34284
|
-
|
|
34285
|
-
|
|
34286
|
-
|
|
34287
|
-
## DEFAULT VALUE
|
|
34288
|
-
If not specified, defaults to: ["userinterface", "webstore"]
|
|
34289
|
-
- |-
|
|
34290
|
-
## VALID VALUES
|
|
34291
|
-
- "userinterface" - User interactions in the NetSuite UI
|
|
34292
|
-
- "webservices" - SOAP web services calls
|
|
34293
|
-
- "csvimport" - CSV import operations
|
|
34294
|
-
- "offlineclient" - Offline client synchronization
|
|
34295
|
-
- "portlet" - Portlet interactions
|
|
34296
|
-
- "scheduled" - Scheduled script executions
|
|
34297
|
-
- "suitelet" - Suitelet executions
|
|
34298
|
-
- "custommassupdate" - Custom mass update operations
|
|
34299
|
-
- "workflow" - Workflow actions
|
|
34300
|
-
- "webstore" - Web store transactions
|
|
34301
|
-
- "userevent" - User event script triggers
|
|
34302
|
-
- "mapreduce" - Map/Reduce script operations
|
|
34303
|
-
- "restlet" - RESTlet API calls
|
|
34304
|
-
- "webapplication" - Web application interactions
|
|
34305
|
-
- "restwebservices" - REST web services calls
|
|
34306
|
-
- |-
|
|
34307
|
-
## EXAMPLE
|
|
34308
|
-
```json
|
|
34309
|
-
["userinterface", "webstore"]
|
|
34310
|
-
```
|
|
34291
|
+
Defaults to `userinterface` and `webstore` — the manual, time-sensitive saves a
|
|
34292
|
+
real-time export exists for. Bulk contexts such as `csvimport`, `custommassupdate`
|
|
34293
|
+
and `mapreduce` turn every record of a mass update into an outbound call and flood
|
|
34294
|
+
the flow with records a scheduled export would batch; add them only when asked.
|
|
34311
34295
|
default:
|
|
34312
34296
|
- userinterface
|
|
34313
34297
|
- webstore
|
|
@@ -34348,50 +34332,13 @@ components:
|
|
|
34348
34332
|
disabled:
|
|
34349
34333
|
type: boolean
|
|
34350
34334
|
description: |-
|
|
34351
|
-
When true,
|
|
34352
|
-
|
|
34335
|
+
When true, the listener's NetSuite deployment is inactive and record saves no longer
|
|
34336
|
+
trigger the export. Maintained by the platform as the flow is disabled and re-enabled;
|
|
34337
|
+
re-enabling the flow re-registers the deployment.
|
|
34353
34338
|
x-celigo-ai-guidance:
|
|
34354
34339
|
- |-
|
|
34355
|
-
|
|
34356
|
-
|
|
34357
|
-
This boolean flag controls the availability and operational status of the
|
|
34358
|
-
distributed functionalities within the NetSuite integration,
|
|
34359
|
-
allowing administrators or systems to enable or disable these features as needed.
|
|
34360
|
-
- |-
|
|
34361
|
-
## FIELD BEHAVIOR:
|
|
34362
|
-
- When set to true, the distributed feature is fully disabled, preventing any distributed operations or workflows from executing.
|
|
34363
|
-
- When set to false or omitted, the distributed feature remains enabled and fully operational.
|
|
34364
|
-
- Acts as a toggle switch to control the accessibility of distributed capabilities within the NetSuite environment.
|
|
34365
|
-
- Changes to this flag directly influence the behavior of distributed-related processes and integrations.
|
|
34366
|
-
- |-
|
|
34367
|
-
## IMPLEMENTATION GUIDANCE:
|
|
34368
|
-
- Use a boolean value: `true` to disable the distributed feature, `false` to enable it.
|
|
34369
|
-
- Before disabling, verify that no critical processes depend on distributed functionality to avoid disruptions.
|
|
34370
|
-
- Implement validation checks to confirm the current state before initiating distributed operations.
|
|
34371
|
-
- Provide clear user notifications or system logs when the feature is disabled to aid in troubleshooting and auditing.
|
|
34372
|
-
- Consider the impact on dependent modules and ensure coordinated updates if disabling this feature.
|
|
34373
|
-
- |-
|
|
34374
|
-
## EXAMPLES:
|
|
34375
|
-
- `disabled: true` # The distributed feature is turned off, disabling all related operations.
|
|
34376
|
-
- `disabled: false` # The distributed feature is active and available for use.
|
|
34377
|
-
- Omitted `disabled` property defaults to `false`, enabling the feature by default.
|
|
34378
|
-
- |-
|
|
34379
|
-
## IMPORTANT NOTES:
|
|
34380
|
-
- Disabling this feature may interrupt workflows or processes that rely on distributed capabilities, potentially causing failures or delays.
|
|
34381
|
-
- Some systems may require a restart or reinitialization after changing this setting for the change to take full effect.
|
|
34382
|
-
- Modifying this property should be restricted to users with appropriate permissions to prevent unauthorized disruptions.
|
|
34383
|
-
- Always assess the broader impact on the NetSuite integration before toggling this flag.
|
|
34384
|
-
- |-
|
|
34385
|
-
## DEPENDENCY CHAIN:
|
|
34386
|
-
- Directly affects modules and properties that rely on distributed functionality within the NetSuite integration.
|
|
34387
|
-
- Should be checked and respected by any API calls, workflows, or processes that involve distributed features.
|
|
34388
|
-
- May influence error handling and fallback mechanisms in distributed-related operations.
|
|
34389
|
-
- |-
|
|
34390
|
-
## TECHNICAL DETAILS:
|
|
34391
|
-
- Data type: Boolean
|
|
34392
|
-
- Default value: `false` (distributed feature enabled)
|
|
34393
|
-
- Located under the `netsuite.distributed` namespace in the API schema
|
|
34394
|
-
- Changing this property triggers state changes in distributed feature availability within the system
|
|
34340
|
+
Pause a listener by disabling its flow, not by setting this field. A listener that has
|
|
34341
|
+
stopped firing is re-registered by disabling and re-enabling the flow.
|
|
34395
34342
|
executionType:
|
|
34396
34343
|
type: array
|
|
34397
34344
|
description: |-
|
|
@@ -34399,39 +34346,13 @@ components:
|
|
|
34399
34346
|
export only when its operation matches one of the listed types.
|
|
34400
34347
|
x-celigo-ai-guidance:
|
|
34401
34348
|
- |-
|
|
34402
|
-
|
|
34403
|
-
|
|
34404
|
-
|
|
34405
|
-
- |-
|
|
34406
|
-
## DEFAULT VALUE
|
|
34407
|
-
If not specified, defaults to: ["create", "edit", "xedit"]
|
|
34408
|
-
- |-
|
|
34409
|
-
## VALID VALUES
|
|
34410
|
-
- "create" - New record creation
|
|
34411
|
-
- "edit" - Record editing via UI
|
|
34412
|
-
- "delete" - Record deletion
|
|
34413
|
-
- "xedit" - Inline editing (edit without opening the record)
|
|
34414
|
-
- "copy" - Record copy operation
|
|
34415
|
-
- "view" - Record view
|
|
34416
|
-
- "cancel" - Transaction cancellation
|
|
34417
|
-
- "approve" - Approval action
|
|
34418
|
-
- "reject" - Rejection action
|
|
34419
|
-
- "pack" - Pack operation (fulfillment)
|
|
34420
|
-
- "ship" - Ship operation (fulfillment)
|
|
34421
|
-
- "markcomplete" - Mark as complete
|
|
34422
|
-
- "reassign" - Reassignment action
|
|
34423
|
-
- "editforecast" - Forecast editing
|
|
34424
|
-
- "dropship" - Drop ship operation
|
|
34425
|
-
- "specialorder" - Special order operation
|
|
34426
|
-
- "orderitems" - Order items action
|
|
34427
|
-
- "paybills" - Pay bills action
|
|
34428
|
-
- "print" - Print action
|
|
34429
|
-
- "email" - Email action
|
|
34349
|
+
Defaults to `create`, `edit` and `xedit` (inline edit) — new records plus every way
|
|
34350
|
+
an existing record changes. Narrow it for event-driven work: Celigo's own example
|
|
34351
|
+
exports a sales order only on `approve` to notify a chat channel.
|
|
34430
34352
|
- |-
|
|
34431
|
-
|
|
34432
|
-
|
|
34433
|
-
|
|
34434
|
-
```
|
|
34353
|
+
The UI offers thirteen of these values (`create`, `edit`, `delete`, `xedit`,
|
|
34354
|
+
`approve`, `cancel`, `reject`, `pack`, `ship`, `dropship`, `specialorder`,
|
|
34355
|
+
`orderitems`, `paybills`); the API accepts all twenty.
|
|
34435
34356
|
default:
|
|
34436
34357
|
- create
|
|
34437
34358
|
- edit
|
|
@@ -34486,692 +34407,171 @@ components:
|
|
|
34486
34407
|
- string
|
|
34487
34408
|
- 'null'
|
|
34488
34409
|
description: |-
|
|
34489
|
-
|
|
34490
|
-
|
|
34491
|
-
|
|
34410
|
+
Field-specific qualification criteria the SuiteApp evaluates against the record before
|
|
34411
|
+
exporting it; saves that do not match are discarded. Stored as a filter-expression array
|
|
34412
|
+
of `[field, operator, value]` rules joined by lowercase `"and"` / `"or"`, as a legacy
|
|
34413
|
+
expression string, or null when no criteria are set.
|
|
34414
|
+
examples:
|
|
34415
|
+
- - custrecord_ai_entitlements_status_code
|
|
34416
|
+
- '!='
|
|
34417
|
+
- '200'
|
|
34418
|
+
- - - val:entity
|
|
34419
|
+
- '='
|
|
34420
|
+
- '1397'
|
|
34421
|
+
- and
|
|
34422
|
+
- - shipstatus
|
|
34423
|
+
- '='
|
|
34424
|
+
- C
|
|
34492
34425
|
x-celigo-ai-guidance:
|
|
34493
34426
|
- |-
|
|
34494
|
-
|
|
34495
|
-
A
|
|
34496
|
-
categorizes,
|
|
34497
|
-
or scopes the associated data within the NetSuite distributed context.
|
|
34498
|
-
This property enables more granular identification, filtering,
|
|
34499
|
-
and processing of data by applying specific criteria or attributes relevant to business logic,
|
|
34500
|
-
integration workflows, or operational requirements.
|
|
34501
|
-
It serves as an optional but powerful tool to distinguish data subsets,
|
|
34502
|
-
enhance data semantics,
|
|
34503
|
-
and support conditional handling in distributed NetSuite environments.
|
|
34427
|
+
Rules combine strictly pairwise: three conditions are stored as
|
|
34428
|
+
`[A, "and", [B, "and", C]]`, never as a flat `[A, "and", B, "and", C]`.
|
|
34504
34429
|
- |-
|
|
34505
|
-
|
|
34506
|
-
|
|
34507
|
-
|
|
34508
|
-
|
|
34509
|
-
- Accepts string values that correspond to predefined, standardized, or custom qualifiers recognized by the system or integration layer.
|
|
34510
|
-
- Supports multiple use cases including regional segmentation, priority tagging, type classification, and channel identification.
|
|
34511
|
-
- |-
|
|
34512
|
-
## IMPLEMENTATION GUIDANCE:
|
|
34513
|
-
- Ensure the qualifier value strictly aligns with the accepted set of qualifiers defined in the business domain, integration specifications, or system configuration.
|
|
34514
|
-
- Implement validation mechanisms to verify that the qualifier string matches allowed or expected values to avoid errors, misclassification, or unintended behavior.
|
|
34515
|
-
- Adopt consistent naming conventions and formatting standards (e.g., lowercase, hyphen-separated) for qualifiers to maintain clarity, readability, and interoperability across systems.
|
|
34516
|
-
- Maintain comprehensive documentation of all custom and standard qualifiers used, including their intended meaning and usage scenarios, to facilitate maintenance, troubleshooting, and future integrations.
|
|
34517
|
-
- Consider the impact of qualifiers on downstream processing, reporting, and analytics to ensure they are leveraged effectively and do not introduce ambiguity.
|
|
34430
|
+
The left operand is a body field ID; sublist (line) fields cannot be used. A select
|
|
34431
|
+
field takes a prefix: `text:<field>` compares the option's label (the UI's "(Name)"
|
|
34432
|
+
row) and `val:<field>` the internal ID (the "(InternalId)" row — `entity.internalid`
|
|
34433
|
+
is stored as `val:entity`); multiselects use `texts:` / `vals:`.
|
|
34518
34434
|
- |-
|
|
34519
|
-
|
|
34520
|
-
|
|
34521
|
-
- "
|
|
34522
|
-
|
|
34523
|
-
- "channel-online" to denote sales or operations conducted through online channels.
|
|
34524
|
-
- "segment-enterprise" to classify data pertaining to enterprise-level customers.
|
|
34525
|
-
- "status-active" to filter or identify active records within a dataset.
|
|
34435
|
+
Operator tokens are `=`, `!=`, `?` (like), `contains`, `doesNotContain`, `>` and
|
|
34436
|
+
`<` (the HTML entities, literally); emptiness is the rule `[field, "empty", true]`
|
|
34437
|
+
and non-emptiness `[field, "empty", false]`. Checkbox values are `"T"` / `"F"` on
|
|
34438
|
+
SuiteBundle and SuiteApp 1.0 steps and boolean `true` / `false` on `suiteapp2.0` steps.
|
|
34526
34439
|
- |-
|
|
34527
|
-
|
|
34528
|
-
|
|
34529
|
-
|
|
34530
|
-
-
|
|
34440
|
+
The UI's value dropdown for a select field is NetSuite's own option list for that
|
|
34441
|
+
field on that record type, capped at the first 1,000 options alphabetically — a value
|
|
34442
|
+
missing from the dropdown can still exist in NetSuite. Read the list through the
|
|
34443
|
+
record-type metadata endpoint with `includeSelectOptions=true` before judging it.
|
|
34531
34444
|
skipExportFieldId:
|
|
34532
34445
|
type: string
|
|
34533
34446
|
description: |-
|
|
34534
|
-
ID of
|
|
34535
|
-
|
|
34447
|
+
Script ID of a checkbox body field on the record type. A save with that box checked is
|
|
34448
|
+
skipped by the listener, which then clears the box itself — used to keep a mass update
|
|
34449
|
+
from fanning out and to stop a write-back import from re-triggering the listener.
|
|
34536
34450
|
x-celigo-ai-guidance:
|
|
34537
34451
|
- |-
|
|
34538
|
-
|
|
34539
|
-
|
|
34540
|
-
excluded from export processes.
|
|
34541
|
-
It serves as a control mechanism to selectively omit data associated with
|
|
34542
|
-
particular fields during export operations,
|
|
34543
|
-
enabling tailored and efficient data handling.
|
|
34544
|
-
- |-
|
|
34545
|
-
## FIELD BEHAVIOR:
|
|
34546
|
-
- Acts as a flag or marker to skip exporting data associated with the specified field ID.
|
|
34547
|
-
- When set, the export routines will omit the data linked to this field from being included in the export payload.
|
|
34548
|
-
- Helps control and customize the export behavior on a per-field basis within distributed NetSuite configurations.
|
|
34549
|
-
- Does not affect data visibility or storage within NetSuite; it only influences export output.
|
|
34550
|
-
- Supports multiple uses in scenarios where sensitive, redundant, or irrelevant data should be excluded from exports.
|
|
34551
|
-
- |-
|
|
34552
|
-
## IMPLEMENTATION GUIDANCE:
|
|
34553
|
-
- Ensure the field ID provided corresponds to a valid and existing field within the NetSuite schema to prevent export errors.
|
|
34554
|
-
- Use this property to optimize export operations by excluding unnecessary or sensitive data fields, improving performance and compliance.
|
|
34555
|
-
- Validate the field ID format and existence before applying it to avoid runtime issues during export.
|
|
34556
|
-
- Integrate with export logic to check this property before including fields in the export output, ensuring consistent behavior.
|
|
34557
|
-
- Consider maintaining a centralized list or configuration of skipExportFieldIds for easier management and auditing.
|
|
34558
|
-
- |-
|
|
34559
|
-
## EXAMPLES:
|
|
34560
|
-
- skipExportFieldId: "custbody_internal_notes" (skips exporting the internal notes custom field)
|
|
34561
|
-
- skipExportFieldId: "item_custom_field_123" (excludes a specific item custom field from export)
|
|
34562
|
-
- skipExportFieldId: "custentity_sensitive_data" (prevents export of sensitive customer entity data)
|
|
34563
|
-
- |-
|
|
34564
|
-
## IMPORTANT NOTES:
|
|
34565
|
-
- This property only affects export operations and does not alter data storage or visibility within NetSuite.
|
|
34566
|
-
- Misconfiguration may lead to incomplete data exports if critical fields are skipped unintentionally, potentially impacting downstream processes.
|
|
34567
|
-
- Should be used judiciously to maintain data integrity and compliance with business rules and regulatory requirements.
|
|
34568
|
-
- Changes to this property should be documented and reviewed to avoid unintended data omissions.
|
|
34569
|
-
- |-
|
|
34570
|
-
## DEPENDENCY CHAIN
|
|
34571
|
-
- Depends on the existence and validity of the specified field ID within the NetSuite schema.
|
|
34572
|
-
- Relies on export routines to check and respect this property during data export processes.
|
|
34573
|
-
- May interact with other export configuration settings that control data inclusion/exclusion.
|
|
34452
|
+
For a bidirectional sync, have the write-back import set this checkbox to true in the
|
|
34453
|
+
same save: the listener skips that save and unchecks the box, breaking the loop.
|
|
34574
34454
|
hooks:
|
|
34575
34455
|
type: object
|
|
34456
|
+
description: SuiteScript hook that runs inside NetSuite before the record leaves it.
|
|
34576
34457
|
properties:
|
|
34577
34458
|
preSend:
|
|
34578
34459
|
type: object
|
|
34460
|
+
description: |-
|
|
34461
|
+
Pre-send hook: a SuiteScript function in the NetSuite file cabinet invoked before
|
|
34462
|
+
records leave NetSuite, with the full SuiteScript API available — for example to run
|
|
34463
|
+
dynamic searches against the record being exported.
|
|
34464
|
+
x-celigo-ai-guidance:
|
|
34465
|
+
- |-
|
|
34466
|
+
The hook's SuiteScript version must match the step's `frameworkVersion` (1.0 and
|
|
34467
|
+
2.x are not interchangeable); migrating a step to another version means rewriting
|
|
34468
|
+
the hook as a separate task.
|
|
34579
34469
|
properties:
|
|
34580
34470
|
fileInternalId:
|
|
34581
34471
|
type: string
|
|
34582
|
-
description: Internal ID of the file
|
|
34472
|
+
description: Internal ID of the file cabinet file that holds the hook's SuiteScript.
|
|
34583
34473
|
examples:
|
|
34584
34474
|
- '12345'
|
|
34585
34475
|
- '987654'
|
|
34586
|
-
- '1001'
|
|
34587
|
-
x-celigo-ai-guidance:
|
|
34588
|
-
- |-
|
|
34589
|
-
fileInternalId:
|
|
34590
|
-
The unique internal identifier assigned to a file within the NetSuite system.
|
|
34591
|
-
This identifier is essential for accurately referencing and manipulating a
|
|
34592
|
-
specific file during various operations such as retrieval,
|
|
34593
|
-
update, or deletion within NetSuite's environment.
|
|
34594
|
-
It acts as a primary key that ensures precise targeting of files in automated workflows,
|
|
34595
|
-
scripts, and API calls.
|
|
34596
|
-
- |-
|
|
34597
|
-
## FIELD BEHAVIOR:
|
|
34598
|
-
- Serves as a unique and immutable key to identify a file in the NetSuite file cabinet.
|
|
34599
|
-
- Utilized in pre-send hooks and other automation points to specify the exact file being processed or referenced.
|
|
34600
|
-
- Must correspond to an existing file's internal ID within the NetSuite account to ensure valid operations.
|
|
34601
|
-
- Enables consistent and reliable file operations by linking actions directly to the file's system-assigned identifier.
|
|
34602
|
-
- |-
|
|
34603
|
-
## IMPLEMENTATION GUIDANCE:
|
|
34604
|
-
- Always ensure the value is a valid integer that corresponds to an existing file's internal ID in NetSuite.
|
|
34605
|
-
- Validate the internal ID before performing any file operations to avoid runtime errors or failed transactions.
|
|
34606
|
-
- Use this ID when invoking NetSuite APIs, SuiteScript, or other integration points to fetch, update, or delete files.
|
|
34607
|
-
- Avoid hardcoding the internal ID; instead, dynamically retrieve it through queries or API calls to maintain adaptability and reduce maintenance overhead.
|
|
34608
|
-
- Handle exceptions gracefully when the ID does not correspond to any file, providing meaningful error messages or fallback logic.
|
|
34609
|
-
- |-
|
|
34610
|
-
## EXAMPLES:
|
|
34611
|
-
- 12345
|
|
34612
|
-
- 987654
|
|
34613
|
-
- 1001
|
|
34614
|
-
- |-
|
|
34615
|
-
## IMPORTANT NOTES:
|
|
34616
|
-
- The internal ID is system-generated by NetSuite and guaranteed to be unique within the account.
|
|
34617
|
-
- This ID is distinct from file names, external URLs, or folder identifiers and should not be confused with them.
|
|
34618
|
-
- Using an incorrect or non-existent internal ID will cause operations to fail, potentially interrupting workflows.
|
|
34619
|
-
- The internal ID remains constant for the lifetime of the file and does not change even if the file is moved or renamed.
|
|
34620
|
-
- |-
|
|
34621
|
-
## DEPENDENCY CHAIN:
|
|
34622
|
-
- Depends on the file existing in the NetSuite file cabinet prior to referencing.
|
|
34623
|
-
- Often used alongside related properties such as file name, folder ID, file type, or metadata to provide context or additional filtering.
|
|
34624
|
-
- May be required input for downstream processes that manipulate or validate file contents.
|
|
34625
|
-
- |-
|
|
34626
|
-
## TECHNICAL DETAILS:
|
|
34627
|
-
- Represented as an integer value assigned by NetSuite upon file creation.
|
|
34628
|
-
- Immutable once assigned; cannot be altered or reassigned to a different file.
|
|
34629
|
-
- Used internally by NetSuite APIs, SuiteScript, and integration
|
|
34630
34476
|
function:
|
|
34631
34477
|
type: string
|
|
34632
|
-
description:
|
|
34633
|
-
Name of the function invoked as the preSend hook. The function can validate
|
|
34634
|
-
or modify the payload before it is sent.
|
|
34478
|
+
description: Name of the function in that file to invoke for each export.
|
|
34635
34479
|
examples:
|
|
34636
|
-
-
|
|
34637
|
-
- sanitizePayloadBeforeSend
|
|
34638
|
-
- logPreSendActivity
|
|
34639
|
-
- customAuthorizationCheck
|
|
34480
|
+
- preSendCustomer
|
|
34640
34481
|
- enrichOrderDetails
|
|
34641
|
-
- checkInventoryAvailability
|
|
34642
|
-
x-celigo-ai-guidance:
|
|
34643
|
-
- '## DEPENDENCY'
|
|
34644
|
-
- |-
|
|
34645
|
-
function:
|
|
34646
|
-
> Specifies the name of the custom function to be executed as a pre-send hook
|
|
34647
|
-
within the NetSuite distributed system.
|
|
34648
|
-
This function is invoked immediately before sending data or requests,
|
|
34649
|
-
allowing for custom processing, validation,
|
|
34650
|
-
or modification of the payload to ensure data integrity and compliance with business rules.
|
|
34651
|
-
- |-
|
|
34652
|
-
## FIELD BEHAVIOR:
|
|
34653
|
-
- Defines the exact function to be called prior to sending data or requests.
|
|
34654
|
-
- Enables interception, inspection, and manipulation of data before transmission.
|
|
34655
|
-
- Supports integration of custom business logic, validation, enrichment, or logging steps.
|
|
34656
|
-
- Must reference a valid, accessible function within the current execution context or environment.
|
|
34657
|
-
- The function's execution outcome can influence whether the sending process proceeds, is modified, or is aborted.
|
|
34658
|
-
- |-
|
|
34659
|
-
## IMPLEMENTATION GUIDANCE:
|
|
34660
|
-
- Ensure the function name corresponds exactly to a defined function in the codebase, script environment, or registered hooks.
|
|
34661
|
-
- The function should accept the expected input parameters (such as the payload or context) and return appropriate results or modifications.
|
|
34662
|
-
- Implement robust error handling within the function to prevent unhandled exceptions that could disrupt the sending workflow.
|
|
34663
|
-
- Document the function's purpose, input/output contract, and side effects clearly for maintainability and future reference.
|
|
34664
|
-
- Validate that the function executes efficiently and completes promptly to avoid introducing latency or blocking the sending process.
|
|
34665
|
-
- If asynchronous operations are necessary, ensure they are properly awaited or handled to guarantee completion before sending.
|
|
34666
|
-
- Follow consistent naming conventions aligned with the overall codebase or organizational standards.
|
|
34667
|
-
- |-
|
|
34668
|
-
## EXAMPLES:
|
|
34669
|
-
- "validateCustomerData"
|
|
34670
|
-
- "sanitizePayloadBeforeSend"
|
|
34671
|
-
- "logPreSendActivity"
|
|
34672
|
-
- "customAuthorizationCheck"
|
|
34673
|
-
- "enrichOrderDetails"
|
|
34674
|
-
- "checkInventoryAvailability"
|
|
34675
|
-
- |-
|
|
34676
|
-
## IMPORTANT NOTES:
|
|
34677
|
-
- The function must be synchronous or correctly handle asynchronous behavior to ensure it completes before the send operation proceeds.
|
|
34678
|
-
- If the function throws an error or returns a failure state, it may block, modify, or abort the sending process depending on the implementation.
|
|
34679
|
-
- Avoid performing long-running or blocking operations within the function to maintain system responsiveness.
|
|
34680
|
-
- The function should not perform irreversible side effects unless explicitly intended, as it runs prior to data transmission.
|
|
34681
|
-
- Ensure the function does not introduce security vulnerabilities, such as exposing sensitive data or allowing injection attacks.
|
|
34682
|
-
- Consistent and clear error reporting within the function aids in troubleshooting and operational monitoring.
|
|
34683
34482
|
configuration:
|
|
34684
34483
|
type: object
|
|
34685
|
-
description: Settings
|
|
34686
|
-
x-celigo-ai-guidance:
|
|
34687
|
-
- |-
|
|
34688
|
-
configuration:
|
|
34689
|
-
> Configuration settings for the preSend hook in the NetSuite distributed system.
|
|
34690
|
-
This property defines the parameters and options that control the behavior and
|
|
34691
|
-
execution of the preSend hook,
|
|
34692
|
-
allowing customization of how data is processed before being sent.
|
|
34693
|
-
It enables fine-tuning of operational aspects such as retries, timeouts,
|
|
34694
|
-
validation rules, logging,
|
|
34695
|
-
and payload constraints to ensure reliable and efficient data transmission.
|
|
34696
|
-
- |-
|
|
34697
|
-
## FIELD BEHAVIOR:
|
|
34698
|
-
- Specifies the customizable settings that dictate how the preSend hook operates.
|
|
34699
|
-
- Controls data manipulation, validation, and preparation steps prior to sending.
|
|
34700
|
-
- Can include flags, thresholds, retry policies, timeout durations, logging options, and other operational parameters.
|
|
34701
|
-
- May be optional or mandatory depending on the specific implementation and requirements of the preSend hook.
|
|
34702
|
-
- Supports nested configuration objects to allow detailed and structured settings.
|
|
34703
|
-
- |-
|
|
34704
|
-
## IMPLEMENTATION GUIDANCE:
|
|
34705
|
-
- Define clear, well-documented configuration options that directly impact the preSend process.
|
|
34706
|
-
- Validate all configuration values rigorously to ensure they conform to expected data types, ranges, and formats.
|
|
34707
|
-
- Provide sensible default values for optional parameters to enhance usability and reduce configuration errors.
|
|
34708
|
-
- Ensure backward compatibility when extending or modifying configuration options.
|
|
34709
|
-
- Include comprehensive documentation for each configuration parameter, including its purpose, accepted values, and effect on hook behavior.
|
|
34710
|
-
- Consider security implications when allowing configuration of headers or other sensitive parameters.
|
|
34711
|
-
- |-
|
|
34712
|
-
## EXAMPLES:
|
|
34713
|
-
- `{ "retryCount": 3, "timeout": 5000, "enableLogging": true }`
|
|
34714
|
-
- `{ "validateSchema": true, "maxPayloadSize": 1048576 }`
|
|
34715
|
-
- `{ "customHeaders": { "X-Custom-Header": "value" } }`
|
|
34716
|
-
- `{ "retryPolicy": { "maxAttempts": 5, "backoffStrategy": "exponential" }, "enableLogging": false }`
|
|
34717
|
-
- `{ "payloadCompression": "gzip", "timeout": 10000 }`
|
|
34718
|
-
- |-
|
|
34719
|
-
## IMPORTANT NOTES:
|
|
34720
|
-
- Incorrect or invalid configuration values can cause the preSend hook to fail or behave unpredictably.
|
|
34721
|
-
- Thorough testing of configuration changes in development or staging environments is critical before deploying to production.
|
|
34722
|
-
- Some configuration changes may require restarting or reinitializing the hook or related services to take effect.
|
|
34723
|
-
- Sensitive configuration parameters should be handled securely to prevent exposure of confidential information.
|
|
34724
|
-
- Configuration should be version-controlled and documented to facilitate maintenance
|
|
34725
|
-
description: |-
|
|
34726
|
-
Hook invoked immediately before the payload is sent, allowing custom
|
|
34727
|
-
processing, modification, or validation.
|
|
34728
|
-
x-celigo-ai-guidance:
|
|
34729
|
-
- |-
|
|
34730
|
-
preSend is a hook function that is invoked immediately before a request is sent
|
|
34731
|
-
to the NetSuite API.
|
|
34732
|
-
It allows for custom processing, modification,
|
|
34733
|
-
or validation of the request payload and headers,
|
|
34734
|
-
enabling dynamic adjustments or logging prior to transmission.
|
|
34735
|
-
- |-
|
|
34736
|
-
## FIELD BEHAVIOR:
|
|
34737
|
-
- Executed synchronously or asynchronously just before the API request is dispatched to the NetSuite endpoint.
|
|
34738
|
-
- Receives the full request object, including headers, body, query parameters, and other relevant metadata.
|
|
34739
|
-
- Permits modification of any part of the request, such as altering headers, adjusting the payload, or changing query parameters.
|
|
34740
|
-
- Supports validation logic to ensure the request meets required criteria; throwing an error will abort the request.
|
|
34741
|
-
- Enables injection of dynamic data like authentication tokens, custom headers, or correlation IDs.
|
|
34742
|
-
- Can be used for logging or auditing outgoing request details for debugging or monitoring purposes.
|
|
34743
|
-
- |-
|
|
34744
|
-
## IMPLEMENTATION GUIDANCE:
|
|
34745
|
-
- Implement as a function or asynchronous callback that accepts the request context object.
|
|
34746
|
-
- Ensure that any asynchronous operations within the hook are properly awaited to maintain request integrity.
|
|
34747
|
-
- Keep processing lightweight to avoid introducing latency or blocking the request pipeline.
|
|
34748
|
-
- Handle exceptions carefully; unhandled errors will prevent the request from being sent.
|
|
34749
|
-
- Centralize request customization logic here to improve maintainability and reduce duplication.
|
|
34750
|
-
- Avoid side effects that could impact other parts of the system or subsequent requests.
|
|
34751
|
-
- Validate inputs thoroughly to prevent malformed requests from being sent to the API.
|
|
34752
|
-
- |-
|
|
34753
|
-
## EXAMPLES:
|
|
34754
|
-
- Adding a Bearer token or API key to the Authorization header dynamically before sending.
|
|
34755
|
-
- Logging the complete request payload and headers for troubleshooting network issues.
|
|
34756
|
-
- Modifying request parameters based on user roles or feature flags at runtime.
|
|
34757
|
-
- Validating that required fields are present and correctly formatted, throwing an error if validation fails.
|
|
34758
|
-
- Adding a unique request ID header for tracing requests across distributed systems.
|
|
34759
|
-
- |-
|
|
34760
|
-
## IMPORTANT NOTES:
|
|
34761
|
-
- This hook executes on every outgoing request, so its performance impact should be minimized.
|
|
34762
|
-
- Any modifications made within preSend directly affect the final request sent to NetSuite.
|
|
34763
|
-
- Throwing an error inside this hook will abort the request and propagate the error upstream.
|
|
34764
|
-
- This hook is strictly for pre-request processing and should not be used for handling responses.
|
|
34765
|
-
- Avoid making network calls or heavy computations inside this hook to prevent delays.
|
|
34766
|
-
- Ensure thread safety if the hook accesses shared resources or global state.
|
|
34767
|
-
- |-
|
|
34768
|
-
## DEPENDENCY CHAIN:
|
|
34769
|
-
- Invoked after request construction but before the request is dispatched.
|
|
34770
|
-
- Precedes any network transmission or retry
|
|
34771
|
-
description: Custom hook functions executed at defined points in the distributed export lifecycle.
|
|
34772
|
-
x-celigo-ai-guidance:
|
|
34773
|
-
- |-
|
|
34774
|
-
hooks:
|
|
34775
|
-
> A collection of user-defined functions or callbacks that are executed at
|
|
34776
|
-
specific points during the lifecycle of the distributed process within the
|
|
34777
|
-
NetSuite integration.
|
|
34778
|
-
These hooks enable customization and extension of the default behavior by
|
|
34779
|
-
injecting custom logic before,
|
|
34780
|
-
during, or after key operations,
|
|
34781
|
-
allowing for flexible adaptation to unique business requirements and integration scenarios.
|
|
34782
|
-
- |-
|
|
34783
|
-
## FIELD BEHAVIOR:
|
|
34784
|
-
- Contains one or more functions or callback references mapped to specific lifecycle events.
|
|
34785
|
-
- Each hook corresponds to a distinct event or stage in the distributed process, such as pre-processing, post-processing, error handling, or data transformation.
|
|
34786
|
-
- Hooks are invoked automatically by the system at predefined points in the workflow.
|
|
34787
|
-
- Can modify data payloads, trigger additional workflows or external API calls, perform validations, or handle errors.
|
|
34788
|
-
- Supports both synchronous and asynchronous execution models depending on the hook's purpose and implementation.
|
|
34789
|
-
- Execution order of hooks for the same event is deterministic and should be documented.
|
|
34790
|
-
- Hooks should be designed to avoid side effects that could impact other parts of the process.
|
|
34791
|
-
- |-
|
|
34792
|
-
## IMPLEMENTATION GUIDANCE:
|
|
34793
|
-
- Define hooks as named functions or references to executable code blocks compatible with the integration environment.
|
|
34794
|
-
- Ensure hooks are idempotent to prevent unintended consequences from repeated or retried executions.
|
|
34795
|
-
- Validate all inputs and outputs rigorously within hooks to maintain data integrity and system stability.
|
|
34796
|
-
- Use hooks to integrate with external systems, perform custom validations, enrich data, or implement business-specific logic.
|
|
34797
|
-
- Document each hook's purpose, expected inputs, outputs, and any side effects clearly for maintainability.
|
|
34798
|
-
- Implement robust error handling within hooks to gracefully manage exceptions without disrupting the main process flow.
|
|
34799
|
-
- Test hooks thoroughly in isolated and integrated environments to ensure reliability and performance.
|
|
34800
|
-
- Consider security implications, such as data exposure or injection risks, when implementing hooks.
|
|
34801
|
-
- |-
|
|
34802
|
-
## EXAMPLES:
|
|
34803
|
-
- A hook that validates transaction data before it is sent to NetSuite to ensure compliance with business rules.
|
|
34804
|
-
- A hook that logs detailed transaction metadata after a successful operation for auditing purposes.
|
|
34805
|
-
- A hook that modifies or enriches payload data during transformation stages to align with NetSuite's schema.
|
|
34806
|
-
- A hook that triggers email or system notifications upon error occurrences to alert support teams.
|
|
34807
|
-
- A hook that retries failed operations with exponential backoff to improve resilience.
|
|
34808
|
-
- |-
|
|
34809
|
-
## IMPORTANT NOTES:
|
|
34810
|
-
- Improperly implemented hooks can cause process failures, data inconsistencies, or performance degradation.
|
|
34484
|
+
description: Settings passed to the hook function.
|
|
34811
34485
|
sublists:
|
|
34812
34486
|
type:
|
|
34813
34487
|
- array
|
|
34814
34488
|
- 'null'
|
|
34489
|
+
description: |-
|
|
34490
|
+
IDs of the NetSuite sublists to include with each exported record (for example `item`
|
|
34491
|
+
for transaction line items). Records are exported with body fields only when no
|
|
34492
|
+
sublists are selected. Legacy documents may store null (equivalent to no sublists).
|
|
34815
34493
|
items:
|
|
34816
34494
|
type: string
|
|
34817
|
-
description: |-
|
|
34818
|
-
IDs of the NetSuite sublists to include with each exported record (for
|
|
34819
|
-
example `item` for transaction line items). Records are exported with
|
|
34820
|
-
body fields only when no sublists are selected. Legacy documents may
|
|
34821
|
-
store null (equivalent to no sublists).
|
|
34822
34495
|
examples:
|
|
34823
34496
|
- - item
|
|
34824
|
-
referencedFields:
|
|
34825
|
-
type: object
|
|
34826
|
-
description: Field identifiers referenced by the distributed export.
|
|
34827
34497
|
x-celigo-ai-guidance:
|
|
34828
34498
|
- |-
|
|
34829
|
-
|
|
34830
|
-
|
|
34831
|
-
|
|
34832
|
-
|
|
34833
|
-
|
|
34834
|
-
|
|
34835
|
-
|
|
34836
|
-
|
|
34837
|
-
## FIELD BEHAVIOR:
|
|
34838
|
-
- Contains identifiers of fields that the current field or process depends on or interacts with.
|
|
34839
|
-
- Used to establish explicit relationships or dependencies between multiple fields.
|
|
34840
|
-
- Enables tracking of data flow and ensures consistency across distributed systems.
|
|
34841
|
-
- Supports dynamic resolution of dependencies during runtime or configuration.
|
|
34842
|
-
- |-
|
|
34843
|
-
## IMPLEMENTATION GUIDANCE:
|
|
34844
|
-
- Populate with valid and existing field identifiers as defined in the NetSuite schema or metadata.
|
|
34845
|
-
- Verify that all referenced fields are accessible and correctly scoped within the current context.
|
|
34846
|
-
- Use this property to manage dependencies critical for data validation, synchronization, or processing logic.
|
|
34847
|
-
- Keep the list updated to reflect any schema changes to avoid broken references or inconsistencies.
|
|
34848
|
-
- Avoid circular references by carefully managing dependencies between fields.
|
|
34849
|
-
- |-
|
|
34850
|
-
## EXAMPLES:
|
|
34851
|
-
- ["customerId", "orderDate", "shippingAddress"]
|
|
34852
|
-
- ["invoiceNumber", "paymentStatus"]
|
|
34853
|
-
- ["productCode", "inventoryLevel", "reorderThreshold"]
|
|
34854
|
-
- |-
|
|
34855
|
-
## IMPORTANT NOTES:
|
|
34856
|
-
- Referenced fields must be unique within the list to prevent redundancy and confusion.
|
|
34857
|
-
- Modifications to referenced fields can impact dependent processes; changes should be tested thoroughly.
|
|
34858
|
-
- This property contains only the identifiers (names or keys) of fields, not their actual data or values.
|
|
34859
|
-
- Proper documentation of referenced fields improves maintainability and clarity of dependencies.
|
|
34860
|
-
- |-
|
|
34861
|
-
## DEPENDENCY CHAIN:
|
|
34862
|
-
- Often linked with fields that require validation or data aggregation from other fields.
|
|
34863
|
-
- May influence or be influenced by business rules, workflows, or automation scripts that depend on multiple fields.
|
|
34864
|
-
- Changes in referenced fields can cascade to affect dependent fields or processes.
|
|
34865
|
-
- |-
|
|
34866
|
-
## TECHNICAL DETAILS:
|
|
34867
|
-
- Data type: Array of strings.
|
|
34868
|
-
- Each string represents a unique field identifier within the NetSuite distributed environment.
|
|
34869
|
-
- The array should be serialized in a format compatible with the consuming system (e.g., JSON array).
|
|
34870
|
-
- Maximum length and allowed characters for field identifiers should conform to NetSuite naming conventions.
|
|
34499
|
+
Each selected sublist is an extra query inside the NetSuite save, so select only the
|
|
34500
|
+
sublists the flow maps. Qualification criteria cannot reference sublist fields
|
|
34501
|
+
regardless of this setting.
|
|
34502
|
+
referencedFields:
|
|
34503
|
+
type: object
|
|
34504
|
+
description: |-
|
|
34505
|
+
Field references recorded on the listener by the platform. Not exposed in the listener
|
|
34506
|
+
form; leave as stored.
|
|
34871
34507
|
relatedLists:
|
|
34872
34508
|
type: object
|
|
34873
|
-
description:
|
|
34874
|
-
|
|
34875
|
-
|
|
34876
|
-
relatedLists:
|
|
34877
|
-
A collection of related list objects that represent associated records or
|
|
34878
|
-
entities linked to the primary record within the NetSuite distributed data
|
|
34879
|
-
model.
|
|
34880
|
-
These related lists provide contextual information and enable navigation to connected data,
|
|
34881
|
-
facilitating comprehensive data retrieval and management.
|
|
34882
|
-
Each related list encapsulates a set of records that share a defined
|
|
34883
|
-
relationship with the primary record,
|
|
34884
|
-
such as transactions, contacts, or custom entities,
|
|
34885
|
-
thereby supporting a holistic view of the data ecosystem.
|
|
34886
|
-
- |-
|
|
34887
|
-
## FIELD BEHAVIOR:
|
|
34888
|
-
- Contains multiple related list entries, each representing a distinct association to the primary record.
|
|
34889
|
-
- Enables retrieval of linked records such as transactions, custom records, subsidiary data, or other relevant entities.
|
|
34890
|
-
- Supports hierarchical or relational data structures by referencing related entities, allowing nested or multi-level associations.
|
|
34891
|
-
- Typically read-only in the context of distributed data retrieval but may support updates or synchronization depending on API capabilities and permissions.
|
|
34892
|
-
- May include metadata such as record counts, last updated timestamps, or status indicators for each related list.
|
|
34893
|
-
- Supports dynamic inclusion or exclusion based on user permissions, record type, and system configuration.
|
|
34894
|
-
- |-
|
|
34895
|
-
## IMPLEMENTATION GUIDANCE:
|
|
34896
|
-
- Populate with relevant related list objects that are directly associated with the primary record, ensuring accurate representation of relationships.
|
|
34897
|
-
- Ensure each related list entry includes unique identifiers, descriptive metadata, and navigation links or references necessary for data access and traversal.
|
|
34898
|
-
- Maintain consistency in naming conventions, data structures, and field formats to align with NetSuite's standard data model and API specifications.
|
|
34899
|
-
- Implement pagination, filtering, or sorting mechanisms to efficiently handle large sets of related records within each list.
|
|
34900
|
-
- Validate all references and links to ensure data integrity, preventing broken or stale connections within the distributed data environment.
|
|
34901
|
-
- Consider caching strategies or incremental updates to optimize performance when dealing with frequently accessed related lists.
|
|
34902
|
-
- Respect and enforce access control and permission checks to ensure users only see related lists they are authorized to access.
|
|
34903
|
-
- |-
|
|
34904
|
-
## EXAMPLES:
|
|
34905
|
-
- A customer record's relatedLists might include "Transactions" (e.g., sales orders, invoices), "Contacts" (associated individuals), and "Cases" (customer support tickets).
|
|
34906
|
-
- An invoice record's relatedLists could contain "Payments" (payment records), "Shipments" (delivery details), and "Adjustments" (billing corrections).
|
|
34907
|
-
- A custom record type might have relatedLists such as "Attachments" (files linked to the record) or "Notes" (user comments or annotations).
|
|
34908
|
-
- A vendor record's relatedLists may include "Purchase Orders," "Bills," and "Vendor Contacts
|
|
34509
|
+
description: |-
|
|
34510
|
+
Related record lists recorded on the listener by the platform. Not exposed in the
|
|
34511
|
+
listener form; leave as stored.
|
|
34909
34512
|
forceReload:
|
|
34910
34513
|
type: boolean
|
|
34911
|
-
description:
|
|
34514
|
+
description: |-
|
|
34515
|
+
When true, the listener reloads the record from the database after the save before
|
|
34516
|
+
exporting it, so fields that are populated only once the save completes — such as
|
|
34517
|
+
transaction line IDs on new lines — are included. The reload slows every save of that
|
|
34518
|
+
record type.
|
|
34912
34519
|
x-celigo-ai-guidance:
|
|
34913
34520
|
- |-
|
|
34914
|
-
|
|
34915
|
-
|
|
34916
|
-
|
|
34917
|
-
- Implement robust error handling during the reload process to manage potential failures without causing system downtime or inconsistent states.
|
|
34918
|
-
- Monitor system resource utilization and response times when forceReload is active to identify and mitigate performance bottlenecks.
|
|
34919
|
-
- Document scenarios and triggers for using forceReload to guide developers and operators in its appropriate application.
|
|
34920
|
-
- |-
|
|
34921
|
-
## EXAMPLES:
|
|
34922
|
-
- forceReload: true
|
|
34923
|
-
(forces the system to bypass caches and reload data/configuration from the authoritative source immediately)
|
|
34924
|
-
- forceReload: false
|
|
34925
|
-
(allows the system to serve data from cache if available, improving response time)
|
|
34926
|
-
- forceReload omitted
|
|
34927
|
-
(defaults to false behavior, relying on cached data unless otherwise specified)
|
|
34928
|
-
- |-
|
|
34929
|
-
## FIELD BEHAVIOR:
|
|
34930
|
-
- When set to true, the system bypasses all caches and reloads data or configurations directly from the primary source, ensuring the latest state is retrieved.
|
|
34931
|
-
- When set to false or omitted, the system may utilize cached or previously stored data to optimize performance and reduce load times.
|
|
34932
|
-
- Primarily used in contexts where stale data could lead to errors, inconsistencies, or outdated processing results.
|
|
34933
|
-
- The reload operation triggered by this flag typically involves invalidating caches and refreshing dependent components or services.
|
|
34934
|
-
- |-
|
|
34935
|
-
## IMPORTANT NOTES:
|
|
34936
|
-
- Excessive or unnecessary use of forceReload can lead to increased latency, higher resource consumption, and potential service degradation.
|
|
34937
|
-
- This flag does not validate the correctness or integrity of the source data; it only ensures the latest available data is fetched.
|
|
34938
|
-
- Downstream systems or processes should be designed to handle the potential delays or transient states caused by forced reloads.
|
|
34939
|
-
- Coordination with cache invalidation policies and data synchronization mechanisms is essential to maintain overall system consistency.
|
|
34940
|
-
- |-
|
|
34941
|
-
## DEPENDENCY CHAIN:
|
|
34942
|
-
- Relies on underlying cache management and invalidation frameworks to effectively bypass stored data.
|
|
34943
|
-
- Interacts with data retrieval modules, configuration loaders, and possibly distributed synchronization services.
|
|
34944
|
-
- |-
|
|
34945
|
-
forceReload:
|
|
34946
|
-
Indicates whether the system should forcibly reload the data or configuration,
|
|
34947
|
-
bypassing any cached or stored versions to ensure the most up-to-date information is used.
|
|
34948
|
-
This flag is critical in scenarios where data accuracy and freshness are paramount,
|
|
34949
|
-
such as after configuration changes or data updates that must be immediately reflected.
|
|
34521
|
+
Leave false unless a field is missing from the exported payload that NetSuite fills
|
|
34522
|
+
in after submit (line IDs are the documented case); there is no published list of such
|
|
34523
|
+
fields.
|
|
34950
34524
|
ioEnvironment:
|
|
34951
34525
|
type: string
|
|
34952
|
-
description:
|
|
34526
|
+
description: |-
|
|
34527
|
+
integrator.io environment the listener's NetSuite deployment reports to. Written by the
|
|
34528
|
+
platform when the listener registers with NetSuite; live-observed values include
|
|
34529
|
+
`production` and `staging`.
|
|
34953
34530
|
examples:
|
|
34954
|
-
- development
|
|
34955
|
-
- staging
|
|
34956
34531
|
- production
|
|
34957
|
-
-
|
|
34532
|
+
- staging
|
|
34958
34533
|
x-celigo-ai-guidance:
|
|
34959
34534
|
- |-
|
|
34960
|
-
|
|
34961
|
-
|
|
34962
|
-
defining how data is handled, processed,
|
|
34963
|
-
and routed across different operational environments.
|
|
34964
|
-
This property determines the context in which I/O operations occur,
|
|
34965
|
-
influencing data flow, security protocols, performance characteristics,
|
|
34966
|
-
and consistency guarantees within the distributed architecture.
|
|
34967
|
-
- |-
|
|
34968
|
-
## FIELD BEHAVIOR:
|
|
34969
|
-
- Determines the operational context for all input/output processes within the distributed NetSuite system.
|
|
34970
|
-
- Influences how data is read from and written to various storage systems, message queues, or communication channels.
|
|
34971
|
-
- Affects performance tuning, security measures, and data consistency mechanisms based on the selected environment.
|
|
34972
|
-
- Typically set during system initialization or configuration phases and remains stable during runtime to ensure predictable behavior.
|
|
34973
|
-
- May trigger environment-specific logging, monitoring, and error-handling strategies.
|
|
34974
|
-
- |-
|
|
34975
|
-
## IMPLEMENTATION GUIDANCE:
|
|
34976
|
-
- Validate the ioEnvironment value against a predefined set of supported environments such as "development," "staging," "production," and any custom configurations.
|
|
34977
|
-
- Ensure that the selected environment is compatible with other system settings related to data handling, network communication, and security policies.
|
|
34978
|
-
- Implement robust error handling and fallback mechanisms to manage unsupported or invalid environment values gracefully.
|
|
34979
|
-
- Clearly document the operational implications, limitations, and recommended use cases for each environment option to guide system administrators and developers.
|
|
34980
|
-
- Coordinate environment settings across all distributed nodes to maintain consistency and prevent configuration drift.
|
|
34981
|
-
- |-
|
|
34982
|
-
## EXAMPLES:
|
|
34983
|
-
- "development" — used for local testing and debugging with relaxed security and simplified data handling.
|
|
34984
|
-
- "staging" — a pre-production environment that closely mirrors production settings for validation and testing.
|
|
34985
|
-
- "production" — the live environment optimized for security, performance, and data integrity.
|
|
34986
|
-
- "custom" — user-defined environment configurations tailored for specialized I/O requirements or experimental setups.
|
|
34987
|
-
- |-
|
|
34988
|
-
## IMPORTANT NOTES:
|
|
34989
|
-
- Changing the ioEnvironment typically requires restarting services or reinitializing connections to apply new configurations.
|
|
34990
|
-
- The environment setting directly impacts data integrity, access controls, and compliance with security policies.
|
|
34991
|
-
- Sensitive data must be handled according to the security standards appropriate for the selected environment.
|
|
34992
|
-
- Consistency across all distributed nodes is critical; all nodes should be configured with compatible ioEnvironment values to avoid data inconsistencies or communication failures.
|
|
34993
|
-
- Misconfiguration can lead to degraded performance, security vulnerabilities, or data loss.
|
|
34994
|
-
- |-
|
|
34995
|
-
## DEPENDENCY CHAIN:
|
|
34996
|
-
- Depends on system initialization and configuration management components.
|
|
34997
|
-
- Interacts with data storage modules, network communication layers, and security frameworks.
|
|
34998
|
-
- Influences logging, monitoring, and error
|
|
34535
|
+
Never author or change it. When updating from a GET that returned a value, carry it
|
|
34536
|
+
through unchanged; when the GET returned none, send none.
|
|
34999
34537
|
ioDomain:
|
|
35000
34538
|
type: string
|
|
35001
34539
|
description: |-
|
|
35002
|
-
integrator.io domain the
|
|
35003
|
-
|
|
34540
|
+
integrator.io domain the listener's NetSuite deployment calls back to — the account's
|
|
34541
|
+
own regional domain, stamped by the platform on every save and echoed on create and
|
|
34542
|
+
update responses; not returned by GET.
|
|
35004
34543
|
examples:
|
|
35005
|
-
-
|
|
35006
|
-
- distributed-services.companydomain.com
|
|
35007
|
-
- staging-netsuite.io.company.com
|
|
35008
|
-
- eu-west-1.api.netsuite.com
|
|
35009
|
-
- dev-networks.internal.company.com
|
|
34544
|
+
- integrator.io
|
|
35010
34545
|
x-celigo-ai-guidance:
|
|
35011
34546
|
- |-
|
|
35012
|
-
|
|
35013
|
-
|
|
35014
|
-
|
|
35015
|
-
distributed components and services,
|
|
35016
|
-
ensuring seamless communication and integration across the system.
|
|
35017
|
-
- |-
|
|
35018
|
-
## FIELD BEHAVIOR:
|
|
35019
|
-
- Defines the domain name utilized for network communication in distributed NetSuite environments.
|
|
35020
|
-
- Serves as the base domain for constructing URLs for API calls, data synchronization, and service endpoints.
|
|
35021
|
-
- Must be a valid, fully qualified domain name (FQDN) adhering to DNS standards.
|
|
35022
|
-
- Typically remains consistent within a deployment environment but can differ across environments such as development, staging, and production.
|
|
35023
|
-
- Influences routing, load balancing, and failover mechanisms within distributed services.
|
|
35024
|
-
- |-
|
|
35025
|
-
## IMPLEMENTATION GUIDANCE:
|
|
35026
|
-
- Verify that the domain is properly configured in DNS and is resolvable by all distributed components.
|
|
35027
|
-
- Validate the domain format against standard domain naming conventions (e.g., RFC 1035).
|
|
35028
|
-
- Ensure the domain supports secure communication protocols (e.g., HTTPS with valid SSL/TLS certificates).
|
|
35029
|
-
- Coordinate updates to ioDomain with network, security, and operations teams to maintain service continuity.
|
|
35030
|
-
- When migrating or scaling services, update ioDomain accordingly and propagate changes to all dependent components.
|
|
35031
|
-
- Monitor domain accessibility and performance to detect and resolve connectivity issues promptly.
|
|
35032
|
-
- |-
|
|
35033
|
-
## EXAMPLES:
|
|
35034
|
-
- "api.netsuite.com"
|
|
35035
|
-
- "distributed-services.companydomain.com"
|
|
35036
|
-
- "staging-netsuite.io.company.com"
|
|
35037
|
-
- "eu-west-1.api.netsuite.com"
|
|
35038
|
-
- "dev-networks.internal.company.com"
|
|
35039
|
-
- |-
|
|
35040
|
-
## IMPORTANT NOTES:
|
|
35041
|
-
- Incorrect or misconfigured ioDomain values can cause failed network requests, service interruptions, and data synchronization errors.
|
|
35042
|
-
- The domain must support necessary security certificates to enable encrypted communication and protect data in transit.
|
|
35043
|
-
- Changes to ioDomain may necessitate updates to firewall rules, proxy configurations, and network security policies.
|
|
35044
|
-
- Consistency in ioDomain usage across distributed components is essential to avoid routing conflicts and authentication issues.
|
|
35045
|
-
- Consider the impact on caching, CDN configurations, and DNS propagation delays when changing ioDomain.
|
|
35046
|
-
- |-
|
|
35047
|
-
## DEPENDENCY CHAIN:
|
|
35048
|
-
- Dependent on underlying network infrastructure, DNS setup, and domain registration.
|
|
35049
|
-
- Utilized by distributed service components for constructing communication endpoints.
|
|
35050
|
-
- May affect authentication and authorization workflows that rely on domain validation or origin verification.
|
|
35051
|
-
- Interacts with security components such as SSL/TLS certificate management and firewall configurations.
|
|
35052
|
-
- Influences monitoring, logging, and troubleshooting processes related to network communication.
|
|
35053
|
-
|
|
35054
|
-
##
|
|
34547
|
+
Never author it: the platform re-stamps the account's domain on save. Live-verified on
|
|
34548
|
+
one North America account, where a PUT that omitted it came back with that account's
|
|
34549
|
+
domain (`integrator.io`); other regions carry their own host.
|
|
35055
34550
|
lastSyncedDate:
|
|
35056
34551
|
type: string
|
|
35057
34552
|
format: date-time
|
|
35058
34553
|
description: |-
|
|
35059
|
-
|
|
35060
|
-
|
|
35061
|
-
examples:
|
|
35062
|
-
- '2024-06-15T14:30:00Z'
|
|
35063
|
-
- '2023-12-01T08:45:22Z'
|
|
35064
|
-
- '2024-01-10T23:59:59Z'
|
|
34554
|
+
When the listener's deployment last synchronized with NetSuite. Written by the platform;
|
|
34555
|
+
not set until the first successful synchronization.
|
|
35065
34556
|
x-celigo-ai-guidance:
|
|
35066
34557
|
- |-
|
|
35067
|
-
|
|
35068
|
-
|
|
35069
|
-
This timestamp is essential for monitoring the freshness, consistency,
|
|
35070
|
-
and integrity of synchronized data,
|
|
35071
|
-
enabling systems to determine whether updates or incremental syncs are necessary.
|
|
35072
|
-
- |-
|
|
35073
|
-
## FIELD BEHAVIOR:
|
|
35074
|
-
- Captures the exact date and time of the most recent successful synchronization event.
|
|
35075
|
-
- Automatically updates only after a sync operation completes successfully without errors.
|
|
35076
|
-
- Serves as a reference point to assess if data is current or requires refreshing.
|
|
35077
|
-
- Typically stored and transmitted in ISO 8601 format to maintain uniformity across different systems and platforms.
|
|
35078
|
-
- Does not reflect the start time or duration of the synchronization process, only its successful completion.
|
|
35079
|
-
- |-
|
|
35080
|
-
## IMPLEMENTATION GUIDANCE:
|
|
35081
|
-
- Record the timestamp in Coordinated Universal Time (UTC) to prevent timezone-related inconsistencies.
|
|
35082
|
-
- Update this field exclusively after confirming a successful synchronization to avoid misleading data states.
|
|
35083
|
-
- Validate the date and time format rigorously to comply with ISO 8601 standards (e.g., "YYYY-MM-DDTHH:mm:ssZ").
|
|
35084
|
-
- Utilize this timestamp to drive incremental synchronization logic, data refresh triggers, or audit trails in downstream workflows.
|
|
35085
|
-
- Handle cases where the field may be null or missing, indicating that no synchronization has occurred yet.
|
|
35086
|
-
- |-
|
|
35087
|
-
## EXAMPLES:
|
|
35088
|
-
- "2024-06-15T14:30:00Z"
|
|
35089
|
-
- "2023-12-01T08:45:22Z"
|
|
35090
|
-
- "2024-01-10T23:59:59Z"
|
|
35091
|
-
- |-
|
|
35092
|
-
## IMPORTANT NOTES:
|
|
35093
|
-
- This timestamp marks the completion of synchronization, not its initiation.
|
|
35094
|
-
- Do not update this field if the synchronization process fails or is incomplete.
|
|
35095
|
-
- Maintaining timezone consistency (UTC) is critical to avoid synchronization conflicts or data mismatches.
|
|
35096
|
-
- The field may be null or omitted if synchronization has never been performed.
|
|
35097
|
-
- Systems relying on this field should implement fallback or error handling for missing or invalid timestamps.
|
|
35098
|
-
- |-
|
|
35099
|
-
## DEPENDENCY CHAIN:
|
|
35100
|
-
- Depends on successful completion of the synchronization process between the system and NetSuite.
|
|
35101
|
-
- Influences downstream processes such as incremental sync triggers, data validation, and audit logging.
|
|
35102
|
-
- May be referenced by monitoring or alerting systems to detect synchronization delays or failures.
|
|
35103
|
-
- |-
|
|
35104
|
-
## TECHNICAL DETAILS:
|
|
35105
|
-
- Stored as a string in ISO 8601 format with UTC timezone designator (e.g., "YYYY-MM-DDTHH:mm:ssZ").
|
|
35106
|
-
- Should be generated programmatically at the moment synchronization completes successfully
|
|
34558
|
+
Never author or change it. When updating from a GET that returned a value, carry it
|
|
34559
|
+
through unchanged; when the GET returned none, send none.
|
|
35107
34560
|
settings:
|
|
35108
34561
|
type: object
|
|
35109
|
-
description:
|
|
35110
|
-
|
|
35111
|
-
|
|
35112
|
-
settings:
|
|
35113
|
-
> Configuration settings specific to the distributed module within the NetSuite integration,
|
|
35114
|
-
enabling fine-grained control over distributed processing behavior and performance optimization.
|
|
35115
|
-
- |-
|
|
35116
|
-
## FIELD BEHAVIOR:
|
|
35117
|
-
- Encapsulates a collection of key-value pairs representing various configuration parameters that govern the distributed NetSuite integration's operation.
|
|
35118
|
-
- Includes toggles (boolean flags), numeric thresholds, timeouts, batch sizes, logging options, and other customizable settings relevant to distributed processing workflows.
|
|
35119
|
-
- Typically optional for basic usage but essential for advanced customization, performance tuning, and adapting the integration to specific deployment environments.
|
|
35120
|
-
- Changes to these settings can dynamically alter the integration's behavior, such as retry logic, concurrency limits, and error handling strategies.
|
|
35121
|
-
- |-
|
|
35122
|
-
## IMPLEMENTATION GUIDANCE:
|
|
35123
|
-
- Define each setting with a clear, descriptive key name and an appropriate data type (e.g., integer, boolean, string).
|
|
35124
|
-
- Validate input values rigorously to ensure they fall within acceptable ranges or conform to expected formats to prevent runtime errors.
|
|
35125
|
-
- Provide sensible default values for all settings to maintain stable and predictable integration behavior when explicit configuration is absent.
|
|
35126
|
-
- Document each setting comprehensively, including its purpose, valid values, default, and impact on the integration's operation.
|
|
35127
|
-
- Consider versioning or schema validation to manage changes in settings structure over time.
|
|
35128
|
-
- Ensure that sensitive information is either excluded or securely handled if included within settings.
|
|
35129
|
-
- |-
|
|
35130
|
-
## EXAMPLES:
|
|
35131
|
-
- `{ "retryCount": 3, "enableLogging": true, "timeoutSeconds": 120 }` — configures retry attempts, enables detailed logging, and sets operation timeout.
|
|
35132
|
-
- `{ "batchSize": 50, "useSandbox": false }` — sets the number of records processed per batch and specifies production environment usage.
|
|
35133
|
-
- `{ "maxConcurrentJobs": 10, "errorThreshold": 5, "logLevel": "DEBUG" }` — limits concurrent jobs, sets error tolerance, and defines logging verbosity.
|
|
35134
|
-
- |-
|
|
35135
|
-
## IMPORTANT NOTES:
|
|
35136
|
-
- Modifications to settings may require restarting or reinitializing the integration service to apply changes effectively.
|
|
35137
|
-
- Incorrect or suboptimal configuration can cause integration failures, data inconsistencies, or degraded performance.
|
|
35138
|
-
- Avoid storing sensitive credentials or secrets in settings unless encrypted or otherwise secured.
|
|
35139
|
-
- Settings should be managed carefully in multi-environment deployments to prevent configuration drift.
|
|
34562
|
+
description: |-
|
|
34563
|
+
Additional key-value settings for the distributed export. Not exposed in the listener
|
|
34564
|
+
form.
|
|
35140
34565
|
useSS2Framework:
|
|
35141
34566
|
type: boolean
|
|
35142
34567
|
description: |-
|
|
35143
|
-
|
|
35144
|
-
|
|
35145
|
-
|
|
35146
|
-
creation-time-only constraint applies (see frameworkVersion).
|
|
34568
|
+
Derived by the platform from `frameworkVersion` — true when it is `suiteapp2.0`, absent
|
|
34569
|
+
otherwise — and echoed on create and update responses; not returned by GET. A value
|
|
34570
|
+
sent on create or update is replaced by the derived one.
|
|
35147
34571
|
x-celigo-ai-guidance:
|
|
35148
34572
|
- |-
|
|
35149
|
-
|
|
35150
|
-
the
|
|
35151
|
-
enabling modern scripting capabilities and modular architecture within the NetSuite environment.
|
|
35152
|
-
- |-
|
|
35153
|
-
## FIELD BEHAVIOR:
|
|
35154
|
-
- Determines if the SuiteScript 2.0 (SS2) framework is enabled for the NetSuite integration.
|
|
35155
|
-
- When set to true, the system uses SS2 APIs, modular script definitions, and updated scripting conventions.
|
|
35156
|
-
- When set to false or omitted, the system defaults to using SuiteScript 1.0 or legacy frameworks.
|
|
35157
|
-
- Influences script loading mechanisms, module resolution, and API compatibility within NetSuite.
|
|
35158
|
-
- |-
|
|
35159
|
-
## IMPLEMENTATION GUIDANCE:
|
|
35160
|
-
- This is an authoring-time choice: set it when creating the listener step (true unless the user explicitly needs a legacy version). It cannot be toggled on a saved step — moving an existing listener to a different framework version means recreating or cloning it.
|
|
35161
|
-
- Verify that the integrator.io SuiteApp is installed in the target NetSuite environment when authoring SuiteScript 2.0 steps.
|
|
35162
|
-
- When migrating by recreation, verify any SuiteScript hooks are written for the matching version before cutting over.
|
|
35163
|
-
- |-
|
|
35164
|
-
## EXAMPLES:
|
|
35165
|
-
- `useSS2Framework: true` — Enables SuiteScript 2.0 framework usage, activating modern scripting features.
|
|
35166
|
-
- `useSS2Framework: false` — Disables SuiteScript 2.0, falling back to legacy SuiteScript 1.0 framework.
|
|
35167
|
-
- Property omitted — Defaults to legacy SuiteScript framework (typically 1.0), maintaining backward compatibility.
|
|
35168
|
-
- |-
|
|
35169
|
-
## IMPORTANT NOTES:
|
|
35170
|
-
- Enabling the SS2 framework may require refactoring existing scripts to comply with SuiteScript 2.0 syntax, including the use of define/require for module loading.
|
|
35171
|
-
- Some legacy APIs, global objects, and modules available in SuiteScript 1.0 may be deprecated or behave differently in SuiteScript 2.0.
|
|
35172
|
-
- Performance improvements and new features in SS2 may not be realized if scripts are not properly adapted.
|
|
35173
|
-
- Ensure that all scheduled scripts, workflows, and integrations are reviewed for compatibility to prevent runtime errors.
|
|
35174
|
-
- Documentation and developer training may be necessary to fully leverage SuiteScript 2.0 capabilities.
|
|
34573
|
+
Never set this; `frameworkVersion` is authoritative. Live-verified: a PUT sending the
|
|
34574
|
+
opposite value came back with the value derived from `frameworkVersion`.
|
|
35175
34575
|
frameworkVersion:
|
|
35176
34576
|
type: string
|
|
35177
34577
|
enum:
|
|
@@ -36177,19 +35577,38 @@ components:
|
|
|
36177
35577
|
|
|
36178
35578
|
**Usage**
|
|
36179
35579
|
|
|
36180
|
-
|
|
36181
|
-
|
|
35580
|
+
In a flow test run, and for an upstream lookup during a page-processor preview
|
|
35581
|
+
(`previewPageProcessor`), integrator.io substitutes this mock output for the export's live
|
|
35582
|
+
response instead of calling the source. It is not substituted anywhere else: a target lookup
|
|
35583
|
+
in that preview runs its live query, `POST /v1/exports/preview` calls the source, and real
|
|
35584
|
+
runs ignore it. This allows you to:
|
|
36182
35585
|
- Test mappings with representative data
|
|
36183
35586
|
- Configure downstream flow steps without waiting for real data
|
|
36184
35587
|
- Simulate various data scenarios
|
|
36185
35588
|
|
|
35589
|
+
Where it is substituted, the records stand in for the RAW parsed response: the export's own
|
|
35590
|
+
`transform` and output `filter` still run on top of them, so downstream steps — and a
|
|
35591
|
+
lookup's results mapping — see the transformed, filtered records, not the shape stored here.
|
|
35592
|
+
|
|
36186
35593
|
**Limitations**
|
|
36187
35594
|
|
|
36188
35595
|
- Maximum of 10 records
|
|
36189
35596
|
- Maximum size of 1 MB
|
|
36190
35597
|
- Must follow the canonical format shown above
|
|
36191
35598
|
|
|
36192
|
-
Mock output can be populated automatically from preview data
|
|
35599
|
+
Mock output can be populated automatically from preview data (which is the parsed response,
|
|
35600
|
+
before `transform` / `filter`) or entered manually.
|
|
35601
|
+
x-celigo-ai-guidance:
|
|
35602
|
+
- |-
|
|
35603
|
+
Store the RAW parsed response records here, never transformed ones — the platform runs
|
|
35604
|
+
the export's `transform` and `filter` on the mock exactly as on live data, and a
|
|
35605
|
+
pre-transformed mock would be transformed twice. When you read `mockOutput` to learn
|
|
35606
|
+
what a lookup returns, apply the transform first; a results mapping authored against
|
|
35607
|
+
the stored shape walks paths that do not exist at runtime.
|
|
35608
|
+
- |-
|
|
35609
|
+
A saved mockOutput is read in exactly two places — a flow test run, and an upstream lookup
|
|
35610
|
+
during a page-processor preview. A target lookup's preview, `POST /v1/exports/preview` and
|
|
35611
|
+
every real run call the source and never read it.
|
|
36193
35612
|
properties:
|
|
36194
35613
|
page_of_records:
|
|
36195
35614
|
type: array
|