req_word_html_converter

As an administrator, you can selectively convert requirement content in HTML format to Microsoft Word format (or the reverse, depending on the option selected). You can perform a selective conversion by providing a criteria file or a comma separated file containing fullText UIDs or directory containing multiple such Fulltext UID files. In non-permanent selective conversion from rich text to Microsoft Word, the converted requirements have the necessary named reference attachments as MSWordXPart; however, the content type remains rich text. Similarly, in non-permanent conversions from Microsoft Word to rich text, the converted requirements have the named references attachments as Arm0HTML and Arm0HTMLIMG, but the content type is still rich text. Note Before you run this utility, ensure that the Active Workspace Requirements Management feature is installed. Several files are created in the transient volume folder when you run the utility: failed_ID.txt contains failed UIDs separated by commas invalidIDs.txt contains invalid UIDs validIDs.txt contains valid UIDs dumpLogs.log if you use the dumpLogs option The utility performs conversion for the following objects only: SpecElementRevision, SpecElement, or SpecificationRevision. Syntax req_word_html_converter [-u=user-id -p=password | password-file -g=group] ] [-path=full file path of HtmlConverter01.exe ] [-dumpLogs] [-forceUpdate] [-h][-htmlToWord] [-wordToHtml] [-processObjectList=full path of the text file containing FullTextUIDs -in=full file path of criteria file ][-permanentConvert] [-dryRun] Arguments -u=user_id Specifies the user ID to be used for the upgrade. This is a user with Teamcenter administration privileges. -p=password Specifies the password for the specified user ID. -g=group_name Specifies the group associated with the user. -path=full file path of WordHtmlConverter.exe (including the .exe extension) Specifies the full path to the WordHtmlConverter.exe utility, including the filename WordHtmlConverter.exe. -dumpLogs (Optional) Dumps a detailed debug log with more information about the point in the code the utility is failing or which full-text dataset is causing the error. -forceUpdate (Optional) Forces the update and repair of all requirements in database even if they were previously converted. -h Displays help for this utility. -htmlToWord Converts requirements from HTML format to Microsoft Word. -wordToHtml Converts requirements from Microsoft Word format to HTML. -processObjectList= Specifies the full path of the text file containing FullText UIDs. The text files must contain FullText IDs separated only by commas; no spaces allowed. -in= Performs a selective conversion of an entire requirement specification structure to html. The input is a criteria file that defines this structure. The schema for the file is as follows: KEYWORD_SEPARATOR=KWS KEY_VALUE_SEPARATOR=KVS RULE_SEPARATOR=RS keys KWS key1=value1 KVS keyN=valueN RS rev_rule KWS revision-rule RS topline_rev KWS topline rev keys KWS key1=value1 KVS keyN=valueN RS rev_rule KWS revision-rule RS keys KWS key1=value1 Note the following conditions: The KEYWORD_SEPARATOR, KEY_VALUE_SEPARATOR, and RULE_SEPARATOR entries are required and you must enter in the order indicated. These entries define the separators that segregate the key-value pairs and keywords from corresponding values. You cannot use the equal sign (=) as the value for these entries. For example, the entry RULE_SEPARATOR= = is invalid. Separate all entries with the new-line character (\n). Starting in the fourth row, define the entries as follows: Segment 1 (Required) Consists of multi-field key-value (MFK) pairs. Multifield keys are IDs assigned to each object to ensure their uniqueness in the database. Based on the MFK, specifications/requirements are retrieved, and then further configuration is applied based on Segment 2 and Segment 3. This segment is required to uniquely identify the top object in the database. Syntax keys KWS key1=value1 KVS key2=value2 KVS keyN=valueN Example keys : item_id=REQ-000002 , object_type=Requirement Segment 2 (Optional unless Segment 3 is defined) Denotes the revision rule to apply to the revision retrieved based on the MFK pairs in Segment 1. If you do not define this segment, then the defined revision rule as read from preference TC_config_rule_name is applied. Syntax rev_rule KWS revision_rule_name Example rev_rule : Latest Working Segment 3 (Optional) Defines the revision of the item retrieved on the basis of the MFK pairs defined in Segment 1. You can use this segment to determine the structure of interest. If you do not define this segment, then the latest revision is considered for configuring structure. If this segment is defined then you must define Segment 2 also. For example, if the MFK pairs in Segment 1 return a particular item such as item_id=REQ-000002, then there can be different structures for different revisions of this item. Revision A as a top line might contain 6 children items; revision B might contain 12 children items. Syntax topline_rev KWS topline_revision Example topline_rev : A Example: valid input criteria file KEYWORD_SEPARATOR=: KEY_VALUE_SEPARATOR=, RULE_SEPARATOR=| keys: item_id=REQ-000001 keys: item_id=REQ-000001 , object_type=Requirement | rev_rule:Latest Working keys: item_id=REQ-000001 | rev_rule:Precise Only keys: item_id=REQ-000001 | rev_rule:Any Status; Working | topline_rev:A Example: invalid input criteria file KEYWORD_SEPARATOR= = (invalid because the equals sign (=) is not a valid separator) KEY_VALUE_SEPARTOR=, (invalid because KEY_VALUE_SEPARATOR is misspelled) RULE_SEPARATOR| (invalid because the equals sign (=) is missing) keys: item_id=REQ-000001 | rev_rule: | topline_rev:A (invalid because the revision rule name is not provided) rev_rule:Latest Working | keys: item_id=REQ-000002 , object_type=Requirement (Invalid because Segment 1, Segment 2, and Segment 3 must be defined in that order: Segment 1 is the MFK, Segment 2 is the revision rule, and Segment 3 is the topline revision ) keys: item_id=REQ-000003 | topline_rev:A (Invalid because Segment2 is skipped and directly Segment3 is defined) -permanentConvert (Optional) Permanently converts requirements to one of the following formats: If you include the -wordToHtml switch, converts to HTML format, which is editable in the CK Editor in the Documentation tab. If you include the -htmlToWord switch, converts to Word format, which is not editable in the CK Editor in the Documentation tab. -dryRun These files are created: failed_ID.txt with failed UIDs separated by comma, invalidIDs.txt with the invalid UIDs, and validIDs.txt with the valid. The conversion does not take place. The files are described below: invalidIDs.txt: any UID not present in the database or has a blank content_type property. failed_ID.txt : any UID having corrupted data, cannot be opened in Word, the user does not have write access on it, or is checked out by another user or a replica object. validIDs.txt : All UIDs are valid. alreadyConvertedIDs.txt : UIDs that are already HTML for wordTOHtml conversion case or already Word for HtmlToWord conversion, is contained in this file. Examples req_word_html_converter -u=user_id -p=password -g=group -path=full file path of WordHtmlConverter.exe -forceUpdate -htmlToWord req_word_html_converter -u=user_id -p=password -g=group -path=full file path of WordHtmlConverter.exe -dryrun -htmlToWord req_word_html_converter -u=user_id -p=password -g=group -path=full file path of WordHtmlConverter.exe -dumpLogs -htmlToWord req_word_html_converter -u=user_id -p=password -g=group -path=full file path of WordHtmlConverter.exe -in=full path of the criteria file for selective conversion -wordToHtml req_word_html_converter -u=user_id -p=password -g=group -path=full file path of WordHtmlConverter.exe -processObjectList=full path of the process uidst text file -wordToHtml req_word_html_converter -u=user_id -p=password -g=group -path=full file path of WordHtmlConverter.exe -dir=full path of the folder that contains text files with process uids -htmlToWord req_word_html_converter -u=user_id -p=password -g=group -path=full file path of WordHtmlConverter.exe -permanentConvert -htmlToWord Caution The following conditions are not supported: Creating a requirement in Teamcenter Rich Client and modifying it in Active Workspace (and vice-versa). Creating a requirement in Teamcenter Rich Client and creating a sibling in Active Workspace and exporting to Word. The sibling cannot be edited. Creating a requirement in Teamcenter Rich Client and exporting it using microservices. To create a specification that can be edited in Active Workspace, use IMPORT SPECIFICATION with the Enable Editing checkbox selected, or use the microservice-based import.