Redwood Documentation

Product Documentation

 

›JCS 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.set_job_formatjcs.set_text_mode →

on-site-related topic PL/SQL API jcs.set_job_name

Summary

  • procedure set_job_name(script in varchar2, name in varchar2)
  • procedure set_job_name(name in varchar2, can_commit in boolean)
  • procedure set_job_name(job_id in number, name in varchar2, can_commit in boolean) ( In version 9 it is not possible to set the name of a job in a final state, where it was allowed in previous versions.Trailing spaces are trimmedThe job name is silently truncated to the maximum length, which is 80 characters in v6/7 and 255 in v8When passing an empty name the exception ORA-20000: JCS-MULTI: Modification vetoed: JCS-102074: Field Description on Job ... (submitted from ...) must be specified is thrown instead of ORA-01407: cannot update ("SYSJCS"."RWS_JOB$"."NAME") to NULL )

Set the name of job that is going to be submitted.

By default the name of a job is the description or name of the script that it is for. By changing the job name to some dynamically computed value, the operators will get more information in the job monitor.

The following exceptions can occur when you set a job name:

  • JCS-02041 - when the job does not exist yet/anymore.

Specification

procedure set_job_name(script in varchar2,
name in varchar2)

Set the name of a job immediately before submitting the job using jcs.submit or jcs.run.

Parameters

  • script - object name (script_name or owner.script_name), possibly with double quotes to specify lower case identifiers
  • name - new name for the job (max 80 characters)

Transaction keyword

The transaction keyword defines how and/or when the changes are committed to the database. A definition of the various transaction keywords can be found on the jcs package summary page.

submit_buffer

Specification

procedure set_job_name(name in varchar2,
can_commit in boolean default true)

Set the name of the current job.

Parameters

  • name - new name for the job (max 80 characters)
  • can_commit - should this be committed immediately?

Transaction keyword

The transaction keyword defines how and/or when the changes are committed to the database. A definition of the various transaction keywords can be found on the jcs package summary page.

can_commit

Specification

procedure set_job_name(job_id in number,
name in varchar2,
can_commit in boolean default true)

Set the name of any existing job.

Parameters

  • job_id - the ID of the job
  • name - new name for the job (max 80 characters)
  • can_commit - should this be committed immediately?

Transaction keyword

The transaction keyword defines how and/or when the changes are committed to the database. A definition of the various transaction keywords can be found on the jcs package summary page.

can_commit

Examples

Using jcs.set_job_name
       create or replace script balance_and_invoice_customers
       is
         cursor c_get_custid is
         select custid
         from   customer;
       begin
         for r in c_get_custid
         loop
           jcs.parameter('BALANCE', 'CUSTID', r.custid);
           jcs.set_job_name('BALANCE', 'Updating balance ' || r.custid);
           jcs.submit('BALANCE');
           commit;
           if jcs.job_statuscode_wait(jcs.last_job_id) = 'C'
           then
             jcs.parameter('INVOICE', 'CUSTID', r.custid);
             jcs.set_job_name('INVOICE', 'Invoicing ' || r.custid);
             jcs.submit('INVOICE');
             commit;
           end if;
         end loop;
       end;

Using jcs.set_job_name

``` Using jcs.set_job_name create or replace script balance ( p_custid in number ) is begin jcs.set_job_name('Updating balance ' || r.custid); -- do the work end;
<p class="FigureParagraph">Using jcs.set_job_name</p>

## See Also


*  <a href="jcs/submit">jcs.submit</a>
*  <a href="jcs/run">jcs.run</a>

  <div class="topic"><p>plsqlTopic</p></div>

<div class="topic"><p>onsiteTopic</p></div>
← jcs.set_job_formatjcs.set_text_mode →
  • Summary
  • Specification
  • Parameters
  • Transaction keyword
  • Specification
  • Parameters
  • Transaction keyword
  • Specification
  • Parameters
  • Transaction keyword
  • Examples
  • See Also
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 |