API query SelectWorkObject (optimised)

Description

Select query for workobject

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
tBusActivity.BusActivityCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBusActivity.BusActivityLabel	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBusComponent.BusComponentCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBusComponent.BusComponentLabel	c	=,>=,>,<>,<=,<,begins,can-do,matches
tRole.RoleName	c	=,>=,>,<>,<=,<,begins,can-do,matches
tUsr.UsrName	c	=,>=,>,<>,<=,<,begins,can-do,matches
tWorkObject.WorkObjectExternal_ID	c	=,>=,>,<>,<=,<,begins,can-do,matches
tWorkObject.WorkObjectInstruction	c	=,>=,>,<>,<=,<,begins,can-do,matches
tWorkObject.WorkObjectIsExternalCtrl	l	=,<>
tWorkObject.WorkObjectIsInternalCtrl	l	=,<>
tWorkObject.WorkObjectIsReturnToSender	l	=,<>
tWorkObject.WorkObjectIsSendMail	l	=,<>

Parameters (internal)

iiCompanyId

integer

Company id

query condition

each WorkObject where

WorkObject.Company_Id = iiCompanyId AND

first BusActivity (inner-join) where

BusActivity.BusActivity_ID = WorkObject.BusActivity_ID AND

first BusComponent (inner-join) where

BusComponent.BusComponent_ID = WorkObject.BusComponent_ID AND

first Role (conditional-join) where

Role.Role_ID = WorkObject.Role_ID AND

first Usr (conditional-join) where

Usr.Usr_ID = WorkObject.Usr_ID AND

query sort order

BusComponent.BusComponentCode (ascending)

query resultset tqSelectWorkObject

field name	data type	db field	description
tiBusActivity_ID	integer	BusActivity.BusActivity_ID	Record ID
tcBusActivityCode	character	BusActivity.BusActivityCode	Code
tcBusActivityLabel	character	BusActivity.BusActivityLabel	Activity
tiBusComponent_ID	integer	BusComponent.BusComponent_ID	BusComponent_ID
tcBusComponentCode	character	BusComponent.BusComponentCode	Component
tcBusComponentLabel	character	BusComponent.BusComponentLabel	Label
	api annotation:		test annotation for BusComponentLabel
tiCompany_ID	integer	WorkObject.Company_ID	Entity
ttLastModifiedDate	date	WorkObject.LastModifiedDate	Last Modified Date
tiLastModifiedTime	integer	WorkObject.LastModifiedTime	Last Modified Time
tcLastModifiedUser	character	WorkObject.LastModifiedUser	Last Modified User
tiObjectFlexStatus_ID	integer	WorkObject.ObjectFlexStatus_ID	Custom Object Status
tiRole_ID	integer	WorkObject.Role_ID	Role
tcRoleName	character	Role.RoleName	Role Name
tiSharedSet_ID	integer	WorkObject.SharedSet_ID	Shared Set
tiUsr_ID	integer	WorkObject.Usr_ID	User
tcUsrName	character	Usr.UsrName	User Name
tiWorkObject_ID	integer	WorkObject.WorkObject_ID	Record ID
tcWorkObjectExternal_ID	character	WorkObject.WorkObjectExternal_ID	reference to a external workflow system (if applicable)
tcWorkObjectInstruction	character	WorkObject.WorkObjectInstruction	Instructions
tiWorkObjectInternal_ID	integer	WorkObject.WorkObjectInternal_ID	Identification of the business object (= identity value of the main table record)
tlWorkObjectIsExternalCtrl	logical	WorkObject.WorkObjectIsExternalCtrl	Workflow is controlled by an external workflow system.
tlWorkObjectIsInternalCtrl	logical	WorkObject.WorkObjectIsInternalCtrl	Workflow is controlled by the internal ad-hoc workflow system.
tlWorkObjectIsReturnToSender	logical	WorkObject.WorkObjectIsReturnToSender	When true, the business object will be added in the sender's inbox after requested activity is completed.
tlWorkObjectIsSendMail	logical	WorkObject.WorkObjectIsSendMail	E-mail Notification
WorkObjectCustom	character	calculated	custom fields
BusActivityCustom	character	calculated	custom fields
BusComponentCustom	character	calculated	custom fields
RoleCustom	character	calculated	custom fields
UsrCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(WorkObject),rowid(BusActivity),rowid(BusComponent),rowid(Role),rowid(Usr)

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 = "BWorkObject".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "SelectWorkObject".
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/bworkobject.selectworkobject.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.