API query SelectDCollection (optimised)

Description

Select query for DCollection records

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
tDCollection.DCollectionBalanceCC	d	=,>=,>,<>,<=,<
tDCollection.DCollectionBalanceLC	d	=,>=,>,<>,<=,<
tDCollection.DCollectionBalanceTC	d	=,>=,>,<>,<=,<
tDCollection.DCollectionBankFileFormat	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDCollection.DCollectionCreationDate	t	=,>=,>,<>,<=,<
tDCollection.DCollectionCreationTime	i	=,>=,>,<>,<=,<
tDCollection.DCollectionIncSelCodeList	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDCollection.DCollectionIsAutomatic	l	=,<>
tDCollection.DCollectionIsExecuted	l	=,<>
tDCollection.DCollectionName	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDCollection.DCollectionNumber	i	=,>=,>,<>,<=,<
tDCollection.DCollectionOrigDebitCC	d	=,>=,>,<>,<=,<
tDCollection.DCollectionOrigDebitLC	d	=,>=,>,<>,<=,<
tDCollection.DCollectionOrigDebitTC	d	=,>=,>,<>,<=,<
tDCollection.DCollectionReference	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDCollection.DCollectionRequestedDate	t	=,>=,>,<>,<=,<
tDCollection.DCollectionYear	i	=,>=,>,<>,<=,<
tDPaySel.DPaySelStatus	c	=,>=,>,<>,<=,<,begins,can-do,matches
tGL.GLCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tUsr.UsrName	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiCompanyId

integer

Company id

query condition

each DCollection where

DCollection.Company_Id = iiCompanyId AND

first DPaySel (conditional-join) where

DPaySel.Company_Id = iiCompanyId AND
DPaySel.DPaySel_ID = DCollection.DPaySel_ID AND

first GL (inner-join) where

GL.SharedSet_Id = vi_GL_sharedset(iiCompanyId) AND
GL.GL_ID = DCollection.GL_ID AND

first Usr (outer-join) where

Usr.Usr_ID = DCollection.CreationUsr_ID AND

query sort order

DCollection.DCollectionYear (ascending)
DCollection.DCollectionNumber (ascending)

query resultset tqSelectDCollection

field name	data type	db field	description
tiCompany_ID	integer	DCollection.Company_ID	Link to Company
tiCreationUsr_ID	integer	DCollection.CreationUsr_ID	Link to Usr
tiDCollection_ID	integer	DCollection.DCollection_ID	Record ID
tdDCollectionBalanceCC	decimal	DCollection.DCollectionBalanceCC	SC Balance
tdDCollectionBalanceLC	decimal	DCollection.DCollectionBalanceLC	BC Balance
tdDCollectionBalanceTC	decimal	DCollection.DCollectionBalanceTC	TC Balance
tcDCollectionBankFileFormat	character	DCollection.DCollectionBankFileFormat	Bank File Format
ttDCollectionCreationDate	date	DCollection.DCollectionCreationDate	Creation Date
tiDCollectionCreationTime	integer	DCollection.DCollectionCreationTime	Creation Time
tcDCollectionIncSelCodeList	character	DCollection.DCollectionIncSelCodeList	Customer Payment Selection Code
tlDCollectionIsAutomatic	logical	DCollection.DCollectionIsAutomatic	Automatic
tlDCollectionIsExecuted	logical	DCollection.DCollectionIsExecuted	Executed
tcDCollectionName	character	DCollection.DCollectionName	Name
tiDCollectionNumber	integer	DCollection.DCollectionNumber	Number
tdDCollectionOrigDebitCC	decimal	DCollection.DCollectionOrigDebitCC	SC Original Debit
tdDCollectionOrigDebitLC	decimal	DCollection.DCollectionOrigDebitLC	BC Original Debit
tdDCollectionOrigDebitTC	decimal	DCollection.DCollectionOrigDebitTC	TC Original Debit
tcDCollectionReference	character	DCollection.DCollectionReference	1099 Box Reference
ttDCollectionRequestedDate	date	DCollection.DCollectionRequestedDate	Requested Date
tiDCollectionYear	integer	DCollection.DCollectionYear	Year/Customer Payment Selection Code
tcDPaySelStatus	character	DPaySel.DPaySelStatus	Status
tcDPaySelStatusTR	character	calculated
tiGL_ID	integer	DCollection.GL_ID	GL Account
tcGLCode	character	GL.GLCode	A code identifying the GL account.
tcUsrName	character	Usr.UsrName	User Name
DCollectionCustom	character	calculated	custom fields
GLCustom	character	calculated	custom fields
UsrCustom	character	calculated	custom fields
DPaySelCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(DCollection),rowid(DPaySel),rowid(GL),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 = "BDCollection".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "SelectDCollection".
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/bdcollection.selectdcollection.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.