API query SelectDDocument (optimised)

Description

Select query for DDocument

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
tBankNumber.BankNumber	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBusinessRelation.BusinessRelationCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBusinessRelation.BusinessRelationName1	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBusinessRelation.BusinessRelationSearchName	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCorporateGroup.CorporateGroupCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCurrency.CurrencyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDDocument.DDocumentBankImpRef	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDDocument.DDocumentCreationDate	t	=,>=,>,<>,<=,<
tDDocument.DDocumentCreationTime	i	=,>=,>,<>,<=,<
tDDocument.DDocumentDueDate	t	=,>=,>,<>,<=,<
tDDocument.DDocumentIncassoSelectCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDDocument.DDocumentIsOpen	l	=,<>
tDDocument.DDocumentLastPrintDate	t	=,>=,>,<>,<=,<
tDDocument.DDocumentNumber	i	=,>=,>,<>,<=,<
tDDocument.DDocumentOriginalDebitCC	d	=,>=,>,<>,<=,<
tDDocument.DDocumentOriginalDebitLC	d	=,>=,>,<>,<=,<
tDDocument.DDocumentOriginalDebitTC	d	=,>=,>,<>,<=,<
tDDocument.DDocumentReference	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDDocument.DDocumentStatus	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDDocument.DDocumentSubType	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDDocument.DDocumentTimesPrinted	i	=,>=,>,<>,<=,<
tDDocument.DDocumentType	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDDocument.DDocumentValueDays	i	=,>=,>,<>,<=,<
tDDocument.DDocumentYear	i	=,>=,>,<>,<=,<
tDebtor.DebtorCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDPaySel.DPaySelCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tGL.GLCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatType.PayFormatTypeCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tUsr.UsrName	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiCompanyId

integer

Company id

query condition

each DDocument where

DDocument.Company_Id = iiCompanyId AND

first BankNumber (inner-join) where

BankNumber.BankNumber_ID = DDocument.BankNumber_ID AND

first BankPayFormat (inner-join) where

BankPayFormat.BankPayFormat_ID = BankNumber.BankPayFormat_ID AND

first PayFormatType (inner-join) where

PayFormatType.PayFormatTypeCode = BankPayFormat.PayFormatTypeCode AND

first Currency (inner-join) where

Currency.Currency_ID = DDocument.Currency_ID AND

first Debtor (inner-join) where

Debtor.SharedSet_Id = vi_DEBTOR_sharedset(iiCompanyId) AND
Debtor.Debtor_ID = DDocument.Debtor_ID AND

first BusinessRelation (inner-join) where

BusinessRelation.BusinessRelation_ID = Debtor.BusinessRelation_ID AND

first CorporateGroup (conditional-join) where

CorporateGroup.CorporateGroup_ID = BusinessRelation.CorporateGroup_ID AND

first DPaySel (conditional-join) where

DPaySel.Company_Id = iiCompanyId AND
DPaySel.DPaySel_ID = DDocument.DPaySel_ID AND

first GL (inner-join) where

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

first Usr (outer-join) where

Usr.Usr_ID = DDocument.CreationUsr_ID AND

query sort order

DDocument.Company_ID (ascending)
DDocument.DDocumentType (ascending)
DDocument.DDocumentYear (ascending)
DDocument.DDocumentNumber (ascending)

query resultset tqSelectDDocument

field name	data type	db field	description
tcBankNumber	character	BankNumber.BankNumber	Bank Number
tcBusinessRelationCode	character	BusinessRelation.BusinessRelationCode	Business Relation. A code to identify the business relation. If this field does not have a input from the user, the system automatically generates a number for the record based on the sequence defined in Business Relation Autonumber Create.
tcBusinessRelationName1	character	BusinessRelation.BusinessRelationName1	Name: The full name of the business relation. This field sets the default name for linked addresses such as customers and suppliers.
	api annotation:		PartialUpdate = yes - defaults to the BusinessRelationCode.
tcBusinessRelationSearchName	character	BusinessRelation.BusinessRelationSearchName	Search Name: An alternate name for finding the business relation. This field can be useful for sorting and filtering.
	api annotation:		PartialUpdate = yes - defaults to the BusinessRelationCode.
tiCompany_ID	integer	DDocument.Company_ID	Link to Company
tcCorporateGroupCode	character	CorporateGroup.CorporateGroupCode	Group Name
tiCreationUsr_ID	integer	DDocument.CreationUsr_ID	Login
tcCreationUsrName	character	Usr.UsrName	User Name
tiCurrency_ID	integer	DDocument.Currency_ID	Currency Code
tcCurrencyCode	character	Currency.CurrencyCode	Currency Code
tiDCollection_ID	integer	DDocument.DCollection_ID	Link to DCollection
tiDDocument_ID	integer	DDocument.DDocument_ID	Record ID
tcDDocumentBankImpRef	character	DDocument.DDocumentBankImpRef	Bank Importing Reference
ttDDocumentCreationDate	date	DDocument.DDocumentCreationDate	Creation Date.This field indicate the payment creation date. This field is read-only.
tiDDocumentCreationTime	integer	DDocument.DDocumentCreationTime	Creation Time. The time payment is created.
tcDDocumentCreationTimeCalc	character	calculated
ttDDocumentDueDate	date	DDocument.DDocumentDueDate	Due Date. The date on which the payment is receivable.
tcDDocumentIncassoSelectCode	character	DDocument.DDocumentIncassoSelectCode	Customer Payment Selection Code. This field displays the customer payment selection code. This field is read-only.
tlDDocumentIsOpen	logical	DDocument.DDocumentIsOpen	Open. This field indicates if the payment is completely paid already.
ttDDocumentLastPrintDate	date	DDocument.DDocumentLastPrintDate	Last Printed Date. This field indicates the most recent printing date.
tiDDocumentNumber	integer	DDocument.DDocumentNumber	Document Number. This field hold a unified number for report use.
tdDDocumentOriginalDebitCC	decimal	DDocument.DDocumentOriginalDebitCC	TC Original Debit. This field holds the debit value of the payment in management currency.
tdDDocumentOriginalDebitLC	decimal	DDocument.DDocumentOriginalDebitLC	TC Original Debit. This field holds the debit value of the payment in base currency.
tdDDocumentOriginalDebitTC	decimal	DDocument.DDocumentOriginalDebitTC	Amount.This field hold the value of the payment in the transaction currency. This field must be positive and can be entered manually or automatically by linking the payment to an open item.
tcDDocumentReference	character	DDocument.DDocumentReference	Reference. Reference text for the payment.
tcDDocumentStatus	character	DDocument.DDocumentStatus	Status. The payment status. The default value for a new record is Initial.
tcDDocumentStatusCalc	character	calculated
tcDDocumentSubType	character	DDocument.DDocumentSubType	Subtype. This read-only field indicates that the payment is manual or automatic. You create manual customer payments through the Customer Payment activities, and automatic payments through the Customer Payment Selections.
tcDDocumentSubTypeCalc	character	calculated
tiDDocumentTimesPrinted	integer	DDocument.DDocumentTimesPrinted	Times Printed.This field indicates the number of times the payment has been printed. This field is read-only.
tcDDocumentType	character	DDocument.DDocumentType	Payment Instrument. The system displays the payment instrument associated with the payment format linked to the customer bank.
tcDDocumentTypeCalc	character	calculated
tiDDocumentValueDays	integer	DDocument.DDocumentValueDays	Value Days. A value for the number of days required by the bank to process the transaction. The default is based on the payment status entered.
tiDDocumentYear	integer	DDocument.DDocumentYear	Year/Number. This field displays the accounting year and payment sequence number, which is automatically generated by the accounting year.
tiDebtor_ID	integer	DDocument.Debtor_ID	Customer
tcDebtorCode	character	Debtor.DebtorCode	A code (maximum eight characters) that identifies a customer. If the code you specify matches an existing supplier code, a warning message displays. You can choose to ignore the warning, and create the record. However, when a supplier and customer share the same code, they must reference the same business relation.
	api annotation:		If you leave the Customer Code field blank, the system automatically generates a number for the record based on the sequence defined in Customer Autonumber Create.
tiDPaySel_ID	integer	DDocument.DPaySel_ID	Link to DPaySel
tcDPaySelCode	character	DPaySel.DPaySelCode	Payment Selection
tiGL_ID	integer	DDocument.GL_ID	Bank Account
tcGLCode	character	GL.GLCode	A code identifying the GL account.
tcPayFormatTypeCode	character	PayFormatType.PayFormatTypeCode	Format Name
DDocumentCustom	character	calculated	custom fields
BankNumberCustom	character	calculated	custom fields
PayFormatTypeCustom	character	calculated	custom fields
CurrencyCustom	character	calculated	custom fields
DebtorCustom	character	calculated	custom fields
BusinessRelationCustom	character	calculated	custom fields
CorporateGroupCustom	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(DDocument),rowid(BankNumber),rowid(BankPayFormat),rowid(PayFormatType),rowid(Currency),rowid(Debtor),rowid(BusinessRelation),rowid(CorporateGroup),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 = "BDDocument".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "SelectDDocument".
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/bddocument.selectddocument.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.