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_ODF 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_odf.create_eventjcs_odf.create_lock →

on-site-related topic PL/SQL API jcs_odf.create_format

Summary

  • procedure create_format(name in varchar2, description in varchar2, extension in varchar2, type in varchar2, out_index_name in varchar2, log_index_name in varchar2, mimetype in varchar2, comment_text in varchar2, application_name in varchar2, partition in varchar2, application_partition in varchar2, character_set in varchar2) (Parameter out_index_name is unsupported Parameter log_index_name is unsupported Parameter character_set is unsupported When parameter mime_type is set, then parameter type is ignored. Otherwise, when type is set to ASCII, the mime type text/plain is used and when type is set to BINARY or is unset, the mime type application/octet-stream is used. br/> )

Create a format.

Specification

procedure create_format(name in varchar2,
description in varchar2 default const.def_str,
extension in varchar2 default const.def_str,
type in varchar2 default const.def_str,
out_index_name in varchar2 default const.def_str,
log_index_name in varchar2 default const.def_str,
mimetype in varchar2 default const.def_str,
comment_text in varchar2 default const.def_str,
application_name in varchar2 default const.def_str,
partition in varchar2 default const.def_str,
application_partition in varchar2 default const.def_str,
character_set in varchar2 default const.def_str)

Parameters

  • name - the name of the format
  • description - a description for the format
  • extension - the extension of the format
note

The process server will assign this extension to the output file with this format type.

  • type - the output format ASCII or binary - this influences the way the process server treats special characters
  • out_index_name - the index type for the output file of the job - the process server uses the following index types:
  • TEXT - for indexing standard text reports
  • HTML - for indexing HTML reports
  • INSO_FILTER - the Inso filter is a universal filter that filters most report formats. Use it for indexing single and mixed format columns.
  • log_index_name - the index type for the log file of the job
  • mimetype - the content-type as used in MIME - the default value is 'text/plain'
  • comment_text - a comment with the format
  • application_name - the name of the application the format belongs to
  • partition - the partition of the format
  • application_partition - the partition of the application the format belongs to
  • character_set - used for jobfile conversion during jcs.readfile

See Also

  • jcs_odf.alter_format
  • jcs_odf.drop_format

plsqlTopic

onsiteTopic

← jcs_odf.create_eventjcs_odf.create_lock →
  • Summary
  • Specification
  • Parameters
  • 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 |