Oracle MGWI_ADMIN
Version 21c

General Information
Library Note Morgan's Library Page Header
ACE Director Alum Daniel Morgan, founder of Morgan's Library, is scheduling complimentary technical Workshops on Database Security for the first 30 Oracle Database customers located anywhere in North America, EMEA, LATAM, or APAC that send an email to asra_us@oracle.com. Request a Workshop for your organization today.
Purpose Messaging Gateway Administration
AUTHID DEFINER
Dependencies
ALL_QUEUES DBMS_SYS_ERROR MGW_DBSHUTDOWN_TRIG
AQ$_AGENT DBMS_UTILITY MGW_GATEWAY
DBA_QUEUES MGW$_AGENT_OPTIONS MGW_MQSERIES_PROPERTIES
DBA_QUEUE_TABLES MGW$_CONFIG MGW_MSMQ_PROPERTIES
DBA_ROLE_PRIVS MGW$_FOREIGN_QUEUES MGW_NOTIFY
DBA_SCHEDULER_JOBS MGW$_GATEWAY MGW_NOTIF_ELEMENT
DBA_SCHEDULER_RUNNING_JOBS MGW$_LINKS MGW_NOTIF_ELEMENT_LIST
DBA_USERS MGW$_SCHEDULES MGW_NOTIF_MSG
DBMS_AQADM MGW$_SUBSCRIBERS MGW_PROPERTIES
DBMS_AQADM_SYS MGWI_CONST MGW_PROPERTY
DBMS_LOCK MGWI_CRYPTO MGW_TIBRV_PROPERTIES
DBMS_MGWADM MGWI_FOREIGNQUEUE PLITBLM
DBMS_MGWADM_AGENT_LIB MGWI_MSGLINK V$INSTANCE
DBMS_REGISTRY MGWI_SCHEDULE V$MYSTAT
DBMS_SCHEDULER MGWI_SUBSCRIBER  
Documented No
Exceptions
Error Code Reason
ORA-32800 internal error
First Available Not known
Security Model Owned by SYS with EXECUTE granted to the MGW_AGENT_ROLE role.
Source {ORACLE_HOME}/rdbms/admin/mgwiadm.plb
SQL> @?/mgw/admin/mgwiadm.plb

SP2-0808: Package created with compilation warnings

SP2-0808: Package created with compilation warnings

Grant succeeded.

SQL> sho err
Errors for PACKAGE MGWI_ADMIN:

LINE/COL ERROR
------------------------------------------------------------------------
1/1 PLW-05018: unit MGWI_ADMIN omitted optional AUTHID clause;
default value DEFINER used

400/5 PLW-07203: parameter 'P_SUBSID' may benefit from use of the NOCOPY compiler hint

401/5 PLW-07203: parameter 'P_SCHEDID' may benefit from use of the NOCOPY hint

402/5 PLW-07203: parameter 'P_SUBSGUID' may benefit from use of the NOCOPY compiler hint

403/5 PLW-07203: parameter 'P_SCHEDGUID' may benefit from use of the NOCOPY compiler hint

550/5 PLW-07203: parameter 'P_SCHEMA' may benefit from use of the NOCOPY compiler hint

551/5 PLW-07203: parameter 'P_NAME' may benefit from use of the NOCOPY compiler hint

552/5 PLW-07203: parameter 'P_LINK' may benefit from use of the NOCOPY compiler hint

557/5 PLW-07203: parameter 'P_SCHEMA' may benefit from use of the NOCOPY compiler hint

558/5 PLW-07203: parameter 'P_NAME' may benefit from use of the NOCOPY compiler hint

559/5 PLW-07203: parameter 'P_LINK' may benefit from use of the NOCOPY compiler hint

571/5 PLW-07203: parameter 'P_ELEM_LIST' may benefit from use of the NOCOPY compiler hint

577/5 PLW-07203: parameter 'P_PROPERTIES' may benefit from use of the NOCOPY compiler hint

607/5 PLW-07203: parameter 'P_PROPS' may benefit from use of the NOCOPY compiler hint

611/5 PLW-07203: parameter 'P_PROPS' may benefit from use of the NOCOPY compiler hint
Subprograms
ADD_SUBSCRIBER DROP_TRACE_CONFIG PING
ADMIN_LOCK_TIMEOUT ENABLE_JOB PROPJOB_IDS
AGENT_FOR_LINK ENABLE_PROPAGATION_SCHEDULE PROPJOB_STYLE
AGENT_FOR_SCHEDULE FORMAT_MSG RAISE_ERROR
AGENT_FOR_SUBSCRIBER FQUEUE_EXISTS REGISTER_FOREIGN_QUEUE
AGENT_JOB_CLASS FULL_NAME REMOVE_AGENT
AGENT_JOB_NAME GET_AGENT_CAPABILITIES REMOVE_AGENT_OPTION
AGENT_LOG_QUEUE INVOKE_AGENT REMOVE_JOB
AGENT_NOTIFY_QUEUE INVOKE_AGENT2 REMOVE_MSGSYS_LINK
ALTER_AGENT INVOKE_AGENT3 REMOVE_OPTION
ALTER_JOB INVOKE_AGENT4 REMOVE_SUBSCRIBER
ALTER_JOB_OPTION IS_AQ_NORMAL_QUEUE REMOVE_SUBSCRIBER_BY_AGENT
ALTER_LINK_OPTION IS_BIT_SET RESET_JOB
ALTER_MSGSYS_LINK IS_DEFAULT_AGENT RESET_SUBSCRIBER
ALTER_PROPAGATION_SCHEDULE IS_FAQ_LINK SCHEDULE_PROPAGATION
ALTER_PROPERTIES IS_FQUEUE_REFBY_SCHEDULE SCHED_DISABLE_ATX
ALTER_SUBSCRIBER IS_FQUEUE_REFBY_SUBSCRIBER SCHED_DROP_OBJECT
ALTER_VALUE IS_LINK_LOG_QUEUE_SET SCHED_DROP_OBJECT_ATX
AQ_DROP_QUEUE IS_LINK_REFBY_FQUEUE SCHED_ENABLE_ATX
AQ_DROP_QUEUE_TABLE IS_LINK_REFBY_SUBSCRIBER SCHED_SET_ATTRIBUTE_ATX
AQ_QUEUE_EXISTS IS_LINK_REFBY_SUBS_PROPTYPE SEND_MANAGER_EVENT
AQ_QUEUE_PAYLOAD IS_LINK_USING_JMS SET_AGENT_OPTION
AQ_QUEUE_TYPE IS_NOTIFY SET_BIT
AS_BOOL IS_NO_CHANGE SET_INITDIR
AS_BOOLEAN IS_PROPERTY_ALTERED SET_LOG_EVENT
BOOLEAN_STRING IS_WINDOWS_PLATFORM SET_LOG_LEVEL
CLEANUP_GATEWAY LINK_COMPONENT SET_OPTION
CLEAR_BIT LINK_JMS_TYPE SET_TRACE_CONFIG
CONNTYPE_STR_FROM_FLAGS LINK_REFBY SHUTDOWN
CREATE_AGENT LOCK_ADMIN STARTUP
CREATE_AGENT_JOB_CLASS MGWPROP_ADD START_AGENT
CREATE_AGENT_JSJOB MGWPROP_FIND SUBSCRIBER_AQAGENT
CREATE_AGENT_JSJOB_ATX MGWPROP_GET TASK
CREATE_COMMON_SCHEDULER_OBJS MGWPROP_IS_RESERVED TEST_LIBRARY_ACCESS
CREATE_JOB MGWPROP_NAME_MATCH TRACE
CREATE_MSGSYS_LINK MGWPROP_REMOVE TRACE_AGENT_INFO
DB_CONNECT_INFO MGW_COMPONENT_VERSION UC_TRUN
DB_SHUTDOWN_TRIGGER NFYLIST_APPEND_PROPERTIES UNLOCK_ADMIN
DISABLE_JOB NORMALIZE_NAME UNREGISTER_FOREIGN_QUEUE
DISABLE_PROPAGATION_SCHEDULE PARSE_COMPONENT UNSCHEDULE_PROPAGATION
DROP_AGENT_SCHEDULER_OBJS PARSE_DB_NAME WRITE_LOG_ENTRY
DROP_COMMON_SCHEDULER_OBJS PARSE_NAME  
 
ADD_SUBSCRIBER
Undocumented mgwi_admin.add_subscriber(
p_subscriberid   IN VARCHAR2,
p_proptype       IN BINARY_INTEGER,
p_queuename      IN VARCHAR2,
p_destination    IN VARCHAR2,
p_rule           IN VARCHAR2,
p_transformation IN VARCHAR2,
p_exceptionqueue IN VARCHAR2,
p_options        IN sys.mgw_properties);
TBD
 
ADMIN_LOCK_TIMEOUT
Undocumented mgwi_admin.admin_lock_timeout RETURN BINARY_INTEGER;
SELECT mgwi_admin.admin_lock_timeout
FROM dual;

ADMIN_LOCK_TIMEOUT
------------------
 
 
AGENT_FOR_LINK
Undocumented mgwi_admin.agent_for_link(p_linkname IN VARCHAR2) RETURN VARCHAR2;
TBD
 
AGENT_FOR_SCHEDULE
Undocumented mgwi_admin.agent_for_schedule(p_scheduleid IN VARCHAR2) RETURN VARCHAR2;
TBD
 
AGENT_FOR_SUBSCRIBER
Undocumented mgwi_admin.agent_for_subscriber(p_subscriberid IN VARCHAR2) RETURN VARCHAR2;
TBD
 
AGENT_JOB_CLASS
Undocumented mgwi_admin.agent_job_class(
p_agent    IN VARCHAR2,
p_fullname IN BINARY_INTEGER)
RETURN VARCHAR2;
TBD
 
AGENT_JOB_NAME
Undocumented mgwi_admin.agent_job_name(
p_agent    IN VARCHAR2,
p_fullname IN BINARY_INTEGER)
RETURN VARCHAR2;
TBD
 
AGENT_LOG_QUEUE
Undocumented mgwi_admin.agent_log_queue(
p_agent IN VARCHAR2,
p_which IN BINARY_INTEGER)
RETURN VARCHAR2;
TBD
 
AGENT_NOTIFY_QUEUE
Undocumented mgwi_admin.agent_notify_queue(
p_agent IN VARCHAR2,
p_which IN BINARY_INTEGER)
RETURN VARCHAR2;
TBD
 
ALTER_AGENT
Undocumented

Overload 1
mgwi_admin.alter_agent(
p_max_connections IN BINARY_INTEGER,
p_max_memory      IN BINARY_INTEGER,
p_max_threads     IN BINARY_INTEGER,
p_service         IN VARCHAR2);
TBD
Overload 2 mgwi_admin.alter_agent(
p_agent       IN VARCHAR2,
p_username    IN VARCHAR2,
p_password    IN VARCHAR2,
p_database    IN VARCHAR2,
p_conntype    IN VARCHAR2,
p_max_memory  IN BINARY_INTEGER,
p_max_threads IN BINARY_INTEGER,
p_service     IN VARCHAR2,
p_initfile    IN VARCHAR2,
p_comment     IN VARCHAR2);
TBD
 
ALTER_JOB
Undocumented mgwi_admin.alter_job(
p_job_name        IN VARCHAR2,
p_rule            IN VARCHAR2,
p_transformation  IN VARCHAR2,
p_exception_queue IN VARCHAR2,
p_poll_interval   IN BINARY_INTEGER,
p_options         IN sys.mgw_properties,
p_comments        IN VARCHAR2);
TBD
 
ALTER_JOB_OPTION
Undocumented mgwi_admin.alter_job_option(
p_job_name IN VARCHAR2,
p_name     IN VARCHAR2,
p_value    IN VARCHAR2,
p_remove   IN BOOLEAN);
TBD
 
ALTER_LINK_OPTION
Undocumented mgwi_admin.alter_link_option(
p_linkname IN VARCHAR2,
p_name     IN VARCHAR2,
p_value    IN VARCHAR2,
p_remove   IN BOOLEAN);
TBD
 
ALTER_MSGSYS_LINK
Undocumented

Overload 1
mgwi_admin.alter_msgsys_link(
p_linkname   IN VARCHAR2,
p_properties IN sys.mgw_mqseries_properties,
p_options    IN sys.mgw_properties,
p_comment    IN VARCHAR2);
TBD
Overload 2 mgwi_admin.alter_msgsys_link(
p_linkname   IN VARCHAR2,
p_properties IN sys.mgw_tibrv_properties,
p_options    IN sys.mgw_properties,
p_comment    IN VARCHAR2);
TBD
Overload 3 mgwi_admin.alter_msgsys_link(
p_linkname   IN VARCHAR2,
p_properties IN sys.mgw_msmq_properties,
p_options    IN sys.mgw_properties,
p_comment    IN VARCHAR2);
TBD
 
ALTER_PROPAGATION_SCHEDULE
Undocumented mgwi_admin.alter_propagation_schedule(
p_scheduleid IN VARCHAR2,
p_duration   IN NUMBER,
p_nexttime   IN VARCHAR2,
p_latency    IN NUMBER);
TBD
 
ALTER_PROPERTIES
Undocumented mgwi_admin.alter_properties(
p_properties    IN OUT sys.mgw_properties,
p_alter         IN     sys.mgw_properties,
p_null_if_empty IN     BOOLEAN);
TBD
 
ALTER_SUBSCRIBER
Undocumented mgwi_admin.alter_subscriber(
p_subscriberid   IN VARCHAR2,
p_rule           IN VARCHAR2,
p_transformation IN VARCHAR2,
p_exceptionqueue IN VARCHAR2,
p_options        IN sys.mgw_properties);
TBD
 
ALTER_VALUE
Undocumented mgwi_admin.alter_value(
p_expr1 IN VARCHAR2,
p_expr2 IN VARCHAR2)
RETURN VARCHAR2;
TBD
 
AQ_DROP_QUEUE
Undocumented mgwi_admin.aq_drop_queue(
p_queue        IN VARCHAR2,
p_ignore_error IN BOOLEAN);
TBD
 
AQ_DROP_QUEUE_TABLE
Undocumented mgwi_admin.aq_drop_queue_table(p_qtable IN VARCHAR2);
TBD
 
AQ_QUEUE_EXISTS
Undocumented mgwi_admin.aq_queue_exists(p_fullname IN VARCHAR2) RETURN BINARY_INTEGER;
SELECT mgwi_admin.aq_queue_exists('ALERT_QUE')
FROM dual;

MGWI_ADMIN.AQ_QUEUE_EXISTS('ALERT_QUE')
---------------------------------------
                                      0
 
AQ_QUEUE_PAYLOAD
Undocumented mgwi_admin.aq_queue_payload(p_queue IN VARCHAR2) RETURN VARCHAR2;
SELECT mgwi_admin.aq_queue_payload('ALERT_QUE')
FROM dual;

MGWI_ADMIN.AQ_QUEUE_PAYLOAD('ALERT_QUE')
----------------------------------------
 
 
AQ_QUEUE_TYPE
From the name a reasonable assumption would be that given a queue name it would return the queue type ... tested with a normal queue, exception queue, and a non-persistent queue it always returned NULL mgwi_admin.aq_queue_type(p_queue IN VARCHAR2) RETURN VARCHAR2;
DECLARE
 retVal dbms_id;
BEGIN
  retVal := mgwi_admin.aq_queue_type('AQ$_SYS$SERVICE_METRICS_TAB_E');
  dbms_output.put_line(retVal);
END;
/

PL/SQL procedure successfully completed.
 
AS_BOOL
TRUE returns 1, FALSE returns 0 mgwi_admin.as_bool(p_value IN BOOLEAN) RETURN NUMBER;
DECLARE
 retVal NUMBER;
BEGIN
  retVal := mgwi_admin.as_bool(TRUE);
  dbms_output.put_line(retVal);
END;
/
1

PL/SQL procedure successfully completed.
 
AS_BOOLEAN
If 0 returns FALSE, else any value returns TRUE mgwi_admin.as_boolean(p_value IN NUMBER) RETURN BOOLEAN;
DECLARE
 retVal NUMBER;
BEGIN
  IF mgwi_admin.as_boolean(3) THEN
    dbms_output.put_line('T');
  ELSE
    dbms_output.put_line('F');
  END IF;
END;
/
T

PL/SQL procedure successfully completed.
 
BOOLEAN_STRING
Converts a Boolean TRUE or FALSE to its string representation mgwi_admin.boolean_string(p_value IN BOOLEAN) RETURN VARCHAR2;
BEGIN
  dbms_output.put_line(mgwi_admin.boolean_string(TRUE));
END;
/
TRUE

PL/SQL procedure successfully completed.
 
CLEANUP_GATEWAY
Undocumented mgwi_admin.cleanup_gateway(
p_agent  IN VARCHAR2,
p_action IN BINARY_INTEGER,
p_sarg   IN VARCHAR2);
TBD
 
CLEAR_BIT
Undocumented mgwi_admin.clear_bit(
p_value IN NUMBER,
p_bit   IN NUMBER)
RETURN NUMBER;
TBD
 
CONNTYPE_STR_FROM_FLAGS
0 and even numbers return 'oci', odd numbers return 'thin' mgwi_admin.conntype_str_from_flags(p_flags IN BINARY_INTEGER) RETURN VARCHAR2;
BEGIN
  FOR i IN -10 .. 10 LOOP
    dbms_output.put_line(TO_CHAR(i) || ' - ' || mgwi_admin.conntype_str_from_flags(i));
  END LOOP;
END;
/
-10 - oci
-9 - thin
-8 - oci
-7 - thin
-6 - oci
-5 - thin
-4 - oci
-3 - thin
-2 - oci
-1 - thin
0 - oci
1 - thin
2 - oci
3 - thin
4 - oci
5 - thin
6 - oci
7 - thin
8 - oci
9 - thin
10 - oci

PL/SQL procedure successfully completed.
 
CREATE_AGENT
Undocumented mgwi_admin.create_agent(
p_agent       IN VARCHAR2,
p_username    IN VARCHAR2,
p_password    IN VARCHAR2,
p_database    IN VARCHAR2,
p_conntype    IN VARCHAR2,
p_max_memory  IN BINARY_INTEGER,
p_max_threads IN BINARY_INTEGER,
p_service     IN VARCHAR2,
p_initfile    IN VARCHAR2,
p_comment     IN VARCHAR2);
TBD
 
CREATE_AGENT_JOB_CLASS
Undocumented mgwi_admin.create_agent_job_class(
p_agent   IN VARCHAR2,
p_service IN VARCHAR2);
TBD
 
CREATE_AGENT_JSJOB
Undocumented mgwi_admin.create_agent_jsjob(p_agent IN VARCHAR2);
TBD
 
CREATE_AGENT_JSJOB_ATX
Undocumented mgwi_admin.create_agent_jsjob_atx(p_agent IN VARCHAR2);
TBD
 
CREATE_COMMON_SCHEDULER_OBJS
Undocumented mgwi_admin.create_common_scheduler_objs;
exec mgwi_admin.create_common_scheduler_objs;

PL/SQL procedure successfully completed.
 
CREATE_JOB
Undocumented mgwi_admin.create_job(
p_job_name        IN VARCHAR2,
p_prop_type       IN BINARY_INTEGER,
p_source          IN VARCHAR2,
p_destination     IN VARCHAR2,
p_rule            IN VARCHAR2,
p_transformation  IN VARCHAR2,
p_exception_queue IN VARCHAR2,
p_poll_interval   IN BINARY_INTEGER,
p_options         IN sys.mgw_properties,
p_enabled         IN BOOLEAN,
p_comments        IN VARCHAR2);
TBD
 
CREATE_MSGSYS_LINK
Undocumented

Overload 1
mgwi_admin.create_msgsys_link(
p_linkname   IN VARCHAR2,
p_agent      IN VARCHAR2,
p_properties IN sys.mgw_mqseries_properties,
p_options    IN sys.mgw_properties,
p_comment    IN VARCHAR2);
TBD
Overload 2 mgwi_admin.create_msgsys_link(
p_linkname   IN VARCHAR2,
p_agent      IN VARCHAR2,
p_properties IN sys.mgw_tibrv_properties,
p_options    IN sys.mgw_properties,
p_comment    IN VARCHAR2);
TBD
Overload 3 mgwi_admin.create_msgsys_link(
p_linkname   IN VARCHAR2,
p_agent      IN VARCHAR2,
p_properties IN sys.mgw_msmq_properties,
p_options    IN sys.mgw_properties,
p_comment    IN VARCHAR2);
TBD
 
DB_CONNECT_INFO
Undocumented mgwi_admin.db_connect_info(
p_username IN VARCHAR2,
p_password IN VARCHAR2,
p_database IN VARCHAR2);
TBD
 
DB_SHUTDOWN_TRIGGER
Undocumented mgwi_admin.db_shutdown_trigger;
exec mgwi_admin.db_shutdown_trigger;

PL/SQL procedure successfully completed.
 
DISABLE_JOB
Undocumented mgwi_admin.disable_job(p_job_name IN VARCHAR2);
TBD
 
DISABLE_PROPAGATION_SCHEDULE
Undocumented mgwi_admin.disable_propagation_schedule(p_scheduleid IN VARCHAR2);
TBD
 
DROP_AGENT_SCHEDULER_OBJS
Undocumented mgwi_admin.drop_agent_scheduler_objs(p_agent IN VARCHAR2);
TBD
 
DROP_COMMON_SCHEDULER_OBJS
Undocumented mgwi_admin.drop_common_scheduler_objs;
exec mgwi_admin.drop_common_scheduler_objs;

PL/SQL procedure successfully completed.
 
DROP_TRACE_CONFIG
Undocumented mgwi_admin.drop_trace_config;
exec mgwi_admin.drop_trace_config;

PL/SQL procedure successfully completed.
 
ENABLE_JOB
Undocumented mgwi_admin.enable_job(p_job_name IN VARCHAR2);
TBD
 
ENABLE_PROPAGATION_SCHEDULE
Undocumented mgwi_admin.enable_propagation_schedule(p_scheduleid IN VARCHAR2);
TBD
 
FORMAT_MSG
Undocumented mgwi_admin.format_msg(
p_base IN VARCHAR2,
p_arg1 IN VARCHAR2,
p_arg2 IN VARCHAR2,
p_arg3 IN VARCHAR2,
p_arg4 IN VARCHAR2,
p_arg5 IN VARCHAR2)
RETURN VARCHAR2;
TBD
 
FQUEUE_EXISTS
Undocumented mgwi_admin.fqueue_exists(p_fullname IN VARCHAR2) RETURN BINARY_INTEGER;
TBD
 
FULL_NAME
Undocumented mgwi_admin.full_name(
p_schema IN VARCHAR2,
p_name   IN VARCHAR2,
p_link   IN VARCHAR2 DEFAULT NULL)
RETURN VARCHAR2;
SELECT mgwi_admin.full_name(USER, 'ZZYZX', 'TESTLINK')
FROM dual;

MGWI_ADMIN.FULL_NAME(USER,'ZZYZX')
-----------------------------------
SYS.ZZYZX@TESTLINK
 
GET_AGENT_CAPABILITIES
Undocumented mgwi_admin.get_agent_capabilities(infotype IN BINARY_INTEGER) RETURN BINARY_INTEGER;
SELECT mgwi_admin.get_agent_capabilities(1)
FROM dual;

MGWI_ADMIN.GET_AGENT_CAPABILITIES(1)
------------------------------------
                                   3
 
INVOKE_AGENT
Undocumented mgwi_admin.invoke_agent(
username IN VARCHAR2,
password IN VARCHAR2,
database IN VARCHAR2,
heapsize IN BINARY_INTEGER)
RETURN BINARY_INTEGER;
TBD
 
INVOKE_AGENT2
Undocumented mgwi_admin.invoke_agent2(
username IN VARCHAR2,
password IN VARCHAR2,
database IN VARCHAR2,
heapsize IN BINARY_INTEGER,
initfile IN VARCHAR2,
version  IN BINARY_INTEGER)
RETURN BINARY_INTEGER;
TBD
 
INVOKE_AGENT3
Undocumented mgwi_admin.invoke_agent3(
username IN VARCHAR2,
password IN VARCHAR2,
database IN VARCHAR2,
heapsize IN BINARY_INTEGER,
initfile IN VARCHAR2,
gwguid   IN VARCHAR2,
jobsid   IN VARCHAR2,
version  IN BINARY_INTEGER)
RETURN BINARY_INTEGER;
TBD
 
INVOKE_AGENT4
Undocumented mgwi_admin.invoke_agent4(
username    IN VARCHAR2,
password    IN VARCHAR2,
database    IN VARCHAR2,
heapsize    IN BINARY_INTEGER,
initfile    IN VARCHAR2,
gwguid      IN VARCHAR2,
jobinstid   IN VARCHAR2,
agentname   IN VARCHAR2,
initfiledir IN VARCHAR2,
conntype    IN VARCHAR2,
version     IN BINARY_INTEGER)
RETURN BINARY_INTEGER;
TBD
'ALERT_QUE')
IS_AQ_NORMAL_QUEUE
Undocumented mgwi_admin.is_aq_normal_queue(p_queue IN VARCHAR2) RETURN BINARY_INTEGER;
SELECT mgwi_admin.is_aq_normal_queue('ALERT_QUE')
FROM dual;

MGWI_ADMIN.IS_AQ_NORMAL_QUEUE('ALERT_QUE')
------------------------------------------
                                        -1
 
IS_BIT_SET
Undocumented mgwi_admin.is_bit_set(
p_value IN NUMBER,
p_bit   IN NUMBER)
RETURN BOOLEAN;
TBD
 
IS_DEFAULT_AGENT
Undocumented mgwi_admin.is_default_agent(p_agent IN VARCHAR2) RETURN BOOLEAN;
TBD
 
IS_FAQ_LINK
Undocumented

Overload 1
mgwi_admin.is_faq_link(p_mlink IN sys.mgwi_msglink) RETURN BINARY_INTEGER;
TBD
Overload 2 mgwi_admin.is_faq_link(p_link IN VARCHAR2) RETURN BINARY_INTEGER;
TBD
 
IS_FQUEUE_REFBY_SCHEDULE
Undocumented mgwi_admin.is_fqueue_refby_schedule(p_queue IN VARCHAR2) RETURN BINARY_INTEGER;
SELECT mgwi_admin.is_fqueue_refby_schedule('ALERT_QUE')
FROM dual;

MGWI_ADMIN.IS_FQUEUE_REFBY_SCHEDULE('ALERT_QUE')
------------------------------------------------
                                               0
 
IS_FQUEUE_REFBY_SUBSCRIBER
Undocumented mgwi_admin.is_fqueue_refby_subscriber(p_queue IN VARCHAR2) RETURN BINARY_INTEGER;
SELECT mgwi_admin.is_fqueue_refby_subscriber('ALERT_QUE')
FROM dual;

MGWI_ADMIN.IS_FQUEUE_REFBY_SUBSCRIBER('ALERT_QUE')
--------------------------------------------------
                                                 0
 
IS_LINK_LOG_QUEUE_SET
Undocumented

Overload 1
mgwi_admin.is_link_log_queue_set(
p_link      IN VARCHAR2,
p_prop_type IN NUMBER)
RETURN BINARY_INTEGER;
TBD
Overload 2 mgwi_admin.is_link_log_queue_set(
p_mlink     IN sys.mgwi_msglink,
p_prop_type IN NUMBER)
RETURN BINARY_INTEGER;
TBD
 
IS_LINK_REFBY_FQUEUE
Undocumented mgwi_admin.is_link_refby_fqueue(p_link IN VARCHAR2) RETURN BINARY_INTEGER;
TBD
 
IS_LINK_REFBY_SUBSCRIBER
Undocumented mgwi_admin.is_link_refby_subscriber(p_link IN VARCHAR2) RETURN BINARY_INTEGER;
TBD
 
IS_LINK_REFBY_SUBS_PROPTYPE
Undocumented mgwi_admin.is_link_refby_subs_proptype(
p_link      IN VARCHAR2,
p_prop_type IN VARCHAR2)
RETURN BINARY_INTEGER;
TBD
 
IS_LINK_USING_JMS
Undocumented

Overload 1
mgwi_admin.is_link_using_jms(p_mlink IN sys.mgwi_msglink) RETURN BINARY_INTEGER;
TBD
Overload 2 mgwi_admin.is_link_using_jms(p_link IN VARCHAR2) RETURN BINARY_INTEGER;
TBD
 
IS_NOTIFY
Undocumented mgwi_admin.is_notify(p_agent IN VARCHAR2) RETURN BOOLEAN;
TBD
 
IS_NO_CHANGE
Undocumented mgwi_admin.mgwi_admin.is_no_change(p_expr IN VARCHAR2) RETURN BOOLEAN;
TBD
 
IS_PROPERTY_ALTERED
Undocumented mgwi_admin.is_property_altered(
p_properties1 IN sys.mgw_properties,
p_properties2 IN sys.mgw_properties,
p_name        IN VARCHAR2)
RETURN BOOLEAN;
TBD
 
IS_WINDOWS_PLATFORM
Undocumented mgwi_admin.is_windows_platform RETURN BOOLEAN;
BEGIN
  IF mgwi_admin.is_windows_platform THEN
    dbms_output.put_line('So embarrassing ... hosted on Windows');
  ELSE
    dbms_output.put_line('Hosted on a real operating system');
  END IF;
END;
/
So embarrassing ... hosted on Windows

PL/SQL procedure successfully completed.
 
LINK_COMPONENT
Undocumented mgwi_admin.link_component(p_str IN VARCHAR2) RETURN VARCHAR2;
TBD
 
LINK_JMS_TYPE
Undocumented

Overload 1
mgwi_admin.link_jms_type(p_mlink IN sys.mgwi_msglink) RETURN BINARY_INTEGER;
TBD
Overload 2 mgwi_admin.link_jms_type(p_link IN VARCHAR2) RETURN BINARY_INTEGER;
TBD
 
LINK_REFBY
Undocumented mgwi_admin.link_refby(
p_prop_type   IN BINARY_INTEGER,
p_source      IN VARCHAR2,
p_destination IN VARCHAR2)
RETURN VARCHAR2;
TBD
 
LOCK_ADMIN
Undocumented mgwi_admin.lock_admin(p_timeout IN NUMBER);
exec mgwi_admin.lock_admin(2);

PL/SQL procedure successfully completed.

exec mgwi_admin.unlock_admin;

PL/SQL procedure successfully completed.
 
MGWPROP_ADD
Undocumented mgwi_admin.mgwprop_add(
p_props IN OUT sys.mgw_properties,
p_value IN     sys.mgw_property);
TBD
 
MGWPROP_FIND
Undocumented mgwi_admin.mgwprop_find(
p_props IN sys.mgw_properties,
p_name  IN VARCHAR2)
RETURN BINARY_INTEGER;
TBD
 
MGWPROP_GET
Undocumented mgwi_admin.mgwprop_get(
p_props IN sys.mgw_properties,
p_name  IN VARCHAR2)
RETURN sys.mgw_property;
TBD
 
MGWPROP_IS_RESERVED
Undocumented mgwi_admin.mgwprop_is_reserved(p_name IN VARCHAR2) RETURN BOOLEAN;
TBD
 
MGWPROP_NAME_MATCH
Undocumented mgwi_admin.mgwprop_name_match(
p_name1 IN VARCHAR2,
p_name2 IN VARCHAR2)
RETURN BOOLEAN;
BEGIN
  IF mgwi_admin.mgwprop_name_match('A', 'B') THEN
    dbms_output.put_line('Match');
  ELSE
    dbms_output.put_line('No Match');
  END IF;
END;
/
 
MGWPROP_REMOVE
Undocumented mgwi_admin.mgwprop_remove(
p_props IN OUT sys.mgw_properties,
p_name  IN     VARCHAR2);
TBD
 
MGW_COMPONENT_VERSION
Undocumented mgwi_admin.mgw_component_version RETURN VARCHAR2;
SELECT mgwi_admin.mgw_component_version
FROM dual;

MGW_COMPONENT_VERSION
---------------------
21.0.0.0.0
 
NFYLIST_APPEND_PROPERTIES
Undocumented mgwi_admin.nfylist_append_properties(
p_elem_list      IN OUT sys.mgw_notif_element_list,
p_properties     IN     sys.mgw_properties,
p_attr_name      IN     VARCHAR2,
p_case_sensitive IN     BOOLEAN);
TBD
 
NORMALIZE_NAME
Undocumented mgwi_admin.normalize_name(
p_name  IN VARCHAR2,
p_type  IN BINARY_INTEGER,
p_flags IN BINARY_INTEGER)
RETURN VARCHAR2;
TBD
 
PARSE_COMPONENT
From a string containing schema_name dot object_name (at) dblink name can parse and return the first 2 but not the third mgwi_admin.parse_component(
p_str   IN VARCHAR2,
p_which IN BINARY_INTEGER)
RETURN VARCHAR2;
SELECT mgwi_admin.parse_component('uwclass.servers@dblink', 1)
FROM dual;

MGWI_ADMIN.PARSE_COMPONENT('UWCLASS.SERVERS@DBLINK',1)
------------------------------------------------------
uwclass


SELECT mgwi_admin.parse_component('uwclass.servers@dblink', 2)
FROM dual;

MGWI_ADMIN.PARSE_COMPONENT('UWCLASS.SERVERS@DBLINK',1)
------------------------------------------------------
uwclass


SELECT mgwi_admin.parse_component('uwclass.servers@dblink', 3)
FROM dual;

MGWI_ADMIN.PARSE_COMPONENT('UWCLASS.SERVERS@DBLINK',1)
------------------------------------------------------
 
 
PARSE_DB_NAME
Undocumented mgwi_admin.parse_db_name(
p_str    IN  VARCHAR2,
p_schema OUT VARCHAR2,
p_name   OUT VARCHAR2,
p_link   OUT VARCHAR2);
TBD
 
PARSE_NAME
Undocumented

p_type = 1: MSGLINK_NAME
p_type = 2: QUEUE_NAME
p_type = 3: SUBSCRIBER_ID
p_type = 4: SCHEDULER_ID
p_type = 5: AQ_QUEUE
p_type = 6: FOREIGN_QUEUE
p_type = 7: JOB_NAME
p_type = 8: AGENT_NAME
mgwi_admin.parse_name(
p_fullname IN  VARCHAR2,
p_type     IN  BINARY_INTEGER,
p_schema   OUT VARCHAR2,
p_name     OUT VARCHAR2,
p_link     OUT VARCHAR2,
p_flags    IN  BINARY_INTEGER DEFAULT NULL);
DECLARE
 outS dbms_id;
 outN dbms_id;
 outL dbms_id;
BEGIN
  mgwi_admin.parse_name('uwclass.server@dblink', 5, outS, outN, outL);
  dbms_output.put_line(outS);
  dbms_output.put_line(outN);
  dbms_output.put_line(outL);
END;
/
DECLARE
*
ERROR at line 1:
ORA-32804: invalid value UWCLASS.SERVER@DBLINK, AQ_QUEUE should have form SCHEMA.NAME
ORA-06512: at "SYS.DBMS_SYS_ERROR", line 116
ORA-06512: at "SYS.MGWI_ADMIN", line 649
ORA-06512: at "SYS.MGWI_ADMIN", line 5696
ORA-06512: at line 6
 
PING
Undocumented mgwi_admin.ping(
p_agent   IN VARCHAR2,
p_timeout IN NUMBER)
RETURN NUMBER;
TBD
 
PROPJOB_IDS
Undocumented mgwi_admin.propjob_ids(
p_jobname   IN  VARCHAR2,
p_subsid    OUT VARCHAR2,
p_schedid   OUT VARCHAR2,
p_subsguid  OUT RAW,
p_schedguid OUT RAW);
TBD
 
PROPJOB_STYLE
Undocumented mgwi_admin.propjob_style(p_jobname IN VARCHAR2) RETURN BINARY_INTEGER;
TBD
 
RAISE_ERROR
Undocumented mgwi_admin.raise_error(
p_errnum     IN BINARY_INTEGER,
p_arg1       IN VARCHAR2,
p_arg2       IN VARCHAR2,
p_arg3       IN VARCHAR2,
p_arg4       IN VARCHAR2,
p_keep_stack IN BINARY_INTEGER);
TBD
 
REGISTER_FOREIGN_QUEUE
Undocumented mgwi_admin.register_foreign_queue(
p_name           IN VARCHAR2,
p_linkname       IN VARCHAR2,
p_provider_queue IN VARCHAR2,
p_domain         IN NUMBER,
p_options        IN sys.mgw_properties,
p_comment        IN VARCHAR2);
TBD
 
REMOVE_AGENT
Undocumented mgwi_admin.remove_agent(p_agent IN VARCHAR2);
TBD
 
REMOVE_AGENT_OPTION
Undocumented mgwi_admin.remove_agent_option(
p_agent IN VARCHAR2,
p_type  IN BINARY_INTEGER,
p_name  IN VARCHAR2);
TBD
 
REMOVE_JOB
Undocumented mgwi_admin.remove_job(
p_job_name IN VARCHAR2,
p_force    IN BINARY_INTEGER)
TBD
 
REMOVE_MSGSYS_LINK
Undocumented mgwi_admin.remove_msgsys_link(p_linkname IN VARCHAR2);
TBD
 
REMOVE_OPTION
Undocumented mgwi_admin.remove_option(
target_type IN BINARY_INTEGER,
target_name IN VARCHAR2,
option_name IN VARCHAR2);
TBD
 
REMOVE_SUBSCRIBER
Undocumented mgwi_admin.remove_subscriber(
p_subscriberid IN VARCHAR2,
p_force        IN BINARY_INTEGER);
TBD
 
REMOVE_SUBSCRIBER_BY_AGENT
Undocumented mgwi_admin.remove_subscriber_by_agent(subs_guid IN RAW) RETURN BINARY_INTEGER;
TBD
 
RESET_JOB
Undocumented mgwi_admin.reset_job(p_job_name IN VARCHAR2);
TBD
 
RESET_SUBSCRIBER
Undocumented mgwi_admin.reset_subscriber(p_subscriberid IN VARCHAR2);
TBD
 
SCHEDULE_PROPAGATION
Undocumented mgwi_admin.schedule_propagation(
p_scheduleid  IN VARCHAR2,
p_proptype    IN BINARY_INTEGER,
p_source      IN VARCHAR2,
p_destination IN VARCHAR2,
p_starttime   IN DATE,
p_duration    IN NUMBER,
p_nexttime    IN VARCHAR2,
p_latency     IN NUMBER);
TBD
 
SCHED_DISABLE_ATX
Undocumented mgwi_admin.sched_disable_atx(
p_name  IN VARCHAR2,
p_force IN BOOLEAN);
TBD
 
SCHED_DROP_OBJECT
Undocumented mgwi_admin.sched_drop_object(
p_which IN BINARY_INTEGER,
p_name  IN VARCHAR2,
p_force IN BOOLEAN);
TBD
 
SCHED_DROP_OBJECT_ATX
Undocumented mgwi_admin.sched_drop_object_atx(
p_which IN BINARY_INTEGER,
p_name  IN VARCHAR2,
p_force IN BOOLEAN);
TBD
 
SCHED_ENABLE_ATX
Undocumented mgwi_admin.sched_enable_atx(p_name IN VARCHAR2);
TBD
 
SCHED_SET_ATTRIBUTE_ATX
Undocumented

Overload 1
mgwi_admin.sched_set_attribute_atx(
p_name      IN VARCHAR2,
p_attribute IN VARCHAR2,
p_value     IN VARCHAR2);
TBD
Overload 2 mgwi_admin.sched_set_attribute_atx(
p_name      IN VARCHAR2,
p_attribute IN VARCHAR2,
p_value     IN BINARY_INTEGER);
TBD
Overload 3 mgwi_admin.sched_set_attribute_atx(
p_name      IN VARCHAR2,
p_attribute IN VARCHAR2,
p_value     IN BOOLEAN);
TBD
 
SEND_MANAGER_EVENT
Undocumented mgwi_admin.send_manager_event(
p_agent          IN VARCHAR2,
p_manager        IN VARCHAR2,
p_event_name     IN VARCHAR2,
p_event_data     IN sys.mgw_properties,
p_case_sensitive IN NUMBER,
p_nfy_type       IN NUMBER);
TBD
 
SET_AGENT_OPTION
Undocumented mgwi_admin.set_agent_option(
p_agent     IN VARCHAR2,
p_type      IN BINARY_INTEGER,
p_name      IN VARCHAR2,
p_value     IN VARCHAR2,
p_encrypted IN BOOLEAN);
TBD
 
SET_BIT
Undocumented mgwi_admin.set_bit(
p_value IN NUMBER,
p_bit   IN NUMBER)
RETURN NUMBER;
TBD
 
SET_INITDIR
Undocumented mgwi_admin.set_initdir(p_initdir IN VARCHAR2);
TBD
 
SET_LOG_EVENT
Undocumented mgwi_admin.set_log_event(
p_agent     IN VARCHAR2,
p_log_event IN NUMBER,
p_component IN NUMBER);
TBD
 
SET_LOG_LEVEL
Undocumented mgwi_admin.set_log_level(
p_agent     IN VARCHAR2,
p_log_level IN BINARY_INTEGER);
TBD
 
SET_OPTION
Undocumented mgwi_admin.set_option(
target_type  IN BINARY_INTEGER,
target_name  IN VARCHAR2,
option_name  IN VARCHAR2,
option_value IN VARCHAR2,
encrypted    IN BOOLEAN);
TBD
 
SET_TRACE_CONFIG
Undocumented mgwi_admin.set_trace_config(
p_trace_enabled IN NUMBER,
p_trace_table   IN VARCHAR2);
TBD
 
SHUTDOWN
Shutdown Messaging Gateway agent mgwi_admin.shutdown(p_agent IN VARCHAR2);
TBD
 
STARTUP
Startup Messaging Gateway agent mgwi_admin.startup(p_agent IN VARCHAR2);
TBD
 
START_AGENT
Undocumented mgwi_admin.start_agent(
p_job_name IN VARCHAR2,
p_agent    IN VARCHAR2);
TBD
 
SUBSCRIBER_AQAGENT
Undocumented mgwi_admin.subscriber_aqagent(p_subscriberid IN VARCHAR2) RETURN sys.aq$_agent;
TBD
 
TASK
Undocumented mgwi_admin.task(
p_task   IN NUMBER,
p_extra1 IN VARCHAR2,
p_extra2 IN VARCHAR2);
TBD
 
TEST_LIBRARY_ACCESS
Undocumented mgwi_admin.test_library_access;
exec mgwi_admin.test_library_access;

PL/SQL procedure successfully completed.
 
TRACE
Undocumented mgwi_admin.trace(
p_method   IN VARCHAR2,
p_text     IN VARCHAR2,
p_category IN VARCHAR2,
p_errcode  IN NUMBER,
p_errmsg   IN VARCHAR2,
p_flags    IN BINARY_INTEGER);
TBD
 
TRACE_AGENT_INFO
Undocumented mgwi_admin.trace_agent_info(
p_agent  IN VARCHAR2,
p_method IN VARCHAR2,
p_text   IN VARCHAR2,
p_flags  IN BINARY_INTEGER);
TBD
 
UC_TRUN
Appears to be a wrapper for SUSTR(p_str,1,p_maxlen)

Haven't got a clue why anyone would have written this unless there is some less than obvious additional functionality
mgwi_admin.uc_trun(
p_str    IN VARCHAR2,
p_maxlen IN BINARY_INTEGER)
RETURN VARCHAR2;
SELECT mgwi_admin.uc_trun('ABCDEFGHIJKLMNOP', 12)
FROM dual;

MGWI_ADMIN.UC_TRUN('ABCDEFGHIJKLMNOP',12)
------------------------------------------
ABCDEFGHIJKL
 
UNLOCK_ADMIN
Undocumented mgwi_admin.unlock_admin;
See LOCK_ADMIN demo above
 
UNREGISTER_FOREIGN_QUEUE
Undocumented mgwi_admin.unregister_foreign_queue(
p_name     IN VARCHAR2,
p_linkname IN VARCHAR2);
TBD
 
UNSCHEDULE_PROPAGATION
Undocumented mgwi_admin.unschedule_propagation(p_scheduleid IN VARCHAR2);
TBD
 
WRITE_LOG_ENTRY
Undocumented mgwi_admin.write_log_entry(
p_agent     IN VARCHAR2,
p_text      IN VARCHAR2,
p_facility  IN VARCHAR2,
p_level     IN NUMBER,
p_component IN NUMBER,
p_event     IN NUMBER,
p_nfy_type  IN NUMBER);
TBD

Related Topics
Built-in Functions
Built-in Packages
Database Security
MGWI_CONST
MGWI_CRYPTO
MGWI_REG
What's New In 21c
What's New In 23c

Morgan's Library Page Footer
This site is maintained by Dan Morgan. Last Updated: This site is protected by copyright and trademark laws under U.S. and International law. © 1998-2023 Daniel A. Morgan All Rights Reserved
  DBSecWorx