Realtask Jobs
Job is a container where you create one or more Tasks, setup scheduling and other configuration that is applicable for all Tasks. When you run a Job, all active Tasks in that Job are executed in the order they are defined in the Job.
// screenshot of Jobs list page
Listing Jobs
Jobs are listed by default when you navigate to Realtask application from the Home page.
- It will show all jobs that you have Read or Edit access to.
- Jobs are listed in alphabetical order
- You can filter the jobs by their Status, Frequency, Environment and Owner of the job
You can also navigate to the Job list page by clicking on the Jobs link in the Breadcrumbs or Jobs
Top Menu.
Creating a Job
To create a Job, click on +
icon in the toolbar button in the Jobs list page. It will open a dialog where you can
specify various
Job Dialog Fields
Field | Type | Default | Description |
---|---|---|---|
Name | String (100) | Name of the Job | |
Status | Picklist | Active | Status of the Job. If Inactive job will not be executed. |
Environment | Ref (Environment) | Environment to which this Job belongs to. There is no particular logic attached to this selection a this time but it is good to select appropriate environment for your job for maintenance | |
Folder | String | Folder in which to place this Job in. Folders allows you to filter the Job easily in Jobs list page. | |
Description | String | Any text that describes what this Job does. | |
Scheduling | |||
Frequency | Picklist | Manual | Frequency at this which this job must be executed. Defaults to Manual in which case, Job runs only when somebody executes it manually. |
Cron Pattern | String | (Shown when Frequency=Cron ) Specifies the Cron pattern by this this Job must be run. To section Scheduling for more info. | |
Schedulig TimeZone | Time zone that be used to determine time of day during scheduling. | ||
Start At | Date Time | Absolute time when Job execution should begin | |
Stop At | Date Time | Absolute time when Job execution should stop | |
Default Connections | This section shows various Connection types for Source and Target. Choose appropriate connections. See section Default Connections for more info | ||
Button (Sharing) | Allows you to configure sharing for your job. See section Sharing for more info. | ||
Button (Options) | Allows you to configure various Options for the Job. See below section Options Dialog Fields for more info. |
Options Dialog Fields
Field | Type | Default | Description |
---|---|---|---|
Params | See below section Params for more info | ||
Preview Params | See below section Preview Params for more info | ||
Execution | This section groups various options that impacts the execution | ||
Worker Type | Picklist | Short Job | Type of the worker to use during the execution. See section Workers for more info. |
Treat Record Errors As | Picklist | Warning | If you select this value as Error , then any errors that happens while processing individual records are treated as Task has Errored. See below section Execution Flow for more info |
Log Level | Picklist | Info | Indicates how much information to Log into server logs for this Job. Defaults to Info |
Log Full Record For | Picklist | Error | If it's Error when full record is logged into Status file if record errors. If it's All then full record details are logged always even if record is successfully processed. |
Scheduling
In Realtask Job can be scheduled to run manually or automatically at a requirement frequency. Job field Frequency
indicates how a Job is executed.
If Manual
Job must be executed manually. If it is any other value then it is auto-executed according to defined
Frequency
value.
Frequency
provides various pre-defined values like Every Minute
, Every Hour
etc., If one of those frequency value
is appropriate for your use case
select that. If none of them are applicable, then you can choose Cron
as Frequency and then specify Cron pattern.
Appsuite uses opensource cronjs package
(which was built for this product but later open sourced). Refer to its documentation on how to specify cron
patterns here.
Realtask Cron Pattern
supports multi-cron expressions. With this, we can support any scheduling requirement that your
business needs.
There are some Frequency
values that requires timezone information. For ex., Every Day
or Every Monday
etc., which
suppose to run at 00:00 AM.
To define when is 00:00 AM, Realtask uses Scheduling Timezone
field. Make sure you set that value appropriately
otherwise Job
may run at wrong intervals.
Default Connections
Default Connections allows you to specify default Source
and Target
connections for different connection types like
Sfdc
or Google
etc., If a Task
connection
is specified as <Conn Type> Source
or <Conn Type> Target
, then appropriate connection will be used from this
Default Connections
configuration.
Here are some advantages of Default Connections
- They help you avoid duplication of specifying same connection multiple times if multiple Tasks refer to same ones.
- They help you avoid wrong configuration
- They help you clone the Job to be used in different environments easily as you just need to update
Default Connections
section
Sharing
When you create a Job
it is private by default which means it is visible to you only and Admins. If you would like to
share the Job
with other team
members, then you must share it.
To share a Job
click on Sharing
button in Job
Add/Edit dialog. It shows a Dialog where you can choose Sharing
Type. Types are as follows.
Type | Description |
---|---|
Private | This is default setting. Job is visible to you and Admins only |
All Read | All Realtask users can view the Job and its details but cannot edit or execute it. |
All Edit | All Realtask users can edit the Job and execute it. |
Manual | Allows you to specify which Groups get access to this Job and at what level. |
If you specify Manual as Sharing Type, then you can specify sharing level (Read/Edit) for individual group. In that case, users in that Group gets the specified access.
Workers
Jobs are executed in a background computing resources called Workers. Worker Type
and Worker Level
indicates the
type and resources assigned to those workers.
Worker Type
Type | Description |
---|---|
Short Job | Short Job workers are appropriate if your Job takes maximum 10-12 minutes to complete the execution. From our experience, majority (around 80%) of the Realtask Jobs fit this profile. |
Long Job | If you need to run a Job for longer than 10-12 minutes, then choose this as Worker Type |
Worker Level
Worker Level
indicates the amount of resources assigned for each worker created to execute a Job
. Specify the value
suggested by Datasert support team.
Job Execution
When a Job is executed, it is put in a queue and then executed by a worker. Realtask uses a queue to manage the execution of Jobs.
Status Files
Each job has a status file which is a csv file which illustrates the status of the Job. You have the option to download the file onto your local file storage
Concurrent Edits
If two users in the system makes changes to same entity (Job or Task etc.,) at same time, then last change wins. So it is critical that you do not keep the Edit dialogs open for long time to ensure you are not overriding others changes.
Status
The current status of the Job is shown in the Status
column.