API query DocumentList

Description

DocumentList

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
icBusinessComponent	c	=
iiObjectId	i	=
tDocumentLink.DocumentLinkDate	t	=,>=,>,<>,<=,<
tDocumentLink.DocumentLinkDescription	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDocumentLink.DocumentLinkOpenDocument	l	=,<>
tDocumentLink.DocumentLinkSize	i	=,>=,>,<>,<=,<

Parameters (internal)

icBusinessComponent	character	Business Component
iiObjectId	integer	Object ID

query condition

each DocumentLink where

DocumentLink.DocumentLinkComponent = icBusinessComponent AND
DocumentLink.DocumentLinkInternal_ID = iiObjectId

query resultset tqDocumentList

field name	data type	db field	description
tiDocumentLink_ID	integer	DocumentLink.DocumentLink_ID	Record ID
ttDocumentLinkDate	date	DocumentLink.DocumentLinkDate	Date
tcDocumentLinkDescription	character	DocumentLink.DocumentLinkDescription	Description
tlDocumentLinkOpenDocument	logical	DocumentLink.DocumentLinkOpenDocument	When true, automatically open this document when the parent object is opened.
tiDocumentLinkSize	integer	DocumentLink.DocumentLinkSize	Size
DocumentLinkCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(DocumentLink)

Internal usage

BLF

dataset BDocumentLink.tDocumentProperties

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 = "BDocumentLink".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "DocumentList".
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/bdocumentlink.documentlist.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.