Update Node Output

Each Script Node in BuildShip has the following configurations:

• Node Logic: The core functionality of the node.
• Inputs: The input parameters required by the node.
• Output: The output schema defining the structure of the data returned by the node.
• Info: Additional information or metadata about the node.

The Output configuration tab allows you to define the structure of the output generated by the node. This output configuration makes it easier for users to access the specific values being returned from the node without using complex dot notations.

For example, if a node returns a JSON object with the following structure:

{
  "content": "This is some content.",
  "metadata": {
    "author": "John Doe",
    "timestamp": "2023-04-01T12:00:00Z"
  }
}

The output configuration can be set to expose the content, metadata.author, and metadata.timestamp properties directly, allowing users to access them in subsequent nodes without using dot notation like nodeOutput.metadata.author.

Auto-Updating Node Output

When building or customizing a node, you can automatically update the output schema based on the actual output generated by the node logic. Here are the steps to auto-update the node output:

1. Open the node editor and make any necessary changes to the node logic.
2. Click the "Test Node" button to execute the node and view its output.
3. In the output section, you should see an option to "Update Output Schema". Click this button.
4. The output configuration tab will be updated with the schema of the output generated by the node logic.

By auto-updating the output schema, you ensure that the output configuration accurately reflects the structure of the data returned by the node. This allows you to use the different or nested outputs returned by the node in subsequent nodes directly from the context menu, as shown in the image below.