API query CompanyPropertyForShare (optimised)

Description

Shared Address Number Company information of company based on company Id and domain.
Shared Address Number Company is different from the CompanyIdToShare that is passed as a parameter.

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
icCompanyDomain	c	=
iiCompanyIdToShare	i	<>
tCompany.CompanyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCompany.CompanyIsActive	l	=,<>
tCompanyProperty.CompanyPropertyIsAddGLNbr	l	=,<>
tDomains.DomainCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDomains.DomainIsActive	l	=,<>
tUsr.UsrLogin	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiCompanyId	integer	Company id
icCompanyDomain	character	Domain Code
iiCompanyIdToShare	integer	Company Id that is used here is not equal to the one in the resultset.

query condition

each CompanyProperty where

CompanyProperty.Company_ID <> iiCompanyIdToShare AND
(CompanyProperty.SharedAddNrCompany_ID = ? OR
CompanyProperty.SharedAddNrCompany_ID = 0 ) AND
CompanyProperty.CompanyPropertyIsAddGLNbr = true

first Company (inner-join) where

Company.Company_Id = iiCompanyId AND
Company.Company_ID = CompanyProperty.Company_ID AND
Company.CompanyIsActive = true

first Domains (inner-join) where

Domains.Domain_ID = Company.Domain_ID AND
Domains.DomainCode = icCompanyDomain AND
Domains.DomainIsActive = true

each UsrCompany (inner-join) where

UsrCompany.Company_Id = iiCompanyId AND
UsrCompany.Company_ID = Company.Company_ID AND

first Usr (inner-join) where

Usr.Usr_ID = UsrCompany.Usr_ID AND

query resultset tqCompanyPropertyForShare

field name	data type	db field	description
tiCompany_ID	integer	CompanyProperty.Company_ID	Link to Company
tiCompany_ID2	integer	Company.Company_ID	Record ID
tcCompanyCode	character	Company.CompanyCode	Entity Code
tlCompanyIsActive	logical	Company.CompanyIsActive	Active
tlCompanyPropertyIsAddGLNbr	logical	CompanyProperty.CompanyPropertyIsAddGLNbr	Additional GL Numbering
tcDomainCode	character	Domains.DomainCode	Domain
tlDomainIsActive	logical	Domains.DomainIsActive	Active
tiSharedAddNrCompany_ID	integer	CompanyProperty.SharedAddNrCompany_ID	Entity Code
tcUsrLogin	character	Usr.UsrLogin	Login
CompanyPropertyCustom	character	calculated	custom fields
CompanyCustom	character	calculated	custom fields
DomainsCustom	character	calculated	custom fields
UsrCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(CompanyProperty),rowid(Company),rowid(Domains),rowid(UsrCompany),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 = "BCompanyProperty".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "CompanyPropertyForShare".
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/bcompanyproperty.companypropertyforshare.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.