Adding Jobs
Applies to: Kyvos Reporting
To create a new job, click Add Job on the Job List page. A job defines when and how a report should run and includes task details, schedule, execution preferences, and delivery options.
Job Details
Field | Description |
|---|---|
Name | Enter a unique name for the job. |
Skip delivery on no data | If selected, the report will only be delivered if it contains data. Otherwise, the job will be skipped. |
Delete on completion | If selected, the job is automatically deleted after execution. Applies to "Run Now" and "Once" jobs, or recurring jobs with no future schedule. |
Suspend | If selected, the job is disabled and will not run until resumed. |
Task Details
Field | Description |
|---|---|
Choose Task | Select an existing task. Click Modify Task to edit the selected task. |
New Task | Click to create a new task. |
Report Name | Displays the report associated with the selected task. This is auto-populated. |
Note
When adding a job, the Run As, Format, and Delivery fields remain blank until the associated task is modified or selected.
Run Options
Select when to execute the job:
Option | Description |
|---|---|
Now | Executes the job immediately. |
Once | Executes the job once at the specified date and time. - Select the date and time (24-hour format). - Choose the appropriate Time Zone (e.g., GMT). - If no time zone is selected, the report server’s default time zone is used. |
Recurring | Executes the job based on a predefined schedule. - Select a schedule from the Schedule List. - Click New Schedule to create one. - For existing jobs, click Modify Schedule to edit the associated schedule. |
Run As
Run the job on behalf of a specific user:
Select the Organization ID and User ID.
This overrides the Run As setting defined in the task.
Notification Settings
Configure email notifications:
Condition | Action |
|---|---|
On Success | Select the checkbox and provide the email address to receive a notification when the job completes successfully. |
On Failure | Select the checkbox and provide the email address to receive a notification when the job fails. |
Advanced Options
On Error
If report generation begins but fails before completion, you can configure retry options.
Field | Description |
|---|---|
Retry | Enable retry on error. Specify retry interval using one or more of: - Minutes - Hours - Days - Retry Times: Number of attempts. The total wait time is a combination of all specified intervals (e.g., 2 days + 4 hours + 10 minutes). |
On Skip
If a job does not start as per schedule, it is considered skipped. Use the Recover option to retry.
Field | Description |
|---|---|
Recover | Enable retry for skipped executions. Specify the retry interval using: - Minutes - Hours - Days |