Export To vPlan

The Export To vPlan node provides a direct way to send data from a dataflow to the vPlan API. It connects to all available vPlan API endpoints, including orders, activities, boards, resources, statuses, and custom entities, making it possible to create, update, or delete almost any type of data stored in vPlan. The integration is continuously maintained to stay compatible with new and updated vPlan API endpoints.

Configuration

Setting	Type	Required	Description
Connection	Select	No	An existing connector, such as an OAuth 2.0 or API key-based connection.
Advanced	Button	Yes	Opens the configuration window for entity mappings, operations, fields, and output behavior.
Entity library	Select	Yes	Defines which version of the entity model to use (e.g. Legacy or Latest).
Preload Entities	Checkbox	No	See below.
Update Policy	Select	No	See below.

Preload Entities

Determines how existing records are retrieved when the node needs to perform operations such as CreateOrUpdate.

When enabled, the system retrieves existing entities in advance, before processing the input data. Entities are fetched in pages and cached for reuse during execution: this reduces the number of required API calls compared to checking each input record individually, and preloading stops fetching further pages as soon as all required entities have been found.

• Disabled → one API call per input record.
• Enabled → entities are fetched in bulk (paged), reducing total API calls. Recommended for larger incoming datasets.

Update Policy

Defines how the node determines whether an update should be sent to vPlan.

• Full (default): an update is always performed for each processed record, regardless of whether the data has changed. A PUT API call is sent to vPlan for every record, even if all mapped field values are identical to the existing entity. Ensures data consistency but may result in unnecessary API calls.
• Changes Only: the node first retrieves the existing entity from vPlan and compares the mapped fields with the incoming data. An update is only performed if at least one mapped field differs. Reduces the number of API calls and improves performance, especially with large datasets that see minimal changes.

Export configuration

Setting	Type	Description
Entity	Select	The vPlan entity type to export, such as Card, Order, Collection, Project, Activity, or Resource.
Operation	Select	The export action, such as Create, Update, Update or Create, or Delete, depending on the selected entity.
Output	Tab	Displays the API response after the export operation. Useful for debugging and retrieving new IDs.
Column Mapping	Table	Maps incoming Datahub fields to the corresponding vPlan API fields required for the selected entity and operation.

Supported operations

Action	Description
Create	Creates a new record in vPlan.
Update	Updates an existing record using its id or external_ref.
Update or Create	Updates a record if it exists; otherwise creates it automatically.
Delete	Deletes an existing entity in vPlan.

Errors & troubleshooting

Error message	Meaning	Solution
401 Unauthorized	Invalid or expired API key.	Verify your connection configuration.
404 Not Found	The specified entity or endpoint does not exist.	Check the entity name and library version.
400 Bad Request	Invalid request payload or missing fields.	Validate mappings and required fields.
Rate Limit Exceeded	Too many API requests.	Batch your export or reduce frequency.

Example flow

1. Time Trigger: the flow starts on a scheduled interval.
2. Production Order Import (SQL): retrieves the latest production orders from the database.
3. Compare Node (New or Changed Detection): compares current results with previously stored results, identifying new orders and orders with modified fields.
4. Not Empty Check: ensures only new or changed records continue.
5. Export to vPlan: only new or updated production orders are sent to vPlan to be created or updated.

Tips

• Validate incoming data (e.g. date formats, required fields) using a Query node before exporting.
• Use Update or Create for system synchronizations to ensure stable incremental updates.
• Keep external_ref stable and unique: this is the most reliable identifier for linking systems.
• Filter out unchanged or duplicate data before exporting to prevent unnecessary updates.
• When exporting large datasets, use batching or delays to prevent vPlan rate limits.
• When using Update Policy, prefer Changes Only to minimize payload size and avoid overwriting unchanged fields.