Versions Compared

Key

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

Table of Contents

Scope

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

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
titleINVENTORY_INSTANCES
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary keyKey 
SCHEDULER_IDNOT NULLVARCHAR  corresponds to the SCHEDULER_ID that is specified during installation of the JobScheduler instance
HOSTNAMENOT NULLVARCHAR  host on which the JobScheduler instance has been installed
PORTNOT NULLNUMERIC 

TCP port that the JobScheduler instance is listening to

Status
colourRed
titleto be discussed

  • TCP, UDP Port
extra
  • in separate columns? yes.
LIVE_DIRECTORYNOT NULLVARCHAR  path of the live directory
CREATEDNOT NULLDATETIME  timestamp of record creation
MODIFIEDNOT NULLDATETIME  timestamp of record modification
Expand
titleINVENTORY_FILES
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary keyKey 
INSTANCE_IDNOT NULLNUMERICForeign keyKey

references INVENTORY_INSTANCES.ID

FILE_TYPENOT NULLVARCHAR 

file types in use:

  • job
  • job_chain
  • order

Not treatedfile types not used:

  • process_class
  • config
  • lock
  • schedule
  • ...
FILE_NAMENOT NULLVARCHAR 

Path path from live directory

e.g. test/my_job.job.xml

FILE_BASENAMENOT NULLVARCHAR 

file base name

File basename

e.g.

my_job.job.xml

FILE_DIRECTORYNOT NULLVARCHAR 

Path path calculated from the live directory

e.g. test

FILE_CREATEDNULLDATETIME UTC time timestamp of the creation date of the file
FILE_MODIFIEDNULLDATETIME UTC time timestamp of the last change modification date of the file
FILE_LOCAL_CREATEDNULLDATETIME Local time local timestamp of the creation date of the file
FILE_LOCAL_MODIFIEDNULLDATETIME Local time local timestamp of the last change modification date of the file
CREATEDNOT NULLDATETIME  timestamp of record creation
MODIFIEDNOT NULLDATETIME  timestamp of record modification
Expand
titleINVENTORY_JOBS
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary keyKey 
INSTANCE_IDNOT NULLNUMERICForeign keyKey

references INVENTORY_INSTANCES.ID

for easy cleanupused for simplified clean-up

FILE_IDNOT NULLNUMERICForeign keyKeyreferences INVENTORY_FILES.ID
NAMENOT NULLVARCHAR 

Job job name

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

BASENAMENOT NULLVARCHAR 

Job job base name

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

TITLENULLVARCHAR  job title

IS_ORDER_JOB

NOT NULLNUMERIC 

specifies if this job is part of a job chain:

  • 1: yes
  • 0: no

 

IS_RUNTIME_DEFINED

 

NOT 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
Expand
titleINVENTORY_JOB_CHAINS
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary keyKey 
INSTANCE_IDNOT NULLNUMERICForeign keyKey

references INVENTORY_INSTANCES.ID

for easy cleanupused for simplified clean-up
FILE_IDNOT NULLNUMERICForeign keyKeyreferences INVENTORY_FILES.ID
START_CAUSENOT NULLVARCHAR 

the following start causes are available:

  • file trigger
  • order
  • ...
NAMENOT NULLVARCHAR 

Job job chain name

e.g. test/my_jobchain ( for a given job chain path test/my_jobchain.job_chain.xml)

BASENAMENOT NULLVARCHAR 

Job job chain base name

e.g. my_jobchain ( for a given job chain path test/my_jobchain.job_chain.xml)
TITLENULLVARCHAR  job chain title
CREATEDNOT NULLDATETIME  timestamp of record creation
MODIFIEDNOT NULLDATETIME  timestamp of record modification
Expand
titleINVENTORY_JOB_CHAIN_NODES
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary keyKey 
INSTANCE_IDNOT NULLNUMERICForeign keyKey

references INVENTORY_INSTANCES.ID

for easy cleanupused for simplified clean-up
JOB_CHAIN_IDNOT NULLNUMERICForeign keyKeyreferences INVENTORY_JOB_CHAINS.ID
NAMENOT NULLVARCHAR 

job node name:

  • file_order_source
  • job_chain_node

Status
colourRed
titleto be discussed
Eventuell

  • possibly add end nodes such as END_NODE ...?
ORDERINGNOT NULLNUMERIC Node orderordering of node in job chain

STATE 

NULLVARCHAR  job node state as specified in the configuration
NEXT_STATENULLVARCHAR  next state for an order in case of successful execution
ERROR_STATENULLVARCHAR  error state for an order in case of unsuccessful execution
JOBNULLVARCHAR 

job reference as specified in the job node configuration

e.g. ../my_job

JOB_NAMENOT NULLVARCHARForeign keyKey

corresponds to INVENTORY_JOBS.NAME

e.g. test/my_job

CREATEDNOT NULLDATETIME  timestamp of record creation
MODIFIEDNOT NULLDATETIME  timestamp of record modification
Expand
titleINVENTORY_JOB_CHAIN_ORDERS
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary keyKey 
INSTANCE_IDNOT NULLNUMERICForeign keyKey

referencesINVENTORY_INSTANCES.ID

for easy cleanupused for simplified clean-up
FILE_IDNOT NULLNUMERICForeign keyKeyreferences INVENTORY_FILES.ID
JOB_CHAIN_NAMENOT NULLVARCHARForeign keyKey

corresponds to INVENTORY_JOB_CHAINS.NAME

e.g. test/my_jobchain

ORDER_IDNOT NULLVARCHAR 

order identification (unique per job chain)

Order name

e.g.

my_order ( for a given job chain path test/my_jobchain,my_order.order.xml)

TITLENULLVARCHAR  order title

IS_RUNTIME_DEFINED

 

NOT NULLNUMERIC 

specifies if a start time has been configured:

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

Fact Tables

  • The following tables are used to collect facts from the JobScheduler history.
  • These tables can be used to create individual reports.

Status
colourRed
titleto be discussed
Eine neue extra Tabelle

  • Use of a separate table REPORT_TRIGGER_

...

  • CONFIGURATIONS for job chains including the PARENT_xxx

...

  • columns?

 ??

Expand
titleREPORT_TRIGGERS
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary keyKey 

SCHEDULER_ID

NOT NULL

VARCHAR

 

corresponds to SCHEDULER_ORDER_HISTORY.SCHEDULER_ID

HISTORY_IDNOT NULLNUMERIC 

corresponds to SCHEDULER_ORDER_HISTORY.HISTORY_ID

NAMENOT NULLVARCHAR 

corresponds to SCHEDULER_ORDER_HISTORY.ORDER_ID

TITLENULLVARCHAR 

Titleorder title

corresponds to INVENTORY_JOB_CHAIN_ORDERS.TITLE

PARENT_NAMENOT NULLVARCHAR 

corresponds to SCHEDULER_ORDER_HISTORY.JOB_CHAIN

PARENT_BASENAMENULLVARCHAR Job job chain basenamebase name
PARENT_TITLENULLVARCHAR 

corresponds to INVENTORY_JOB_CHAINS.TITLE

START_TIMENOT NULLDATETIME 

corresponds to SCHEDULER_ORDER_HISTORY.START_TIME

END_TIMENULLDATETIME 

corresponds to SCHEDULER_ORDER_HISTORY.END_TIME

SYNC_COMPLETEDNOT NULLNUMERIC 

specifies if a synchronization has been configured and has been completed successfully:

  • 1: yes
  • 0: no
  • 0
  • 1
RESULTS_COMPLETEDNOT NULLNUMERIC 0

specifies if all job nodes have been completed successfully:

  • 1: yes
  • 0: no
CREATEDNOT NULLDATETIME  timestamp of record creation
MODIFIEDNOT NULLDATETIME  timestamp of record modification
Expand
titleREPORT_EXECUTIONS
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary keyKey 
SCHEDULER_ID NOT NULLNUMERICForeign keyKeycorresponds to SCHEDULER_ORDER_HISTORY.SCHEDULER_ID
HISTORY_IDNOT NULLNUMERICForeign keyKeycorresponds to SCHEDULER_ORDER_HISTORY.HISTORY_ID
TRIGGER_IDNOT NULLNUMERICForeign keyKeyreferences REPORT_TRIGGERS.ID
STEPNOT NULLNUMERIC 

Sequence of steps

corresponds to SCHEDULER_ORDER_STEP_HISTORY.STEP

NAMENOT NULLVARCHAR 

corresponds to SCHEDULER_HISTORY.JOB_NAME

e.g. test/my_job

BASENAMENOT NULLVARCHAR 

Job 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
CREATEDNOT NULLDATETIME  timestamp of record creation
MODIFIEDNOT NULLDATETIME  timestamp of record modification

Custom Tables

  • The following tables are used for 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
    • Mapping of start causes for jobs

 

Expand
titleREPORT_APPS
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary keyKey 
NAMENOT NULLVARCHAR  application name
TITLENULLVARCHAR  application title
Expand
titleREPORT_JOBS
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary keyKey 
NAMENOT NULLVARCHAR  job name
TITLENULLVARCHAR  job title
Expand
titleREPORT_MANDATORS
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary keyKey 
NAMENOT NULLVARCHAR  mandator name
TITLENULLVARCHAR  mandator title
Expand
titleREPORT_MAP_JOB_APPS
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary keyKey 
JOB_IDNOT NULLVARCHARForeign key Key references REPORT_JOBS.ID
APPLICATION_IDNOT NULLNUMERICForeign keyKeyreferences REPORT_APPLICATIONS.ID
Expand
titleREPORT_MAP_JOB_MANDATORS
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary keyKey 
JOB_CHAINNOT NULLVARCHARForeign keyKeyreferences REPORT_JOBS.ID
MANDATOR_IDNOT NULLNUMERICForeign keyKeyreferences REPORT_MANDATOR.ID
Expand
titleREPORT_MAP_CAUSES
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary keyKey 
CAUSENOT NULLVARCHAR  start cause as used by JobScheduler
MAPPED_CAUSENOT NULLVARCHAR  individual mapping of start cause

Aggregation Tables

Expand
titleREPORT_TRIGGER_RESULTS
FieldNullableData typeConstraintDescription
IDNOT NULLNUMERICPrimary keyKey 
TRIGGER_IDNOT NULLNUMERICForeign keyKey

Reference to the

references

REPORT_TRIGGERS.ID

START_CAUSENOT NULLVARCHAR 

references SCHEDULER_HISTORY.CAUSE of the 1.st first step

if equals "order" check in the

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

STEPSNOT NULLNUMERIC 

Number specifies the number of steps that have been effected:

  • SCHEDULER_ORDER_STEP_HISTORY.STEP of the last step or
  • 1 for not order standalone jobs
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 keyKey 
REFERENCE_IDNOT NULLNUMERICForeign keyKey

Reference to the

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 calendar day

e.g. 1

START_WEEKNOT NULLNUMERIC 

Calendar calendar week

e.g. 52

START_MONTHNOT NULLNUMERIC 

Calendar calendar month

e.g. 12

START_QUARTERNOT NULLNUMERIC 

Quarterquarter

e.g. 1

START_YEARNOT NULLNUMERIC 

Yearyear

e.g. 2015

END_DAYNOT NULLNUMERIC 

Calendar calendar day

e.g. 1

END_WEEKNOT NULLNUMERIC 

Calendar calendar week

e.g. 52

END_MONTHNOT NULLNUMERIC 

Calendar calendar month

e.g. 12

END_QUARTERNOT NULLNUMERIC 

Quarterquarter

e.g. 1

END_YEARNOT NULLNUMERIC 

Calendar calendar year

e.g. 2015

CREATEDNOT NULLDATETIME  timestamp of record creation
MODIFIEDNOT NULLDATETIME  timestamp of record modification