Schedule a data collection job

Schedule a data collection job to regularly collect scores without manual intervention.

Before you begin

Roles required: pa_data_collector or admin

Before defining data collection jobs, make sure that indicator sources, breakdown sources, and indicators have been defined. Otherwise, jobs cannot return any results.

Procedure

  1. Navigate to Performance Analytics > Data Collector > Jobs.
  2. Click New.
  3. Fill in the fields, as appropriate.
    Table 1. Scheduled Data Collection form
    Field Description
    Name Enter a name to identify this scheduled job.
    Description Enter a description to identify this scheduled job.
    Operator Select Fixed start to collect data for an absolute time period.

    Select Relative to collect historical data, for instance from 60 days backwards, to populate indicator scores.

    Fixed start Enter a fixed start date. Available only when the Operator field is set to Fixed.
    Fixed end Enter a fixed end date. Available only when the Operator field is set to Fixed.
    Relative start Enter the number of days, weeks, or months (set in the Relative start interval) for the relative start. This determines for how far back, scores will be retrieved. Available only when the Operator field is set to Relative.
    Relative start interval Select the unit used when the interval should start in days ago, weeks ago, or months ago. Available only when the Operator field is set to Relative.
    Relative end Enter the number of days, weeks, or months (set in the Relative start interval) for the relative end. This determines for how far back, scores will be retrieved. Available only when the Operator field is set to Relative.
    Relative end interval Select the unit used when the interval should end in days ago, weeks ago, or months ago. Available only when the Operator field is set to Relative.

    For example, if you want to collect data from one year back up to the current day, enter 12 in Relative start and months ago in Relative start interval. In the other fields, accept the default values. As this type of data collection can take a long time and is usually done when setting up the system, set the Run field to Once or On Demand.

    Run as Select the user that runs this scheduled job. For optimal performance choose a user who is authorized to collect scores for the indicators specified in the job. The user who is logged in is used by default.
    Run as tz Select the time zone the queries that will be executed from the scheduled job will use. By default the System time zone is used, but can be changed when needed.
    Active If selected, as it is by default, the data collection occurs at the scheduled date and time.
    Run Select the type of schedule to collect the data. Choices are:
    • Daily
    • Weekly
    • Monthly
    • Periodically
    • Once
    • On demand
    Day
    • If Run is Weekly, the day of the week.
    • If Run is Monthly, the day of the month.
    Repeat Interval If Run is Periodically, the amount of time between scheduled data collections, in days and hour.
    Starting If Run is Periodically or Once, the date and time of the first scheduled data collection.
    Time If Run is Weekly or Monthly, the time of day, on a 24-hour clock.
    Conditional If checked, the data collection occurs only if certain conditions are met.
    Conditions If Conditional is selected, a script determines under what conditions the entity is generated.
  4. Right-click the form header and select Save.
  5. In the Job Indicators related list, click New to select an indicator for the job to collect.
    Important: At least one indicator must be included for the job. Otherwise, the job cannot return any results.
  6. Fill in the fields, as appropriate.
    Table 2. Job Indicator form
    Field Description
    Job Is automatically copied from the job name.
    Indicator Select the indicator that must be collected for this job.
    Active Select the check box to make the job indicator active (the default). Clear the check box to deactivate the job temporarily without deleting it from the job definition.
    Collect Choose to collect All breakdowns, One breakdown, or No breakdowns.
    Breakdown Specify the breakdown you want to collect. Only available if Collect is set to One breakdown.
    Collect indicator Select the check box to collect data for the indicator itself (the default). Clear this check box if you want to collect data for breakdowns alone. Depending on the setting in Collect, data is collected for all breakdowns, one breakdown, or none at all.
  7. Click Submit.
  8. Repeat steps 6 through 8 to select additional indicators that this job should collect.