getDocForExportTemplateFolder

Exports items from a specific folder to a Microsoft Word document using a specified export template. A SOAP error envelope is returned if the operation fails.

Parameters

Parameter	Type	Description
cookie	long	Session cookie returned by projectLogon.
templateID	long	Word export template record ID. The record ID is displayed in the Configure Word Export Templates dialog box in Helix ALM. Use 0 if using templateName.
templateName	string	Word export template name. Leave empty if using templateID.
tablename	string	Table name to retrieve information from if exporting a specific item type. Valid values: Defect, Test Case, Test Run, Requirement, Requirement Document, and Folder. Use getTableList to retrieve a list of available tables. Interactive filters are not supported.
sortOrder	string	Sort order of items in the resulting document. Use 'Rank' or 'Tag'.
filtername	string	Filter name to apply to the items retrieved from the table if only exporting one item type. Set as an empty string to use no filter. Use getFilterListForTable to retrieve a list of filters for the table. Can only use if tablename is specified.
timezoneID	string	Internet Assigned Numbers Authority (IANA) time zone identifier to use for the export (e.g., America/New_York). Identifiers in the IANA Time Zone (TZ) Database are supported. To easily find an identifier, perform a web search. If an identifier is invalid or not specified, the hoursBetweenLocalAndGMT value is used.
locale	string	Common Locale Data Repository (CLDR) locale to use for the export. Use the two- or three-letter ISO 639 language code followed by an underscore and the uppercase two-letter ISO 3166 country/territory code. (e.g., en_US). If a locale is invalid or not specified, the locale set on the computer hosting the Helix ALM Server is used.
hoursBetweenLocalAndGMT	double	Difference in hours between the time zone to use for the export and GMT. For example, the Eastern Standard Time (EST) value is -5. Not used if a valid timezoneID value is specified.

Return value

Value	Type
pDocument	CFile

Example

CFile doc = ttsdk.getDocForExportTemplateFolder(cookie, 42, "", "/Public/folder A", true, "Defect", "Fixed Defects", "Rank", "America/New_York", "en_US", -5);

mySaveFileAttach("MyReqDocExport.docx", doc.mpFileData);