API query SelectCDocumentStatus (optimised)

Description

Select query of creditor payment status
use this query in case you want to lookup a creditor payment status.
this query should only be used by UI-components!!!!

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
tCDocumentStatus.CDocumentStatusDefValDays	i	=,>=,>,<>,<=,<
tCDocumentStatus.CDocumentStatusDocType	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCDocumentStatus.CDocumentStatusStatus	c	=,>=,>,<>,<=,<,begins,can-do,matches
tGL1.GLCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tGL2.GLCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tJournal.JournalCode	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiCompanyId

integer

Company id

query condition

each CDocumentStatus where

CDocumentStatus.Company_Id = iiCompanyId AND

first GL1 (outer-join) where

GL1.SharedSet_Id = vi_GL_sharedset(iiCompanyId) AND
GL1.GL_ID = CDocumentStatus.GL_ID AND

first GL2 (inner-join) where

GL2.SharedSet_Id = vi_GL_sharedset(iiCompanyId) AND
GL2.GL_ID = CDocumentStatus.BankGL_ID AND

first Journal (outer-join) where

Journal.SharedSet_Id = vi_JOURNAL_sharedset(iiCompanyId) AND
Journal.Journal_ID = CDocumentStatus.Journal_ID AND

query sort order

CDocumentStatus.CDocumentStatusDocType (ascending)
CDocumentStatus.CDocumentStatusStatus (ascending)

query resultset tqSelectCDocumentStatus

field name	data type	db field	description
tcBankGLCode	character	GL2.GLCode	A code identifying the GL account.
tcDocumentStatusDocumentTypeCalc	character	calculated
tcDocumentStatusStatusCalc	character	calculated
tcCDocumentStatusDocType	character	CDocumentStatus.CDocumentStatusDocType	Payment Instrument
tcCDocumentStatusStatus	character	CDocumentStatus.CDocumentStatusStatus	Status
tiCDocumentStatusDefValDays	integer	CDocumentStatus.CDocumentStatusDefValDays	Default Value Days
tcGLCode	character	GL1.GLCode	A code identifying the GL account.
tcJournalCode	character	Journal.JournalCode	A daybook code (maximum eight characters).
tiCDocumentStatus_ID	integer	CDocumentStatus.CDocumentStatus_ID	Record ID
tiGL_ID	integer	CDocumentStatus.GL_ID	GL Account
tiJournal_ID	integer	CDocumentStatus.Journal_ID	Daybook Code
CDocumentStatusCustom	character	calculated	custom fields
GL1Custom	character	calculated	custom fields
GL2Custom	character	calculated	custom fields
JournalCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(CDocumentStatus),rowid(GL1),rowid(GL2),rowid(Journal)

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 = "BCDocumentStatus".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "SelectCDocumentStatus".
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/bcdocumentstatus.selectcdocumentstatus.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.