QAD 2017 Enterprise Edition > User Guides > Reporting Framework > External Metadata > ReportHelper.p XML Metadata Procedure Reference
  
ReportHelper.p XML Metadata Procedure Reference
Following are the available procedures and functions related to XML metadata processing in the ReportHelper.p program.
SetIsTranslated
Used to set whether display values are to be treated as pre-translated values or as untranslated terms. A value of false will treat values as terms and attempt to convert them, whereas a value of true will bypass this conversion (for example, if the values are already translated).

SetlsTranslated Parameters
 
Name
Input/Output
Data Type
Description
ilIsTranslated
Input
Logical
Input logical specifies value for whether values are to be treated as already translated
FillMetaData
Procedure called from proxy to build report metadata.

FillMetaData Parameters
 
Name
Input/Output
Data Type
Description
ihDS
Input
 
Input handle to the report dataset which is used to create default metadata records for all fields in the report dataset
icMetaDataFile
Input
String
Input string for the name of a runtime XML metadata file which will provide overrides to the default metadata values. This file is located on the appserver’s propath with “com/qad/shell/report/reports/” prepended (it should be collocated with the report proxy).
SetMetaData
Wrapper to SetFieldMetaParameter procedure in ReportHelper program which provides for optional translation of field labels and display part of value lists. These values are only translated if the SetIsTranslated procedure is called with a false value, otherwise the values are passed directly to the ReportHelper without performing any translation.

SetMetaData Parameters
 
Name
Input/Output
Data Type
Description
icBufferName
Input
Character
Input name of the report temp-table to assign metadata value for
icField
Input
Character
Input name of the report temp-table's field to assign metadata value for
icMetaField
Input
Character
Input name of metadata field as specified by ReportHelper
icMetaValue
Input
Character
Input value to assign to the specified metadata field
AddAllConditions
Used to add all filter constraints for a specified DB table name to a query string.

AddAllConditions Parameters
 
Name
Input/Output
Data Type
Description
icDBTable
Input
Character
Input name of DB table to add filter constraints for
bcQueryString
Input
Character
Input-Output string to append filter constraints to
AddSomeConditions
Adds all filter constraints for a specified DB table name to a query string except for the fields provided.

AddSomeConditions Parameters
 
Name
Input/Output
Data Type
Description
icDBTable
Input
Character
Input name of DB table to add filter constraints for
icExclusionList
Input
Character
Input comma separated string of fields to exclude from constraints
bcQueryString
Input/Output
Character
Input-Output string to append filter constraints to
AddSpecificConditions
Adds filter constraints only for specified fields for a given DB table name to a query string.

AddSpecificConditions Parameters
 
Name
Input/Output
Data Type
Description
icDBTable
Input
Character
Input name of DB table to add filter constraints for
vcFieldData
Input
Character
Input comma separated string of fields for which to add constraints. Syntax of each field is as follows:
{DBFieldName}[:{DB Field}]
Where {DBFieldName} is the field’s metadata DBFieldName value and {DB Field} is the name of the field as it will be used in the resulting filter constraint
entryName
Input/Output
Character
Input-Output string to append filter constraints to
AddExtentConditions
Adds filter constraints for a specific extent DB field, applying the constraint to each element in the DB field array. (This procedure is typically called internally from the ReportHelper.p program, but is listed here for reference.)

AddExtentConditions Parameters
 
Name
Input/Output
Data Type
Description
icBufferName
Input
Character
Input name of the temp-table
icFieldName
Input
Character
Input of the temp-table field
icDBFieldName
Input
Character
Input name of corresponding database field
iiExtent
Input
Integer
Number of elements in the array for the database field
bcQueryString
Input/Output
Character
Input-Output string to append filter constraints to