index

Package gb_event

This API provides the event messaging support for the Banner APIs.
Registers Banner business entity changes and publishes as XML to Oracle AQ.

Program units
f_entity_publishable   Determines if messaging is enabled system wide and for this entity.
f_messaging_enabled   Determines if messaging is enabled system wide and for this entity.
p_register_entity   Registers a business entity with the Event API
p_add_parameter   Adds the Entity attribute information to a previously registered entity.
p_add_parameter   Adds the Entity attribute information to a previously registered entity.
p_add_parameter   Adds the Entity attribute information to a previously registered entity.
p_discard   Removes the pending entity changes which are waiting to be published.
p_publish   Publishes all pending business entity changes.
p_set_bulksync_code   Enables bulk sync operating mode for event publishing and defines a bulk sync code.
P_DISABLE_SYNC_PUBLISHER   Disables sync publisher.
P_ENABLE_SYNC_PUBLISHER   Enables sync publisher.
P_ENABLE_SYNC_PUBLISHER   Enables sync publisher.

Constants
BASELINE_IND   Defines the indicator value for GURMESG_SOURCE_IND which specifies baseline records in the GURMESG table.
LOCAL_IND   Defines the indicator value for GURMESG_SOURCE_IND which specifies local records in the GURMESG table.
CREATE_OPERATION   Defines the create operation value for the p_register_entity p_operation_type parameter.
UPDATE_OPERATION   Defines the update operation value for the p_register_entity p_operation_type parameter.
DELETE_OPERATION   Defines the delete operation value for the p_register_entity p_operation_type parameter.
APP_ERROR   Defines the exception error number for all Banner API exceptions.

BASELINE_IND 

BASELINE_IND          CONSTANT VARCHAR2(1) := 'B';

Defines the indicator value for GURMESG_SOURCE_IND which specifies baseline records in the GURMESG table.

LOCAL_IND 

LOCAL_IND             CONSTANT VARCHAR2(1) := 'L';

Defines the indicator value for GURMESG_SOURCE_IND which specifies local records in the GURMESG table.

CREATE_OPERATION 

CREATE_OPERATION      CONSTANT NUMBER      := 1;

Defines the create operation value for the p_register_entity p_operation_type parameter.

UPDATE_OPERATION 

UPDATE_OPERATION      CONSTANT NUMBER      := 2;

Defines the update operation value for the p_register_entity p_operation_type parameter.

DELETE_OPERATION 

DELETE_OPERATION      CONSTANT NUMBER      := 3;

Defines the delete operation value for the p_register_entity p_operation_type parameter.

APP_ERROR 

APP_ERROR             CONSTANT NUMBER      := -20100;

Defines the exception error number for all Banner API exceptions.

f_entity_publishable 

FUNCTION f_entity_publishable(p_source_ind  VARCHAR2,
                              p_entity_name VARCHAR2 DEFAULT NULL)
  RETURN BOOLEAN

Determines if messaging is enabled system wide and for this entity.
@returns true is the entity is publishable, false if not.

Parameters
p_source_ind   The Baseline or Local source indicator for the entity definition.
p_entity_name   the Banner business entity name.

f_messaging_enabled 

FUNCTION f_messaging_enabled(p_source_ind  VARCHAR2,
                             p_entity_name VARCHAR2 DEFAULT NULL)
  RETURN BOOLEAN

Determines if messaging is enabled system wide and for this entity.
Support for 6.x compatibility.
@returns true is the entity is publishable, false if not.

Parameters
p_source_ind   The Baseline or Local source indicator for the entity definition.
p_entity_name   the Banner business entity name.

p_register_entity 

PROCEDURE p_register_entity(p_entity_name    VARCHAR2,
                            p_operation_type NUMBER)

Registers a business entity with the Event API

Parameters
p_entity_name   The name of the business entity.
p_operation_type   The type of operation performed on the entity.

p_add_parameter 

PROCEDURE p_add_parameter(p_name  VARCHAR2,
                          p_value VARCHAR2)

Adds the Entity attribute information to a previously registered entity.

Parameters
p_name   The attribute name.
p_value   The VARCHAR2 value of the attribute.

p_add_parameter 

PROCEDURE p_add_parameter(p_name  VARCHAR2,
                          p_value DATE)

Adds the Entity attribute information to a previously registered entity.

Parameters
p_name   The attribute name.
p_value   The DATE value of the attribute.

p_add_parameter 

PROCEDURE p_add_parameter(p_name  VARCHAR2,
                          p_value NUMBER)

Adds the Entity attribute information to a previously registered entity.

Parameters
p_name   The attribute name.
p_value   The NUMBER value of the attribute.

p_discard 

PROCEDURE p_discard

Removes the pending entity changes which are waiting to be published.

p_publish 

PROCEDURE p_publish

Publishes all pending business entity changes.

p_set_bulksync_code 

PROCEDURE p_set_bulksync_code(p_code VARCHAR2)

Enables bulk sync operating mode for event publishing and defines a bulk sync code. The bulk sync code is used to dispatch events to a special Bulk Sync Topic used to perform initial 3rd party data loads.

Parameters
p_code   The code used to distiguish events produced for this specific data load operation.

P_DISABLE_SYNC_PUBLISHER 

PROCEDURE p_disable_sync_publisher

Disables sync publisher. This procedure is called by the OpenEAI BannerGateway

P_ENABLE_SYNC_PUBLISHER 

PROCEDURE p_enable_sync_publisher

Enables sync publisher. This procedure is called by the OpenEAI BannerGateway

P_ENABLE_SYNC_PUBLISHER 

PROCEDURE p_enable_sync_publisher(p_test_suite_name      VARCHAR2,
                                  p_test_series_number   VARCHAR2,
                                  p_test_case_number     VARCHAR2,
                                  p_test_step_number     VARCHAR2,
                                  p_test_message_release VARCHAR2)

Enables sync publisher. This procedure is called by the OpenEAI BannerGateway Parameters below are from the TestId element of the OpenEAI protocol

Parameters
p_test_suite_name   The Test Suite identifier
p_test_series_number   The Test Series identifier
p_test_case_number   The Test Case identifier
p_test_step_number   The Test Step identifier
p_test_message_release   The Message Release being tested