Manage Scheduler
  • 28 May 2024
  • 5 Minutes to read
  • PDF

Manage Scheduler

  • PDF

Article summary

Efficiently manage multiple Schedulers with flexible View, Filter, Search and Edit options.

View

The View option in the Scheduler displays the list of schedulers configured for the specific Domain and Sub Domain

To view the listing page of the Scheduler, perform the following steps. 

  1.  Navigate to Design Studio > Module > Specify a module > Scheduler
  2.  Enter the Domain and Sub Domain
  3.  The page displays the list of schedulers configured for the chosen Domain and Sub Domain and Tenant.
    Figure: View Scheduler

Grid 

The grid provides a detailed view of the list page of the Scheduler. For more information refer to the field description table below. 

FieldDescription

Id
This is the system generated unique Id given to the configured Scheduler. 

Name

The specific name provided for the Scheduler in the general step is displayed.
DescriptionA brief description of the Scheduler provided in the general step is displayed.
Monitoring SourceThe Monitoring Source is specified in the general step is displayed. It can be Web Server or Proxy Server.  
Scheduler TypeThe Scheduler Type chosen as one time event or recurring is displayed.
FrequencyThe Frequency set for the configured Scheduler is displayed. 
Last Records ImpactedThe last records that have been impacted by the Scheduler are displayed here. Opening the list page gives a concise view of the actions undertaken and records impacted. For more information, refer to a sample screenshot below.

This image shows the no. of notifications sent for this Scheduler
Scheduler ActionThe action configured for the Scheduler is displayed.
Last RunA date for when the Scheduler was last run is provided here.
StatusThe Status of the Scheduler as to whether it has been Successful, Failure, Partial, or In queue.
  • Successful - When the actions of the Scheduler have been executed and run successfully. 
  • In progress - The status of the Scheduler when it is executing. 
  • Failure - When the Scheduler has run but all the configured actions failed.  
  • Partial - When the Scheduler has run, but of all the configured actions atleast one has been successful while others failed. 
  • In Queue - When the Scheduler is in queue for being executed. 
Note:
An Error log appears for Failure and Partial status that can be referred as a pop up. 
Next RunThe next schedule for when the Scheduler will run is provided.
Updated ByThe details of last update for the Scheduler is given.
Updated TimeThe last updated time for the Scheduler is provided.
Active This toggle button states if the Scheduler is active.
Publish StatusThe details of the Scheduler either in draft status or published status is provided. For more information refer to Publish. 
Actions
The icons are listed below with their description.
The icon allows the Designed/Published/Maintenance Scheduler to be Cloned.
Click the icon to allow the Scheduler to run immediately.
The icon displays the Error Logs in the Scheduler run. Click the icon and the following page is displayed. Recent and past errors can be viewed here. Past errors can be viewed for up to 60 days. We can also specify a date range for viewing the error logs. Reasons for the failure of the Scheduler can also be viewed here. 
Click the export icon (as shown above) to export the error logs to Excel. Also, view the list of error logs using a virtual scroll.
We can use the search functionality to search for a particular error log. 
Select the icon to validate dependent fields configured in the Update Fields Action. For more information, refer to Job History.
Note
This icon will appear when a new validation has been added after the scheduler has been executed. 

The icon displays the Scheduler Job History.

An asterisk (*) represents mandatory field.

Edit

The Edit option in the Scheduler is used to amend the configured Schedules.

To Edit the Scheduler, perform the following steps. 

  1. Navigate to Design Studio > Module > Select a Module > Scheduler
  2. Specify the Domain and Sub Domain.

    Figure: Edit Scheduler
  3. Click on the ID and open the scheduled activity. If the scheduler is in Publish state, move it to Maintenance stage. Make the necessary changes and click Save. Any alterations to the Scheduler can be made and updated.  

Filters 

The Filter option present in the Scheduler allows the restriction of content based on specific criteria. 

Figure: Filter icon

  • Click the Filter icon to view the following filter options. Select the Match All or Match Any option from the list to filter the data based on the condition selected. The Match All option is selected, by default.

    Figure: Filter option

  • Select the option to compare the data based on the conditions. Available options are as follows:
    • Starts With
    • Contains
    • Not contains
    • Ends with
    • Equals
    • Not equals
    • Less than
    • Less than or equal to
    • Greater than
    • Greater than or equal to
    • Date is 
    • Date is not
    • Date is before
    • Date is after
    • Active
    • Not Active
      Note
      The following filter options are available for numeric column values:
      • Less than
      • Less than or equal to
      • Greater than
      • Greater than or equal to
      The following filter options are available for date column values:
      • Date is 
      • Date is not
      • Date is before
      • Date is after

      The following filter options are available for toggle switch Active:

      • Active
      • Not Active 


You can click Clear to clear the configured filter and click Apply to set the filter condition.


Figure: Add column

Add or remove the columns to be displayed on the list page by clicking on the checkbox next to the columns. (Refer the below sample screenshot). We can also drag and drop to switch the column positions. 

Figure: Add columns

Click Save to save the new view of columns on the list page. Click Cancel to revert all the changes made and close the pop-up. Click Clear All to remove all the applied column view settings.

Figure: Filter icon 

Search 

The Search option in Scheduler helps to easily search configured schedulers from the list page. 

Figure: Search icon

Job History

The Job History icon allows the user to view the error logs on the Scheduler. It can be filtered by specifying a date range and status.

Figure: Job History

This showcases the list of scheduled jobs run with their ID, Last Run details, Duration, Status, Records Impacted and Error Log. It contains the past 60 days data to be viewed. 

Refresh Jobs

The Refresh Jobs icon helps to refresh all the schedulers from the List page. Upon clicking the button, it will refresh the page and the status of all the schedulers will be updated to the current state.

Scheduler Vs Business Rule Designer 

  • A Scheduler is run based on the frequency set in configuration while a Business Rule Designer triggers based on the conditions. 
  • A Scheduler is set to both Custom and System Defined actions whereas a Business Rule Designer has fixed custom actions.



Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.