API query SelectEventConfig (optimised)

Description

SelectEventConfiguration; Select on table EventConfig

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
tBusComponent.BusComponentLabel	c	=,>=,>,<>,<=,<,begins,can-do,matches
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

Parameters (internal)

iiCompanyId

integer

Company id

query condition

each EventConfig where

EventConfig.Company_Id = iiCompanyId AND

first BusComponent (inner-join) where

BusComponent.BusComponent_ID = EventConfig.BusComponent_ID AND

first EventDestination (inner-join) where

EventDestination.EventDestination_ID = EventConfig.EventDestination_ID AND

query sort order

BusComponent.BusComponentLabel (ascending)

query resultset tqSelectEventConfig

field name	data type	db field	description
tiBusComponent_ID	integer	BusComponent.BusComponent_ID	BusComponent_ID
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.
tlEventConfigSuppressEmpty	logical	EventConfig.EventConfigSuppressEmpty	When true, empty fields are removed from the published data.
tcEventDestinationName	character	EventDestination.EventDestinationName	Destination Name
tlSuppressDefault	logical	calculated
tlSuppressEmpty	logical	calculated
tcBusComponentLabel	character	BusComponent.BusComponentLabel	Label
	api annotation:		test annotation for BusComponentLabel
tlEventConfigEnabled	logical	EventConfig.EventConfigEnabled	When not enabled, nothing will be published.
tlEventConfigAllUpdates	logical	EventConfig.EventConfigAllUpdates	When true, publish any update on the object. When false, see EventConfigStatusFieldName.
tcEventConfigStatusValue	character	EventConfig.EventConfigStatusValue	Event will be published when the new status of the object is this value.
tlEventConfigLockRequired	logical	EventConfig.EventConfigLockRequired	When lock required, object will be locked after publishing. (see BExternalControl)
ttLastModifiedDate	date	EventConfig.LastModifiedDate	Last Modified Date
tiLastModifiedTime	integer	EventConfig.LastModifiedTime	Last Modified Time
tcLastModifiedUser	character	EventConfig.LastModifiedUser	Last Modified User
tiCompany_ID	integer	EventConfig.Company_ID	Entity
tiEventConfig_ID	integer	EventConfig.EventConfig_ID	Record ID
tiEventDestination_ID	integer	EventConfig.EventDestination_ID	Event Destination
EventConfigCustom	character	calculated	custom fields
BusComponentCustom	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

unused

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 = "SelectEventConfig".
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.selecteventconfig.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.