getDocForExportTemplateReqDoc

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

Items in the resulting Word document are displayed in the order of the outline numbering in the requirement document.

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.
documentID	long	Requirement document ID to export.
snapshotVersion	int	Snapshot number of the document to export. Use 0 to export the current version.
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.getDocForExportTemplateReqDoc(cookie, 42, "", 12, 0, "America/New_York", "en_US", -5);

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