Prerequisites:
The functions described below can only be called in an Adelia program generated for the Java platform (Windows and AS/400 platforms are not supported).
The VaToolBx functions for using the APE are as follows:
-
VaToolBxAPEClearDataModel
This function is used to delete the content of a FreeMarker data model from memory (a program can manipulate several data models). -
VaToolBxAPEAddInDataModel
This function is used to add Adelia data (simple type - BOOL, NUM_BIN_2, etc. - or complex type - LIST, ARRAY, REF_CLASS) to a data model.
The complete creation of a data model will usually require several calls to this function. -
VaToolBxAPEMergeDoc
This function is used to execute the "Merge" step of the APE. The result document is stored in an IMAGE-type variable.
After calling this function, changes to the data model (call from VaToolBxAPEAddInDataModel) do not have any effect on the result document. -
VaToolBxAPETransformDoc
This function is used to execute the "Transform" step of the APE.
It takes the result document of the VaToolBxAPEMergeDoc function as an input and produces a document stored in an IMAGE-type variable. -
VaToolBxAPEMergeAndTransformDoc
This function is used to execute the two "Merge" and "Transform" steps of the APE in sequence.
Important:
Using these functions requires the VaToolBx toolbox to be loaded and it must still be loaded when the APE functions are called.