method ApiGetSalespersonCommissions

Description

This method retrieves Salesperson Commission Data from Debtor Invoice Data.

Parameters

tSalespersonCommission	output	temp-table	output temp-table with sales person commission data
icDomainCode	input	character	Domain Code
itInvoiceStartDate	input	date	Invoice date to start with
itInvoiceEndDate	input	date	Invoice Date to end with
icSalespersonFrom	input	character	Sales person to start with
icSalespersonTo	input	character	Sales person to end with
icTransactionCurrency	input	character	Transaction Currency Code
oiReturnStatus	output	integer	Return status of the method.

Internal usage

unused

program code (program3/bdinvoice.p)

/* ================================================================ */
/* This API method was created to return salesperson commission data */
/* given a set of input ranges     */
/* This method will be called from MFG/PRO for reports              */
/* ================================================================ */
/* Initialize the output parameter value */     
if oiReturnStatus = ? or oiReturnStatus = 0
then assign oiReturnStatus  = -1.
empty temp-table tSalespersonCommission no-error.

/* Handle invalid input parameters */
if icDomainCode       = ?    or
   icDomainCode       = '':U 
then return.

/* Get the Salesperson commission data for the input parameters */
<Q-1 run DInvoiceBySalesperson (all) (Read) (NoCache)
   (input ?, (CompanyId)
    input itInvoiceStartDate, (InvoiceStartDate)
    input itInvoiceEndDate, (InvoiceEndDate)
    input icSalespersonFrom, (InvoiceSalespersonFrom)
    input icSalespersonTo, (InvoiceSalespersonTo)
    input icTransactionCurrency, (TransactionCurrency)
    output dataset tqDInvoiceBySalesperson) in BDInvoice >
    
for each tqDInvoiceBySalesperson 
   where tqDInvoiceBySalesperson.tcDomainCode = icDomainCode:

   assign oiReturnStatus = 0
          vhDInvoiceBySalesperson = dataset tqDInvoiceBySalesperson:get-buffer-handle(1).
   
   create tSalespersonCommission.
   <M-2 run BufferCopy
      (input  vhDInvoiceBySalesperson (ihFrom), 
       input  buffer tSalespersonCommission:handle (ihTo), 
       output viFcReturnSuper (oiReturnStatus)) in BDInvoice>
       
   assign tSalespersonCommission.tdDInvoiceExchangeRateScale = tqDInvoiceBySalesperson.tdDInvoiceRateScale.
   
   if viFcReturnSuper < 0
   then do:
      assign oiReturnStatus = -1.
      return.
   end.
end.

Sample code: how to call this method 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 = "BDInvoice".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiGetSalespersonCommissions".
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/bdinvoice.apigetsalespersoncommissions.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icDomainCode = <parameter value>
       vhParameter::itInvoiceStartDate = <parameter value>
       vhParameter::itInvoiceEndDate = <parameter value>
       vhParameter::icSalespersonFrom = <parameter value>
       vhParameter::icSalespersonTo = <parameter value>
       vhParameter::icTransactionCurrency = <parameter value>.

/* 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.