API query SelectWorkClass (optimised)

Description

SelectWorkClass

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
icWorkClassDescription	c	matches
ilWorkClassIsActive	l	=
icBusinessComponent	c
ilRoleIsActive	l	=
tBusActivity.BusActivityCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBusActivity.BusActivityIsActive	l	=,<>
tBusActivity.BusActivityLabel	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBusComponent.BusComponentCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBusComponent.BusComponentIsActive	l	=,<>
tBusComponent.BusComponentIsRSVEnabled	l	=,<>
tBusComponent.BusComponentLabel	c	=,>=,>,<>,<=,<,begins,can-do,matches
tRole.RoleDescription	c	=,>=,>,<>,<=,<,begins,can-do,matches
tRole.RoleName	c	=,>=,>,<>,<=,<,begins,can-do,matches
tWorkClass.WorkClassDescription	c	=,>=,>,<>,<=,<,begins,can-do,matches
tWorkClass.WorkClassInstruction	c	=,>=,>,<>,<=,<,begins,can-do,matches
tWorkClass.WorkClassIsReturnToSender	l	=,<>
tWorkClass.WorkClassIsSendMail	l	=,<>
tWorkClass.WorkClassScopeBusinessFld	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

icWorkClassDescription	character	WorkClassDescription
ilWorkClassIsActive	logical	WorkClassIsActive
icBusinessComponent	character	Business component name
ilRoleIsActive	logical	RoleIsActive

query condition

each WorkClass where

WorkClass.WorkClassDescription matches icWorkClassDescription AND
WorkClass.WorkClassIsActive = ilWorkClassIsActive

first BusActivity (conditional-join) where

BusActivity.BusActivity_ID = WorkClass.BusActivity_ID AND

first BusComponent (conditional-join) where

BusComponent.BusComponent_ID = WorkClass.BusComponent_ID AND

first Role (conditional-join) where

Role.Role_ID = WorkClass.Role_ID AND
Role.RoleIsActive = ilRoleIsActive

query sort order

WorkClass.WorkClassDescription (ascending)

query resultset tqSelectWorkClass

field name	data type	db field	description
tiRole_ID	integer	Role.Role_ID	Record ID
tcRoleName	character	Role.RoleName	Role Name
tcWorkClassDescription	character	WorkClass.WorkClassDescription	Description
tcWorkClassInstruction	character	WorkClass.WorkClassInstruction	Instruction
tlWorkClassIsReturnToSender	logical	WorkClass.WorkClassIsReturnToSender	Return to Sender
tlWorkClassIsSendMail	logical	WorkClass.WorkClassIsSendMail	E-mail Notification
tcRoleDescription	character	Role.RoleDescription	RoleDescription
tcWorkClassScopeBusinessFld	character	WorkClass.WorkClassScopeBusinessFld	Business Field
tcBusComponentCode	character	BusComponent.BusComponentCode	Component
tcBusComponentLabel	character	BusComponent.BusComponentLabel	Label
	api annotation:		test annotation for BusComponentLabel
tlBusComponentIsActive	logical	BusComponent.BusComponentIsActive	Active
tlBusComponentIsRSVEnabled	logical	BusComponent.BusComponentIsRSVEnabled	Role Scope Enabled
tcBusActivityCode	character	BusActivity.BusActivityCode	Code
tcBusActivityLabel	character	BusActivity.BusActivityLabel	Activity
tlBusActivityIsActive	logical	BusActivity.BusActivityIsActive	Active
tiBusActivity_ID	integer	BusActivity.BusActivity_ID	Record ID
tiWorkClass_ID	integer	WorkClass.WorkClass_ID	Record ID
tiBusComponent_ID	integer	BusComponent.BusComponent_ID	BusComponent_ID
WorkClassCustom	character	calculated	custom fields
BusActivityCustom	character	calculated	custom fields
BusComponentCustom	character	calculated	custom fields
RoleCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(WorkClass),rowid(BusActivity),rowid(BusComponent),rowid(Role)

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 = "BWorkClass".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "SelectWorkClass".
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/bworkclass.selectworkclass.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.