API query SelectCompanyPropertyForSiteAd

Description

Select query to look up the address and business relation information of a company.
This query also includes the operational tables.

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
icDomainCode	c	=
tAddress.AddressCity	c	=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressState	c	=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressStreet1	c	=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressStreet2	c	=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressStreet3	c	=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressTaxIDState	c	=,>=,>,<>,<=,<,begins,can-do,matches
tAddressType.AddressTypeCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressZip	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBusinessRelation.BusinessRelationCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCompanyProperty.CompanyPropertyActCheckp	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCompanyProperty.CompanyPropertyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCountry.CountryCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCountry.CountryIsEUCountry	l	=,<>
tsi_mstr.si_domain	c	=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.TxzTaxZone	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiCompanyId	integer	Company id
icDomainCode	character	domain Code

query condition

each CompanyProperty where

CompanyProperty.Company_Id = iiCompanyId AND

each si_mstr (inner-join) where

si_mstr.si_entity = CompanyProperty.CompanyPropertyCode AND
si_mstr.si_domain = icDomainCode

each ls_mstr (inner-join) where

ls_mstr.ls_domain = si_mstr.si_domain AND
ls_mstr.ls_addr = si_mstr.si_site AND
ls_mstr.ls_type = 'company' AND

first ad_mstr (inner-join) where

ad_mstr.ad_addr = ls_mstr.ls_addr AND
ad_mstr.ad_domain = ls_mstr.ls_domain AND

first BusinessRelation (inner-join) where

BusinessRelation.BusinessRelationCode = ad_mstr.ad_bus_relation AND

each Address (inner-join) where

Address.BusinessRelation_ID = BusinessRelation.BusinessRelation_ID AND

first AddressType (inner-join) where

AddressType.AddressType_ID = Address.AddressType_ID AND

first Country (inner-join) where

Country.Country_ID = Address.Country_ID AND

query sort order

CompanyProperty.CompanyPropertyCode (ascending)

query resultset tqSelectCompanyPropertyForSiteAd

field name	data type	db field	description
tiAddress_ID	integer	Address.Address_ID	Record ID
tcAddressCity	character	Address.AddressCity	City. The city for this address. This field can be used to decide the tax zone of the address.
tcAddressState	character	Address.AddressState	Obsolete field
tcAddressStreet1	character	Address.AddressStreet1	Address: Line one of address details. This field can be blank.
tcAddressStreet2	character	Address.AddressStreet2	Address.Line two of address details. This field can be blank.
tcAddressStreet3	character	Address.AddressStreet3	Address.Line three of address details. This field can be blank.
tcAddressTaxIDState	character	Address.AddressTaxIDState	State Tax. This field is for reference and documentation purposes, the value of the field is either a state or provincial tax identification number or a VAT registration number.
tcAddressTypeCode	character	AddressType.AddressTypeCode	Address Type
tcAddressZip	character	Address.AddressZip	Zip. The postal code or US zip code associated with this address. This field is used to decide the tax zone for the address. This field can be blank.
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.
tiCompanyProperty_ID	integer	CompanyProperty.CompanyProperty_ID	Record ID
tcCompanyPropertyActCheckp	character	CompanyProperty.CompanyPropertyActCheckp	Activity Sheets Checkpoint
tcCompanyPropertyCode	character	CompanyProperty.CompanyPropertyCode	Entity Code
tcCountryCode	character	Country.CountryCode	Country Code
tlCountryIsEUCountry	logical	Country.CountryIsEUCountry	EU Member
tcsi_domain	character	si_mstr.si_domain	Domain
tcTxzTaxZone	character	Address.TxzTaxZone	Tax Zone. This field indicates the tax zone for this address. This field is mandatory.
	api annotation:		PartialUpdate = yes - defaults to a value the system searches for based on the country, state or province, county, city, and postal code of the current address.
CompanyPropertyCustom	character	calculated	custom fields
si_mstrCustom	character	calculated	custom fields
BusinessRelationCustom	character	calculated	custom fields
AddressCustom	character	calculated	custom fields
AddressTypeCustom	character	calculated	custom fields
CountryCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(CompanyProperty),rowid(si_mstr),rowid(ls_mstr),rowid(ad_mstr),rowid(BusinessRelation),rowid(Address),rowid(AddressType),rowid(Country)

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 = "SelectCompanyPropertyForSiteAd".
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.selectcompanypropertyforsitead.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.