bpi.makediag()

bpi.makediag()

This subroutine is used to make a diagnostic structure of all tags and values being passed to a document.  This diagnostic structure can be assigned to its own tag and then placed in a document template as a test.  When rendered, the structure, containing all tags and values will be displayed in the document.  This allows you to check the logic of your integration to ensure the completeness and accuracy of your passed tags and values.

The application program will normally take the resulting diag array and assign it to a tag called %diag% via a call to bpi.set.tagval2.  Then the template designer may insert the tag %diag% anywhere in the template and this will cause the diag structure to be inserted into the document at that point.  It is recommended that the template designer create a custom ruler on the line where the %diag% occurs to set the horizontal position of each column of the tab delimited structure.

Subroutine Syntax

CALL bpi.makediag( blocks, tags, vals, format, diag, status)

Parameters

Param

Direction

Description

tags

passed

array of tags

vals

passed

array of values associated with tags

format

passed

A format string telling routine how to format the structure (RTF or ODT).  Defaults to ODT if not specified

diag

returned

The returned structure format is arrayVector <tab> blockName <tab> tagname <tab> valueVector <tab> value.

status

returned

@FALSE of no error, otherwise value indicates error

 Example

See the example bpi_simple_test_program