“Job administration” tab

In the “Job Administration” tab you can create jobs for an automated execution of a report and configure them according to your requirements.

Create new jobs

In order to create a new job, proceed as follows:

  1. Click on the ADD button in the footer to call up the corrresponding dialog box.
  2. Enter an identifier in the input field “Identifier”.
  3. From the “Job-Type” menu either select an interval or the option “Manually”. If you chose the option “Manually”, the job can only be run manually.
  1. Depending on the selected interval, make further settings:
    • If you selected the interval “Every week”, define a weekday when the report is carried out.
    • If you selected the interval “Every second”, “Every minute” or “Every hour”, use the slider to define the desired interval length.
    • Depending on the interval you selected, define a day of the month when the job is to be started.
    • Depending on the interval you selected, define an hour of the day when the job is to be started.
    • Depending on the interval you selected, define a minute of the hour when the job is to be started.
  2. Click the ACCEPT button to confirm your settings. Afterwards the dialog box closes. The job is now created. It appears as a new entry in the table with the individual job properties displayed in the different table cells.
INFO
  • The screenshot above shows an exemplary job that is carried out every Sunday at 11.45 pm.
  • First introduced in version 5.5.0: Using the property general.report.max.parallel you can specify how many reports can be run in parallel.

Configure jobs

By customizing the job properties in the individual table cells you can further configure a job.

Show/hide job properties

The parameters of jobs are represented by the corresponding attributes. Some attributes are shown in the table by default, other attributes are shown optionally. In order to include optional attributes in the table, proceed as follows:

  1. Click on the Attributes button to call up the corresponding dialog box.
  1. Possibly enter a search term in the search field to filter the list of attributes by a search term.
  2. Select an attribute. You can also select multiple attributes:
    • In order to select an attribute, transfer it from the left column to the right column . To do so, click on the attribute .
    • In order to deselect an attribute, transfer it from the right column back to the left column. To do this, click on the attribute.
  • In order to finalise the attribute selection, click on the ACCEPT button . The dialog box closes and the selected attribute is shown in the table.
  • In order to cancel the attribute selection, click on the CANCEL button .
Note
Using the button and the button you can transfer all the job properties from one column to the other column at once.

Add job descriptions

You can create multilingual descriptions for a job. To do so, proceed as follows:

  1. First expand the different locale levels. To do so, click on thechevron to the rightbutton in the respective table row.
  2. Double-click in the table cell you want to edit.
  3. Make the desired changes.
  4. Leave the table cell.
  5. Possibly make further changes to other table cells.
  • In order to save your changes, click on the SAVE button.
    Pfeil nach rechtsA success message is shown.
  • In order to dismiss your changes, click on the RESET button.

Add parameters to jobs

You can add parameters to a job. To do so, proceed as follows:

  1. In the table row of the respective job, double-click in the table cell of the “Parameter” column to call up the corresponding dialog box.
  2. Click on the ADD button. Then appears a new entry in the parameter table.
  3. Double-click in the table cell of the “Value” column and enter a value.
  4. Possibly add additional parameters and enter the corresponding values.
  5. Click on the ACCEPT button. Then the dialog box closes.
  • In order to save your changes, click on the SAVE button.
    Pfeil nach rechtsA success message is shown.
  • In order to dismiss your changes, click on the RESET button.

Define downtimes

You can define downtimes during which the execution of a job is suspended. To do so, proceed as follows:

  1. In the table row of the respective job, double-click in the table cell of the “Downtime” column, to call up the corresponding dialog box.
  1. Possibly define one or more weekdays. Following this, the selected weekdays will be display below the separator.
  2. Possibly define a time period:
    1. In the upper “Hour” field, enter the hour from which on the job is to be suspended.
    2. In the upper “Minute” field, enter the minute of the hour from which on the job is to be suspended.
    3. In the lower “Hour” field, enter the hour until which the job is to be suspended.
    4. In the lower “Minute” field, enter the minute of the hour until which the job is to be suspended.
This screenshots shows a downtime which effects that the respective job is suspended on Mondays, Fridays as well as between 01:00 and 08:00 am.
  1. Possibly define additional time periods. To do so, click on the Add button. The last set time period is then transferred to the area below the hyphen. Now enter the parameters for the additional time period. If necessary, repeat the steps described under this point to set further time periods.
  2. Click on the ACCEPT button to confirm your settings. The dialog box will then close.
  • In order to save your changes, click on the SAVE button.
    Pfeil nach rechtsA success message is shown.
  • In order to dismiss your changes, click on the RESET button.
Note
Settings regarding weekdays and time periods are considered independently. For example: A downtime setting for a particular weekday and a time period effects that the respective job is suspended on this weekday as well as on any other weekday during the defined time period.

Activate jobs

A newly created job needs to be activated before it can be run. To activate the job, proceed as follows:

  1. Hover the mouse cursor over the table row of the job. Then appears a menu bar with several action buttons.
  2. Click on the on button to activate the job. If the process was successful, a corresponding message will appear.
INFO
In order to deactivate the job again, click on the button.

Execute jobs manually

You can manually run a job outside the specified interval. To do so, proceed as follows:

  1. Hover the mouse cursor over the table row of the job. Then appears a menu bar with several action buttons.
  2. Click on the Play button to initiate the job. If the process was successful, a corresponding message will appear.

Retrieve job histories

Once a job was run for the first time, a job history with the corresponding data is available. To retrieve that data, proceed as follows:

  1. Hover the mouse cursor over the table row of the job. Then appears a menu bar with several action buttons.
  2. Click on the Historie button to call up the corresponding dialog box.
  1. Select the desired time period:
    • In order to retrieve the job history for a given time period, click on the “Choose date range” field. Then appears the corresponding selection menu. Here, select the desired start date and the desired end date. Then the selection menu closes and the job history for the selected time period is shown in the table below.
    • In order to retrieve the job history for the present day, click on the ADD button. Then the job history for this time period is shown in the table below.
    • In order to retrieve the job history for the past three days, click on the LAST 3 DAYS buttons. Then the job history for this time period is shown in the table below.
    • In order to retrieve the job history for the past week, click on the LAST WEEK buttons. Then the job history for this time period is shown in the table below.
    • In order to close the dialog box again, click on the CLOSE button.

FAQ

What is the difference between an interval job and the “Manually” option?

If you select an interval as the job type, the job is run automatically according to the defined interval. If you select the “Manually” option, the job can only be run manually.

What is a downtime used for in a job?

A downtime allows you to define the weekdays and/or time periods during which the execution of a job is suspended. To do so, double-click in the table cell of the “Downtime” column in the table row of the respective job, which calls up a dialog box where you can define weekdays and/or a time period.

How do weekdays and time periods of a downtime affect each other?

Settings regarding weekdays and time periods are considered independently. If both a weekday and a time period are set, the job is suspended on the selected weekday as well as on any other weekday during the defined time period.

Why does a newly created job need to be activated first?

A newly created job needs to be activated before it can be run automatically. To do so, hover the mouse cursor over the table row of the job and click on the corresponding button, after which the ACTIVE chip appears in the table cell of the “Enabled” column.

How can you run a job manually outside the specified interval?

To do so, hover the mouse cursor over the table row of the job so that a menu bar with several action buttons appears. Click on the corresponding button to run the job.

Can you specify how many reports can be run in parallel?

First introduced in version 5.5.0: using the property general.report.max.parallel, you can specify how many reports can be run in parallel.