IntelleDoc Visualizer User Guide

About IntelleDoc Visualizer

IntelleDoc Visualizer is an application used to validate the content of CSi TXL data files structured on the CSi Data Schema. It allows transaction data in a TXL file to be checked against a schema file, flagging data that does not comply with parameters of the schema so that it may be corrected.

IntelleDoc Visualizer also allows the TXL data file to be exercised against the Transaction Server, CSi’s component for selecting, assembling, and outputting transaction documents. When IntelleDoc Visualizer is installed, the Transaction Server component is automatically installed on the same system to provide access to its functionality.

Getting Started

IntelleDoc Visualizer is added to the Start menu upon its installation. It is started by clicking **Start > All Programs > Compliance Systems > CSi IntelleDoc Solutions Software 7.00.0> IntelleDoc Visualizer. By default, the application is installed in C:\Program Files\Compliance Systems\CSi IntelleDoc Solutions Software v7.00.0\visualizer.

To exit IntelleDoc Visualizer, click File > Exit.

Starting IntelleDoc Visualizer from the Command Prompt

IntelleDoc Visualizer may be launched from the command prompt. This allows the application to be shell-executed and opened with a specific TXL file.

Starting IntelleDoc Visualizer from the command prompt:

1. Click Start > Programs > Accessories > Command Prompt to open a Command Prompt window.

2. Specify the directory location of visualizer.exe.

3. Type visualizer.exe [filename] where filename is the name of the TXL to be opened in IntelleDoc Visualizer.

4. Press ENTER.

About File Associations

A file association connects a given file type with an application capable of opening that file. The file type is determined by its three-character file extension, such as .TXT, .PDF, etc. When a file extension is associated with an application, users can double-click on the file in a file manager, such as Windows Explorer, to open the file with its associated application.

File associations may be registered automatically by the applications using the file types. Users may also register file associations manually.

Registering the TXL File Extension

A TXL file is an XML data file based on the CSi Data Schema. It can contain all of the information necessary to document a given transaction. Upon startup, IntelleDoc Visualizer checks the system registry for the TXL file extension. If it is not already registered to IntelleDoc Visualizer, a prompt appears to allow the extension to be registered to IntelleDoc Visualizer.

Licensing IntelleDoc Visualizer

In order to access the functionality of IntelleDoc Visualizer, it is necessary to enter a valid license key for the product.

Entering a license key:

1. Click Tools > Options and view the Licensing tab.

2. Type or paste the license key into the License Key field.
   
   OR
   
   Click the From File button and browse for the text file containing the license key. Select the file and click Open. The Details section of the Options window describes the functionality accessible with the license key.

3. Click Save in the Options dialog box.

Managing the Transaction Server

In order to select and render documents with IntelleDoc Visualizer, it is necessary to specify the file path for the document repository. Documents must exist in the root of the repository directory. Documents contained in subdirectories of the root directory are not available.

The Server tab of the Options dialog box contains parameters that control the Transaction Server. The Transaction Server selects, assembles, and outputs documents required for a transaction using the CSi Data Schema for data management. It is embedded into the system on which IntelleDoc Visualizer is installed.

Option	Description
Repository	Determines the location to be checked for CSi documents. Type in a file path or click the Browse button to locate it. Navigate to the necessary directory, then click OK. After a repository is specified, the number of DSL files and form files are reported beneath the repository path. A DSL file is an FXL file used to perform document selection. A form file is an FXL file corresponding to a document in a lending or deposit transaction.
Maximum Concurrent Jobs	Sets the maximum number of transaction jobs that the Transaction Server may concurrently process. For the purposes of IntelleDoc Visualizer functionality, this number can set at 1.
Document Cache Capacity	Sets the maximum number of documents that may be cached in memory. The higher the number of cached documents, the more memory resources are used. Application performance will be increased unless the number of documents cached competes with other running applications for memory resources.
Time out (in seconds)	Sets the number of seconds that are allowed for a transaction to be processed by the Transaction Server. If the transaction times out prior to completion, a message describing this is posted to the Messages tab of the Document window.
Empty Value (default)	Determines the default behavior of data elements for which there is no defined value in the data file. blankField treats the empty value as if it were a blank field when the data element is blankable. emptyString interprets the value as nothing. A document using the data file may not pass validation, depending on the fields with nothing as a value. ignoreValue treats the data element as if it were not present in the data file.

Specifying the CSi Data Schema Location

The Schema tab of the Options dialog box includes an option to set the file path where the CSi Data Schema file is located. The schema file located with this file path information is used to validate the data files loaded or created in IntelleDoc Visualizer. When a data file does not conform to the structure of the specified schema file, IntelleDoc Visualizer flags the data that does not comply with parameters of the schema so that it may be corrected.

Option	Description
CSi Schema	Specifies the default file path used to access the CSi Data Schema. Type in a file path or click the Browse button to locate it. Navigate to the necessary directory, then click OK.

If an invalid file path is entered or if the file path becomes invalid after it is entered, IntelleDoc Visualizer displays the message “Repository filepath is INVALID” under the file path edit box.

The CSi Data Schema also provides access to IntelliSense features in the upper left pane of the Data window. IntelliSense is an auto-completion feature that, as the user types, provides closing element tags and lists the element tags that are appropriate for a given branch of the schema structure.

Navigating the IntelleDoc Visualizer Environment

IntelleDoc Visualizer organizes document information in a collection of work windows. All work windows can be manually positioned and resized.

Data Window

The Data window compares the transaction data associated with the current TXL data file with the CSi Data Schema file specified in the Schema tab of the Options dialog box. Each open TXL file in IntelleDoc Visualizer is displayed in its own Data window.

The Data window is comprised of three tabs.

Transaction Tab

The Transaction tab of the Data window is divided into three viewing panes.

The Edit pane (1) displays the transaction information loaded from the current TXL file. This pane includes a menu of options controlling the display of data. To display the menu, click.

Option	Description
Show Whitespace	Displays and hides the non-printing characters that create white space in the document. This includes characters for paragraph markers (), tab stops (), and spaces created with the spacebar ().
Word Wrap	Determines if line text flows to the right edge of the Document Editor window or if it wraps to flow within the boundaries of the display area. When Show Whitespace is active, the artificial lines breaks associated with word wrap are displayed ().
Highlight Current Line	Displays and hides a highlight bar behind the text line that holds the cursor.
Outline	Displays and hides tree display controls ( ) affecting the hierarchical display of text elements in the Document Editor window.
Line Numbers	Displays and hides the line numbers in the Document Editor window using the left margin area.
Editor Font	Controls the font used to display text on the Transaction tab of the Data window.
List Font	Controls the font used to display text on the Document List tab of the Data window.

The Navigation pane (2) displays the schema tree structure of the current data file. Click on an element in the schema structure to navigate to the the corresponding element in the TXL file.

The Error pane (3) displays the results of the comparison of the schema XSD file with the transaction data in the TXL file. Invalid elements in the TXL file are noted in the Message column, along with the line and column number in which they appear in the TXL file. Double-click on an error message in the lower left pane to select the element containing the error in the Data pane.

If no schema file is specified in Tools > Options > Schema, the right pane and lower left pane appear blank.

Transaction Tab Context Menu Commands

The Transaction tab of the Data window includes a context menu that provides convenient access to frequently used commands affecting the content of the current TXL file.

Command	Description
Undo	Reverses the last content edit that was made. If Undo has been used, selecting this command again reverses the previous content edit in sequence.
Redo	Reinstates the last reversed action on the Transaction tab.
Cut	Removes selected text and places it on the Windows clipboard.
Copy	Duplicates selected text and places it on the Windows clipboard.
Paste	Places copies of the text from the clipboard at the cursor position. If text is selected, the pasted text replaces it.
Delete	Removes the selected text.
Select All	Selects all content on the tab.

The Edit > Undo and Edit > Redo commands also reverse the last content edit made on the Transaction tab.

Document List Tab

When documents are selected from the document repository, the Document List tab of the Data window displays a list of those document names. Individual documents on the list can be viewed and saved.

Documents that appear gray on the list are not available in the document repository to be rendered. For information about specifying the location of the document repository, please see the topic Managing the Transaction Server (on page 10).

Column	Description
ID	The CSi identification number for the document. If the document is custom, “custom” is listed for the document’s ID.
OXL	Indicates if an OXL file is associated with the document. OXL files are associated with a CSi stock document when it is customized in Custom Document Editor.
MXL	Indicates if an MXL file is associated with the document. MXL files are associated with a CSi stock document when it is customized in Custom Document Editor.
Document Name	The name of the document.
Width	Indicates the page width of the document. Zero (0) indicates the default width. Any other value indicates a custom width.
Height	Indicates the page height of the document. Zero (0) indicates the default height. Any other value indicates a custom height.
Copies	Indicates the number of copies to be generated for the document.
Associations	Indicates associations, or relationships, between a document with a unique identifier that denotes entities or collateral in a transaction. For more information on associations, please see Understanding Associations[]{#H_10729 .anchor} (on page 49).

The Warranty button displays a Loan Summary or Deposit Summary document for the transaction in Adobe Acrobat. The summary includes information describing the parameters of the transaction, such as the number of borrowers and closing state, as well as documents required for the transaction.

The Manifest button creates a transaction manifest listing all documents included in the transaction set and displays it in Adobe Acrobat. It is available when the Generate Manifest option is enabled in Options > Job Ticket and the user either renders a document set or generates a transaction.

The Combined button displays a combined PDF file in Adobe Acrobat when the user either renders a document set or generates a transaction. It is available when the destination is defined as a combined PDF rather than individual PDFs.

The Document List tab also includes a context menu for managing documents on the list.

Document List Tab Context Menu Commands

The Document List tab of the Data window includes a context menu that provides convenient access to frequently used commands affecting selected documents.

Option	Description
Render Document (with Associations)	Renders the selected document using all associated entity or collateral IDs found in the current data file. When a document is successfully rendered, a check mark []{#O_12909 .anchor} displays next to its name on the Document List tab. When a document fails to render, an []{#O_12910 .anchor} appears next to its name.
View Document	Displays the rendered document in Adobe Acrobat. The document must be rendered before it can be viewed.
Save Document	Opens a dialog box for saving the rendered document as a PDF file.
Clear Document List	Removes all documents from the list in the Data window. A prompt appears to confirm this action. When documents are listed, certain functions are not available. These include selecting documents; rendering specific documents; and rendering documents with associations.
Add Document	Allows users to add a document to the list to render. For example, users may want to render a custom document, which is not selected by the Lending.FXL or Deposit.FXL files. After selecting a document from the Repository list, users may associate an ID with entities and collateral as well as change the document output dimensions. To associate an ID with an entity or collateral type, click on the type, then enter the ID value in the ID column. Page size is measured in inches. To use the default page size for the document, enter 0 (zero) for Page Width and Page Height.
Remove Document	Allows users to remove a document from the list to render. For example, users may not want a specific document to render. A dialog box appears to confirm the removal of the document from the list.
Change Document Output Options	Allows the page size of the document as well as the number of copies generated to be modified. Page size is measured in inches. To use the default page size for the document, enter 0 (zero) for Page Width and Page Height.
Document Properties	Opens the Properties window, which reports information about the document. For more information about document properties, please see Viewing Document Properties (on page 40).

Messages Tab

The Messages tab of the Data window displays system messages that are generated as a result of document selection or rendering. The top portion of the window lists the system messages.

Missing Data Values

When data values required to render documents are missing from the data file, IntelleDoc Visualizer lists the XPath and data element name of those data values in the lower portion of the Messages tab.

Two paths are listed for each datapoint. The top path is the XPATH. The lower path in gray is the CSi Mapping Path.

XPATH is an XML approach for accessing items in an XML document by specifying a path through the document structure. XPath uses the root node (the point from which the path address begins), the logical tree that is inherent in any XML document, and the concepts expressing logical relationships that are defined in the XML Information Set, such as ancestor, attribute, child, parent, and self. The resulting XPATH shows the realized transaction relationships for items in that path.

The CSi Mapping Path is based on XPATH, but shows the unrealized transaction data relationships for items in that path. For example, a CSi Mapping Path may include i. and .j suffixing references, which in the XPATH become specific references to transaction data elements.

IntelleDoc Visualizer automatically attempts to add the appropriate branch and data element tags for the missing data values on the Transaction tab. The placeholder text __MISSING_DATA_VALUE__ is added to indicate where missing data should be entered. Missing data element information is highlighted in green on the Messages tab to indicate that the data element was added.

For example, in the previous image three data values are missing. They relate to loan status type, loan type, and the total count of the borrowers. Their XPath and datapoint names are indicated on the Messages tab. On the Transaction tab, the missing data elements are automatically inserted at the proper location in the data file. When IntelleDoc Visualizer cannot successfully add the data element on the Transaction tab, the missing data element is highlighted in red on the Messages tab.

Transaction File List

The Transaction File List allows a directory to be specified from which FXL files may be more conveniently opened.

Displaying the Transaction File List:

1. Click View > Transaction Data File Browser.

Specifying transaction data file directories:

1. Click the Browse button in the Transaction File List.

2. Navigate to the directory list as necessary and select the directory in which document files are stored.

3. Click OK. The directory path is displayed at the top of the Transaction File List and the document files within that directory are listed.

Selecting files from the Transaction File List:

1. Click on the TXL file to be evaluated against the CSi Data Schema.

2. The document name appears bold in the Transaction File List when open.
   \If the maximum number of files is open, you are prompted to close the most recently opened file before the new file is opened from the Transaction File List.

Managing the IntelleDoc Visualizer Environment

The Tools > Options command and the Options tool provide access to various application settings.

General Options

The General tab of the Options dialog box includes parameters to control basic application features and file access.

Option	Description
Show splash screen	Determines if the IntelleDoc Visualizer splash screen is displayed when the application is started.
Most recently used documents	Specifies the number of recently used document files listed at the bottom of the File menu.
Maximum number of open documents	Specifies how many document files may be opened at once.
Show Messages	Determines if warning messages are displayed. This refers to the warning messages that are logged in the log file. When the option is active, these messages are also displayed in message boxes that appear in IntelleDoc Visualizer as the warning trigger events occur.

Data Options

The Data tab of the Options dialog box includes an option to set a default directory to be checked for transaction data files. This file path becomes the default file path when you select File > Open or click the Open tool.

Option	Description
Data filepath	Specifies the default file path used to access data files. Type in a file path or click the Browse button to locate it. Navigate to the necessary directory, then click OK.
Extracted DXL Dir	Specifies an optional directory where the DXL datapoint/value pairs used to select or render a document are written. The writing of such information to this directory is typically done for the purposes of debugging.

The file path for data files may also be set in the Transaction File List window.

Editor Options

The Editor tab of the Options dialog box includes parameters to control the default appearance of transaction data in the Data window.

Option	Description
Show Whitespace	Displays and hides the non-printing characters that create white space in the document. This includes characters for paragraph markers ([]{#O_10643 .anchor}), tab stops ([]{#O_10644 .anchor}), and spaces created with the spacebar ([]{#O_10645 .anchor}).
Word Wrap	Determines if line text flows to the right edge of the Document Editor window or if it wraps to flow within the boundaries of the display area. When Show Whitespace is active, the artificial lines breaks associated with word wrap are displayed ([]{#O_10646 .anchor}).
Highlight Current Line	Displays and hides a highlight bar behind the text line that holds the cursor.
Outline	Displays and hides tree display controls ([]{#O_10649 .anchor} []{#O_10650 .anchor}) affecting the hierarchical display of text elements in the Document Editor window.
Line Numbers	Displays and hides the line numbers in the Document Editor window using the left margin area.
Editor Font	Controls the font used to display text on the Transaction tab of the Data window.
List Font	Controls the font used to display text on the Document List tab of the Data window.

Word Wrap does not affect the printed appearance of documents.

Job Ticket Options

The Job Ticket tab of the Options dialog box contains parameters that define the manner in which documents are output for the Transaction Server as well as information that is to be returned by the Transaction Server. The Transaction Server selects, assembles, and outputs documents required for a transaction using the CSi Data Schema for data management. It is embedded into the system on which IntelleDoc Visualizer is installed.

Job Ticket, Rendered Document Options

Option	Description
Enable Blank Fields	Determines if blank fields are to be displayed in the rendered document.
Blank Fields Highlight	When Enable Blank Fields is active, determines the highlighting style used to display blank fields. Available options include an underline style and gray shading with a range of opacities.
Blank Fields Default Width	When Enable Blank Fields is active, determines the width of blank fields in the rendered document.
Alignment Default (static only)	Determines the character alignment of text in the datafields of rendered static documents.
Shrink to Fit Minimum Font Size	Forces the size of text characters to shrink to fit in a datafield when the size of the field does not allow all text characters to be displayed. Text shrinks until it fits the datafield or until it reaches the minimum font size specified. To disable shrink-to-fit functionality, set the value in this field to 0 (zero).
Truncate (after Shrink to Fit minimum reached)	Truncates text to fit in a datafield when the size of a datafield does not allow all text characters to be displayed. When a value greater than zero is entered in the Shrink to Fit Minimum Font Size option, the text font size is reduced accordingly and then truncates if there is more text than can be displayed in the datafield. For more information, see Shrink-to-Fit and Truncation Options[]{#H_26745 .anchor} (on page 27).

Shrink-to-fit and Truncation Options

Shrink-to-Fit and Truncate options may be applied to mergable text overlay fields and fields in static documents. Dynamic documents are not affected by these options.

Shrink-to-Fit forces the size of text characters to shrink to fit in a field when the size of the field does not allow all text characters to be displayed. The text shrinks until it fits or reaches the minimum font size. If the minimum font size is reached before the text fits, the text overruns the field. The font is reduced by .1 increments.

Truncate shortens text to fit in a field when the size of the field does not allow all text characters to be displayed. When Truncate is enabled and the text of the datapoint does not fit in a field, the truncation symbol (§) appears in the lower right of the field to indicate that there is additional data that is not displayed.

Element	Truncate and Shrink-to-Fit disabled	Truncate enabled	Shrink-to-Fit enabled	Truncate and Shrink-to-Fit enabled
Dynamic document	NA	NA	NA	NA
Static document, single-line field	Text runs off right edge.	Text truncates when it reaches the right edge.	Text shrinks to the minimum point size, then runs off right edge.	Text shrinks to the minimum point size, then truncates when it reaches the right edge.
Static document, multi-line field OR Mergable text overlay field	Text wraps in field and runs off bottom edge.	Text truncates when it reaches the right edge of the last line.	Text shrinks to the minimum point size, then wraps in field and runs off bottom edge.	Text shrinks to the minimum point size, then truncates when it reaches the right edge of the last line.

When both Shrink-to-Fit and Truncate are enabled, the Shrink-to-Fit guidelines are enforced, followed by the Truncate guidelines.

Job Ticket, Transaction Options

Option	Description
Use Default Values	Allows predefined datapoint values embedded in an FXL file to be used when rendering the document when no values are provided in the data file.
Generate Manifest	Creates a list of all documents included in the transaction set.
Return Inplay Datapoints	Creates a list of inplay datapoints based on the current transaction values. An inplay datapoint is one that is required in order for the document to be considered complete.
Return Superfluous Data elements	Creates a list of superfluous data elements based on the current transaction values and displays it on the Messages tab. A superfluous data element is one that is not in play for the current transaction values.

Job Ticket, Document Selection Options

These options are not available in this release.

Job Ticket, Files Options

Command	Description
Global MXL	Specifies the location of the MXL file that is to be used to access script information that manipulates or maps datapoint values before applying them in documents. Type in a file both or click the Browse button to locate it. Navigate to the necessary directory, then click OK.
Global OXL	Specifies the location of the OXL file that is to be used to access overlay elements that are to be incorporated into documents. The overlays elements may be datapoints, fixed (static) text, or graphics such as lines and rectangles. Type in a file both or click the Browse button to locate it. Navigate to the necessary directory, then click OK.

Arranging Windows

The Window menu includes commands for arranging open documents. All open windows are listed on the menu. Selecting a window name from the list makes a given window active.

• Cascade overlaps the windows so that all title bars are visible.

• Tile Horizontal splits the display area horizontally so that document windows are displayed from top to bottom.

• Tile Vertical splits the display area vertically so that windows are displayed from left to right.

Application Toolbar

The IntelleDoc Visualizer toolbar provides alternative access to commonly used commands. It is displayed using the View > Toolbar command.

Tool	Description
	Creates a new blank data file.
	Opens a TXL data file.
	Saves the current data file.
	Displays page setup parameters for the contents of the Document Editor window.
	Displays the content of the Document Editor window as it will be printed.
	Prints the content of the Document Editor window.
	Displays the Options dialog box.
	Displays the online help for IntelleDoc Visualizer.

Commands are described in more detail in the sections that are dedicated to their functionality.

Working with Transaction Data

There are three types of actions that users may perform with data files created or modified with IntelleDoc Visualizer.

• Document selection. The content of the TXL file is designed to select documents required to document the transaction.

• Document rendering. The content of the TXL file is designed to render documents required to document the transaction.

• Document selection and rendering. The content of the TXL file is designed to support an entire transaction, and thus it is sufficient to both select and render the required documents.

Opening Data Files

CSi’s TXL data files are based on the CSi Data Schema and can contain all of the information necessary to document a given transaction. The contents of a TXL file are displayed in the Edit pane of the Data window. Opening TXL data files:

1. Click File > Open or click the Open tool []{#O_10340 .anchor}.

2. Navigate to the drive and folder containing the TXL file.

3. Select the file name to be opened, then click Open.

Recently-used data files are listed at the bottom of the File menu. They can be opened by clicking on their names. The General tab in the Options dialog box allows the number of recently-used data files listed to be specified. Click Tools > Options to access it.

TXL data files may also be opened from the Transaction File List.

Users can open a TXL file by dragging and dropping the file from any file source, such as a network drive folder, into IntelleDoc Visualizer.

IntelleDoc Visualizer supports SystemFileWatcher, which monitors the opened TXL file. If the file is changed outside of IntelleDoc Visualizer while it is opened, you are prompted to reload it to access the file’s latest changes.

Creating New Data Files

New data files may be created in IntelleDoc Visualizer. When a schema file is specified in the Options dialog box, IntelliSense features in the Data window become available. IntelliSense is an auto-completion feature that provides closing element tags and lists the element tags that are appropriate for a given branch of the schema structure. Creating new data files:

1. Click File > New or click the New tool []{#O_10088 .anchor}.

2. A new blank data list is opened in the Data window on the Transaction tab.

3. Add branch tags, leaf node tags, and leaf node values as necessary.

4. To save the file, click File > Save or click the Save tool .

Importing Transaction Data

If you have transaction data in CSi’s DXL data format, you can import the files into IntelleDoc Visualizer. In order to do so, it is necessary to:

• Create a new blank data file in IntelleDoc Visualizer.

• Specify the FXL document file on which the DXL data has been defined. Unlike TXL data files, DXL files contain data values and layout directives that are specific to a document rather than data pertaining to the transaction as a whole.

Importing DXL data files:

1. Click File > Import > DXL.

2. Type a file path and name in the DXL edit box.
   
   OR
   Click the Browse button []{#O_7909 .anchor} to locate the file. Navigate to the necessary directory and select the file, then click Open.

3. Use the drop-down list in the FXL field to select a corresponding FXL document file.

4. Click Import. The data from the DXL file is loaded in the Data window and appears on the Transaction tab. When saved in IntelleDoc Visualizer, it will use the TXL file format.

Saving Data Files

Data elements and values loaded from TXL files appear in the Data window on the Transaction tab. Changes made to the data elements and values can be saved either in the same TXL file or in a new TXL file.

To update an existing TXL file, click File > Save or click the Save tool . To save changes in a new TXL file, click File > Save As.

Saving data files with Save As:

1. If necessary, make sure that the Data window is selected.

2. Click File > Save As.
   
   OR
   If the file is new and has not yet been saved, click the Save tool []{#O_10089 .anchor}.

3. Select the location in which to save the file.

4. Type a name for the file in the File Name box.

5. Click Save. If necessary, confirm the replacement of existing files with the same name.

Navigating and Selecting Transaction Data

The Data window includes several features for navigating and selecting transaction data.

Navigation or selection type	Feature
Page up and down through the content of a data file.	Use the Page Up []{#O_10715 .anchor} and Page Down []{#O_10716 .anchor} buttons on the scroll bar.
Select all of the data associated with a data branch.	Click on the branch element in the right pane of the Data window.
Locate an element that is generating an error message.	Double-click on the error message in the bottom left pane of the Data window.
Go to a specific line in the data file.	Click Edit > Go To, then enter the number of the line that you want to hold the cursor.
Select text.	Click and drag over the text to be selected.
Select a line of text.	Position the mouse near the line number and click. If line numbers are not displayed, position the mouse near the left margin of the text lines.
Select all text.	Click Edit > Select All or select Select All from the Document window’s context menu.

Navigating with Bookmarks

The content of a data file may be navigated more quickly by setting bookmarks in the text. Bookmarks appear in the margin area of the Transaction tab and are managed with commands on the Edit > Bookmarks submenu.

Command	Description
Toggle Bookmark	Sets a bookmark for the text line that currently holds the cursor.
Previous Bookmark	Moves the cursor to the beginning of the line that holds the previous bookmark.
Next Bookmark	Moves the cursor to the beginning of the line that holds the next bookmark.
Clear Bookmarks	Removes all bookmarks from the content.

Editing Transaction Data

The content of a data file can be modified in the upper left pane of the Data window. Generally, modifications are made to address errors that prevent the rendering of documents that use the data. New data files may also be created and completed in the Data window.

A red underline is used to flag elements in the Transaction pane that do not synchronize with the schema file specified in Options.

Cutting and Copying Data

Data content can be cut and copied using the Windows clipboard. Commands for Cut, Copy, and Paste are located on the Edit menu as well as on the context menu available on the Transaction tab of the Data window.

Context menu for the Document window’s Transaction tab

• Edit > Cut and the context menu Cut command remove selected text and place it on the Windows clipboard.

• Edit > Copy and the context menu Copy command duplicate selected text and place it on the Windows clipboard.

• Edit > Paste and the context menu Paste command place copies of the text from the clipboard into the Data window.

To cut, copy, and paste text from the Transaction tab, use the keyboard shortcuts CTRL-X (cut), CTRL-C (copy), and CTRL-V (paste).

Finding and Replacing Data

IntelleDoc Visualizer includes find and replace features to help you quickly locate data elements or values on the Transaction tab of the Data window.

The Find and Replace features is used to locate content on the Transaction tab of the Data window.

Command	Description
Find what	An edit box for entering the text to be located.
Replace with	An edit box for entering the text to be substituted for the located text.
Find Next	Locates the next instance of the Find what text.
Replace	Replaces the selected instance of the Find text with the Replace text.
Replace All	Replaces all instances of the Find text with the Replace text.
Mark All	Selects all instances of the Find text.
Match case	Locates only those instances of the Find text that match the Find capitalization. When the option is not active, all instances of the Find text are located, regardless of case.
Match whole word	Locates only those instances of the Find text that constitute a complete word. For example, the Find text TotalCount will only locate TotalCount, not TotalCountOfCosigners.
Search Up	When active, searches the window from the location of the cursor up to the top of window. When inactive, searches the window from the location of the cursor down to the bottom of the window.
Search hidden text	Searches content that is not currently displayed in the window.
Search in selection	Searches only in the selected content in the window.
Use Regular Expressions	When Use Regular expressions is active, clicking this button displays a list of regular expressions that may be added to the Find what edit box by clicking the Expand button:
Use Wildcards	When Use Wildcards is active, clicking this button displays a list of regular expressions that may be added to the Find what edit box by clicking the Expand button:

Using Find and Replace

The Find feature is used to locate specified content on the Transaction tab of the Data window.

Using Find:

1. If necessary, make sure that the Transaction tab of the Data window is selected.

2. Click Edit > Find and Replace > Find.

3. Enter the text to be used as the search criteria in the Find what box.

4. Set other Find options as necessary, then click Find Next.

5. To find the next instance of the text, click Find Next again.

6. Click Close when done.

The Replace feature is used to replace specified content on the Transaction tab of the Data window.

Using Replace:

1. If necessary, make sure that the Transaction tab of the Data window is selected.

2. Click Edit > Find and Replace > Find.

3. Enter the text to be used as the search criteria in the Find what box.

4. Enter the text to be used as the replacement string in the Replace with box.

5. Set other Find options as necessary, then click Find Next to locate the next instance of the text.

6. To replace the text, click Replace.

7. Repeat steps 5-6 as necessary.

8. Click Close when done.

Deleting Data

Content can be deleted from the Transaction tab of the Data window. The commands for Delete are located on the Edit menu as well as on the context menu available on the Transaction tab of the Data window.

• When content is selected, the Delete command removes the selected content.

• When content is not selected, the Delete command removes the first character to the right of the cursor.

Advanced Editing

The Edit > Advanced submenu contains additional data editing commands.

Command	Description
Comment Selection	Adds comment tags to the selected text.
Uncomment Selection	Removes comment tags from the selected text.
Make Uppercase	Modifies the selected text so that it is in uppercase letters: Text becomes TEXT
Make Lowercase	Modifies the selected text so that it is in lowercase letters: Text becomes text
Toggle Case	Modifies the selected text so that it is in reverse case: Text becomes tEXT
Capitalize	Modifies the selected text so that each word in the selection is given an initial capital: text content becomes Text Content
Delete Horizontal Whitespace	Removes tabs and multiple spaces in the selected text. Single spaces between words are preserved.
Trim Trailing Whitespace	Removes only the white space following the last bracket ( >) of the selected text lines.
Delete Line	Removes the selected text lines. If no line is selected, this removes the line that holds the cursor.
Duplicate Line	Creates a copy of the selected text lines. If no line is selected, this creates a copy of the line that holds the cursor.
Delete Blank Lines	Removes any blank lines in the selected text.
Transpose Lines	Reorders text lines so that the line that holds the cursor is moved down one line.
Transpose Words	Reorders words so that the word that holds the cursor is moved one word to the right. text content becomes content text
Transpose Characters	Reorders text characters so that character preceding the cursor is moved one character to the right. When text is selected, the last character of the selection is moved one character to the right.

The Edit > Pretty Print command removes extra white space at the beginning and end of text lines.

Selecting Documents

There are two types of CSi FXL files. One type is an FXL file that corresponds to a document in a lending or deposit transaction. The other type is an FXL file used to perform document selection. CSi distributes two base FXL files used for document selection, lending.fxl and deposit.fxl, and they are selected based on the type of transaction specified by the data in the TXL data file.

At least one document selection FXL file must be specified in order to select documents for the transaction. Additionally, users may elect to select a second, optional FXL file to customize the selection of documents for the transaction.

Option	Description
Please select one primary file and optionally one subordinate file (if available)	Specifies the FXL file that is to be used to select documents for the transaction. As many as two FXL files may be specified: one master and one optional supplemental file. The master FXL file provides the main document selection for the transaction based on CSi’s warranted document selection logic. The supplemental FXL provides additional, customized document selection at the user’s discretion. The selection of a supplemental FXL file is not required.
Do Not Group	Determines if all documents are listed in alphabetical order (Do Not Group) or if the documents are separated into categories based on their function in the transaction.
Include Application Documents on Warranty Document	Allows documents associated with loan application to be included on a warranty document at loan closing
Include Underwriting Documents on Warranty Document	Allows documents associated with loan underwriting to be included on a warranty document.

When a supplemental FXL file is selected, it must be of the same selection type as the master FXL file. For example, when the master FXL file is Deposit, then the supplemental FXL file must also select Deposit documents.

Selecting Documents:

1. Click Action > Select Documents.

2. Specify the necessary master FXL (Deposit or Lending) to select documents for the transaction. A supplemental FXL can also be selected to customize document selection.

3. Make selections as necessary from the Document Selection Preferences options in the Select Documents dialog box.

4. Click Select. The Processing Transaction dialog box appears to track the document selection process. The process may take a few moments to complete, depending on the number of documents required for the transaction.

5. The selected documents are listed on the Document List tab of the Data window. From there, documents may be viewed, printed, and saved.
   
   OR
   
   If the document is not rendered, the Messages tab of the Data window is displayed. Information regarding the document’s failure to render is listed there.

Supplemental Deposit and Lending FXL Files

CSi’s FXL files are used to control document selection with CSi’s Document Selection Logic (DSL) product. A supplemental FXL file can be used to customize the selection list and allows selection of CSi static documents in place of dynamic documents under certain conditions. This is useful as an interim step for partners who are making the transition from older static documents to dynamic documents.

Supplemental Deposit and Lending FXL files are developed by CSi and distributed upon the request of business partners. To request a supplemental FXL, please contact Deposit Client Services at 800.968.8522, option 1, or Lending Client Services at 800. 968.8522, option 3.

Clearing the Document List

Clearing the Document List tab:

1. Click Action > Clear Document List.
   
   OR
   
   Right-click on the Document List tab and select Clear Document List from the context menu.

Rendering Documents

The transaction information contained in data files is used to render documents in IntelleDoc Visualizer. While any document from the document repository may be selected, rendering is possible only when the current data file includes the data elements required to render the document.

Rendering documents:

1. Click Action > Render Document.

2. Select the document to be rendered from the document repository.

3. To change the document’s output page dimensions or number of copies, click the Format button. If necessary, indicate page dimensions in thousandths of an inch. When Page Width and Page Height values are 0 (zero), the document’s default dimensions are used.

4. To select the rendering format destination, click the Destination button. This determines if the rendered document is sent directly to the current printer (Printer) or displayed in Adobe Acrobat (PDF). When the rendering format is PDF, the user may embed form fields into the resulting PDF.

5. Click Render. The Transaction Server dialog box appears to track the rendering process.

6. The selected document is rendered. In the case of Printer, the document is sent to the specified printer. In the case of PDF, Adobe Acrobat is opened to display the rendered document.
   
   OR
   
   If the document is not rendered, the Messages tab of the Data window is displayed. Information regarding the document’s failure to render is listed there.

The directory used as the document repository is specified on the Transaction Server tab of the Options dialog box.

The default page size of the document can be checked on the General tab of the Properties window.

Changing Render Format

The Destination button opens the Change Render Format Options dialog box allows users to specify that the rendered document be printed or generated as a PDF.

When the destination is Printer, users may specify duplexing options.

Option	Description
default	Prints the document using the printer’s default settings related to duplex printing.
horizontal	Prints the document on both sides of the paper using a landscape orientation.
vertical	Prints the document on both sides of the paper using a portrait orientation.
simplex	Prints the document using a single side of the paper.

When the destination is PDF, users may specify whether form fields are embedded. Users can also specify options related to the use of digital signatures in the PDF.

The Embed Form Fields option creates a fillable PDF file by embedding datafields in the document so that their data values may be modified in Adobe Acrobat.

Rendering Documents with Associations

IntelleDoc Visualizer can render a document using all associated entity or collateral IDs found in the current data file.

Rendering documents with associations:

1. Click Action > Render Document with Associations.

2. Select the document to be rendered from the document repository.

3. To associate an ID with an entity or collateral type, click on the type, then enter the ID value in the ID column.

4. To change the document’s output page dimensions or number of copies, click the Format button. If necessary, indicate page dimensions in thousandths of an inch. When Page Width and Page Height values are 0 (zero), the document’s default dimensions are used.

5. To select rendering format destination, click the Destination button. This determines if the rendered document is sent directly to the current printer (Printer) or displayed in Adobe Acrobat (PDF). When the rendering format is PDF, the user may embed form fields into the resulting PDF.

6. Click Render. The Processing Transaction dialog box appears to track the rendering process.

7. The selected document is rendered.
   
   OR
   
   If the document is not rendered, the Messages tab of the Data window is displayed. Information regarding the document’s failure to render is listed there.

The directory used as the document repository is specified on the Transaction Server tab of the Options dialog box.

Understanding Associations

IntelleDoc Visualizer Action > Select Documents and Action > Transaction commands select the correct documents required to document a transaction and list them on the Document List tab of the Data window.

CSi IntelleDoc Solutions technology allows IntelleDoc Visualizer to produce this document list with associations. Associations refer to the relationship of a document with a unique identifier, or ID, that denotes an entity or collateral in a transaction. An entity is any real business, individual, association, trust, or governmental body related to a transaction. Collateral is security that is pledged for a lending transaction.

Associations occur whenever a given document is used multiple times with different data values in the same transaction. For example, a home equity line of credit application with Borrower1 and Borrower2 will associate two instances of the Credit Score Summary, Notice to Home Loan Applicant, and Home Equity Consumer Loan Application document with each entity. The instances of the documents render differently depending on whether they are associated with the entity Borrower1 or Borrower2.

Rendering Document Sets

The transaction information contained in data files is used to render the selected documents listed on the Document List tab of the Data window. The entire document set can be rendered at once. In order for the documents to be successfully rendered, they must exist in the specified document repository.

Rendering document sets:

1. Click Action > Render Document Set. The Render Document Set dialog box appears.

2. To select the rendering format destination, click the Destination button. This determines if the rendered document is sent directly to the current printer (Printer) or displayed in Adobe Acrobat (PDF). When the rendering format is PDF, the use may embed form fields into the resulting PDF.

3. Click Render. The Transaction Server dialog box appears to track the rendering process.

4. The required documents are rendered.
   
   OR
   
   If the documents are not rendered, the Messages tab of the Document window is displayed. Information regarding the documents’ failure to render is listed there.

The directory used as the document repository is specified on the Transaction Server tab of the Options dialog box.

To view the session summary in Adobe Acrobat, click the Warranty button on the Document List tab of the Data window.

Generating Transactions

The transaction information contained in data files is used to generate a transaction. The Transaction command performs both document selection and document set rendering activities. The transaction parameters defined in the current data file determine which documents are required to document the transaction.

Option	Description
Please select one primary file and optionally one subordinate file (if available)	Specifies the FXL file that is to be used to select documents for the transaction. As many as two FXL files may be specified: one master and one optional supplemental file. The master FXL file provides the base document selection for the transaction based on CSi’s warranted document selection logic. The supplemental FXL provides additional, customized document selection at the user’s discretion. The selection of a supplemental FXL file is not required.
Do Not Group	Determines if all documents are listed in alphabetical order (Do Not Group) or if the documents are separated into categories based on their function in the transaction.
Include Application Documents on Warranty Document	Allows documents associated with loan application to be included on a warranty document at loan closing.
Include Underwriting Documents on Warranty Document	Allows documents associated with loan underwriting to be included on a warranty document.
Destination	Determines if the rendered document is sent directly to the current printer (Printer) or displayed in Adobe Acrobat (PDF). When the rendering format is PDF, the use may embed form fields into the resulting PDF.

Generating Transactions:

1. Click Action > Transaction.

2. Specify whether the loaded TXL file describes a Deposit or Lending transaction.

3. Make selections as necessary from the Document Selection Preferences options in the Transaction dialog box.

4. Click Transaction. The Processing Transaction dialog box appears to track the document selection and rendering process. The process may take a few moments to complete, depending on the number of documents required for the transaction.

5. The selected documents are rendered.
   
   OR
   
   If the document is not rendered, the Messages tab of the Data window is displayed. Information regarding the document’s failure to render is listed there.

Changing Render Format

The Destination button opens the Change Render Format Options dialog box allows users to specify if the rendered document is to be printed or generated as a PDF.

When the destination is Printer, users may specify duplexing options.

Option	Description
default	Prints the document using its default settings.
horizontal	Prints the document on both sides of the paper using a landscape orientation.
vertical	Prints the document on both sides of the paper using a portrait orientation.
simplex	Prints the document using a single side of the paper.

When the destination is PDF, users may specify whether form fields are embedded and whether PDFs are individual or combined.

The Embed Form Fields option creates a fillable PDF file by embedding datafields in the document so that their data values may be modified in Adobe Acrobat.

The list option in the upper right corner of the dialog allows users to specify if the resulting PDFs are individual PDFs or combined into a single PDF.

Viewing Document Properties

The Properties window reports information about a document selected from the document repository. It displays data pertaining to the document file as well as data about the document form, such as warranty and datapoint information. Information is divided into tabs for easier reference.

Viewing document properties of a selected document:

1. Right click on a document name on the Document List tab of the Data window and select Properties from the context menu.

Viewing document properties of a document in the repository:

1. Click Action > Document Properties.

2. Select the document to be rendered from the document repository.

3. Click Properties. The Properties window is displayed.

4. Click the Close button when done.

General Information

The Properties window reports warranty general document information on its General tab. The information describes the document’s creator and details pertaining to its default parameters.

Property	Description
ID	The CSi form number.
Title	The document name.
Description	Supplemental description of the document.
FilePath	Directory from which the file was opened.
Source Filename	File name and extension of the document.
Version	Version number of the document.
Creator	Indicates component used to create document.
Created	Date the document was created.
Publisher	Indicates the entity that created the document.

Understanding Document Types

The Properties window reports document type information on its General tab. A document type refers to the document’s nature of origin.

Document Type	Description
csiStock	The document is a warranted CSi stock document.
custom	The document is a custom document.
customLite	The document was created in Custom Document Editor in Lite mode. Lite mode has restricted functionality and customizations are limited to fixed text and mergable text overlays.

Understanding Document Roles

The Properties window reports document role information on its General tab. A document role refers to the manner in which a document may be used in combination with other document files.

Documents may be chained together to enhance functionality. For example, partner and institution document selection customization can be handled by chaining additional partner-specific and institution-specific FXL files behind a generic or general document selection FXL file. The document role specifies how a given document is eligible for chaining.

Document Role	Description
primary	The document is chainable and can be used only as the primary document with subordinate documents.
subordinate	The document is chainable and cannot be used as the primary document.
chainable	The document is chainable. For static or dynamic documents, it can be used as part of a compound document.
standalone	The document is not chainable and, therefore, can only be used as a standalone document.

Warranty Information

The Properties window reports warranty information on its Warranty tab. The warranty information describes the states, institution types, products, and usage types for which the document is warranted.

Datapoint Information

The Properties window reports datapoint information on its Datapoints tab. This refers to datapoints that are embedded and used by the FXL file, not datapoints that are associated with leaf nodes referenced by the TXL file listed in the Data window.

You can hide and display columns on the Datapoints tab. Right-click on a column header, then select a column name to control its display.

Column	Description
Datapoint	The datapoint name.
Calculated	Indicates if the datapoint is the result of calculations based on values entered for other datapoints.
Usage	Indicates the usage type of the datapoint. For more information on CSi usage types, please see Datapoint Usage Types[]{#H_26762 .anchor} (on page 59).
Format	Indicates the CSi format of the datapoint. For more information on CSi datapoint formats, please see Datapoint Formats[]{#H_26764 .anchor} (on page 59).
Blankable	Indicates if the datapoint may be left empty without triggering a “Form must be completed” message when rendering the document. In order for the blank fields to be displayed in the rendered document, the Enable Blank Fields option must be made active in Options > Server. For more information, please see Managing the Transaction Server[]{#H_10712 .anchor} (on page 10).
Default Value	The default value for the datapoint, if any.
Description	The short help description for the datapoint.
Long Description	The long help description for the datapoint.
Mapping Path	The datapoint’s CSi Mapping Path. For more information on the CSi Mapping Path, please see Missing Data Values[]{#H_26783 .anchor} (on page 21).

Datapoint Usage Types

All datapoints have an associated usage type that identifies when its data is required or optional. A form may be considered complete or incomplete based on data supplied to its datapoints. Additionally, a form may or may not render based on data supplied to its datapoints.

An in-play datapoint is one that is required in order for a document to be considered complete. In order for a form to be considered complete, all in-play datapoints must be supplied. As data is supplied to a document to satisfy initial datapoints and its form logic is executed, additional datapoints may be required for the form to render or be considered complete. The in-play datapoints for a given document may thus evolve as the document is being completed.

Usage type	Description
structural_required	The datapoint is required to render the document. If such a datapoint is not supplied, CSi IntelleDoc Solutions™ does not render the document and reports that a value for the datapoint must be supplied.
structural_conditional	The datapoint may be required, depending on the values supplied for one or more other datapoints. If such an in-play datapoint is not supplied, CSi IntelleDoc Solutions™ does not render the document and reports that a value for the datapoint must be supplied. Once a structural_conditional datapoint is put in-play, it is considered structural_required.
structural_optional	Identifies datapoints that are not required, but affect the structure and/or content of the form if values are supplied.
data_required	The datapoint is required in order for the document to be legally compliant. If such a datapoint is not supplied, CSi IntelleDoc Solutions™ renders the document and places the warning message Form must be completed as a watermark on the top of the document.
data_conditional	The datapoint may be required, depending on the values supplied for one or more other datapoints. If such an in-play datapoint is not supplied, CSi IntelleDoc Solutions™ renders the document and places the warning message Form must be completed as a watermark on the top of the document. Once a data_conditional datapoint is put in-play, it is considered data_required.
optional	The datapoint is not required. If a value is supplied, CSi IntelleDoc Solutions™ includes this value in the document. If no value is supplied, CSi IntelleDoc Solutions™ renders the document with no warning or error messages.

Datapoint Formats

Name	Format	Description/Example
alphadate	Month dd, Year	January 1, Two Thousand and Two
alphadollar		Two Thousand Four Hundred Fifty-seven and 35⁄100 Dollars
alphamonth	Month dd, yyyy	January 1, 2002
alphanumber		four
alphaordinal		fourth
alphapercent		five and one quarter percent (5.25%)
alphapercentagepoints		five and one quarter percentage points (5.25%)
canadian-post	XXX XXX	A1A 2B2
capitalize	ALL UPPERCASE	ALL UPPERCASE
dollar	XX,XXX,XXX.XX	100,000.12
dollarroundup	XXX,XXX,XXX	If data entered is = 4567.56, expected display = 4,568
		If data entered is = 4567.49, expected display = 4,568
dollarrounddown	XXX,XXX,XXX	If data entered is = 4567.56, expected display = 4,567
		If data entered is = 4567.49, expected display = 4,567
dollarroundnearest	XXX,XXX,XXX	If data entered is = 4567.56, expected display = 4,568
		If data entered is = 4567.49, expected display = 4,567
exactpercent	XX.XXXXXXXX	18.125375
fourdecimaldown	X.XXXX	1.2345 (assuming 1.23456)
fourdecimalround	X.XXXX	1.2346 (assuming 1.23456)
fourdecimalup	X.XXXX	1.2346 (assuming 1.23456)
mm dd yyyy	mm dd yyyy	1 01 2002
mm/dd/yyyy	mm/dd/yyyy	1/01/2002
mmm dd, yyyy	mmm dd, yyyy	Jan 01, 2002
mmm. d, yyyy	mmm. d, yyyy	Jan. 1, 2002
mmm. dd, yyyy	mmm. dd yyyy	Jan. 01, 2002
noformat		This format allows users to override default phone or Tax ID number and SSN format in the data dictionary. For example, (248) 123-4567 ext. 268.
notarydate	Day of Month, yyyy	First day of January, 2002
notarydatenumericday		1st day of January, 2002
number	XXX,XXX,XXX	123,456,789
numericordinal		4th
odometer	XX,XXX,XXX.X	100,000.3
percent	XX.XXXX	18.125
phone	(XXX)XXX-XXXX	(800)123-4567123-4567
ssn	XXX-XX-XXXX	123-45-6789
tid	XX-XXXXXXX	12-3456789
tin	XXX-XX-XXXX	12-3456789
yieldpercent	XX.XX	18.01
zip	XXXXX-XXXX	1234512345-6789

Document Selection Information

When a Lending or Deposit FXL file is loaded, the Documents tab of the Properties window reports a list of documents available in the Lending or Deposit library, respectively.

You can hide and display columns on the Documents tab. Right-click on a column header, then select a column name to control its display.

Collateral Information

When a Lending FXL file is loaded, the Collateral tab of the Properties window reports a list of collateral types available in the Lending library.

You can hide and display columns on the Collateral tab. Right-click on a column header, then select a column name to control its display.

Printing

The Print command prints the contents of the Editor window. Different output is printed depending on which tab is active when the Print command is used.

Active tab	Output
Transaction	TXL file data.
Document List	The current document list.
Messages	The current message list.

Printed output from the Transaction tab does not reflect the displayed view of the window’s contents. Line numbers and white space characters that may be displayed in the window do not print. Text lines to not word wrap based on the window display size, regardless of whether Word Wrap is active.

Printing:

1. Make sure the active tab in the Editor window corresponds to the information to be printed.

2. Click File > Print or click the Print tool []{#O_649 .anchor}.

3. Select a printer and any necessary options.

4. Click Print.

Managing Page Setup

The File > Page Setup command and Page Setup tool provide control over how content appears on the printed page.

Option	Description
Paper Size	Sets the paper size used by the printer.
Paper Source	Sets the location where the paper is located in the printer.
Orientation	Sets the Portrait or Landscape orientation of data on the page.
Margins	Sets the printable area on the page.
Printer	Opens a dialog box for selecting a different printer.

Removing White Space

The Edit > Pretty Print command removes white space at the end of text lines in the TXL data file. It also removes extra white space occurring at the beginning of text lines while maintaining the hierarchical structure of data elements in the file.

Print Previewing

The File > Print Preview command and Print Preview tool provide a preview of the information to be printed from the Editor window.

Preview of the Document List tab

Option	Description
	Outputs the contents of the Document Editor window to the active printer.
	Allows a zoom magnification to be set for viewing the contents of the Preview window.
	Displays one page at a time in the Preview window.
	Displays two pages at a time in the Preview window.
	Displays three pages at a time in the Preview window.
	Displays four pages at a time in the Preview window.
	Displays six pages at a time in the Preview window.
	Closes the Preview window without printing.
	Displays the number of the page currently viewed in the Preview window and allows a new page to be selected.

Appendix A - Logging

IntelleDoc Visualizer uses an XML text file named visualizer.exe.log4net to define the application’s logging behavior. It is stored in the same directory as visualizer.exe. By default, this is C:\Program Files\Compliance Systems\CSi IntelleDoc Solutions v7.00.0\visualizer. For more information regarding log4net, see http://logging.apache.org/log4net/index.html.

Additional appenders, as <appender> tags, can be added to this logging file to manage the output of log statements appropriate for your environment. For more information regarding appenders, see http://logging.apache.org/log4net/release/config-examples.html.

The <root> determines which appenders are active (<appender-ref ref=“LogFileAppender” />) and what level of logging (<level value=“ERROR” />) is being performed. Valid logging levels are

• ALL,
• DEBUG,
• INFO,
• WARN,
• ERROR,
• FATAL,
• OFF.

For example, when the level is set to DEBUG, all messages are logged. When the level is set to WARN, logging occurs with the types WARN, ERROR, and FATAL (i.e., messages at levels WARN and higher).

<?xml version="1.0" encoding="utf-8" ?>
<!-- This section contains the log4net configuration settings -->
<log4net debug="false" threshold="TRACE">
    <!-- Define some output appenders -->
    <appender name="LogFileAppender" type="log4net.Appender.FileAppender">
        <file value=".\log\editor.log" />
        <!-- Example using environment variables in params -->
        <!-- <file value="${TMP}\log-file.txt" /> -->
        <sppendToFile value="true" />
        <!-- An alternate output encoding can be specified -->
        <!-- <encoding value="unicodeFFFE" /> -->
        <layout type="log4net.Layout.PatternLayout">
            <conversionPattern value="%date [%thread] %-5level %logger [%ndc]- %message%newline" />
        </layout>
        <!-- Alternate layout using XML
        <layout type="log4net.Layout.XMLLayout" /> -->
    </appender>
    <appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender">
        <file value=".\log\editor.log" />
        <appendToFile value="true" />
        <rollingStyle value="Date" />
        <datePattern value="yyyyMMdd" />
        <layout type="log4net.Layout.PatternLayout">
            <conversionPattern value="%date [%thread] %-5level %logger [%ndc]- %message%newline" />
        </layout>
    </appender>
    <!-- Setup the root category, add the appenders and set the default priority -->
    <root>
        <level value="ERROR" />
        <appender-ref ref="LogFileAppender" />
    </root>
</log4net>

Controlling Log File Size

CSi IntelleDoc Solutions uses the log4net library to handle logging services. The Compliance Engine configuration file csi.Engine.Configuration.dll.config handles logging directives for nearly all CSi IntelleDoc Solutions API assemblies.

By Log Level

The easiest way to reduce log file size is to set the log level to WARN or ERROR, thus suppressing all DEBUG and INFO level messages. For example:

...
<root>
  <level value="WARN" />
  <appender-ref ref="RollingLogFileAppender" />
</root>
...

By Specifying Assemblies

The logging level for specific assemblies can be set as well. For example, the following configuration logs warnings and errors for the csi.Transaction.Server assembly, but only errors for everything else:

...
<root>
  <level value="ERROR" />
  <appender-ref ref="RollingLogFileAppender" />
</root>
<logger name="csi.Transaction.Server">
  <level value="WARN" />
</logger>
...

By Maximum File Size

Another way to limit the size of the log file is to designate a maximum size. In the following example, the file will roll once it reaches 1000 KB and up to 10 old files will be kept.

...
<appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender">
    <file value="\${APPDATA}\\CSi IntelleDoc Solutions Software\\IntelleDoc Visualizer\\engine.log" />
    <appendToFile value="true" />
    <rollingStyle value="Size" />
    <maxSizeRollBackups value="10" />
    <maximumFileSize value="1000KB" />
    <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date \[%thread\] %-5level %logger \[%ndc\] - %message%newline" />
    </layout>
</appender>
...

By Date

Log files can be rolled by date as well. Here, the file will roll every day.

...
<appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender">
    <file value="\${APPDATA}\\CSi IntelleDoc Solutions Software\\IntelleDoc Visualizer\\engine.log" />
    <appendToFile value="true" />
    <rollingStyle value="Date" />
    <datePattern value="yyyyMMdd" /> <!-- roll every day -->
    <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date \[%thread\] %-5level %logger \[%ndc\] - %message%newline" />
    </layout>
</appender>
...

Other configuration options are available. Detailed information can be found at http://logging.apache.org/log4net/release/manual/configuration.html http://logging.apache.org/log4net/release/manual/configuration.html.

Glossary of Terms

Administrative

Part of the CSi Data Schema, Administrative is the schema data group that contains institutional and document setup elements for documents generated to contain transaction data. Data elements in this group are generally set up once by an institution for ongoing transactional use.

blank field

A dynamic datapoint approved by CSi to have the data entered manually by the end user after the document is printed.

branch

Within the CSi Data Schema, a branch is a distinct subdivision that organizes related data elements in a logical manner. Branch names comprised of multiple words are presented using the CamelCase naming convention so those words are joined together as a single word with the first letter of each component word capitalized, as in PowerOfAttorney.

Classic eDocs

This product line refers to CSi non-dynamic documents. They use fixed, or static text. The only variable data entered is transaction-specific input in the correct datapoints, which populates the document fields. The static text of these documents does not change based on the transaction parameters.

Collaterals

Part of the CSi Data Schema, Collaterals is the schema data group that contains data elements describing security pledged for a transaction.

COM

An acronym for Component Object Model, a specification developed by Microsoft for building software components that can be assembled into programs or add functionality to existing programs running on Microsoft Windows platforms. COM components can be written in a variety of languages and can be unplugged from a program at runtime without having to recompile the program.

COM+

COM+ is an extension of Component Object Model (COM), Microsoft’s strategic building block approach for developing application programs. COM+ is both an object-oriented programming architecture and a set of operating system services. It adds to COM a new set of system services for application components while they are running, such as notifying them of significant events or ensuring they are authorized to run.

Compliance Engine

A CSi IntelleDoc Solutions™ assembly that evaluates input transaction data and selects appropriate documents or document content based on a given data set, returns error messages if more information is needed, and renders the documents. These documents are rendered on screen as well as output as PDF, printed copy, or image files.

Compliance Logic System or CLS

Compliance Logic System is an application with a wizard-like interface that walks users through a Q&A session to define and assemble regulatory disclosures. It is presented as individual modules under two umbrella groups:

CLS-Deposit	CLS-Lending
CLS-Truth In Savings	CLS-Adjustable Rate Mortgage
CLS-Funds Availability	CLS-Home Equity
CLS-Electronic Funds Transfer

An additional module, CLS-Privacy, can be licensed with either the Deposit or Lending group, or it can be purchased separately. It can be licensed to create:

• Initial Privacy Disclosures (presented at account opening)

• Annual Privacy Disclosures (mailed to an institution’s customers once each year)

Compliance Service

The Compliance Service is a web service that provides access to CSi IntelleDoc Solutions™ functionality through a web service interface.

CSi Classic Solutions

An integrated solution suite of dedicated compliance modules based on CSi static document technology.

CSi eDoc

A CSi electronic document that can be viewed on screen or printed. The CSi eDoc libraries includes lending, deposit, and tax-favored account documents.

CSi IntelleDoc Solutions™

An integrated solution suite of dedicated compliance modules delivered as .NET-managed code. It is dedicated to the production of CSi’s document library in both static and dynamic formats.

Custom Document Editor

An application dedicated to the design of custom documents, either based on existing CSi static IntelleDocs or by creating new documents files from scratch, image files, or PDF files.

Data Schema

The logical and physical definition of a database structure. CSi uses a single data schema for Deposit, IRA, Consumer Lending, and Mortgage transactions. In the CSi Data Schema, XML is used to create a single data set, based on a single standard, to define all transactions across multiple channels of customer contact.

data type

The type of data acceptable as entry for a given datapoint, such as dollar, percentage, alpha, numeric, etc. If the correct data type is not entered, the eDoc cannot render or renders with an error message. Data type can also be used with logic triggers to call for additional information before the eDoc is rendered.

data_conditional

A datapoint usage type designating a datapoint that may be required, depending on the values supplied for one or more other datapoints. If the datapoint is required and not supplied, the Compliance Engine displays and prints the document with the warning message Form must be completed at the top.

data_required

A datapoint usage type designating a datapoint as required in order for the document to be legally compliant. If such a datapoint is not supplied, the Compliance Engine displays and prints the document with the warning message Form must be completed at the top.

datafield

The location on an eDoc form for the variable data associated with a datapoint. There can be many datafields associated with a single datapoint.

datapoint

A CSi variable data placeholder used to populate a document with transaction-specific information. Datapoints may have an associated data type for data validation. Datapoint names are not case sensitive.

datapoint usage type

The use of dynamic datapoints is indicated by one of the following: structural_required; structural_conditional; structural_optional; data_required; data_conditional; and optional. A structural_required or structural_conditional datapoint is generally part of a logic question that drives document creation.

Document Selection Logic or DSL

A software tool that selects the documents required for a given financial transaction type and produces a list of documents that CSi warrants as accurate. The list is the minimum set of documents necessary, including the quantity of each document, for a compliant transaction based on state and federal laws as well as industry standards. DSL products include:

• DSL for Classic Lending
• DSL for Dynamic Lending
• DSL for Dynamic Deposits and TFA

DSL

Part of the CSi Data Schema, DSL is the schema data group that contains data used to select documents appropriate to a given transaction. DSL stands for document selection logic and it is CSi’s Document Selection Logic product that produces the warranted list of necessary documents as a DSL summary session.

DXL

An eDoc data file. An XML file that contains data values along with the associated layout directives for values that are displayed. It is used to aid processing of FXL files. It is equivalent to a DAT file.

Dynamic eDoc

A CSi document that requires variable data to define the usage of the form, to render it with proper language, and to populate the variable fields.

Dynamic eDocs

This product line refers to a library of documents consisting of dynamic and some static documents. The documents are assembled based on customer and transaction-specific data creating a customized document with fully integrated compliance logic and knowledge.

eDoc Advisor

A CSi application used to map, view, and test a dynamic eDoc using a DAT session and applicable FAO files.

eDoc Library

CSi’s collection of eDocs, categorized by Lending, Deposit, and Compliance Logic System.

Mortgage	Consumer/ Commercial Lending	Deposit	Compliance Logic System	Tax Favored Accounts
Conventional Lending	Consumer	Savings	HELOC Disclosure	IRA/ESA
Government Lending	Real Estate	CDs	HELOC Agreement	Traditional/SEP IRA
Home Equity Lending	Construction	Money Market	ARM Early Disclosure	Roth IRA
Construction Lending	Credit Line	Checking	Funds Availability	Simple IRA
Private Investor Documents	Home Equity	NOW	Truth in Savings	Coverdell ESA
Broker Documents	Commercial	Safe Deposit Box	Electronic Funds Transfer	Health Savings Accounts (HSA)
State Disclosures	Agricultural	Privacy

eDoc Utilities

A CSi software suite preceding CSi IntelleDoc Solutions™. It was dedicated to the production of CSi’s document library in both static and dynamic formats. It was written in C++ and delivered as OCX and COM+ objects.

Entities

Part of the CSi Data Schema, Entities is the schema data group that contains any real business, individual, association, trust, or governmental body related to a transaction.

FAO

The file extension used by eDoc files. These files store the form with its datapoint dictionary, validation, and help information. It is deprecated in the CSi IntelleDoc Solutions™ and replaced with FXL.

fat-client

In client/server architecture, a fat-client machine performs most or all of the processing, with little or none performed by the server. The client handles presentation and functions, and the server manages data and access to it.

Financial Calculator Logic (FCL)

A CSi component that performs financial calculations of annual percentage rate (APR) and annual percentage yield (APY).

fixed text overlay

An overlay field that holds static text labels. They may also hold variable datapoints inserted as part of the field text data.

FXL

An eDoc file. It is an XML file that contains coded file information as well as metadata about its form and contents. It is equivalent to an FAO file.

FxlCreate

A utility used to create FXL files. FxlCreate is used for documents in other source formats such as graphic image files. Many banks use WMF documents, for example.

FxlModify

A utility and .NET class object that modifies custom FXL files without using Custom Document Editor. A license key determines what documents customers can modify. Customers cannot modify CSI stock documents.

FxlRender

A utility used to render FXL files as printed output or as a PDF. FxlRender creates these files without using Compliance Engine.

ID

Part of the CSi data schema, an ID is the unique identifier used to establish the relationship of an entity with other transaction components.

image overlay field

An overlay field that holds an image specified as the datapoint for the field.

in-play datapoints

A datapoint that is required in order for a document to be considered complete. As data is supplied to a document to satisfy initial datapoints and its form logic is executed, additional datapoints may be required for the form to render or be considered complete. The in-play datapoints for a given document may thus evolve as the document is being completed.

IntelleDoc

A dynamic document supporting financial transactions that is assembled based on transaction-specific information.

IntelleDoc Advisor

IntelleDoc Advisor is an application used to modify data values in order to assess changes in document rendering. It supports .NET CSi IntelleDoc Solutions file formats.

IntelleDoc Visualizer

IntelleDoc Visualizer is an application used to validate the content of CSi TXL data files structured on the CSi Data Schema. It allows transaction data in a TXL file to be checked against a schema file, flagging data that does not comply with parameters of the schema so that it may be corrected.

Job Ticket

An object that packages all information related to the document request for the Transaction Manager, including the transaction data, preferences information defining document setup, and custom overlay information.

leaf node

Within the CSi Data Schema, a leaf node is a termination in the schema branching structure and contains no additional branches. Leaf node names comprised of multiple words are presented using the CamelCase naming convention so those words are joined together as a single word with the first letter of each component word capitalized, as in NumberOfRequiredSigners.

mergable text overlay

An overlay field that can hold any single datapoint.

MXL

A file format used by script files. MXL uses XML to store script information that manipulates and maps datapoint values before applying them to a customized form. These scripts are created or modified in Custom Document Editor. This scripting information is executed by the host.

natural person

A natural person is a human being, as opposed to a corporation, partnership, organization, trust, partnership, etc., which are also referred to as persons under state and federal law.

optional

A datapoint usage type that designates a datapoint that is not required. If a value is supplied, the Compliance Engine includes this value in the document. If no value is supplied, the Compliance Engine displays and prints the document with no warning or error messages.

overlay field

A field used to add additional elements to an existing CSi eDoc or to a custom document.

OXL

The file format used by overlay files, which store overlay information for the document as XML.

PDF

An acronym for Portable Document Format, a file format developed by Adobe Systems that captures the text, graphics, and formatting of a file so that it may be viewed and printed correctly without the original authoring software. Adobe Reader is distributed by Adobe Systems as freeware to display or print PDF files.

pel

A pel is a unit of measure that CSi defines as 1,000th of an inch.

primary overlay

An overlay field used as the standard for controlling the properties and layout of other overlay fields.

realized datapoint name

A realized datapoint name is one that has been populated with suffix data values (for datapoints with suffixes), as opposed to the generic “.i” suffix placeholder value.

Regulation CC

Regulation CC is the Funds Availability regulation. It governs the disclosure of an institution’s funds availability policy and the establishment of timetables for the processing of deposits to accounts subject to the regulation.

Regulation DD

Regulation DD is the Truth in Savings regulation. It governs the disclosure of deposit account

Regulatory

Part of the CSi Data Schema, Regulatory is the schema data group that contains data related to the fulfillment of state and federal disclosures and requirements.

Roles

Part of the CSi Data Schema, Roles refer to the function that the data element serves in the transaction.

secondary overlay

An overlay field that derives its properties and layout on the document from a primary overlay.

SOAP

An acronym for Simple Object Access Protocol, SOAP is a protocol for exchanging XML-based messages over computer networks, normally using HTTP/HTTPS.

Static 2

Nickname for the Classic documents used in the dynamic product line that have dynamic datapoints rather than Classic datapoints embedded in the document. Examples are state titling documents and UCC documents.

Static eDoc

A CSi document with fixed text.

structural_conditional

A datapoint usage type designating a datapoint as potentially required, depending on the values supplied for one or more other datapoints. If the datapoint is required and not supplied, the Compliance Engine displays a black screen with an error message.

structural_optional

A datapoint usage type designating a datapoint that is not required for a document to be considered complete, but affecting the structure of the document if values are supplied to it.

structural_required

A datapoint usage type designating a datapoint as required to render the document. If such a datapoint is not supplied, the Compliance Engine displays a black screen with an error message.

suffixing

A datapoint style that allows a single datapoint name to reference multiple values. It continues to render as long as data is sent to it. For example, if eight signatures are required on a document, a suffixed signature datapoint renders eight times so that all eight signers are listed on the document.

tab order

The order in which datafields are accessed when pressing the TAB key.

TermsAndProvisions

Part of the CSi Data Schema, TermsAndProvisions is the schema data group that contains the data describing the institution’s product and policies regarding the transaction.

TFA

Tax Favored Accounts. CSi’s TFA library includes documents for both IRA/ESA and HSA, which can be licensed separately.

thin-client

A software layer of a small client for a centrally managed network terminal. A thin client allows the user access to server-hosted applications and data.

Transaction Manager

The Transaction Manager is a component within the Transaction Manager Suite. It assigns job IDs to Job Tickets brought by the Transaction Runner and selects a server URI for job processing based on a load-balancing algorithm.

Transaction Runner

The Transaction Runner is a transaction support system and serves as a means for managing document processing requests from client applications with CSi IntelleDoc Solutions™ technology. The Transaction Runner receives data for a given transaction from client applications, then processes the data into document selection and document rendering for those client applications.

Transaction Server

The Transaction Server is a .NET assembly that processes Job Ticket data into document selection and document rendering for the client applications. It translates input data into multiple Compliance Engine transactions, if necessary, and executes the Compliance Engine. The Transaction Server also reports job status and performance information to the Transaction Manager.

TXL

An XML data file based on the CSi Data Schema containing all of the transaction data necessary to document a given transaction.

Underwriting

Part of the CSi Data Schema, Underwriting is the schema data group that contains decisioning information used to open an account or extend credit. In the case of Deposit and IRA business lines, underwriting includes data elements used to determine account eligibility. In the case of Consumer Lending, Commercial Lending, and Mortgage business lines, underwriting includes data elements used to evaluate risk and determine credit eligibility.

unrealized datapoint

An unrealized datapoint is one that is not yet populated with suffix data values (for datapoints with suffixes), and uses the generic “.i” suffix placeholder value.

VFI

File format output as part of CSi’s JetForm process for creating static documents. It contains data field names, locations, and other relevant information for a single document page.

WSDL

An acronym for Web Services Description Language, an XML-based language that provides a model with which to describe web services.

XHTML

Extensible HyperText Markup Language. This is a reformulation of HTML to conform with the rules of XML.

XML

An acronym for eXtensible Markup Language, a subset of Standard Generalized Markup Language (SGML), XML is a meta-language that allows customized structures and syntaxes of individual markup languages that manage information.

z-order

The order in which objects are drawn on top of one another onscreen to simulate depth (the third dimension) in conjunction with the x and y (height and width) coordinates.