put_in_document

The function put_in_document places produced text in a document. The text placed in a document in this way will not appear in the result document. All result text produced up to the function call is placed in the document specified in the function call. You can call the function several times in a model. Each time the text produced up to the call is placed in a new document.

put_in_document ( "document_to_be_produced"; 
                   "path/folder_of_the_document";
                   "overwrite Y/N"; "pagination (ignored)";
                   "process_includes Y/N" ) 

The function returns a TEXT.

This function has five parameters:

1. document_to_be_produced, type TEXT. The name of the document.
2. path/folder_of_the_document, type TEXT. The path and name of the folder or folder in which the document will be written.
3. overwrite, type TEXT, Y or N. When you set this parameter to Y an already existing document is overwritten, when you set this parameter to N the end user will be prompted to specify an alternative filename/folder. Note that this will cause problems in an ITP/Server environment since ITP/Server cannot interact with the end user.
4. pagination, type TEXT, Y or N. The value of this parameter is ignored but must be present.
5. process_includes, type TEXT, Y or N. When set to Y ITP resolves __INC post includes in the result document. When you have enabled the check box Process includes on the Run tab of the ITP administration program of ITP/Workstation, ITP will always resolve post includes. In ITP/Server this setting is default enabled.

The function put_in_document writes the ITP output to a document, and does not create a copy. Once written to a document the output is no longer available for the ITP Model and will not appear in the result document. The reason for this is that ITP stores text that is produced in an internal buffer. When you call the put_in_document function ITP writes the content of the buffer to the document, this clears the internal buffer.

If you want to create multiple files from one output you can use the open buffer mechanism.

Documents that ITP produces through the put_in_document( ) function are directly available for opening after ITP successfully executed the put_in_document( ) function.

Example

#
This line will be stored in the document 'document.doc' on c:\temp, and will not appear in the result document.
#
TEXT doc := put_in_document("document.doc"; "c:\temp"; "Y"; "N"; "N")
#
The document produced is @(doc). 
These lines will appear in the result document because they are produced after the put_in_document call above.
You could also write these lines to a second document by calling put_in_document again.
#

Note

• If you call the function put_in_document in a Microsoft Word DOC model, you should be aware that the text part you produce by calling the function must end with a paragraph ending. Otherwise the Microsoft Word DOC document you try to produce might be corrupted and can cause errors.
• It is not possible to place the text from repeated calls to put_in_document( ) in the same document, If you want to 'collect' the text from several calls in one document you must use the function add_to_output( ). If you want to leave the result document intact you can use the open buffer mechanism.