Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Provide technical information on the data model.
  • Users can use this information to create their own reports from the data model.

Standard Data Model

Inventory Tables

  • The following tables are managed by reporting inventory jobs that create an inventory of existing jobs, job chains and orders.
  • Records are overwritten by each run of the reporting inventory jobs.

...

Expand
titleREPORT_EXECUTIONS
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary Key 
SCHEDULER_ID NOT NULLNUMERIC corresponds to SCHEDULER_ORDER_HISTORY.SCHEDULER_ID
HISTORY_IDNOT NULLNUMERIC corresponds to SCHEDULER_ORDER_HISTORY.HISTORY_ID
TRIGGER_IDNOT NULLNUMERICForeign Keyreferences REPORT_TRIGGERS.ID
STEPNOT NULLNUMERIC 

corresponds to SCHEDULER_ORDER_STEP_HISTORY.STEP

NAMENOT NULLVARCHAR 

corresponds to SCHEDULER_HISTORY.JOB_NAME

e.g. test/my_job

BASENAMENOT NULLVARCHAR 

job base name

e.g. my_job, for a given job path test/my_job.job.xml

TITLENULLVARCHAR corresponds to INVENTORY_JOBS.TITLE
START_TIMENOT NULLDATETIME 

corresponds to SCHEDULER_ORDER_STEP_HISTORY.START_TIME

END_TIMENULLDATETIME 

corresponds to SCHEDULER_ORDER_STEP_HISTORY.END_TIME

STATENOT NULLVARCHAR 

corresponds to SCHEDULER_ORDER_STEP_HISTORY.STATE

CAUSENOT NULLVARCHAR start cause for execution, can be mapped to an individual start cause by use of table REPORT_MAP_CAUSES
ERRORNOT NULLNUMERIC 

specifies if an error occurred:

  • 0: no error
  • 1: error
ERROR_CODENULLVARCHAR JobScheduler error code
ERROR_TEXTNULLVARCHAR error message
IS_RUNTIME_DEFINEDNOT NULLNUMERIC 

specifies if a start time has been configured:

  • 1: yes
  • 0: no
CREATEDNOT NULLDATETIME timestamp of record creation
MODIFIEDNOT NULLDATETIME timestamp of record modification

...

Aggregation Tables

  • The following tables are used for the mapping of report data. Users can add individual records that are used for the mapping of results in individual reports:contain aggregations for
    • job steps per order 
    • triggers and executions per day, week, month, quarter, year
    • Mapping of start causes for jobs

 

Expand
titleREPORT_MAPTRIGGER_CAUSESRESULTS
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary Key 
CAUSESCHEDULER_IDNOT NULLVARCHAR start cause as used by JobSchedulercorresponds to SCHEDULER_ORDER_HISTORY.SCHEDULER_ID
HISTORY_IDMAPPED_CAUSENOT NULLVARCHARNUMERIC individual mapping of start causecorresponds to SCHEDULER_ORDER_HISTORY.HISTORY_ID
TRIGGER_IDCREATEDNOT NULLDATETIMENUMERIC timestamp of record creationForeign Key

references REPORT_TRIGGERS.ID

START_CAUSEMODIFIEDNOT NULLDATETIMEVARCHAR timestamp of record modification

Aggregation Tables

  • The following tables contain aggregations for
    • job steps per order 
    • triggers and executions per day, week, month, quarter, year

 

Expand
titleREPORT_TRIGGER_RESULTS
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary Key 
SCHEDULER_IDNOT NULLVARCHAR corresponds to SCHEDULER_ORDER_HISTORY.SCHEDULER_ID
HISTORY_IDNOT NULLNUMERIC corresponds to SCHEDULER_ORDER_HISTORY.HISTORY_ID
TRIGGER_IDNOT NULLNUMERICForeign Key

references REPORT_TRIGGERS.ID

START_CAUSENOT NULLVARCHAR 

references SCHEDULER_HISTORY.CAUSE of the first step

for the value order check the start cause given in INVENTORY_JOB_CHAINS.START_CAUSE

STEPSNOT NULLNUMERIC 

specifies the number of job steps that have been executed

ERRORNOT NULLNUMERIC 

specifies if an error occurred

  • 0: no error
  • 1: error
ERROR_CODENULLVARCHAR JobScheduler error code
ERROR_TEXTNULLVARCHAR error message
CREATEDNOT NULLDATETIME timestamp of record creation
MODIFIEDNOT NULLDATETIME timestamp of record modification

references SCHEDULER_HISTORY.CAUSE of the first step

for the value order check the start cause given in INVENTORY_JOB_CHAINS.START_CAUSE

STEPSNOT NULLNUMERIC 

specifies the number of job steps that have been executed

ERRORNOT NULLNUMERIC 

specifies if an error occurred

  • 0: no error
  • 1: error
ERROR_CODENULLVARCHAR JobScheduler error code
ERROR_TEXTNULLVARCHAR error message
CREATEDNOT NULLDATETIME timestamp of record creation
MODIFIEDNOT NULLDATETIME timestamp of record modification
Expand
titleREPORT_EXECUTION_DATES
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary Key 
SCHEDULER_IDNOT NULLVARCHAR corresponds to SCHEDULER_ORDER_HISTORY.SCHEDULER_ID
HISTORY_IDNOT NULLNUMERIC corresponds to SCHEDULER_ORDER_HISTORY.HISTORY_ID
REFERENCE_IDNOT NULLNUMERICForeign Key

references REPORT_TRIGGERS.ID or REPORT_EXECUTIONS.ID

REFERENCE_TYPENOT NULLNUMERIC 

type of reference:

  • 0: references REPORT_TRIGGERS
  • 1: references REPORT_EXECUTIONS
START_DAYNOT NULLNUMERIC 

calendar day

e.g. 1

START_WEEKNOT NULLNUMERIC 

calendar week

e.g. 52

START_MONTHNOT NULLNUMERIC 

calendar month

e.g. 12

START_QUARTERNOT NULLNUMERIC 

quarter

e.g. 1

START_YEARNOT NULLNUMERIC 

year

e.g. 2015

END_DAYNOT NULLNUMERIC 

calendar day

e.g. 1

END
Expand
titleREPORT_EXECUTION_DATES
STARTNUMERIC
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary Key 
SCHEDULER_IDNOT NULLVARCHAR corresponds to SCHEDULER_ORDER_HISTORY.SCHEDULER_ID
HISTORY_IDNOT NULLNUMERIC corresponds to SCHEDULER_ORDER_HISTORY.HISTORY_ID
REFERENCE_IDNOT NULLNUMERICForeign Key

references REPORT_TRIGGERS.ID or REPORT_EXECUTIONS.ID

REFERENCE_TYPENOT NULLNUMERIC 

type of reference:

  • 0: references REPORT_TRIGGERS
  • 1: references REPORT_EXECUTIONS
START_DAYNOT NULLNUMERIC 

calendar day

e.g. 1

START_WEEKNOT NULLNUMERIC 

calendar week

e.g. 52

STARTEND_MONTHNOT NULLNUMERIC 

calendar month

e.g. 12

STARTEND_QUARTERNOT NULLNUMERIC 

quarter

e.g. 1

END_YEARNOT NULLNUMERIC 

calendar year

e.g. 2015

END_DAY
CREATEDNOT NULLDATETIME 

calendar day

e.g. 1

END_WEEKNOT NULLNUMERIC 

calendar week

e.g. 52

END_MONTHNOT NULLNUMERIC 

calendar month

e.g. 12

timestamp of record creation
MODIFIEDNOT NULLDATETIME timestamp of record modification

Mapping Tables

  • The following tables are used for the mapping of report data. Users can add individual records that are used for the mapping of results in individual reports:
    • Mapping of start causes for jobs
  • Contents in these tables is optional, however, their existence is required.

 

Expand
titleREPORT_MAP_CAUSES
FieldNullableData typeConstraintDescription
IDEND_QUARTERNOT NULLNUMERIC 

quarter

e.g. 1

END_YEARNOT NULLNUMERIC 

calendar year

e.g. 2015

Primary Key 
CAUSENOT NULLVARCHAR 

start cause as used by JobScheduler:

possible values include

  • order: job start triggered by manual order
  • min_tasks: job start triggered by forced minimum number of tasks
  • delay_after_error: job start due to a setback event
  • period_single: job start triggered by order start time
  • period_repeat: job start triggered by order repeat interval
  • queue_at: job start scheduled manually or by task congestion

additional values provided by the JobScheduler Reporting Interface include

  • file_trigger: job start due to an incoming file
MAPPED_CAUSENOT NULLVARCHAR individual mapping of start cause
CREATEDNOT NULLDATETIME timestamp of record creation
MODIFIEDNOT NULLDATETIME timestamp of record modification

...

 timestamp of record modification

Customization

  • The standard data model can be customized by use of additional tables and procedures.
  • Such tables are not required by the JobScheduler Reporting Interface.

Sample Tables

  • The following tables are used implement samples for the customization of reports. Users can add individual records that are used for the mapping of results in individual reports:
  • Mapping of applications to jobs
  • Mapping of mandators to jobs:
    • Assigning applications to jobs
    • Assigning mandators to jobs
  • Samples are presented for instructional use only.

Custom Jobs

  • Status
    colourRed
    titleTODO
     Clarify removal of this sample

 

Expand
titleREPORT_CUSTOM_APPSJOBS
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary Key 
NAMENOT NULLVARCHAR application name
TITLENULLVARCHAR application title
 job name
TITLENULLVARCHAR job title

Assigning Applications to Jobs

  • Should a report present information on a number of jobs that are used for the same application then the following tables could be used:

Application Master Data

Expand
titleREPORT_CUSTOM_JOBSAPPS
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary Key 
NAMENOT NULLVARCHAR job application name
TITLENULLVARCHAR job application title

Application Joins to Jobs

Expand
titleREPORT_CUSTOM_MANDATORSJOB_APPS
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary Key 
JOB_NAMENOT NULLVARCHAR mandator nameTITLEcorresponds to INVENTORY_JOBS.NAME
APP_NAMENOT NULLVARCHAR mandator titlecorresponds REPORT_CUSTOM_APPS.NAME

Assigning Mandators to Jobs

Mandator Master Data

Expand
titleREPORT_CUSTOM_JOB_APPSMANDATORS
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary Key 
JOB_NAMENOT NULLVARCHAR corresponds to INVENTORY_JOBS.NAMEAPP_NAMEmandator name
TITLENOT NULLVARCHAR corresponds REPORT_CUSTOM_APPS.NAMEmandator title

Mandator Joins to Jobs

Expand
titleREPORT_CUSTOM_JOB_MANDATORS
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary Key 
JOB_CHAINNOT NULLVARCHARForeign Keyreferences REPORT_JOBS.ID
MANDATOR_IDNOT NULLNUMERICForeign Keyreferences REPORT_MANDATOR.ID