Create a recipe in Data Connect
This article describes how to create a recipe in Data Connect.
To enable Data Connect and begin creating and managing recipes, contact your Tealium Customer Success Manager.
Complete the following steps to create a recipe:
-
Navigate to DataConnect > Integrations.
-
In the Integrations screen, click Create > Recipe.
-
In the My new recipe slideout, enter a name for the recipe and select the profile associated with the recipe.
-
Under Pick a starting point, select how you want to trigger your app in Workato.
- Select Run on a schedule to build a recipe that runs on a schedule for your business case.
- Select Trigger from an App to build a recipe that periodically polls the source system for new data.
For more information about Workato triggers, see the Triggers article in the Workato Recipe Components documentation. To see which triggers are available for your app, read the app-specific document in the Pre-built Connectors documentation.
-
Click Start building.
Build a recipe
Now you can start building your recipe in Workato. Generally, your recipes will follow a specific workflow:
Step 1: Select a trigger
App-based triggers
Search for the app you want to integrate into Tealium. For schedule-based recipes, the trigger is the schedule that you configure.
-
In the Trigger step, choose the trigger for your business case.
Use batch processing when available to reduce the number of tasks per recipe.
-
In the Connection step, connect to your app. Enter a connection name and complete the configuration. Click Connect.
-
In the Setup step, add any additional configurations for this app trigger. Set a trigger condition if you want to set a more specific trigger.
Step 2: Configure an action
-
Under Actions click +.
-
Under What happens next? select Handle errors.
We recommend wrapping the Tealium Events app and related actions in an error monitoring step.Ensure you complete Step 3 to finish configuring error handling in your recipe. If you do not stop the recipe as described in Step 3, automatic error notifications will not work.
-
Select any apps you need to prepare the data to be imported to Tealium. For example, use the Download file contents in Amazon S3, Decrypt and verify data, and Parse CSV apps together to prepare encrypted CSV data stored in an Amazon S3 bucket.
-
(Optional) If your data payload size exceeds 500 records, use the Repeat action loop with the Tealium Events app to break your data into smaller payload sizes.
To use this loop:- Click the + to see a list of actions.
- Click Repeat action.
- Set the loop Repeat mode to Batch of items.
- Set the Batch size to the maximum batch size for your app.
-
Under Select an app and action, select the Tealium Events V2 app.
-
Enter the information from your Tealium Connect data source.
- Tealium Connect API Domain - Enter the regional Tealium Collect API domain used in your Tealium Connect data source.
- Data Source Key - Enter the data source key from your Tealium Connect data source.
- Tealium Account Name and Tealium Profile Name - Enter your Tealium account name and profile name in the corresponding fields.
A single account may have multiple corresponding profiles. Specify the Tealium profile to which you want to send events from this recipe.
-
In the Source Data section, add your source data to the app.
-
Source Data source list - Select the datapill(s) from the Recipe data slideout that represent data to send to Tealium. You can insert batched data from the Recipe data slideout.
-
Visitor ID Value - Select a datapill for the visitor ID value.
- If you are stitching to a known user identifier using a Visitor ID attribute: Select the datapill in your recipe that contains the value of the user identifier. Enter the corresponding visitor attribute ID in the Visitor Attribute ID field. You must set up enrichments for any visitor ID attributes you want to be set for events from the recipe. For more information, see Visitor ID attribute enrichment for Tealium Connect.
- If you are importing data based on an anonymous identifier: Select the datapill in your recipe that contains the anonymous identifier. Leave the Visitor Attribute ID field empty. This value directly sets the
tealium_visitor_id
.
-
Visitor Attribute ID - This numeric value assists in matching the
tealium_visitor_id
to an existing visitor ID attribute. For example_{Account}_{Profile}_{Visitor Attribute ID}_{Visitor ID Value}_
.- If you are stitching to a known user identifier using a visitor ID attribute: Enter the visitor attribute ID. Navigate to AudienceStream > Visitor/Visit Attributes, select the visitor attribute you want to use, and copy the attribute ID to your Tealium Events app in Workato. For more information, see Attribute IDs.
- If you are importing data based on an anonymous identifier: Leave this field empty.
-
Attributes to add - Expand the Attributes to add section. Specify the key and value for each event attribute in the event Workato sends to Tealium.
Ensure your Attributes to add contain fields with unique names, ignoring case.
Tealium processes all event field names in lowercase.- Any data from your recipe that you do not add here is not sent to Tealium.
- For the key, use the Text input to type the desired event attribute name.
- For the value, use the Text input to hardcode an event attribute value or create a value from a datapill.
- Use this feature to edit key names to match existing Tealium configurations to minimize additional work for new attributes, enrichments, and/or rules.
- To create an event specification, add a
tealium_event
value in this section. - (Optional) Add any additional attributes you want to send to Tealium that are not necessarily from your app. For example,
tealium_event
, yourtealium_trace_id
, or_dc_ttl_
, which describes how long the visit will last.When using
tealium_trace_id
for debug purposes, you cannot send more than five events in one batch.
-
-
(Optional) Select whether to enable Hash Visitor ID. If your use case requires visitor ID hashing, click Show optional fields, and enable Hash Visitor ID.
- If you defined the Visitor Attribute ID previously and you want to apply SHA-256 hashing to the constructed
tealium_visitor_id
, select Yes. For most purposes, you set this value to No. - If you want to apply SHA-256 hashing to the value of the visitor ID attribute you are stitching with, use the Workato
encode_sha256
function in the Visitor ID Value field.
- If you defined the Visitor Attribute ID previously and you want to apply SHA-256 hashing to the constructed
Step 3: Configure error handling
- Click the On Error step.
- Under Retry actions in Monitor block?, choose whether to retry actions.
- Add a log message to the job report.
- Click the + to add an additional action to fire when an error occurs.
- Click Action in an app and select the Logger by Workato app.
- Configure the message for the logs.
- Stop the recipe.
- Click the + to add an additional action when an error occurs.
- Click Action in an app and select the ReceipeOps by Workato app.
- Select the Stop a recipe action.
- Under Whose account are you managing?, select My account.
- Click Connect.
- In the Setup step, select the current recipe name from the Recipe drop down list.
- Select Yes from the Force stop drop-down list.
- Stop the current job.
- Click the final + in your recipe to add an additional action when the error occurs.
- Click Stop job.
- Under In job report, mark stopped job as, select Failed in the drop down list.
- Under Reason for failure, type Error.
- Click Save.
- Click Test to test your recipe configuration.
To test the error handling, temporarily change the Tealium Connect API Domain setting in the Tealium Events V2 app to a domain that doesn’t exist. For example, temporarily change the domain to xcollect-eu-west-1.tealiumiq.com
, test the error handling, and then change the domain back to collect-eu-west-1.tealiumiq.com
when your testing is complete.
This page was last updated: August 9, 2023