Report Writer

Macros
#define	EXCEL_REPORT_FORMATTER   "ExcelReportFormatter"
#define	XLT_REF   "XLT"
#define	XML_REPORT_FORMATTER   "XMLReportFormatter"
#define	XSL_REF   "XSL"

Functions
QRY_API int	REP_append_batchfile (char **itemid, char **revisionid, const char *reportlocation, char **revisionrule, const char *variantrule, const char *transfermode, const char *formatter, const char *rt_product, const char *rt_prd_rev_rule, const char *rt_prd_var_rule, const char *rt_process, const char *hierarcyid, const char *level, const char *rt_plt, const char *rt_plt_rev_rule, const char *rt_plt_var_rule, int numberoflines)
QRY_API int	REP_append_batchfile_for_report (char **itemid, char **itemuid, char **revisionid, const char *reportlocation, char **revisionrule, const char *variantrule, const char *transfermode, const char *formatter, const char *rt_product, const char *rt_prd_rev_rule, const char *rt_prd_var_rule, const char *rt_process, const char *hierarcyid, const char *level, const char *rt_plt, const char *rt_plt_rev_rule, const char *rt_plt_var_rule, int numberoflines)
QRY_API int	REP_apply_stylesheet (const char *xmlFile, const char *xslFile, const char *outFile, const char *dirPath)
QRY_API int	REP_create_temp_directory (const char *dirpath, char **created_dir, char **dir_name)
QRY_API int	REP_design_ask_formatters (tag_t design_tag, int *n_tags, char ***filenames, tag_t **dataset_tags)
QRY_API int	REP_design_ask_query (tag_t design_tag, tag_t *query_tag)
QRY_API int	REP_design_extent (int *n_tags, tag_t **design_tags)
QRY_API int	REP_find_design (const char *design_name, tag_t *design_tag)
QRY_API int	REP_generate_multiple_files (const char *outFile, const char *dirPath)
QRY_API int	REP_generate_report (tag_t design_tag, int n_entries, char **criteria_names, char **criteria_values, int limitCount, tag_t *limitList, const char *full_pathname)
QRY_API int	REP_getfilenames (const char *dirpath, int *n_filenames, char ***filenames, char ***abs_filenames)
QRY_API int	REP_save_named_ref (tag_t dataset, const char *dirpath)

Detailed Description

The REP module is a sub module in the QRY module. It provides the interfaces to manage report designs.

Macro Definition Documentation

#define EXCEL_REPORT_FORMATTER   "ExcelReportFormatter"

Definition at line 25 of file rep.h.

#define XLT_REF   "XLT"

Definition at line 27 of file rep.h.

#define XML_REPORT_FORMATTER   "XMLReportFormatter"

Definition at line 24 of file rep.h.

#define XSL_REF   "XSL"

Definition at line 26 of file rep.h.

Function Documentation

QRY_API int REP_append_batchfile	(	char **	itemid,
		char **	revisionid,
		const char *	reportlocation,
		char **	revisionrule,
		const char *	variantrule,
		const char *	transfermode,
		const char *	formatter,
		const char *	rt_product,
		const char *	rt_prd_rev_rule,
		const char *	rt_prd_var_rule,
		const char *	rt_process,
		const char *	hierarcyid,
		const char *	level,
		const char *	rt_plt,
		const char *	rt_plt_rev_rule,
		const char *	rt_plt_var_rule,
		int	numberoflines
	)

This function appends the Batch Request file with selected bom line information This function is deprecated in TC9.1 and will be removed from TC11

Parameters

itemid	(I)
revisionid	(I)
reportlocation	(I)
revisionrule	(I)
variantrule	(I)
transfermode	(I)
formatter	(I)
rt_product	(I)
rt_prd_rev_rule	(I)
rt_prd_var_rule	(I)
rt_process	(I)
hierarcyid	(I)
level	(I)
rt_plt	(I)
rt_plt_rev_rule	(I)
rt_plt_var_rule	(I)
numberoflines	(I)

QRY_API int REP_append_batchfile_for_report	(	char **	itemid,
		char **	itemuid,
		char **	revisionid,
		const char *	reportlocation,
		char **	revisionrule,
		const char *	variantrule,
		const char *	transfermode,
		const char *	formatter,
		const char *	rt_product,
		const char *	rt_prd_rev_rule,
		const char *	rt_prd_var_rule,
		const char *	rt_process,
		const char *	hierarcyid,
		const char *	level,
		const char *	rt_plt,
		const char *	rt_plt_rev_rule,
		const char *	rt_plt_var_rule,
		int	numberoflines
	)

This function appends the Batch Request file with selected bom line information

Parameters

itemid	(I)
itemuid	(I)
revisionid	(I)
reportlocation	(I)
revisionrule	(I)
variantrule	(I)
transfermode	(I)
formatter	(I)
rt_product	(I)
rt_prd_rev_rule	(I)
rt_prd_var_rule	(I)
rt_process	(I)
hierarcyid	(I)
level	(I)
rt_plt	(I)
rt_plt_rev_rule	(I)
rt_plt_var_rule	(I)
numberoflines	(I)

QRY_API int REP_apply_stylesheet	(	const char *	xmlFile,
		const char *	xslFile,
		const char *	outFile,
		const char *	dirPath
	)

This function transforms xml file using xsl into an intermediate file.

Parameters

xmlFile	(I)
xslFile	(I)
outFile	(I)
dirPath	(I)

QRY_API int REP_create_temp_directory	(	const char *	dirpath,
		char **	created_dir,
		char **	dir_name
	)

This functions creates a temporary directory in the specified location

Parameters

dirpath	(I)
created_dir	(OF)
dir_name	(OF)

QRY_API int REP_design_ask_formatters	(	tag_t	design_tag,
		int *	n_tags,
		char ***	filenames,
		tag_t **	dataset_tags
	)

This function asks all report formatters associated with the report design. Report formatters are datasets that control the format of a selected report.

Parameters

design_tag	(I) The report design object tag
n_tags	(O) The number of dataset tags returned
filenames	(OF) n_tags Names of the report formatters
dataset_tags	(OF) n_tags Dataset tags of the report formatters

QRY_API int REP_design_ask_query	(	tag_t	design_tag,
		tag_t *	query_tag
	)

This function returns the query associated with the report design.

Parameters

design_tag	(I)
query_tag	(O)

QRY_API int REP_design_extent	(	int *	n_tags,
		tag_t **	design_tags
	)

This function returns all report designs in the database.

Parameters

n_tags	(O) The number of report design returned
design_tags	(OF) n_tags The returned report design tags

QRY_API int REP_find_design	(	const char *	design_name,
		tag_t *	design_tag
	)

This function finds a report design in the database based on the input design name.

Parameters

design_name	(I) A unique report design name
design_tag	(O) The returned report design object tag

QRY_API int REP_generate_multiple_files	(	const char *	outFile,
		const char *	dirPath
	)

/** Generates multiple html files for intermediate file outFile

Parameters

outFile	(I)
dirPath	(I)

QRY_API int REP_generate_report	(	tag_t	design_tag,
		int	n_entries,
		char **	criteria_names,
		char **	criteria_values,
		int	limitCount,
		tag_t *	limitList,
		const char *	full_pathname
	)

This function generates a XML report file based on a report design.

Parameters

design_tag	(I) A report design object tag
n_entries	(I) Number of entries in the criteria names and criteria values arguments
criteria_names	(I) The saved query input criteria names
criteria_values	(I) The saved query input criteria values
limitCount	(I) The number of objects in the limitList argument
limitList	(I) The list of objects to search within. Users can limit the scope of search by using the limitList argument.
full_pathname	(I) The full path name for the output XML file

QRY_API int REP_getfilenames	(	const char *	dirpath,
		int *	n_filenames,
		char ***	filenames,
		char ***	abs_filenames
	)

This function is used to get the filenames under the directory

Parameters

dirpath	(I)
n_filenames	(O)
filenames	(OF) n_filenames Names of the files
abs_filenames	(OF) n_filenames Names of the files

QRY_API int REP_save_named_ref	(	tag_t	dataset,
		const char *	dirpath
	)

This function adds named references to the dataset.

Parameters

dataset	(I)
dirpath	(I)