API query LookupDestinations (optimised)

Description

lookup destination for event

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
icBusComponentName	c	=
ilAllChanges	l	=
tEventConfig.EventConfigAllUpdates	l	=,<>
tEventConfig.EventConfigEnabled	l	=,<>
tEventConfig.EventConfigLockRequired	l	=,<>
tEventConfig.EventConfigOnlyHeader	l	=,<>
tEventConfig.EventConfigStatusFieldName	c	=,>=,>,<>,<=,<,begins,can-do,matches
tEventConfig.EventConfigStatusValue	c	=,>=,>,<>,<=,<,begins,can-do,matches
tEventConfig.EventConfigSuppressEmpty	l	=,<>
tEventDestination.EventDestinationName	c	=,>=,>,<>,<=,<,begins,can-do,matches
tEventDestination.EventDestinationType	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiCompanyId	integer	Company id
icBusComponentName	character	class short name
ilAllChanges	logical

query condition

each EventConfig where

EventConfig.Company_Id = iiCompanyId AND
EventConfig.EventConfigEnabled = true AND
EventConfig.EventConfigAllUpdates = ilAllChanges

first BusComponent (inner-join) where

BusComponent.BusComponent_ID = EventConfig.BusComponent_ID AND
BusComponent.BusComponentCode = icBusComponentName

first EventDestination (inner-join) where

EventDestination.EventDestination_ID = EventConfig.EventDestination_ID AND

query resultset tqDestinations

field name	data type	db field	description
tlEventConfigAllUpdates	logical	EventConfig.EventConfigAllUpdates	When true, publish any update on the object. When false, see EventConfigStatusFieldName.
tlEventConfigEnabled	logical	EventConfig.EventConfigEnabled	When not enabled, nothing will be published.
tlEventConfigLockRequired	logical	EventConfig.EventConfigLockRequired	When lock required, object will be locked after publishing. (see BExternalControl)
tlEventConfigOnlyHeader	logical	EventConfig.EventConfigOnlyHeader	When true, published data only contains header data.
tcEventConfigStatusFieldName	character	EventConfig.EventConfigStatusFieldName	Points to the object status field in the class dataset, in case the event should only be published when the object changes status.
tcEventConfigStatusValue	character	EventConfig.EventConfigStatusValue	Event will be published when the new status of the object is this value.
tlEventConfigSuppressEmpty	logical	EventConfig.EventConfigSuppressEmpty	When true, empty fields are removed from the published data.
tiEventDestination_ID	integer	EventConfig.EventDestination_ID	Event Destination
tcEventDestinationName	character	EventDestination.EventDestinationName	Destination Name
tcEventDestinationType	character	EventDestination.EventDestinationType	possible values: TODIR DIRECTAPPSERVER
tlSuppressDefault	logical	calculated
tlSuppressEmpty	logical	calculated
EventConfigCustom	character	calculated	custom fields
EventDestinationCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(EventConfig),rowid(BusComponent),rowid(EventDestination)

Internal usage

BLF

method database.AdditionalUpdates
method database.PublishEvent

Sample code: how to call this query through RPCRequestService (QXtend Inbound)

define temp-table ttContext no-undo
    field propertyQualifier as character
    field propertyName as character
    field propertyValue as character
    index entityContext is primary unique
        propertyQualifier
        propertyName
    index propertyQualifier
        propertyQualifier.

define dataset dsContext for ttContext.

define variable vhContextDS as handle no-undo.
define variable vhExceptionDS as handle no-undo.
define variable vhServer as handle no-undo.
define variable vhInputDS as handle no-undo.
define variable vhInputOutputDS as handle no-undo.
define variable vhOutputDS as handle no-undo.
define variable vhParameter as handle no-undo.

/* Create context */
create ttContext.
assign ttContext.propertyName = "programName"
       ttContext.propertyValue = "BEventConfig".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "Destinations".
create ttContext.
assign ttContext.propertyName = "applicationId"
       ttContext.propertyValue = "fin".
create ttContext.
assign ttContext.propertyName = "entity"
       ttContext.propertyValue = "1000".
create ttContext.
assign ttContext.propertyName = "userName"
       ttContext.propertyValue = "mfg".
create ttContext.
assign ttContext.propertyName = "password"
       ttContext.propertyValue = "".

/* Create input dataset */
create dataset vhInputDS.
vhInputDS:read-xmlschema("file", "xml/beventconfig.destinations.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().

assign vhParameter::icRange = "A"
       vhParameter::icRowid = ""
       vhParameter::iiRownum = 0
       vhParameter::iiNumber = 5 /* Number of records to read */
       vhParameter::icSortColumns = ""
       vhParameter::ilCountOnly = false
       vhParameter::ilForwardRead = true
       vhParameter::iiMaximumBrowseRecordsToCount = 0.

vhParameter = vhInputDS:get-buffer-handle("tFilter").
vhParameter:buffer-create().

assign vhParameter::<field-name-1> = <field-value-1>
       vhParameter::<field-name-2> = <field-value-2>
       ...

/* Connect the AppServer */
create server vhServer.
vhServer:connect("-URL <appserver-url>").

if not vhServer:connected()
then do:
    message "Could not connect AppServer" view-as alert-box error title "Error".
    return.
end.

/* Run */
assign vhContextDS = dataset dsContext:handle.

run program/rpcrequestservice.p on vhServer
    (input-output dataset-handle vhContextDS by-reference,
           output dataset-handle vhExceptionDS,
     input        dataset-handle vhInputDS by-reference,
     input-output dataset-handle vhInputOutputDS by-reference,
           output dataset-handle vhOutputDS).

/* Handle output however you want, in this example, we dump it to xml */
if valid-handle(vhExceptionDS)
then vhExceptionDS:write-xml("file", "Exceptions.xml", true).

if valid-handle(vhOutputDS)
then vhOutputDS:write-xml("file", "Output.xml", true).

/* Cleanup */
vhServer:disconnect().
assign vhServer = ?.

if valid-handle(vhInputDS)
then delete object vhInputDS.

if valid-handle(vhOutputDS)
then delete object vhOutputDS.

if valid-handle(vhExceptionDS)
then delete object vhExceptionDS.