Run Recipe
All recipes run as the logged in user or selected service account. Yuniter DOES NOT grant any additional permissions or access to any products or endpoints used in the recipe.
Creating A Recipe Workflow
Recipes can be manual, initiated by the user and run only once, or scheduled, running at set times on set days. Other than the schedule, all steps are the same.
- Visit the Recipe page and click on
- Name the recipe, the name is often used to create assets such as Sheets and Dataset by some recipes, choose the name to reflect an account or client. Select the Groups the recipe belongs to and give it an optional description.
- Select the Ingredients you wish to add to the end of the recipe by checking the checkbox at the top right corner. Do add further instances of the same ingredient click on the button.
- For scheduled recipes, turn on the scheduler and choose how often the recipe is supposed to run.
- Each task has a card with its own instructions, inputs, and fields. Fields are marked optional or required. Some have default values. All values are derived from the API endpoints for that product.
- Click Save, the recipe is now ready to run, and will run on schedule.
- Click Run to execute the recipe immediately, if workers are busy there may be a delay. You can hit the refresh button to update the job status and logs.
- Click Log to view recipe task events including errors and completes.
Job Status
Each task in a recipe workflow is executed in sequence one at a time. Some recipes have tasks executing at different times, and some tasks executing multiple times a day. Job status is updated automatically by workers as the job is processed.
Status | Definition | Action |
Queued | The recipe is waiting for workers to pick up the next task. | Wait for the next scheduled task to execute. If workers are busy, the next tasks may be executed after their scheduled time. |
Running | A task in the recipe is currently executing. | Wait for the task to execute or cancel a running recipe. Check the logs to see which task is running and see real time task updates. |
Finished | All tasks in the recipe were completed without error. | The task will resume again the next day as controlled by its scheduler setting. |
Stopped | No tasks in the recipe will be run. | Unpause the recipe to restart execution. |
Timeout | The task exceeded its 8 hour limit for execution and was terminated. | Check the logs, Edit the task to process less data and complete sooner. Some timeouts may be acceptable, for example a report was not ready, typically these tasks are scheduled multiple times in a workflow and eventually work. |
Error | The task failed to execute. The error will be printed in the log, usually near the bottom for that task. | Correct the error, and click Run Now to re-execute the recipe. Alternatively some errors may be acceptable, for example, a task may run multiple times a day, returning errors until eventually one execution works. |
User Management
Roles
Yuniter enables users to establish distinct roles and allocate individuals to assist in overseeing access privileges, thereby facilitating effective management of permissions.
Groups
Yuniter enables users to be affiliated with various groups, granting individuals within the same group the ability to access and view each other’s recipes.
Users
Users can be created within the organization, and customized roles can be assigned to each user.
Warnings
Yuniter will do what you tell it to. IT RUNS AS YOU, if you have access it will do it, be careful about overwriting, creating, sharing, or deleting data. Double check everything before running tasks. Undo is not a feature.
DATASETS ARE NOT DELETED when a recipe is deleted.
- You will have to manually delete the dataset.
- You will have to verify the dataset contains what you want before sharing.
Changing DBM / DCM report definition requires delete of report.
- You will have to go into DBM / DCM and delete the report.
- Yuniter will then create the new report definition.
BigQuery views are not modified by Yuniter if they exist.
- This is to protect any customizations you may have added.
- You will have to delete the view for Yuniter to recreate it
All tasks in a recipe are executed, even if ones prior fail.
- This allows retries of the same task later in the day.
- For mission critical data flows, check your data before acting on it.
All errors and fields come from the API documentation.
- When looking for field values or formats consult the appropriate API documentation.
- When errors are thrown, the log shows them, consult the API documents to resolve the error.
Debugging
Errors in Yuniter can range from a misconfigured field value to a bug in the code. To promptly resolve most issues please follow these debugging steps.
When working with Yuniter administrators, please include the recipe name and author, found in the Recipes Page, in all communications.
- Consult the log and reference the error in the API documentation relevant to the product used in the task.
- Try logging out and logging back in to refresh user credentials and access to APIs.
- Contact the administrator of the Yuniter UI where the recipe was deployed.
- Contact the owner of the solution listed on the Solution Gallery Page.
- Contact yuniterform@stacktics.com