Versions Compared

Key

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

...

Expand
titleREPORTING_TASKS
FieldNullableData typeConstraintUnique ConstraintDescription
IDNOT NULLNUMERICPrimary Key  
SCHEDULER_ID NOT NULLNUMERIC  Xcorresponds to SCHEDULER_HISTORY.SPOOLER_ID
HISTORY_IDNOT NULLNUMERIC  Xcorresponds to SCHEDULER_HISTORY.ID
IS_ORDER
NOT NULLNUMERIC  

cause for execution of the task:

  • 1: order task
  • 0: standalone task
CLUSTER_MEMBER_ID
 VARCHAR  corresponds to SCHEDULER_HISTORY.CLUSTER_MEMBER_ID
STEPSNOT NULLNUMERIC  

number of steps --> calls to spooler_process()

corresponds to SCHEDULER_HISTORY.STEPS

FOLDER
NOT NULLVARCHAR  

job folder 

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

NAMENOT NULLVARCHAR  

job name

corresponds to SCHEDULER_HISTORY.JOB_NAME

 

 

 

 

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

BASENAMENOT NULLVARCHAR  

job base name

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

TITLENULLVARCHAR  

job title

corresponds to INVENTORY_JOBS.TITLE

START_TIMENOT NULLDATETIME  

UTC timestamp of the task start

corresponds to SCHEDULER_HISTORY.START_TIME

END_TIMENULLDATETIME  

UTC timestamp of the task end

corresponds to SCHEDULER_HISTORY.END_TIME

CAUSENOT NULLVARCHAR  

cause of the task start

e.g. :

  • none
  • period_once
  • period_single
  • period_repeat
  • job_repeat
  • queue
  • queue_at
  • directory
  • signal
  • delay_after_error

corresponds to SCHEDULER_HISTORY.CAUSE

EXIT_

corresponds to SCHEDULER_HISTORY.CAUSE

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

EXIT_CODE
NOT NULLNUMERIC  corresponds to SCHEDULER_HISTORY.EXIT_CODE
ERRORNOT NULLNUMERIC  

specifies if an error occurred:

  • 0: no error
  • 1: error
ERROR_CODENULLVARCHAR  JobScheduler exception-code of the task error code
ERROR_TEXTNULLVARCHAR  exception-message of the task error message
AGENT_URL
 VARCHAR  

agen url

 

corresponds to SCHEDULER_HISTORY.AGENT_URL

IS_RUNTIME_DEFINEDNOT NULLNUMERIC  

specifies if a start time has been configured:

  • 1: yes
  • 0: no

corresponds to INVENTORY_JOBS.IS_RUNTIME_DEFINED

SYNC_COMPLETED
NOT NULLNUMERIC  

for use by the JobScheduler Reporting Interface only:
specifies if a synchronization has been completed:

  • 1: yes
  • 0: no
RESULTS_COMPLETED
NOT NULLNUMERIC  

for use by the JobScheduler Reporting Interface only:
specifies if a aggregation has been completed:

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

...

  • The following tables contain aggregations forjob steps per order  
    • triggers, executions and
    executions per
    • tasks per day, week, month, quarter, year
    SQL ScriptsTables: report.sql

 

Expand
titleREPORTREPORTING_TRIGGEREXECUTION_RESULTSDATES
VARCHARSTEPSERROR
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
TRIGGERREFERENCE_IDNOT NULLNUMERICForeign Key

references REPORTREPORTING_TRIGGERS.ID

START_CAUSE

or REPORTING_EXECUTIONS.ID or REPORTIN_TASKS.ID

REFERENCE_TYPENOT NULLNUMERIC 

references SCHEDULER_HISTORY.CAUSE of the first step

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

type of reference:

  • 0: references REPORTING_TRIGGERS
  • 1: references REPORTING_EXECUTIONS
  • 2: references REPORTING_TASKS
START_DAYNOT NULLNUMERIC 

specifies the number of job steps that have been executed

calendar day

e.g. 1

START_WEEKNOT 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
HISTORY_IDREFERENCE_TYPENUMERIC

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_WEEKNOT NULLNUMERIC 

calendar week

e.g. 52

END_MONTHNOT NULLNUMERIC 

calendar month

e.g. 12

END_QUARTERNOT NULLNUMERIC 

quarter

e.g. 1

END_YEAR
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary Key 
SCHEDULER_IDNOT NULLVARCHAR corresponds to SCHEDULER_ORDER_HISTORY.SCHEDULER_ID
NOT NULLNUMERIC corresponds to SCHEDULER_ORDER_HISTORY.HISTORY_ID
REFERENCE_IDNOT NULLNUMERICForeign Key

references REPORT_TRIGGERS.ID or REPORT_EXECUTIONS.ID

calendar year

e.g. 2015

CREATEDNOT NULLDATETIME 

type of reference:

  • 0: references REPORT_TRIGGERS
  • 1: references REPORT_EXECUTIONS
UTC timestamp of record creation
MODIFIEDSTART_DAYNOT NULLNUMERICDATETIME 

calendar day

e.g. 1

START_WEEKNOT NULLNUMERIC 

calendar week

e.g. 52

START_MONTHNOT NULLNUMERIC 

calendar month

e.g. 12

UTC 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.
  • SQL Scripts
Expand
titleREPORTING_MAP_CAUSES
FieldNullableData typeConstraintDescription
IDSTART_QUARTERNOT NULLNUMERICPrimary Key 

quarter

e.g. 1

START_YEAR
CAUSENOT NULLNUMERICVARCHAR 

year

e.g. 2015

END_DAYNOT NULLNUMERIC 

calendar day

e.g. 1

END_WEEKNOT NULLNUMERIC 

calendar week

e.g. 52

END_MONTHNOT NULLNUMERIC 

calendar month

e.g. 12

END_QUARTERNOT NULLNUMERIC 

quarter

e.g. 1

END_YEARNOT NULLNUMERIC 

calendar year

e.g. 2015

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 UTC timestamp of record creation
MODIFIEDNOT NULLDATETIME UTC 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.
  • SQL Scripts

 

Expand
titleREPORT_MAP_CAUSES
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary 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

Standard Procedures

  • For most DBMS it is recommended to use views or procedures in order to speed up queries by pre-compiled statements.
  • The following procedures implement the use of the standard tables for reporting results.
  • SQL Scripts

Report about Installed Objects

  • Report about jobs, job chains and orders as collected from disk.

 

Expand
titleREPORT_INSTALLED_OBJECTS
CREATE OR REPLACE FUNCTION REPORT_INSTALLED_OBJECTS(start_date DATE, end_date DATE) RETURNS TABLE (
"ID" BIGINT,
"SCHEDULER_ID" VARCHAR(100),
"HOSTNAME" VARCHAR(255),
"JOB_CHAIN" VARCHAR(255),
"JOB_NAME" VARCHAR(255),
"JOB_BASENAME" VARCHAR(100),
"JOB_CHAIN_BASENAME" VARCHAR(100),
"JOB_TITLE" VARCHAR(255),
"JOB_CHAIN_TITLE" VARCHAR(255),
"CAUSE" VARCHAR(100),
"IS_ACTIVE_CALENDAR" INT,
"FILE_CREATED" TIMESTAMP,
"FILE_MODIFIED" TIMESTAMP
)

Report about Execution Summary

  • Report about executions of jobs and job chains.

 

Expand
titleREPORT_EXECUTION_SUMMARY
CREATE OR REPLACE FUNCTION REPORT_EXECUTION_SUMMARY(start_date DATE, end_date DATE) RETURNS TABLE ( 
"ID" BIGINT,
"SCHEDULER_ID" VARCHAR(100),
"HOSTNAME" VARCHAR(255),
"JOB_CHAIN" VARCHAR(255),
"JOB_NAME" VARCHAR(255),
"JOB_BASENAME" VARCHAR(100),
"JOB_CHAIN_BASENAME" VARCHAR(100),
"JOB_TITLE" VARCHAR(255),
"JOB_CHAIN_TITLE" VARCHAR(255),
"CAUSE" VARCHAR(100),
"IS_ACTIVE_CALENDAR" INT,
"START_TIME" TIMESTAMP,
"END_TIME" TIMESTAMP,
"START_DATE" DATE,
"END_DATE" DATE
)

 

 

 

...

Standard Procedures

Cleanup

Report

  • For most DBMS it is recommended to use views or procedures in order to speed up queries by pre-compiled statements.
  • The following procedures implement the use of the standard tables for reporting results.
  • SQL Scripts : reporting_procedure.sql

Report about Installed Objects

  • Report about jobs, job chains and orders as collected from disk.

Report about Execution Summary

  • Report about executions of jobs and job chains.