Configure Ingredient Nodes¶
Configure an ingredient node from the Node Editor.
You can also review the node files, and update the configurations in the File Editor.
Prerequisites¶
- The ingredient must be declared.
- The ingredient node needs to be included in a recipe graph.
- You need to know the ingredient you want to call in order to configure an ingredient node. Have the ingredient's kitchen, recipe, variation, and name ready.
- The following is required to use ingredient nodes:
- An ingredient node must reside in the same customer account as the ingredient it calls.
- If an ingredient node calls an ingredient that resides in a different kitchen, the user configuring the node and any user running the node or its variation must also have access to the ingredient's kitchen.
Configure a node¶
- Navigate to the Node Editor.
- Select a tab to configure the ingredient node.
Required fields are marked with an * asterisk.
Ingredient tab¶
- Select the Kitchen and the Ingredient variation to run in this node.
- Only kitchens you are authorized to access appear in the Kitchen list.
- The Ingredient list groups ingredients by recipe, so any duplicated ingredient names can appear.
- The system references the
ingredient-definitionvalue in the ingredient variation'svariation.jsonfile and stores it as theingredient-namein this node'snotebook.json. These values must be kept in sync for the ingredient to work.
- Review the ingredient summary information and graph.
- Optional. Use the Edit Ingredient Variation link to make changes to the underlying ingredient. Be aware that changes to the ingredient may affect other processes dependent on that ingredient.
- Select Add notes for changelog , describe the changes, then click Update.
Configuration tab¶
Changes to the Configuration tab are optional and don't need to be made to use an ingredient node. Default values are described below.
- Select the Configuration tab.
- Change the Poll Interval so the ingredient node checks more or less often for the completion of the ingredient's processing.
- The default interval is 5 seconds.
- This value also sets the polling frequency for the system to check for new log information from the ingredient order run, for up to 60 seconds.
- Modify the Timeout Duration as needed to control the amount of time the ingredient node will allow the ingredient to run.
- The default duration is 600 seconds (10 minutes).
- Enter values, or select
variables or
secrets, for any Inflowing Variables required by the ingredient variation.
- The default entries in this section are the active values of the variables in the ingredient variation.
- See Inflowing Variable Validations for more information.
- If present, review the Outflowing Variables configured in the ingredient variation.
- Select Add notes for changelog , describe the changes, then click Update.
Tests tab¶
Create data verification tests as needed. These tests run after the ingredient is executed.
- Select the Tests tab.
- Click Add Test.
-
Click Copy next to a test to duplicate its configuration within the node.
Adjust the configuration to make the new test or step unique.
-
Click Delete to remove a test from the node.
- Select Add notes for changelog , describe the changes, then click Update.
For technical details on test properties, see Test Declaration and Test Properties.