API query SelectGLMask (optimised)

Description

SelectGLMask; select query that allows users to select a G/L Mask. This query should only be called from the UI-classes.

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
iiDomainId	i	=
tCostCentre.CostCentreCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCostCentre.CostCentreDescription	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCostCentre.CostCentreIsWithSaf	l	=,<>
tDivision.DivisionCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDivision.DivisionDescription	c	=,>=,>,<>,<=,<,begins,can-do,matches
tGL.GLCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tGL.GLDescription	c	=,>=,>,<>,<=,<,begins,can-do,matches
tGL.GLIsCostCentreAccount	l	=,<>
tGL.GLIsDivisionAccount	l	=,<>
tGL.GLIsProjectAccount	l	=,<>
tGL.GLIsQuantityAccount	l	=,<>
tProject.ProjectCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tProject.ProjectDescription	c	=,>=,>,<>,<=,<,begins,can-do,matches
tProject.ProjectIsWithSaf	l	=,<>

Parameters (internal)

iiCompanyId	integer	Company id
iiDomainId	integer

query condition

each GLMask where

GLMask.Domain_ID = iiDomainId

first CostCentre (conditional-join) where

CostCentre.SharedSet_Id = vi_COSTCENTRE_sharedset(iiCompanyId) AND
CostCentre.CostCentre_ID = GLMask.CostCentre_ID AND

first Division (conditional-join) where

Division.SharedSet_Id = vi_DIVISION_sharedset(iiCompanyId) AND
Division.Division_ID = GLMask.Division_ID AND

first GL (conditional-join) where

GL.SharedSet_Id = vi_GL_sharedset(iiCompanyId) AND
GL.GL_ID = GLMask.GL_ID AND

first Project (conditional-join) where

Project.SharedSet_Id = vi_PROJECT_sharedset(iiCompanyId) AND
Project.Project_ID = GLMask.Project_ID AND

query sort order

GL.GLCode (ascending)

query resultset tqSelectGLMask

field name	data type	db field	description
tiCostCentre_ID	integer	CostCentre.CostCentre_ID	Record ID
tiDivision_ID	integer	Division.Division_ID	Record ID
tiGL_ID	integer	GL.GL_ID	Record ID
tiProject_ID	integer	Project.Project_ID	Record ID
tiDomain_ID	integer	GLMask.Domain_ID	Domain
tlGLIsQuantityAccount	logical	GL.GLIsQuantityAccount	This field is calculated by the system. Set to true if quantity is used on this account.
	api annotation:		This field can be left blank as it will be calculated by the system.
tcGLCode	character	GL.GLCode	A code identifying the GL account.
tcDivisionCode	character	Division.DivisionCode	Sub-Account
tcProjectCode	character	Project.ProjectCode	Project
tcCostCentreCode	character	CostCentre.CostCentreCode	Cost Center: A code that identifies the cost center.
tcGLDescription	character	GL.GLDescription	A description of the GL account.
tcDivisionDescription	character	Division.DivisionDescription	Description
tcProjectDescription	character	Project.ProjectDescription	Description
tcCostCentreDescription	character	CostCentre.CostCentreDescription	Description: a brief description of the cost center.
tlGLIsDivisionAccount	logical	GL.GLIsDivisionAccount	Set to true if the account has a sub-account. Its value is calculated by the system and is determined by the value of tcDivisionProfileCode.
	api annotation:		This field can be left blank as it will be calculated by the system.
tlGLIsProjectAccount	logical	GL.GLIsProjectAccount	Project Analysis: This field will be calculated by the system based on the value of tcAnalysisType. If the analysis type of the account is Project the value will be true.
	api annotation:		This field can be left blank as it will be calculated by the system.
tlGLIsCostCentreAccount	logical	GL.GLIsCostCentreAccount	This field will be calculated by the system based on the value of tcAnalysisType. If the analysis type of the account is Project the value will be true.
	api annotation:		This field can be left blank as it will be calculated by the system.
tlProjectIsWithSaf	logical	Project.ProjectIsWithSaf	SAF Enabled
tlCostCentreIsWithSaf	logical	CostCentre.CostCentreIsWithSaf	SAF Enabled: This field indicates if the SAF analysis is enabled.
	api annotation:		This field can be left blank as it will be calculated by the system. PartialUpdate = yes - defaults to false
tiGLMask_ID	integer	GLMask.GLMask_ID	Record ID
GLMaskCustom	character	calculated	custom fields
CostCentreCustom	character	calculated	custom fields
DivisionCustom	character	calculated	custom fields
GLCustom	character	calculated	custom fields
ProjectCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(GLMask),rowid(CostCentre),rowid(Division),rowid(GL),rowid(Project)

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 = "BGLMask".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "SelectGLMask".
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/bglmask.selectglmask.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.