Description
This method validates the passed in COA elements and combinations.
It validates
1. Account/Cost Centre/Sub Account/Project exist and are active
2. Account combinations are valid - analysis type and COA Mask.
3. Any errors found are returned in the temptable COAValidationErrors
Parameters
| tCOAValidation | input | temp-table | COA elements and combinations to validate |
| tCOAErrorMessages | output | temp-table | Temptable containng any COA validation error messages |
| oiReturnStatus | output | integer | Return status of the method. |
Internal usage
QadFitnesse
program code (program9/bcoavalidation.p)
/* ===================================================================================================== *
* Method: ApiValidateCOA *
* Desc: API to validate the COA elements and combinations *
* ===================================================================================================== */
do on error undo, throw:
<M-19 run ValidateCOA
(input tCOAValidation (tCOAValidation),
output tCOAErrorMessages (tCOAErrorMessages),
output viFcReturnSuper (oiReturnStatus)) in BCOAValidation>
if viFcReturnSuper <> 0
then assign oiReturnStatus = viFcReturnSuper.
if oiReturnStatus < 0
then return.
end. /* do on error undo, throw : */
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 = "BCOAValidation".
create ttContext.
assign ttContext.propertyName = "methodName"
ttContext.propertyValue = "APIValidateCOA".
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/bcoavalidation.apivalidatecoa.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tCOAValidation").
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.