Redwood Documentation

Product Documentation

 

You are currently viewing the legacy RunMyJobs documentation site. This site will be taken down later this month.
All current and future RunMyJobs documentation, including versions 2023.3 and later, can be found here.
Please update your bookmarks. Use the version dropdown menu to select the documentation you need.

›JCS_EVENT Package

RunMyJobsPL/SQL API

Views

  • rs_all_registry_keys
  • rs_all_triggers
  • rs_applications
  • rs_credentials
  • rs_credential_users
  • rs_dba_jobs
  • rs_dba_job_parameters
  • rs_dba_role_privs
  • rs_dba_scripts
  • rs_destinations
  • rs_directories
  • rs_enabled_triggers
  • rs_events
  • rs_files
  • rs_formats
  • rs_format_upload_extensions
  • rs_index_types
  • rs_jobs
  • rs_job_definitions
  • rs_job_locks
  • rs_job_notes
  • rs_job_parameters
  • rs_job_statuses
  • rs_job_wait_events
  • rs_locks
  • rs_object_types
  • rs_operator_messages
  • rs_partitions
  • rs_protocols
  • rs_queues
  • rs_queue_schedulers
  • rs_registry_keys
  • rs_resources
  • rs_roles
  • rs_schedulers
  • rs_scheduler_file_events
  • rs_scheduler_parameters
  • rs_scheduler_queues
  • rs_scheduler_resources
  • rs_scripts
  • rs_scripttype_schedulers
  • rs_script_calls
  • rs_script_call_parameters
  • rs_script_locks
  • rs_script_parameters
  • rs_script_postconditions
  • rs_script_raise_events
  • rs_script_source
  • rs_script_stats
  • rs_script_steps
  • rs_script_step_postconditions
  • rs_script_wait_events
  • rs_submit_frames
  • rs_submit_frame_elements
  • rs_timezones
  • rs_time_windows
  • rs_time_window_elements
  • rs_users
  • rs_user_roles

JCS Package

  • Package jcs summary
  • jcs.add_job_lock
  • jcs.add_job_note
  • jcs.add_job_raise_event
  • jcs.add_job_wait_event
  • jcs.change_password
  • jcs.clear_event
  • jcs.clear_parameters
  • jcs.close
  • jcs.current_job
  • jcs.current_job_id
  • jcs.def_date
  • jcs.def_num
  • jcs.def_str
  • jcs.def_tstamp
  • jcs.delete_job
  • jcs.detach_child
  • jcs.disable_trigger
  • jcs.drop_user
  • jcs.enable_trigger
  • jcs.errorfile
  • jcs.explain_job_status
  • jcs.format_error_stack
  • jcs.generated_user
  • jcs.get_credential_password
  • jcs.get_current_user
  • jcs.get_date_timezone
  • jcs.get_default_partition
  • jcs.get_setuser
  • jcs.get_starttime
  • jcs.is_event_raised
  • jcs.job_parameter
  • jcs.job_pin_to_scheduler
  • jcs.job_status
  • jcs.job_statuscode
  • jcs.job_statuscode_wait
  • jcs.job_status_wait
  • jcs.last_job_id
  • jcs.multiple_values
  • jcs.no
  • jcs.open
  • jcs.operator_message
  • jcs.operator_reply
  • jcs.oracle_date_format
  • jcs.oracle_tstamp_format
  • jcs.outputfile
  • jcs.output_parameter
  • jcs.parameter
  • jcs.parent_job_id
  • jcs.raise_event
  • jcs.read
  • jcs.readfile
  • jcs.remove_job_wait_event
  • jcs.reschedule
  • jcs.return_code
  • jcs.run
  • jcs.search
  • jcs.searchfile
  • jcs.setchild
  • jcs.setpassword
  • jcs.setuser
  • jcs.set_current_job_status
  • jcs.set_date_timezone
  • jcs.set_default_partition
  • jcs.set_job_format
  • jcs.set_job_name
  • jcs.set_text_mode
  • jcs.submit
  • jcs.subscriber_info
  • jcs.ts_sort
  • jcs.use_known_password
  • jcs.wait
  • jcs.waitforone
  • jcs.yes

JCS_CHAIN Package

  • Package jcs_chain summary
  • jcs_chain.job_add_call

JCS_EVENT Package

  • Package jcs_event summary
  • jcs_event.event_comment
  • jcs_event.event_file
  • jcs_event.event_scheduler

JCS_ODF Package

  • Package jcs_odf summary
  • jcs_odf.alter_application
  • jcs_odf.alter_credential
  • jcs_odf.alter_event
  • jcs_odf.alter_format
  • jcs_odf.alter_lock
  • jcs_odf.alter_partition
  • jcs_odf.alter_queue
  • jcs_odf.alter_queue_scheduler
  • jcs_odf.alter_resource
  • jcs_odf.alter_scheduler
  • jcs_odf.alter_scheduler_file_event
  • jcs_odf.alter_scheduler_queue
  • jcs_odf.alter_script
  • jcs_odf.alter_submit_frame
  • jcs_odf.alter_time_window
  • jcs_odf.begin_transaction
  • jcs_odf.commit_transaction
  • jcs_odf.create_application
  • jcs_odf.create_credential
  • jcs_odf.create_event
  • jcs_odf.create_format
  • jcs_odf.create_lock
  • jcs_odf.create_partition
  • jcs_odf.create_queue
  • jcs_odf.create_queue_scheduler
  • jcs_odf.create_resource
  • jcs_odf.create_scheduler
  • jcs_odf.create_scheduler_file_event
  • jcs_odf.create_scheduler_queue
  • jcs_odf.create_scheduler_resource
  • jcs_odf.create_scheduler_scripttype
  • jcs_odf.create_script
  • jcs_odf.create_script_pcd
  • jcs_odf.create_script_step
  • jcs_odf.create_script_step_pcd
  • jcs_odf.create_submit_frame
  • jcs_odf.create_submit_frame_element
  • jcs_odf.create_time_window
  • jcs_odf.create_time_window_element
  • jcs_odf.ddl_trigger
  • jcs_odf.describe_into_table
  • jcs_odf.drop_application
  • jcs_odf.drop_credential
  • jcs_odf.drop_event
  • jcs_odf.drop_format
  • jcs_odf.drop_lock
  • jcs_odf.drop_monitor
  • jcs_odf.drop_partition
  • jcs_odf.drop_queue
  • jcs_odf.drop_queue_scheduler
  • jcs_odf.drop_resource
  • jcs_odf.drop_scheduler
  • jcs_odf.drop_scheduler_file_event
  • jcs_odf.drop_scheduler_queue
  • jcs_odf.drop_scheduler_resource
  • jcs_odf.drop_scheduler_scripttype
  • jcs_odf.drop_script
  • jcs_odf.drop_scripttype
  • jcs_odf.drop_submit_frame
  • jcs_odf.drop_submit_frame_element
  • jcs_odf.drop_time_window
  • jcs_odf.drop_time_window_element
  • jcs_odf.get_transaction_id
  • jcs_odf.rollback_transaction
  • jcs_odf.set_transaction_id

JCS_PRIV Package

  • Package jcs_priv summary
  • jcs_priv.delete_priv
  • jcs_priv.execute_priv
  • jcs_priv.insert_priv
  • jcs_priv.schema_application
  • jcs_priv.schema_code
  • jcs_priv.schema_credential
  • jcs_priv.schema_destination
  • jcs_priv.schema_directory
  • jcs_priv.schema_event
  • jcs_priv.schema_file
  • jcs_priv.schema_format
  • jcs_priv.schema_job
  • jcs_priv.schema_lock
  • jcs_priv.schema_monitor
  • jcs_priv.schema_partition
  • jcs_priv.schema_queue
  • jcs_priv.schema_registry
  • jcs_priv.schema_resource
  • jcs_priv.schema_scheduler
  • jcs_priv.schema_script
  • jcs_priv.schema_scripttype
  • jcs_priv.schema_submit_frame
  • jcs_priv.schema_time_window
  • jcs_priv.select_priv
  • jcs_priv.subscribe_priv
  • jcs_priv.update_priv

JCS_REGISTRY Package

  • Package jcs_registry summary
  • jcs_registry.check_key_id
  • jcs_registry.CURRENT_USER_PRF
  • jcs_registry.get_raw_key
  • jcs_registry.get_repos_parameter
  • jcs_registry.get_value
  • jcs_registry.key_path
  • jcs_registry.path_exists
  • jcs_registry.PUBLIC_PRF
  • jcs_registry.ROOT_CURRENT_USER
  • jcs_registry.ROOT_PUBLIC
  • jcs_registry.ROOT_USER

JCS_SNMP

  • Package jcs_snmp summary
  • jcs_snmp.generate_trap
  • jcs_snmp.sendtrap

TIME Package

  • Package time summary
  • time.calc_subfr
  • time.calc_win
  • time.timestamp_in_new_tz
← jcs_event.event_commentjcs_event.event_scheduler →

on-site-related topic PL/SQL API jcs_event.event_file

Summary

  • function event_file(event_name in varchar2, event_partition in varchar2) return varchar2

This function returns the file name of the file that raised the event.

note

In the 'common scenario' (jobs submitted by a raised event) it is no longer necessary for the parameters to be runtime. If the functions are called from a job context they will obtain their information from the job wait event. If they are called outside of a job context they will take their information from the event itself. For the mentioned 'common scenario' the results are identical.

Example

An example of how to use the jcs_event functionscreate or replace event "TESTE1"
       /

       alter scheduler sch_db_1
         add
           raise       "TESTE1"
             on file   '/tmp/tmp1*3.txt'
             check     2
       /

       create or replace script "TESTS1"
         ( "FILE"      in varchar2(255) null nodisplay noedit runtime
                       default jcs_event.event_file( 'TESTE1' )
         , "COMMENT"   in varchar2(255) null nodisplay noedit runtime
                       default jcs_event.event_comment( 'TESTE1' )
         , "SCHEDULER" in varchar2(255) null nodisplay noedit runtime
                       default jcs_event.event_scheduler( 'TESTE1' )
         )
         event         "TEST1" with clear
         as            begin
                         dbms_output.put_line('File     : '||FILE);
                         dbms_output.put_line('Comment  : '||COMMENT);
                         dbms_output.put_line('Scheduler: '||SCHEDULER);
                       end;
       /

       begin
         jcs.submit('TESTS1');
         commit;
       end;
       /

       begin
         jcs.wait(jcs.last_job_id, 60);
         dbms_output.put_line(jcs.readfile(jcs.last_job_id, 1, 0));
         dbms_output.put_line(jcs.readfile(jcs.last_job_id, 2, 0));
         dbms_output.put_line(jcs.readfile(jcs.last_job_id, 3, 0));
       end;
       /

An example of how to use the jcs_event functions

Specification

function event_file(event_name in varchar2,
event_partition in varchar2 default null)
    return varchar2

Parameters

  • event_name - the event name
  • event_partition - the event partition
  • returns varchar2 -

plsqlTopic

onsiteTopic

← jcs_event.event_commentjcs_event.event_scheduler →
  • Summary
    • Example
  • Specification
  • Parameters
Docs
Getting StartedInstallationFinance InstallationConcepts
TroubleshootingArchiving
Learn and Connect
Support Portal
BlogEventsResources
ISO/ IEC 27001 Information Security Management
Automate to be human

2023 All Rights Reserved |

Terms of Service | Policies | Cookies | Glossary | Third-party Software | Contact | Copyright | Impressum |