Create a job schedule to compute the indicator

This configuration is only required for computed indicators. Indicator computation can be done manually for the computed indicators of a single object in the evaluation views. To make sure that indicator values are always up-to-date, schedule a job that is executed at regular time intervals to compute all indicators for an object class that are based on a defined evaluation type and indicator type.

  1. Go to Administration > Job Schedule.
  2. In the toolbar, click New > Create Job Schedule.
  3. In the Stereotype Selector that opens, select Rescan Indicator Job Schedule.
  4. Define the following:

    Basic Data tab:

    • Name: (Mandatory) Define a unique name for the job schedule. It is not possible to define two job schedules with the same name, even if the type of job schedule is different.
    • Description: Provide a meaningful description about the purpose of the job schedule.
    • Define the attributes in the Configuration field:
      • Class: (Mandatory) Select the object class or object class stereotype that the evaluation type of the indicator is assigned to. The drop-down list includes all object classes which have computed indicators assigned and an option to compute global indicators.
      • Evaluation Type: (Mandatory) Select the evaluation type that the indicator is assigned to.
      • Indicator Type: (Mandatory) Select the indicator type that has the indicators that will be computed.
      • Report: Leave this field empty.

    Schedule tab:

    • Schedule Time: Enter the start time for the job execution into the Start Time field.
    • Recurrence Pattern: Select one of the following check boxes and provide additional data, if applicable:
      • Hourly: The interval between job executions is the time selected in the field of every.
      • Daily: The interval between job executions is the number of days specified in the field day(s) as an integer.
      • Weekly: The interval between job executions is the number of weeks specified in the field week(s) on as an integer. In addition, select the checkbox of the day of the week that the job shall be executed for each recurrence.
      •  Monthly: There are tow methods to select from. If you select the checkbox Date-Based, define a day of the month in the day field behind the checkbox. For example if you want the job to be executed on the fifteenth of each month, enter 15. If you select the checkbox Weekday-Based, you can schedule the job for a specific day of a specific week in the month. In the first field behind the checkbox, select the week of the month the job shall be executed. In the second field behind the checkbox, select the day of the week the job shall be executed. The interval between job executions is the number of weeks specified in the field month(s) field of the selected scheduling method.
      • Once: The job is only executed once.
    • Range of Recurrence: This definition is mandatory. Select the start date for the job schedule from the calendar in the Start Date field. For the definition of the end of the recurrence period, either select End after: and define the maximum number of occurrences in the Occurrences field or select End by: and select the end date for the job scheduling from the calender in the field next to the checkbox entry. If you have selected Once in the Recurrence Pattern field, only define the date of execution via the Start Date field.
  5. Optionally, you can define the following:

    Activate verbose logging to analyse execution issues. Set the checkmark for the Verbose Logging attribute in the Basic Data tab. Only activate verbose logging temporarily for troubleshooting. Verbose logging leads to a decrease in performance and should not be used for the daily execution of jobs.

    Receive a warning if job execution is too long. Define a maximum expected execution time for the job in the Expected Execution Time [min] field. You will receive a warning in the notification if the job execution exceeds the configured time. Job execution is finished even if the configured time has elapsed.

    Change the user receiving job execution notifications. By default, you will receive notifications about the success of job execution when you are logged in with the Portfolio Admin user profile. Click here for information about how to find your notifications. In the Execution Info tab, you must define both of the following fields to change the notification recipient. In the Executing User field, define the user who shall receive the notifications. In the Executing User Profile field, specify the user profile that the user must be logged in with to receive the notifications.

    Configure the job to wait for the results of another job. You can specify that the job execution shall be delayed if other jobs that are scheduled to be executed prior to the current job are not yet finished. For example, two different indicators are calculated to calculate a third indicator. You can then configure the job for the calculation of the third indicator to wait for the other calcuation of the first two indicators to finish.

    1. In the Execution Info tab, click the New button above the Dependent Jobs table and select Create New Job Dependency.
    2. Select the job schedules the current job schedule depends on and click OK.
    3. In the Maximum Wait Time [min] field, enter a maximum time above 5 minutes that the job execution can be postponed. If a job of the current schedule shall be executed while a job defined in the Dependent Jobs field is still running, the exeuction of the job will be shifted in five minute intervals until the dependent jobs are finished or the maximum wait time is reached. If the job could not be executed during the maximum wait time, job execution will be cancelled and an error message will be written to the log file. The next execution of the job is scheduled according to the settings in the Schedule tab of the job schedule editor.

    Start one job after execution of another job.You can configure one job to be started by another job. You need to configure both jobs. Configure the job to be executed first with a time schedule.

    • In the Execution Info tab, click the New button above the On Completion Jobs table and select Add. Select the job that shall be started on completion of the current job.
    • Configure the indirectly triggered job without an own job schedule. In the Basic Data tab of this job, select the Indirectly Triggered checkbox.

After having created the job schedule, you can use it as a template for creating new job schedules. Select the job schedule in the table and click New > Create Job Schedule As Copy from the toolbar.