project QadFinancials > class BDCollection > API query SelectDCollection (optimised)

Description

Select query for DCollection records


query filter (table tFilter)


tcBusinessFieldNametcDataTypetcOperator
iiCompanyIdi
tDCollection.DCollectionBalanceCCd=,>=,>,<>,<=,<
tDCollection.DCollectionBalanceLCd=,>=,>,<>,<=,<
tDCollection.DCollectionBalanceTCd=,>=,>,<>,<=,<
tDCollection.DCollectionBankFileFormatc=,>=,>,<>,<=,<,begins,can-do,matches
tDCollection.DCollectionCreationDatet=,>=,>,<>,<=,<
tDCollection.DCollectionCreationTimei=,>=,>,<>,<=,<
tDCollection.DCollectionIncSelCodeListc=,>=,>,<>,<=,<,begins,can-do,matches
tDCollection.DCollectionIsAutomaticl=,<>
tDCollection.DCollectionIsExecutedl=,<>
tDCollection.DCollectionNamec=,>=,>,<>,<=,<,begins,can-do,matches
tDCollection.DCollectionNumberi=,>=,>,<>,<=,<
tDCollection.DCollectionOrigDebitCCd=,>=,>,<>,<=,<
tDCollection.DCollectionOrigDebitLCd=,>=,>,<>,<=,<
tDCollection.DCollectionOrigDebitTCd=,>=,>,<>,<=,<
tDCollection.DCollectionReferencec=,>=,>,<>,<=,<,begins,can-do,matches
tDCollection.DCollectionRequestedDatet=,>=,>,<>,<=,<
tDCollection.DCollectionYeari=,>=,>,<>,<=,<
tDPaySel.DPaySelStatusc=,>=,>,<>,<=,<,begins,can-do,matches
tGL.GLCodec=,>=,>,<>,<=,<,begins,can-do,matches
tUsr.UsrNamec=,>=,>,<>,<=,<,begins,can-do,matches


Parameters (internal)


iiCompanyIdintegerCompany 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 namedata typedb fielddescription
tiCompany_IDintegerDCollection.Company_IDLink to Company
tiCreationUsr_IDintegerDCollection.CreationUsr_IDLink to Usr
tiDCollection_IDintegerDCollection.DCollection_IDRecord ID
tdDCollectionBalanceCCdecimalDCollection.DCollectionBalanceCCSC Balance
tdDCollectionBalanceLCdecimalDCollection.DCollectionBalanceLCBC Balance
tdDCollectionBalanceTCdecimalDCollection.DCollectionBalanceTCTC Balance
tcDCollectionBankFileFormatcharacterDCollection.DCollectionBankFileFormatBank File Format
ttDCollectionCreationDatedateDCollection.DCollectionCreationDateCreation Date
tiDCollectionCreationTimeintegerDCollection.DCollectionCreationTimeCreation Time
tcDCollectionIncSelCodeListcharacterDCollection.DCollectionIncSelCodeListCustomer Payment Selection Code
tlDCollectionIsAutomaticlogicalDCollection.DCollectionIsAutomaticAutomatic
tlDCollectionIsExecutedlogicalDCollection.DCollectionIsExecutedExecuted
tcDCollectionNamecharacterDCollection.DCollectionNameName
tiDCollectionNumberintegerDCollection.DCollectionNumberNumber
tdDCollectionOrigDebitCCdecimalDCollection.DCollectionOrigDebitCCSC Original Debit
tdDCollectionOrigDebitLCdecimalDCollection.DCollectionOrigDebitLCBC Original Debit
tdDCollectionOrigDebitTCdecimalDCollection.DCollectionOrigDebitTCTC Original Debit
tcDCollectionReferencecharacterDCollection.DCollectionReference1099 Box Reference
ttDCollectionRequestedDatedateDCollection.DCollectionRequestedDateRequested Date
tiDCollectionYearintegerDCollection.DCollectionYearYear/Customer Payment Selection Code
tcDPaySelStatuscharacterDPaySel.DPaySelStatusStatus
tcDPaySelStatusTRcharactercalculated
tiGL_IDintegerDCollection.GL_IDGL Account
tcGLCodecharacterGL.GLCodeA code identifying the GL account.
tcUsrNamecharacterUsr.UsrNameUser Name
DCollectionCustomcharactercalculatedcustom fields
GLCustomcharactercalculatedcustom fields
UsrCustomcharactercalculatedcustom fields
DPaySelCustomcharactercalculatedcustom fields
ti_sequenceintegercalculatedprimary index
tc_rowidcharactercalculated = 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.