Workflows

Workflows

The contents of the workflows tab are shown below.


The following table explains various elements on the Workflows tab.

Field/Icon

Description

Workflows (Number)

Workflow List Tab

  • View the list of all workflows according to the selections from the Workspace/Project/Workflow Drop-downs
  • Details for each Workflow:

    • Workflow Status:

      		Completed
      		Running
      		Yet to Start
      		Failure
    • Workflow Name
    • Workspace to which it belongs
    • Project to which it belongs
    • Start and End Date and Time

    • Duration of workflow run (End Time – Start Time)

Search Workflows

  • Click to search for any workflow.
  • Partial names are allowed for searching.

  • A list of workflow names matching the search string is populated as you start typing.

Expand/Collapse Arrow

  • Click to see further details for each Workflow.
    • Last four executions
    • Start and End Date and Time
    • Duration of workflow run

  • Click on the Expand/Collapse arrow for each execution to see the following details of Log and Trace|

Log

  • View the log details generated during the execution of any workflow.
  • It is especially helpful during troubleshooting.
  • Click to view the following details of the workflow trace.
    • Task Name
    • Task Type
    • Status
    • Row Count
    • Start Time
    • End Time

    • Duration

Trace

  • View the log trace details generated during the execution of any workflow created by other users.
  • It is especially helpful during troubleshooting.
  • Click to view the following details of the workflow log.
    • User
    • Workflow Name

    • Workflow Run Details|

Run Icon

  • Click to run a workflow instantly
  • When you click the Run button
    • The status of the workflow changes to Running ()
    • The Run button changes to the Abort button ()

  • A Run from failed task option is also available if the workflow execution fails.

Run From Failed Task Icon

  • Click to run a Workflow from the last failed task

  • It is visible only in case of failed workflow executions|

Create Schedule Icon

  • Click to create a schedule to run that Workflow
  • Please enter the UTC Time (24 hr clock) in the Run Time field while creating the schedule.
  • When you schedule a workflow run using this icon, the following fields are autoselected:
  • Workspace Name
  • Project Name

  • Workflow Name|

See All ExecutionsClick to see all the executions of the selected Workflow.

Active Schedules

The contents of the active schedules tab are shown below.

The following table explains various elements on the Active Schedules tab.

Field/Icon

Description

Active Schedules (Number)

Active Schedules Tab

Displays a list and details of all active schedules in the selected Workspace (s) and Project (s).

Search Schedules or Workflow
  • Click to search any schedule or Workflow.
  • Partial names are allowed for searching.

  • A list of workflow or schedule names matching the search string is populated as you start typing.

Create New Schedule
  • Click to create a new schedule for a given workflow
  • Please enter the UTC Time (24 hr clock) in the Run Time field while creating the schedule.

Click to view the active workflow schedules on the current date.

Previous Week Arrow
Click to view all active workflows scheduled in the earlier week(s)

Next Week Arrow
Click to view all active workflows scheduled in the coming week(s)

April 2022

Current week/month indicator

Schedule Type
  • Select the type of view for the active workflow schedules
  • By default, All active workflows are displayed
  • You can change the type to

    • Daily | Weekly | Monthly

04 April 2022, Mon

Current Date

View all the active schedules on this date|

Scheduling_27_4

The name of the workflow

Schedule_27

The name given to the workflow schedule while creating a schedule

Yet To Start (Active Workflow Status)

  • Denotes the present status of the selected active Workflow

  • Depending on whether the workflow schedule was executed, the other statuses can be:

    Completed

    Running

    Yet to Start

    Failure

  • When any workflow schedule runs for a given time, you can view the change in its status only when you
    • Refresh the page

    • Click on another tab

  • Shows the Active Status of the Schedule
  • The schedule moves automatically to the Inactive Schedules tab if you clear the checkbox.

  • When you refresh the page or click on another tab, the schedule count gets refreshed.

Edit/Update Schedule Icon

  • Click to edit the created schedule|

Delete Schedule Icon

  • Click to delete the created schedule

Description

View the description given at the time of Creating or Updating the Schedule

Project

View the name of the Project to which the Workflow belongs

Workspace

View the name of the Workspace to which the Workflow belongs

Email Notification to

View the email(s) address(es) of associates to which the schedule is dispatched along with the message.

Message

View the message you send in the email body.

Time Indicator Bar

Inactive Schedules

The contents of the inactive schedules tab are shown below.

The following table explains various elements on the Inactive Schedules tab.

Field/Icon

Description

Inactive Schedules (Number)

Inactive Schedules Tab

  • Displays a list and details of all inactive schedules in the selected Workspace (s) and Project (s).
Search Schedules or Workflow
  • Click to search any schedule or Workflow.
  • Partial names are allowed for searching.

  • A list of workflow or schedule names matching the search string is populated as you start typing.

Create New Schedule
  • Click to create a new schedule for a given workflow
  • Please enter the UTC Time (24 hr clock) in the Run Time field while creating the schedule.

Click to view the inactive workflow schedules on the current date.

Previous Week Arrow
Click to view all inactive workflows scheduled in the earlier week(s)

Next Week Arrow
Click to view all inactive workflows scheduled in the coming week(s)

April 2022

Current week/month indicator

Schedule Type

  • Select the type of view for the inactive workflow schedules
  • By default, All inactive workflows are displayed
  • You can change the type to

    • Daily | Weekly | Monthly

28 March 2022, Mon

Current Date

  • View all the inactive schedules on this date

Yet To Start (Inactive Workflow Status)

  • Denotes the present status of the selected active Workflow

  • Depending on whether the workflow schedule was executed, the other statuses can be:

Completed

Running

Yet to Start

Failure

workflow_schedule

The name of the workflow

Work_schedule_updated

The name given to the workflow schedule while creating a schedule

  • Shows the InActive Status of the Schedule
  • If you clear the checkbox, the schedule moves to the Active Schedules tab.

Edit/Update Schedule Icon

  • Click to edit the created schedule

Delete Schedule Icon

  • Click to delete the created schedule

Description

View the description given at the time of Creating or Updating the Schedule

Project

View the name of the Project to which the Workflow belongs

Workspace

View the name of the Workspace to which the Workflow belongs

Email Notification to

View the email(s) address(es) of associates to which the schedule is dispatched along with the message.

Message

View the message you send in the email body.

Searching a Workflow

The search function is useful when the list of workflows is long. You can search a workflow from

  • Workflow drop-down
  • Workflow Tab

From Workflow Drop-down

To search for a workflow,

  1. On the Workflow Monitoring page, below the title pane, click the Workflow drop-down.
  2. Scroll down to search your Workflow from the list.
  3. Alternatively, type the name of the Workflow in the Search field. Partial names are allowed for searching. A list of workflow or schedule names matching the search string is populated as you start typing.
  4. Select the Workflow and click Done.


From Workflow Tab

To search for a workflow,

  1. On the Workflow Monitoring Page, in the Workflows tab, scroll down to search your Workflow from the list.
  2. Alternatively, type the Workflow name in the Search field on the extreme right. Partial names are allowed for searching. A list of workflow or schedule names matching the search string is populated as you start typing.


Creating a New Workflow Schedule

You can create workflow schedules as required. You can create

  • A schedule for a particular workflow from the Workflow tab
  • A new schedule from the Active Schedules or Inactive Schedules tab

From Workflow Tab

To create a schedule for a particular workflow,

  1. On the Workflow Monitoring Page, in the Workflows tab, scroll down to search the Workflow for which you want to create a schedule.
  2. Click the Expand/Collapse arrow () to the left of the workflow name.
  3. Click the Create Schedule icon (). The Create Schedule page is displayed.
  4. Fill in the required details and click Create.


The Create Schedule Page is described below.

From Active/Inactive Schedules Tab

To create a new schedule,

  1. On the Workflow Monitoring Page, click Active Schedules or Inactive Schedules.
  2. Click Create New Schedule on the extreme right. The Create Schedule page is displayed.
  3. Fill in the required details and click Create.


The Create Schedule Page is described below.

Create Schedule Page

The Figure below shows the various fields and buttons on the Create Schedule page.


The table below describes the fields and buttons on the Create Schedule page.

Field/Icon

Description

Workspace Name

  • Select the Workspace in which the Workflow is created.
  • The field is auto-populated if you create a schedule from the workflow tab.

Project Name

  • Select the Project in which the Workflow is created.
  • The field is auto-populated if you create a schedule from the workflow tab.

Workflow Name

  • Select the Workflow for which the schedule is to be created.
  • The field is auto-populated if you create a schedule from the workflow tab.

Name

  • Enter a name for the schedule
  • Easily search your schedule using the name.

Description

Enter a suitable description for your schedule.

Schedule

Schedule to run data

Select a frequency to run your Workflow
Available Options:

  • Daily
  • Weekly (select the weekday)
  • Monthly (select the date)

Active

  • By default, the Active checkbox is selected in the Create Schedule window.
  • Mark your schedule as Active or Inactive.
  • A selected check box indicates an active schedule.
  • A cleared check box indicates an inactive schedule.

Start Date

  • Select the date from which you want the scheduled run to start.
  • Use the calendar icon to select the date.

End Date

  • Select the date at which you want the scheduled run to end.
  • Use the calendar icon to select the date.

Run Time

  • Select the time of the day at which you want to execute the Workflow.
  • Use the drop-down to select the Hours and Minutes.
  • Enter the UTC time.

Notify Run Status

EMAIL NOTIFICATION

  • By default, the Email Notification checkbox is selected.
  • Receive notifications via email when your scheduled run completes.
  • Please select the checkbox to receive emails; otherwise, clear it.
  • The email notification gives details like the status of execution and the respective message as entered while creating the schedule.

Email Address

  • Enter the email ID(s) to whom you want to send an email notification.
  • You can add multiple email IDs.

Message

Enter a message you want to send in the email body.

Cancel

Cancel the schedule creation and return to the Workflow Monitoring page.

Create

Click to create a workflow schedule.


(info)
Note

While creating a Schedule, please note that ALL FIELDS ARE MANDATORY!

Editing a Workflow Schedule

You can edit a schedule after it is created and in the active or inactive schedule state.
To edit a schedule,

  1. On the Workflow Monitoring Page, click Active Schedules or Inactive Schedules.
  2. Click the Expand/Collapse arrow () to the left of the workflow/schedule that you want to edit/update.
  3. Click the Edit Schedule icon (). The Update Schedule page is displayed. This page is identical to the Create Schedule Page.
  4. Edit the fields as required. Refer to the table above to create a schedule.
  5. Click Update. The schedule is updated, and a notification message is displayed.

Deleting a Workflow Schedule

You can delete a schedule when it is no longer needed.
To delete a schedule,

  1. On the Workflow Monitoring Page, click Active Schedules or Inactive Schedules.
  2. Click the Expand/Collapse arrow () to the left of the workflow/schedule you want to delete.
  3. Click the Delete icon (). A message to confirm your action is displayed.
  4. To confirm, click Delete. The selected schedule is deleted, and a confirmation message is displayed.

    • Related Articles

    • Managing Workflows

      You can schedule workflows to run at pre-decided time intervals as an administrator. The scheduled workflows execute at the set time without any user intervention. It makes the automation of certain processes easier. You can Create new schedules Run ...

    • View Workbooks and Workflows in Running Status

      In a workspace, there are some workbooks and workflows that are still in running mode. They are easy to locate from the home page using the Running tab. You can also filter the status as Failed, Aborted, and Completed Workbooks and Workflows. Click ...

    • View Workbooks and Workflows in Running Status

      In a workspace, there are some workbooks and workflows that are still in running mode. They are easy to locate from the home page using the Running tab. You can also filter the status as Failed, Aborted, and Completed Workbooks and Workflows. Click ...

    • Opening a Workflow

      To open a workflow, follow the steps given below. On the home page and click Workflows. Recent Workflows for the selected workspace are displayed. Hover over the workflow you want to open and click the workflow tile. Your selected workflow canvas is ...

    • Deleting a Workflow

      To delete a workflow, follow the steps given below. On the home page, click Workflows. Recent Workflows for the selected workspace are displayed. Hover over the workflow you want to delete, click the vertical ellipsis (); and then click Delete. A ...