Learn about the Recipe Details Page in Kantata Connect.
Overview
The Recipe Details page is where you can view important recipe data and perform recipe actions such as starting/stopping a recipe, cloning a recipe, and more. From here, you can also access the Recipe Editor page, where you can edit your recipe’s configurations.
To learn more about building a recipe, see the Creating a Recipe in Kantata Connect article.
The Recipe Details page consists of 6 tabs:
- Recipe—Contains a recipe’s workflow summary as well as recipe data.
- Jobs—Contains a log of the recipe’s jobs—which is a single instance of a workflow occurring–that you can filter, view, export, and more.
-
Connections—Displays the connection this recipe is associated to.
Note: A recipe can be associated to multiple connections.
- Versions—Contains a log of the different recipe versions.
- Test Cases—Allows you to create a test case to confirm the recipe is functioning correctly.
- Settings—Contains recipe settings, including concurrency limits and sharing options.
Top Bar
The recipe top bar houses the recipe’s location pathway, title, and actions. This bar remains accessible at the top of the page at all times, keeping the actions conveniently available regardless of which tab you’re currently viewing.
The left side of the bar displays the recipe’s location pathway and the title. Click the Edit
icon to the right of the title to update it.The right side of the top bar contains the recipe actions:
- Edit recipe—Open the recipe editor where you can build or modify a recipe.
-
Start/Stop recipe—Start or stop the recipe. This button name will vary depending on if the recipe is currently active or inactive.
Note: When you start a recipe, it’s continuously active in the background, allowing recipe steps to activate when a trigger event occurs. If you stop and then restart a recipe, it will proceed with the last step it was on when it was stopped.
- Test recipe—Test the recipe.
- Clone—Clone the recipe.
-
Delete—Delete the recipe
Note: Deleted recipes are moved to the Trash folder but can be restored within 30 days of being deleted if needed.
Recipe Tab
The Recipe tab contains a summary of the recipe’s configurations and additional recipe data.
The panel on the right contains the following information:
- Recipe status (Active or Inactive).
- Number of successful and failed jobs.
- Location—or project—this recipe is currently located in.
- Date and time the recipe was most recently started/stopped.
- Number of dependencies.
- Recipe description.
- Latest recipe activity.
Jobs Tab
The Jobs tab contains a log of the recipe’s jobs. A job is a single instance of the recipe running, and a report is generated after each one occurs that contains more detailed information and data.
Use the top section of this tab to search for jobs and filter the list by job status, job type, or time period. To export the job list to a CSV file, click the More
icon and then select Export job report.To repeat or cancel jobs in bulk, select the checkbox next to each job and then click either the Repeat [#] job or Cancel [#] job button above the list.
The panel on the right side of the Jobs tab contains the following information and actions:
- Countdown to when the system will check for the next job.
- An option to manually check for the next job.
- Current number of successful and failed jobs.
- Recent job activity chart for the past 7 days.
Note: Hover over a bar in the activity chart to see the activity summary for that day.
Select a job in the list to open the Job Report Details page. Here you can view information such as the job ID, description, duration, and the number of tasks used. If the job has a Failed status, this page displays error data to better help you troubleshoot.
Connections Tab
The Connections tab displays the connections this recipe is currently using. You can replace the connection with another one by clicking the Switch button or disconnect it via the Disconnect button located under the Connection name field.
Versions Tab
The Versions tab is where you can find a list of each version of the recipe. A new version is created whenever the recipe is updated and saved. You can quickly locate the current recipe version via the Current tag in the Version column.
Use the top section of this tab to search for a specific version and filter the list by time period, change type, or collaborators. Under the Comments tab in the version list, you can click Add comment to the right of a version and add any applicable comments (e.g. describing the changes that were made).
To compare recipe versions, select the checkbox next to the two versions you want to compare and then click the Compare V[#] and V[#] button above the list.
Click on a version to open the Version Details page. From here, you can see the recipe version in its entirety, compare it to the current version, or restore the recipe to this version.
Test Cases Tab
In the Test Cases tab, you can create a test case to validate that the recipe is functioning as expected and check for any potential issues in the current configurations.
Settings Tab
In the Settings tab, you can adjust the maximum concurrency limit, which is the maximum number of jobs that are allowed to run at the same time.
In the Sharing subtab, you can generate a link that will allow anyone with a Kantata Connect account to view and use this recipe.
Comments
0 comments
Please sign in to leave a comment.