Product Knowledge Base

Space shortcuts

Page tree

Versions Compared

Old Version 18

changes.mady.by.user Robert Ehrlich

Saved on

compared with

New Version 19

changes.mady.by.user Robert Ehrlich

Saved on

Key

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

...

  • 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.
  • SQL ScriptsTables:   inventory.sql
    • SQL scripts in this article are provided for PostgreSQL. The SQL scrpts for the respective DBMS are provided by the JobScheduler installer.

 

Expand
titleINVENTORY_AGENT_CLUSTERMEMBERS
FieldNullableData typeConstraintUnique Constraint Description
IDNOT NULLNUMERICPrimary Key  
INSTANCE_IDNOT NULLNUMERICForeign Key  X

references INVENTORY_INSTANCES.ID

AGENT_CLUSTER_ID
NOT NULLNUMERICForeign Key  X

references INVENTORY_AGENT_CLUSTERS.ID

AGENT_INSTANCE_ID
NOT NULLNUMERICForeign Key  X

references INVENTORY_AGENT_INSTANCES.ID

URL
NOT NULLVARCHAR  agent url
ORDERING 
NOT NULL NUMERIC    
CREATEDNOT NULLDATETIME  UTC timestamp of record creation
MODIFIEDNOT NULLDATETIME  UTC timestamp of record modification

...

  • The following tables are used to collect facts from the JobScheduler history.
  • These tables can be used to create individual reports.
  • SQL ScriptsTables:   reporting.sql
    • SQL scripts in this article are provided for PostgreSQL. The SQL scrpts for the respective DBMS are provided by the JobScheduler installer.

 

Expand
titleREPORTING_TRIGGERS
FieldNullableData typeConstraintUnique ConstraintDescription
IDNOT NULLNUMERICPrimary Key  

SCHEDULER_ID

NOT NULL

VARCHAR

 

X

corresponds to SCHEDULER_ORDER_HISTORY.SPOOLER_ID

HISTORY_IDNOT NULLNUMERIC X

corresponds to SCHEDULER_ORDER_HISTORY.HISTORY_ID

NAMENOT NULLVARCHAR  

corresponds to SCHEDULER_ORDER_HISTORY.ORDER_ID

e.g. my_order for a given order path /test/my_jobchain,my_order.order.xml

TITLE VARCHAR  

order title

corresponds to INVENTORY_JOB_CHAIN_ORDERS.TITLE

PARENT_FOLDER
NOT NULLVARCHAR  

job chain folder 

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

PARENT_NAMENOT NULLVARCHAR  

job chain name

corresponds to SCHEDULER_ORDER_HISTORY.JOB_CHAIN

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

PARENT_BASENAME VARCHAR  

job chain base name

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

PARENT_TITLE VARCHAR  

job chain title

corresponds to INVENTORY_JOB_CHAINS.TITLE

STATE
 VARCHAR  

state of the order inside the job chain 

corresponds to SCHEDULER_ORDER_HISTORY.STATE

STATE_TEXT
 VARCHAR  

state text of the order

corresponds to SCHEDULER_ORDER_HISTORY.STATE_TEXT 

START_TIMENOT NULLDATETIME  

UTC timestamp of the start of the order

corresponds to SCHEDULER_ORDER_HISTORY.START_TIME

END_TIME DATETIME  

UTC timestamp of the end of the order

corresponds to SCHEDULER_ORDER_HISTORY.END_TIME

IS_RUNTIME_DEFINED
NOT NULLNUMERIC   specifies if a start time has been configured:
  • 1: yes
  • 0: no

corresponds to INVENTORY_ORDERS.IS_RUNTIME_DEFINED

RESULT_START_CAUSE
NOT NULLVARCHAR  

cause of the order start

  • order
  • file_trigger
  • ... 

corresponds to INVENTORY_JOB_CHAINS.START_CAUSE

RESULT_STEPS
NOT NULLNUMERIC  number of executed order steps 
RESULT_ERROR
NOT NULLNUMERIC  

specifies if an error occurred in the last executed order step:

  • 0: no error
  • 1: error
RESULT_ERROR_CODE
 VARCHAR  exception-code of the last executed order step error 
RESULT_ERROR_TEXT
 VARCHAR  exception-message of the last executed order step error  
SYNC_COMPLETEDNOT NULLNUMERIC  

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

  • 1: yes
  • 0: no
RESULTS_COMPLETEDNOT 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 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
    • Sample Data: reporting_map_insert.sql
      • SQL scripts in this article are provided for PostgreSQL. The SQL scrpts for the respective DBMS are provided by the JobScheduler installer.
         
Expand
titleREPORTING_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 UTC timestamp of record creation
MODIFIEDNOT NULLDATETIME UTC timestamp of record modification

...

  • SQL Scripts: reporting_cleanup_procedure.sql

      Report

        • SQL scripts in this article are provided for PostgreSQL. The SQL scrpts for the respective DBMS are provided by the JobScheduler installer.

      Cleanup all entries

      • cleanup all entries (reporting, dailyplan, yade)

        • SELECT REPORT_CLEANUP('all',0);

          • following tables will be truncated: 

            • REPORTING_TRIGGERS
            • REPORTING_EXECUTIONS
            • REPORTING_TASKS
            • REPORTING_EXECUTION_DATES
            • DAILY_PLAN
            • JADE_FILES
            • JADE_FILES_HISTORY
            • JADE_FILES_POSITIONS 

      • cleanup only reporting entries

        • SELECT REPORT_CLEANUP('reporting',0); 

          • following tables will be truncated:

            • REPORTING_TRIGGERS

            • REPORTING_EXECUTIONS

            • REPORTING_TASKS

            • REPORTING_EXECUTION_DATES 

      • cleanup only dailyplan entries

        • SELECT REPORT_CLEANUP('dailyplan',0);
          • following tables will be truncated

            • DAILY_PLAN 

      • cleanup only yade entries

        • SELECT REPORT_CLEANUP('yade',0);

          • following tables will be truncated:

            • JADE_FILES

            • JADE_FILES_HISTORY

            • JADE_FILES_POSITIONS 

      Cleanup entries older as n days 

      Example - cleanup entries older as 14 days 

      • cleanup all entries (reporting, dailyplan, yade)
        • SELECT REPORT_CLEANUP('all',14);
      • cleanup reporting entries
        • SELECT REPORT_CLEANUP('reporting',14);
      • cleanup reporting entries
        • SELECT REPORT_CLEANUP('reporting',14);
      • cleanup reporting entries
        • SELECT REPORT_CLEANUP('reporting',14)

      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
        • SQL scripts in this article are provided for PostgreSQL. The SQL scrpts for the respective DBMS are provided by the JobScheduler installer.

      Report about Installed Objects

      ...

      • Report about executions of jobs and job chains.