PL/SQL API jcs.operator_message

Summary

• procedure operator_message(text in varchar2, p_jobid in number, p_severity in varchar2)
• function operator_message(text in varchar2, defvalue in varchar2, format in varchar2, checkstr in varchar2, errormsg in varchar2, p_severity in varchar2) return varchar2 (Parameter defvalue ignored, but is needed for the data type of the return value. Parameter format is not used when defvalue is of data type VARCHAR2. When defvalue is of data type NUMBER, DATE or TIMESTAMP WITH TIME ZONE and checkstr is null, then the format is replaced by a regular expression for checkstr. Parameter errormsg ignored. Parameter severity ignored, although an extra operator message is created mentioning the severity. Parameter check_str needs to be changed into a (v8) regular expression, or one of the following upper(nvl(:1,''Y'')) in (''Y'',''N'')upper(substr(:1,1,1)) in (''Y'',''N'')upper(nvl(:1,''N'')) in (''J'',''N'')upper(nvl(:1,''NEE'')) in (''JA'',''NEE'') )
• function operator_message(text in varchar2, defvalue in timestamp with time zone, format in varchar2, checkstr in varchar2, errormsg in varchar2, p_severity in varchar2) return timestamp with time zone (See overload function jcs.operator_message(text varchar2,defvalue varchar2,format varchar2,checkstr varchar2,errormsg varchar2,p_severity varchar2) return varchar2)
• function operator_message(text in varchar2, defvalue in date, format in varchar2, checkstr in varchar2, errormsg in varchar2, p_severity in varchar2) return date (See overload function jcs.operator_message(text varchar2,defvalue varchar2,format varchar2,checkstr varchar2,errormsg varchar2,p_severity varchar2) return varchar2)
• function operator_message(text in varchar2, defvalue in number, format in varchar2, checkstr in varchar2, errormsg in varchar2, p_severity in varchar2) return number (See overload function jcs.operator_message(text varchar2,defvalue varchar2,format varchar2,checkstr varchar2,errormsg varchar2,p_severity varchar2) return varchar2)

Send a notice (message) to the operator or ask the operator a question.

Messages and questions end up in the operator message log, which can be filtered using the client tools.

During this time that the operator has not replied yet the job will be in the CONSOLE status.

Specification

procedure operator_message(text in varchar2,
p_jobid in number default null,
p_severity in varchar2 default null)

Send the operator a message.

Parameters

• text - the text to send to the operator
• p_jobid - override the job id the message is sent as (optional)
• p_severity - an optional severity of the message If defined this must be one of the severities from rs_monitor_severities

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.

autonomous

Specification

function operator_message(text in varchar2,
defvalue in varchar2,
format in varchar2 default null,
checkstr in varchar2 default null,
errormsg in varchar2 default null,
p_severity in varchar2 default null)
    return varchar2

Ask the operator a question and return the answer as a string.

Parameters

• text - the text to send to the operator
• defvalue - default reply displayed on the console
• format - input format that the reply must be in (for dates and numbers)
• checkstr - expression that validates the reply
• errormsg - message given when reply fails validation
• p_severity - an optional severity of the message If defined this must be one of the severities from rs_monitor_severities
• returns varchar2 - reply given by the operator

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.

blocks

Specification

function operator_message(text in varchar2,
defvalue in timestamp with time zone,
format in varchar2 default null,
checkstr in varchar2 default null,
errormsg in varchar2 default null,
p_severity in varchar2 default null)
    return timestamp with time zone

Ask a question that has a timestamp answer.

Parameters

• text - the text to send to the operator
• defvalue - default reply displayed on the console
• format - input format that the reply must be in (for dates and numbers)
• checkstr - expression that validates the reply
• errormsg - message given when reply fails validation
• p_severity - an optional severity of the message If defined this must be one of the severities from rs_monitor_severities
• returns timestamp with time zone -

Specification

function operator_message(text in varchar2,
defvalue in date,
format in varchar2 default null,
checkstr in varchar2 default null,
errormsg in varchar2 default null,
p_severity in varchar2 default null)
    return date

Ask a question that has a date answer.

Parameters

• text - the text to send to the operator
• defvalue - default reply displayed on the console
• format - input format that the reply must be in (for dates and numbers)
• checkstr - expression that validates the reply
• errormsg - message given when reply fails validation
• p_severity - an optional severity of the message If defined this must be one of the severities from rs_monitor_severities
• returns date -

Specification

function operator_message(text in varchar2,
defvalue in number,
format in varchar2 default null,
checkstr in varchar2 default null,
errormsg in varchar2 default null,
p_severity in varchar2 default null)
    return number

Ask a question that has a number answer.

Parameters

• text - the text to send to the operator
• defvalue - default reply displayed on the console
• format - input format that the reply must be in (for dates and numbers)
• checkstr - expression that validates the reply
• errormsg - message given when reply fails validation
• p_severity - an optional severity of the message If defined this must be one of the severities from rs_monitor_severities
• returns number -

See Also

• jcs_operator_messages (not implemented).
• jcs.operator_reply
• jcs_operator_messages (not implemented).
• jcs.operator_reply

plsqlTopic

onsiteTopic