Timer Start Node

Overview

The Timer Start node is a Workflow Builder component. The node enables automation by triggering the start of a workflow on a preset schedule. Unlike the normal Start node, this node does not need a manual event or user interaction to begin.

When creating applications in Unqork, you may need to integrate with another system. As a designer, you'll want to create your integration jobs yourself. Timer Start nodes are great for creating integration and cron jobs. Cron is a time-based scheduler utility that automates system maintenance or administration. It's handy for things like exporting data or sending emails at regular intervals.

The Timer Start node can trigger at an exact time (Tuesdays at 15:30), or a relative time (every 11 hours). The Timer Start node uses UTC (Coordinated Universal Time).

Unlike other workflow nodes, the Timer Start node doesn’t have an input port. Since it’s always the first node in your workflow, your Timer Start node won’t have any preceding nodes. The Timer Start node does include a single output port, letting you connect to a single node. Don’t worry if you need more than one Timer Start node in your workflow. You can have several Timer Start nodes in a single workflow.

You'll find the Timer Start node in the list of nodes on the left of the Workflow Builder.

Using Multiple Timer Start Nodes

You can use more than one Timer Start node in a workflow. You're limited to a maximum of 20 Timer Start nodes per workflow. This limit aims to reduce server load. For example, let’s say you have 3 specific events at these times:

  • Mondays at 08:00 UTC

  • Tuesdays at 10:00 UTC

  • Every 2 hours

As a best practice, you'd set up a separate Timer Start node for each.

Similar Workflow Nodes

While the names are similar, the Timer Start node is different from the Start node and Timer node. Here are the nodes compared:

  • Timer Start Node: Automates the start of a scheduled workflow.

  • Start Node: Starts a workflow when triggered by an event or new user.

  • Timer Node: Pauses an active workflow for a preset amount of time before continuing.

What You'll Learn

In this article you'll learn how to:

Settings Menu Description

Next, let's explore the node's Settings Menu. This menu appears as a blue menu bar, either above or below the node, when you select the node itself. The Timer Start node has these Settings Menu options:

Setting

Description

Edit

Takes you to the Edit Timer Start Event window, where you can configure related settings.

Delete

Removes the node from the workflow.

Run

Activates the workflow, placing it into a running state. Once you start the node, the workflow repeats at the relative or exact time. The workflow runs on that interval until you click Stop.

Stop

Deactivates a running workflow and places it into a stopped state.

Test Run

Performs a test run of your workflow in a separate instance from the "normal" Run/Stop state of the workflow.

You should always test your workflow to be sure it is completing the required steps. That way you can be sure your workflow will work in a run state.

The test runs until the workflow completes one cycle.

Edit Timer Start Event Window

Clicking the Edit button displays the Edit Timer Start Event window.

The following settings are available in the Edit Timer Start Event window:

Setting

Description

Label

The name of the node. By default, the Label displays as timerStart-1. This label is optional and displays below the node once set.

As a best practice, you should define labels by associating them with the role of the node.

Path

The path of the node. By default, the Path displays as timerStart-1.

A path is a unique identifier that other components can reference. As a best practice, name your path with a structure that fits your application.

Relative

Select the Relative choice chip if the event must repeat when an amount of time passes.

For example, a relative time of 9 hours will trigger consecutively every 9 hours.

Exact

Select the Exact choice chip if the event must repeat at a precise time of day on a frequency of Daily, Weekly, Monthly, or Yearly. You’ll enter time using the 24-hour clock format.

For example, the exact time of Friday Weekly at 15:50 will kick off every Friday at 3:50 PM.

NOTE  When selecting a frequency of Weekly, you must select a day of the week from the Day drop-down. When selecting Monthly, you must select a Day of Month value. When selecting Yearly, you must select Month and Day of Month values.

TIP  The Day of Month setting includes the option Last Day of Month. So, your event repeats on the last day of the month, regardless of how many days are in the month.

Close

Closes the Edit Timer Start Event window, returning your focus to the pool.

Adding and Configuring a Timer Start Node

As an example, let's set up a simple workflow, including a Timer Start node, 2 Screen/Task nodes, and an End node. For this use case, you'll generate an Excel report of your submission data that will run every Friday at noon. This use case assumes that you've set up your module in advance and that you have a new workflow ready and waiting.

What You’ll Need

To set up this use case, you’ll need:

  • 1 Timer Start node

  • 2 Screen/Task nodes

  • 1 End Node

Pre-Configuration

When you create a new workflow, a Start node is automatically included. A workflow must have a Start or Timer Start node to function. Because this use case has a Timer Start node, you can delete the Start node.

1. Select your Start node.
2. Click Delete.

Configuring the Timer Start Node

In this use case, the report will run at the exact time of noon each Friday. The Timer Start node is where you set the Exact time for the automated task.

1. Drag and drop a Timer Start node in the pool, positioning your node in the Automated swimlane.
2. Click the Edit button.
3. Enter Timer Start in the Label field.
4. Select Exact.
5. Select Weekly from the Frequency drop-down.
6. Select Friday from the Day of Week drop-down.
7. Enter 12:00 in the Time field.
8. Click Close.

Configuring the First Screen/Task Node

For this node, you’ll link to the dashboard module to access the submissions.

1. Drag and drop a Screen/Task node in the pool, positioning your node in the Automated swimlane.

NOTE  Screen/Tasks nodes added to the Automated swimlane operate as Script-type tasks.

2. Click the Edit button.
3. Enter Enablement Lab: Dashboard in the Label field.
4. Select Enablement Lab: Timer Start Dashboard from the Add a Module drop-down.

5. Click Close.

Configuring the Second Screen/Task Node

For this node, you’ll link to the module that generates your Excel report.

1. Drag and drop a Screen/Task node in the pool, positioning your node in the Automated swimlane.

NOTE  Screen/Tasks nodes added to the Automated swimlane operate as Script-type tasks.

2. Click the Edit button.
3. Enter Enablement Lab: Dashboard Report in the Label field.
4. Select Enablement Lab: Timer Start Dashboard Report from the Add a Module drop-down.

5. Click Close.

Configuring the End Node

1. Drag and drop an End node in the pool, placing the node in the Automated swimlane.
2. Click Edit.
3. Enter End in the Label field.
4. Click Close.
5. Click Save Workflow.

Starting or Stopping a Workflow's Run State

After adding your Timer Start node and End node to your workflow, you can put it into a run state. In a run state, your workflow waits for the Timer Start node to begin. When the start time begins, the workflow kicks off and runs from start to finish. Your workflow continues to run according to the defined schedule, repeating until stopped.

NOTE  You cannot remove a swimlane if it has a running Timer Start node. Stop any Timer Start nodes before removing the swimlane they belong to.

Starting Your Workflow's Run State

Here's how to start your workflow's run state:

1. Select your Timer Start node.
2. Click Run.

Stopping Your Workflow's Run State

Here's how to stop your workflow's run state:

1. Select your Timer Start node.
2. Click Stop.

NOTE  You may find it cumbersome to open each workflow to start or stop the Timer Start node. Here’s where Timer Start Node Administration comes in handy. From this one page, you can filter, sort, and stop or start any Timer Start node in your environment. To learn more about this process, please read our Timer Start Nodes Administration article.

Testing Your Workflow

While building out your workflow, as a best practice, you'll use the Test Run button. A Test Run can help confirm that your workflow completed all required steps. Regardless, you'll likely want to confirm your workflow's expected behavior.

Changing a Timer Start Node's Settings

Let's revisit and make changes to your saved Timer Start node.

1. Select your Timer Start node.
2. Click Edit.
3. Change the Label settings as needed.
4. Change the Path as needed.
5. Select the Relative or Exact choice chip as needed.
6. For a Relative time:
a. Adjust the Time Amount.
b. Adjust the Time Unit.
7. For an Exact time:
a. Adjust the Frequency.
b. Adjust the Time.
8. Click Close.
9. Click Save Workflow.

Deleting a Timer Start Node

It's simple to remove a Timer Start node from your workflow. Remember, a workflow must have a Start or Timer Start node to function.

1. Select your Timer Start node in the pool.
2. Click Delete.
3. Click Save Workflow.

Promoting a Workflow with a Timer Start Node

Timer Start nodes are unique during a workflow promotion. As you promote a workflow, any running Timer Start nodes revert to their stopped state. Then all nodes promote in the stopped state. You'll need to go into the target environment and manually start each Timer Start node to run in this new environment. You can change the run status in your Workflow Builder or under Start Node Administration on the Services Administration page.

Lab

The completed Enablement Lab: Timer Start Workflow is located at: https://training.unqork.io/#/workflow/5f6b8fe1f1a98d024e95ecb9/edit.

The Enablement Lab: Timer Start Get Report dashboard is located at: https://training.unqork.io/#/form/5ff6217bec48d30245be923e/edit.