Introduction
KNIME Community Hub is a KNIME-managed Hub instance.
It is a central place to collect the common knowledge base among the KNIME Community and it has search functionalities as well as collaboration capabilities.
On KNIME Community Hub you can search for nodes, extensions, components, and workflows made available by the community.
You can use these as blueprints and building blocks in KNIME Analytics Platform, and build workflows to solve your data science use cases.
KNIME Hub can also be used to upload and organize workflows in a central place, and to collaborate with other users on your projects.
Via KNIME Hub you can:
-
Find workflows, components uploaded by KNIME Community
-
Upload and organize your workflows and components in projects
-
Create and manage projects
-
Collaborate with other users on your projects
Search items and use them in KNIME Analytics Platform
You can find the KNIME Community Hub at the following address:
In the browser, you will access the KNIME Hub home page shown in Figure 1.
Search
Insert a keyword in the search bar to search among the following items publicly shared by the KNIME Community:
-
Nodes
-
Components
-
Workflows
-
Extensions
-
Collections
Press Enter to visualize the results.
You will see a list of all the search results in tiles, with:
-
An icon indicating if they are nodes, components, workflows or extensions
-
The title
-
Wether it is a draft or a versioned item (for components and workflows)
Find out more about versioning a workflow or a component in the versioning section. -
Tags, when available
-
A preview of the description, when available
-
The owner icon for workflows, and extensions
-
The icon, for nodes and components
On top of the search results list, you can filter the results to list only nodes, components, workflows, and extensions, by clicking the respective tab, shown in Figure 2.
Click on a search result to access the relative page.
When searching for workflows and components, the items that have been versioned will show up higher in rank than draft-only items. This ensures you to be able to easier find versioned workflows and components when searching on KNIME Hub.
Nodes
On the node page you will find:
-
The node function, name, and tags
-
The node owner
-
The node drag & drop element: You can drag & drop the element into the Workflow Editor of KNIME Analytics Platform to use the node directly to build a workflow or a component. See the Drag & drop section for more details on this feature.
-
The node likes (see the Likes section for more details on this feature) and a link icon to copy the node short link.
For each node you can also find:
-
An Overview with a description of the node functionality
-
Node details where you can see information about Input and Output node ports, a description of the additional Options, and, when available, the Views that the node is able to produce
-
In the section Extension, you can see the node extension and the extension owner
-
Finally, in the section Related workflows & nodes you are provided with:
-
Workflows that are available on KNIME Hub and that contain the node
-
When available, the Outgoing nodes, that are the most popular nodes to follow the node when building a workflow.
-
Components
Since components really are KNIME nodes that you create which bundle functionality, have their own configuration dialog and their own composite views, also in the component page you will find similar information as for nodes.
-
The component name and last edit date
-
The component owner
-
The component drag & drop element: You can drag & drop the element into the Workflow Editor of KNIME Analytics Platform to use the component directly to build a workflow. See the Drag & drop section for more details on this feature.
-
The component likes (see the Likes section for more details on this feature), the count of downloads, and a link icon to copy the component short link.
For each component you can also find:
-
An Overview with a description of the component functionality, when provided by the component owner
-
Component details where you can see information about Input and Output component ports, a description of the additional Options, and, when available, the Views that the component is able to produce
-
In the section Used extensions & nodes you can see the component extensions and nodes.
-
Finally, in the section Related workflows you are provided with Workflows that are available on KNIME Hub and that contain the component.
Workflows
A workflow page typically has multiple useful information about the workflow such as:
-
The workflow title, tags and last edit date
-
The space owner where the workflow is contained and, if different from the space owner, the workflow developer
-
The workflow drag & drop element: You can drag & drop the element into a selected mount point in the KNIME Explorer of KNIME Analytics Platform. This will prompt an Import window which allows you to import the workflow into the mount point. See the Drag & drop section for more details on this feature.
-
The workflow likes (see the Likes section for more details on this feature), the count of downloads, and a link icon to copy the workflow short link.
For each workflow you can also find:
-
An Overview with a description of the workflow when provided by the workflow developer
-
External resources links to external resources such as KNIME blog posts, KNIME documentation, or any other interesting link that the workflow developer might want to provide
-
In the section Used extensions & nodes you can see the workflow extensions and nodes, and the KNIME Analytics Platform that has been used to create the workflow
-
Finally, in the section Discussion you can interact with the KNIME Community. See the Collaboration section for more details on this feature.
Extensions
Extensions are collection of nodes that provide additional functionality such as access to and processing of complex data types, the use of advanced algorithms, as well as the use of scripting nodes, and so on.
KNIME Extensions are developed and maintained by KNIME, allowing you to access open source projects and add their functionality to your KNIME workflows. Community Extensions instead include functionality specific to various industries and domains. Some of these community extensions are classified as Trusted Community Extensions, which have been tested for backward compatibility and compliance with the KNIME usage model and quality standards, and Experimental Community Extensions, which come directly from the labs of our community developers. Finally, also Partner Extensions are available which provide additional capabilities offered and maintained by our partners.
All these Extensions are available on KNIME Hub.
An extension page typically has multiple useful information about the extension such as:
-
The extension name and owner, version of the extension
-
The extension drag & drop element: You can drag & drop the element into the Workflow Editor of KNIME Analytics Platform. If the extension is not already installed this will prompt an Install Extension window which allows you to install the extension. See the Drag & drop section for more details on this feature.
-
The extension likes (see the Likes section for more details on this feature), and a link icon to copy the extension short link.
For each extension you can also find:
-
An Overview with a description of the extension when provided
-
Included nodes with a list of all the nodes that are part of the extension and that will be available once the extension is installed
-
In the section Related workflows, you are provided with Workflows that are available on KNIME Hub and that contain the nodes that are part of the extension
-
Finally, in the section Legal & update site, you can have legal information about the copyright and the update site information, with the type of the extension, version number, and the link to the update site.
Collections
KNIME Collections on KNIME Hub allow upskilling users by providing selected workflows, nodes, and links about a specific, common topic.
One example of a collection can be found on KNIME Community Hub here.
This collection, for example, contains:
-
Workflow examples:
Figure 6. Example workflows in a collection on KNIME Hub -
Nodes:
Figure 7. Nodes in a collection on KNIME Hub -
Links:
Figure 8. Additional links in a collection on KNIME Hub
Drag & drop
You can drag & drop nodes, components, extensions, and workflows from KNIME Hub to import them into KNIME Analytics Platform and use them right away to build your own workflow, install KNIME Extensions, and execute uploaded workflow into your local installation.
-
Node and components: You can drag & drop a node or a component from KNIME Hub into your Workflow Editor in KNIME Analytics Platform. In case the node is part of an Extension that is not yet installed into your local installation of KNIME Analytics Platform or in case nodes that are part of extensions that are not yet installed are contained in the component, you will be asked if you want KNIME Analytics Platform to search and install the missing extension(s), as shown in Figure 9.
Figure 9. Drag & drop a node from KNIME Hub to KNIME Analytics Platform and install missing extension -
Extensions: You can drag & drop a specific extension into the Workflow Editor. KNIME Analytics Platform will search and install it. In order to be able to install the extension the extension’s update site that is indicated at the end of the extension page in the section Legal & update site must be activated in KNIME Analytics Platform.
KNIME Hub as a repository
Not only KNIME Community Hub serves as a repository for nodes, components, workflows, and extensions, ready to use in KNIME Analytics Platform via an easy drag & drop, but also you can use KNIME Community Hub to share your workflows with the KNIME Community or to store and organize your material in a private space.
Create a user account
First, if you do not have one already, create a user account. Go to KNIME Hub, click Sign in on the top right corner of the page, and then select Create account. Fill in the required information and click Create new account. Now you can sign in with your account. Click the user icon on the top right corner of KNIME Hub and select Profile from the menu to have access to your profile page. Here you can have an overview of the workflows and components you published, the extensions you published in case you have developed any of those, and the likes received. Also, you will have a list of the items you liked on KNIME Hub.
KNIME Hub spaces
From your profile page or by clicking your profile icon and selecting Spaces you will have access to the KNIME Hub spaces that are linked to your user account. A space is a KNIME Hub repository where you can store and share your workflows and components. When you register and sign in KNIME Hub two spaces will be automatically created. These are a private space and a public space, which have different access permissions. You can manage your spaces by changing their name or adding a description to them. You can upload your items from KNIME Analytics Platform to the spaces you have access to. Moreover, you can create new spaces, both private and public. Finally, you can add contributors to your public spaces. All these functionalities will be explained in the following paragraphs.
Access permissions of spaces
You are the owner of your spaces. Each space is linked and assigned to a specific user.
Spaces can be private or public:
-
A private space is only accessible and manageable by your user account. Here you can store various types of items like workflows, components, or data.
-
A public space, instead, is visible to the entire KNIME Community where you can share your workflows and components. Everyone will then be able to download them, drag & drop them to their KNIME Analytics Platform and use it, as well as like your spaces or items, or copy a link to your space and share it with others.
It is also possible to switch a space from private to public and vice versa. To do so go to the private space you want to make public, click the three dots on the top right part of the page and under Visibility select Make public (or vice versa select Make private).
Manage your spaces
You can manage your spaces at any point in time by going back to the space page.
You can change the space’s name by going on the space page and clicking the title. Insert the new name in the title field and click the yellow tick button or press Enter to save. Click the x button instead to discard your changes.
You can also add a description to your space by clicking Add description at the bottom of the space page. Again, click the yellow tick button or press Enter to save your changes, or the x button to discard them.
The description will be shown in the overview of your spaces in the corresponding space tile.
Create a new space
You can create a space from your profile’s spaces overview. Here, the spaces you have access to are shown, ordered by the latest update. Go to the last tile Create new space and select if you want to create a Private space or a Public space. You can choose a name for the space and the space will be created.
Delete a space
To delete a space you can go to the space page, click the three dots on the top right and select Delete space. You will be asked to insert the name of the space.
Connect to KNIME Hub
You can access KNIME Hub from the KNIME Hub mount point and upload your workflows and components directly from your local KNIME Analytics Platform instance to KNIME Hub.
KNIME Hub mount point
You can connect to your KNIME Hub account on KNIME Analytics Platform.
To do so go to the Home page of KNIME Analytics Platform and sign in to the KNIME Community Hub.
You will be redirected to the sign in page if you are not connected in the current session already.
Once you are signed you will see all your spaces.
Here you can perform different types of operations on:
-
Spaces: you can create a new space, change the name or delete an existing space. You can also open the space page on KNIME Hub or copy the link to the space. To do this right-click the space from the KNIME Explorer and select the desired option from the context menu that opens.
-
Items:
-
Upload items to your KNIME Hub spaces, download, move, delete, or rename your items. More information about this functionality is provided in the next section.
-
Open workflows as local copy or on KNIME Hub, or copy their URL. To do so right-click the desired item and select the options from the context menu.
-
Create workflow groups, which are subfolders that you can use to organize your items in the space. To do so right-click the space and select New Workflow Group… from the context menu.
-
Upload items
Once you are connected to your KNIME Hub account from KNIME Analytics Platform you can upload the desired items to your KNIME Hub spaces.
You can upload workflows or components to any of your spaces by right-clicking the item from the space explorer and selecting Upload to Hub from the context menu. A window will open where you will be able to select the location where you want to upload your workflow or component.
Please notice that if the items are uploaded to a public space they will be available to everyone, hence be very careful with the data and information (e.g., credentials) you share.
Version items
When uploading items to a space on KNIME Hub you will be able to keep track of their changes. Your workflow or component will be saved as a draft until a version is created.
When you create versions of the items you can then go back to a specific saved version at any point in time in the future to download the item in that specific version.
Once a version of the item is created new changes to the item will show up as draft.
Create a version of an item
Go to the item you want to create a version of by navigating through the KNIME Hub and click History.
A panel on the right opens where you can see all the versions already created and all the unversioned changes of the item since the last version was created.
Click Create version to create a new version. You can then give the version a name and add a description.
Show a version
In the Workflow history or Component history panel click the version you want to see or click the icon and select Show this version. You will be redirected to the item in that specific version.
To go back to the latest state of the item click the selected version to unselect it.
Restore a version
To restore a version that you created click the icon in the version tile from the item history and select Restore this version.
The version will be restored as a draft.
Delete a version
In the History panel click the icon for the version you want to delete and click Delete.
Move items
You can move items that you uploaded to KNIME Hub to a new location within the space that contains the item or to a different space that you have access to. To do this you need to be connected to the KNIME Hub mount point on KNIME Analytics Platform. You can then move the items within KNIME Hub just by dragging the item in the KNIME Explorer.
Delete items
You can also delete items that you uploaded to KNIME Hub. To do so you can:
-
Connect to KNIME Hub mount point on KNIME Analytics Platform. Right-click the item you want to delete and select Delete… from the context menu
-
From KNIME Hub, sign in with your account and go to the item you want to delete. Click the three dots on the top right of the page and select Delete workflow.
Figure 20. Delete a workflow from KNIME Hub
Community features on KNIME Hub
KNIME Community Hub is also the place where you can interact and collaborate with the KNIME Community.
Once you have created your profile and uploaded your items in your public spaces you can share them with others, you can remain engaged in other people’s work by liking items or leaving a comment. Finally, you can also add other users from the KNIME Community as contributors to your public spaces. They will be able to access your space from their KNIME Hub profile and from their KNIME Hub mount point on KNIME Analytics Platform, download, and upload workflows or components. Add contributors to your spaces to collaborate on a project and keep all workflows always accessible in one place.
Like items on KNIME Hub
If you find an item on KNIME Hub that has been very useful for you or that you particularly like you can leave a like by clicking the heart icon on the top right of the page. All the items you liked will be shown on your user profile under Overview. See how much the KNIME Community has been engaged in specific items by looking at the number of downloads and likes that a specific item has received.
Discussion
You can discuss a specific workflow on KNIME Community Hub in the session Discussion of the workflow page.
If a discussion has not been started yet you can click Start Discussion, or Continue Discussion in case you want to participate in a discussion that has already started.
You will be redirected to the respective discussion thread on KNIME Forum.
Contributors
You can add any other user of KNIME Community as a contributor to any of your public spaces.
To add a user as a contributor to a public space go to the space and click the pencil tool close to your profile icon.
In the Manage contributors panel that opens you can add contributors by inserting their KNIME Hub user name. Then click Add and Save changes.
In the same panel, you can also manage the contributors. Click on the bin icon to remove a contributor from the space.
When you are added as a contributor to a space you will be able to see the space under Spaces in your profile page and also listed in your KNIME Hub mount point from KNIME Analytics Platform.
Contributors have edit rights for the space they are added to. They can add and edit workflows or components on the space. They do not have the same rights that the owner of the space has. Only the owner of a space can change the space name or change the space visibility to private.
Please notice that since contributors can only be added to public spaces, the contributors will not have access to the space anymore in case the space visibility is changed from public to private.
Teams
KNIME Community Hub Teams is a paid service offered on the KNIME Community Hub.
Teams feature allows you to create a team on KNIME Hub to collaborate on a project with your colleagues. Additionally, you can add execution capabilities to your team. This will allow the team members to schedule and automate the execution of workflows on KNIME Community Hub.
A team is a group of users that work together on shared projects. Specific Hub resources can be owned by a team (e.g., spaces and the contained workflows, files, or components) so that the eam members will have access to these resources.
You can purchase a team and choose the size of the team, meaning the number of users that will be able to access the team resources, and the disk space that you need to save your team workflows, data, and components.
The team can own public or private spaces. For more details see the section Team owned spaces.
The items that are stored in a team’s public space will be accessible by everyone and be presented as search results when searching on KNIME Community Hub. However, only team members will have upload rights to the public spaces of the team.
Also, since only the team members have read access to the items that are stored in a team’s private space KNIME Community Hub, users that are part of a team can collaborate privately on a project.
You can add to your team also the ability to run workflow and also to schedule the execution of the workflows at specific intervals, easily from the web user interface of KNIME Community Hub.
Create a team
To create a team you need to subscribe to a Team Plan. To do so sign in with your KNIME Hub account or go to KNIME Hub pricing page. Here you can proceed with the subscription to the Team Plan.
You will be asked to provide the details of the account and to choose your subscription plan. You can choose how much disk storage and how many users you would like to purchase. The basic plan consists of 30GB of disk storage and a total number of 3 users. Please note that the subscription will be automatically renewed every month if not canceled and that users and disk storage can be adjusted later. Your usage will be prorated for the next billing cycle. To change or cancel your subscription follow the instructions in the section Manage team subscription.
Once you have successfully purchased a team you can assign it a name and start adding members to your team. The number of members that can be added to the team is limited to the number of users that you purchased.
There are two types of roles a user can be assigned when part of a team:
-
Administrator. A team administrator can:
-
Member. A team member can:
-
View the team page, with members list and spaces
-
The team creator is automatically assigned administrator role and can promote any of the team members to administrators. In order to do so please follow the instructions in the section Manage team members.
Team owned spaces
A team can own an unlimited number of both public and private spaces.
-
Team owned public spaces: The items that are stored in a team’s public space will be accessible by everyone and be presented as search results when searching on KNIME Community Hub. Only team members will have upload rights to the public spaces of the team.
-
Team owned private spaces: Only the team members instead have read access to the items that are stored in a team’s private space. This will then allow KNIME Community Hub users that are part of a team to collaborate privately on a project.
You can create a new space by going to the team’s profile. To do so click your profile icon on the top right corner of KNIME Hub. In the tile Create new space click Private space to create a private space for your team, or Public space to create a public space. You can then change the name of the space, or add a description. You can change or add these also later by going to the relative space page and clicking the space name or Add description button to add a description for the space.
You can also change the visibility of the space from private to public and vice-versa or delete the space. To do so, from the space page click the three vertical dots as shown in the image below.
Manage team members
You can manage your team by going to the team’s profile. To do so click your profile icon on the top right corner of KNIME Hub.
In the dropdown menu that opens you will see your teams. Select the team you want to manage to go to the corresponding team’s profile page.
Here you can click Manage team button to open the Manage Team Members side panel, as shown in the image below.
You will see here a list of the team members and their assigned role.
From here a team admin can change the role of the team members. To do so click the drop down arrow close to the name and select the roles you want to assign to each user.
Then click Save changes button to apply your changes.
Add members to a team
To add a new member enter the user name of the users that you want to add to the team in the corresponding field in the Manage Team Members panel then click Save changes button to apply your changes.
In case you added more users than allowed by purchase you will be notified with a message. Please remove the exceeding users or purchase more users.
Delete members from a team
To delete a member go to the Manage Team Members panel and click the bin icon for the user you want to delete. Then click the Save changes button to apply your changes.
Change team name
In the team’s profile page you can also change the name of the team. To do so click the pencil icon close to the name of the team under the team logo on the left side of the page.
Insert the new name and click the check yellow button to confirm.
Manage team subscription
In the team’s profile page you can also manage your subscription by selecting Settings on the side menu.
Here you can:
-
Change subscription: Click Change subscription to contact KNIME in order to change the number of team members or the disk storage. Your usage will be prorated for the next billing cycle.
Please also allow a minimum of 3 business days for processing the subscription changes.
-
Cancel subscription: Click Cancel subscription to contact us if you want to cancel your subscription. Your team and its spaces will be deleted.
Please send us your request at least 3 business days before the end of your subscription cycle.
Execution on KNIME Community Hub
To subscribe to this feature please get in contact with us. |
Execution allows you to run and schedule your team’s workflows directly on KNIME Hub.
To do this the first step is to configure the resources you need.
As the team admin, go to your team’s page and select Execution resources from the menu on the left. Here you can create an execution context, which contains all the necessary resources to run your workflows.
This is how your page will look like the first time you create an execution context.
When you click the button to create a new execution context a panel on the right will open.
Here you can configure the capacity of your execution context, select the size of the execution context to decide how performant your workflows execution will be. You and your team members can execute as many workflows as you wish, even in parallel.
We offer three different execution context capacities:
-
Small: Small has 2vCores and 8GB of RAM. This option is suitable for lightweight data processing with low complexity workflows. The execution power would be slightly slower than executing the workflow your local KNIME Analytics Platform installation, so we recommend this option if you want to perform lightweight automation, e.g. schedule the execution of your workflows.
-
Medium: Medium has 4vCores and 16GB of RAM. This option is suitable for most data processing use cases with medium complex workflows. The performance is similar to a local KNIME Analytics Platform installation.
-
Large: Large had 8vCores and 32GB of RAM. If you have more demanding use cases, with heavier data, complex workflows and you need more parallel processing power with faster computation times you can select this option.
To have more information on the pricing go the Pricing section. |
You will be charged only when the execution context is running. By default the execution context will start and stop automatically on demand. This means that it will start automatically when the execution of a workflow starts. The execution context will then stop automatically once all the workflows executions are finished. Alternatively, you select to start and stop the execution context manually. To change the settings of the execution context regarding the start and stopping, from the Create execution context side panel, go to the Advanced settings and click Set.
The toggle is On by default, meaning that the executor will start and stop automatically. Here, you can also select the inactive time (in minutes) of the executor before it will stop running automatically.
If you move the toggle on Off then you will have to go to the execution context page to start and stop it manually when it is needed.
You can also always change the execution context settings later.
Each execution context executor is based on a specific version of the KNIME Analytics Platform provided by us.
The following extensions are included:
-
KNIME Base nodes
-
KNIME Javasnippet
-
KNIME Database
-
KNIME Math Expression (JEP)
-
KNIME Excel Support
-
KNIME Quick Forms
-
KNIME JSON-Processing
-
KNIME Basic File System Connectors
-
KNIME Google Connectors
-
KNIME Expressions
-
KNIME Data Generation
-
KNIME JavaScript Views
-
KNIME Base Chemistry Types & Nodes
-
KNIME Amazon Cloud Connectors
-
KNIME Amazon Athena Connector
-
KNIME Office 365 Connectors
-
KNIME Timeseries nodes
-
KNIME REST Client Extension
-
KNIME Statistics Nodes
-
KNIME Extension for Big Data File Formats
-
Vernalis KNIME Nodes
-
KNIME Parallel Chunk Loop Nodes
-
KNIME Ensemble Learning Wrappers
-
KNIME XML-Processing
-
KNIME Textprocessing
-
KNIME Views
-
KNIME JavaScript Views (Labs)
-
KNIME Azure Cloud Connectors
-
KNIME Distance Matrix
-
KNIME SVG Support
-
KNIME Interactive R Statistics Integration
-
KNIME Connectors for Common Databases
-
Continental Nodes for KNIME
-
KNIME Tableau Integration
-
KNIME Optimization extension
-
KNIME Amazon Redshift Connector And Tools
-
KNIME Snowflake Integration
-
KNIME BigQuery
-
KNIME Big Data Connectors
-
KNIME Image Processing
-
KNIME H2O Machine Learning Integration
-
KNIME Salesforce Integration
-
KNIME XGBoost Integration
-
KNIME HTML/PDF Writer
-
KNIME Conda Integration
-
KNIME MongoDB Integration
-
KNIME SharePoint List
-
KNIME Integrated Deployment
-
KNIME Power BI Integration
-
KNIME Machine Learning Interpretability Extension
-
KNIME Databricks Integration
-
KNIME Statistics Nodes (Labs)
-
KNIME Itemset Mining
-
KNIME Google Cloud Storage Connection
-
KNIME Extension for Local Big Data Environments
-
KNIME Reporting (Labs)
-
Slack integration
-
KNIME Twitter Connectors
-
KNIME AI Extension
-
KNIME SAP Integration based on Theobald Xtract Universal
-
KNIME Hub Connectivity
-
KNIME SAS7BDAT Reader
-
KNIME Web Service Client
-
KNIME Amazon DynamoDB Nodes
-
KNIME Amazon Machine Learning Integration
-
KNIME Basic Authentication nodes
-
KNIME Git Nodes
-
KNIME Semantic Web
-
Process Mining Extension
-
KNIME Box File Handling Extension
-
KNIME H2O Snowflake Integration
Manage execution contexts
You can manage the execution context of your team by navigating to your team overview page and selecting Execution resources from the menu on the left.
Here, among other things, you can edit the execution context settings, disable or delete your execution context, or show the details of the CPU usage, the jobs that are running on the execution context and so on.
To do so select the appropriate option in the menu that opens when clicking in the tile of the execution context.
Monitor execution contexts consumption
To monitor your execution consumption and projected costs, you can go to your subscription page.
Go to your team page and select Subscription from the menu on the left.
Execute a workflow
Once the execution context is set up you can run and schedule the workflows that are uploaded to your team’s spaces on KNIME Community Hub. Navigate to a workflow in one of your team’s spaces, you will see a Run button and a Deploy button.
Click Run to simply execute the current workflow directly in the browser. The latest version of your workflow will be executed. In the side panel that opens you can also enable the workflow actions, for example allowing the system to send you an email when the chose condition is met.
Be aware that this action, if the selected execution context is set up to start and stop automatically, will start up your executor, which, once the execution is started will start the billing. In case the auto-start and stop option is not selected than you need to first start up the execution context manually. |
Schedule a workflow execution
A schedule allows you to set up a workflow to run automatically at selected times.
To create a schedule deployment of your workflow navigate to a workflow in one of your team’s spaces. In order to be able to create a schedule deployment you need to have created at least one version of your workflow. To know more about versioning read the Versioning section of this guide. Once you have your stable version of the workflow, create a version (click History → Create version). Now you can click the button Deploy and select Create schedule.
This will open a side panel where you can set up the schedule deployment.
Here you can select a name for your schedule deployment and which version of the workflow you want to schedule for execution.
In the section Schedule options you can define when the workflow should be executed:
-
Set up an initial execution, date and time
-
Select Repeat execution to select if you want the workflow to run every specific amount of time (e.g. every 2 hours), or select start times when your workflow will be executed every day at the same time.
-
Set up also a schedule ends date, either to never end or to end in a specific date and time.
Additional schedule details
You can also set more advanced schedule details.
First, check the option Repeat execution, under Set schedule details, then you can click Set to set up recurring executions, retries, and advanced schedule details.
Click Set and the following panel will open:
If you did not check the option Repeat execution, you will only find the set up options for retries and the advanced schedule details. |
The workflow will run when all the selected conditions are met. In the above example the workflow will run from Monday to Friday, every day of the month, except for the month of December.
Finally, in the section execution retries and advanced schedule details you can set up the number of execution retries, and check the following options for the advanced schedule details:
-
Reset before execution: the workflow will be reset before each scheduled execution retries occur.
-
Skip execution if previous job is still running: the scheduled execution will not take place if the previous scheduled execution is still running.
-
Disable schedule: Check this option to disable the schedule. The scheduled execution will start run accordingly to the set ups when it is re-enabled again.