IntelleDoc Advisor User Guide

About IntelleDoc Advisor

IntelleDoc Advisor is an application used to modify data values in order to assess changes in document rendering. It supports CSi IntelleDoc Solutions DXL and FXL file formats. IntelleDoc Advisor provides a convenient environment for viewing datapoint information as it will appear on documents, allowing accurate evaluations to be made regarding structure of both documents and data files.

Getting Started

IntelleDoc Advisor is added to the Start menu upon its installation. Depending on your version of Windows, it may be started by:

• Clicking Start > All Programs > Compliance Systems > CSi IntelleDoc Solutions Software 7.00.0> IntelleDoc Advisor. By default, the application is installed in C:\Program Files\Compliance Systems\CSi IntelleDoc Solutions Software v7.00.0\advisor.

• Clicking on the Windows icon > All Apps> Compliance Systems, Inc> Advisor.

To exit IntelleDoc Advisor, click File > Exit.

Starting IntelleDoc Advisor from the Command Prompt

IntelleDoc Advisor may be launched from the command prompt. This allows the application to be shell-executed and opened with specific DXL and FXL files.

Starting IntelleDoc Advisor 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 advisor.exe [filename.dxl | filename.fxl] where filename are the names of the DXL and FXL files to be opened in IntelleDoc Advisor.

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 DXL and FXL File Extensions

Upon startup, IntelleDoc Advisor checks the system registry for the DXL and TXL file extensions. If they are not already registered to IntelleDoc Advisor, a prompt appears to allow the extensions to be registered to IntelleDoc Advisor.

Licensing IntelleDoc Advisor

In order to access the functionality of Intell*eDo*c Advisor, it is necessary to enter a valid license key.

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.

3. Click Save in the Options dialog box.

Navigating the IntelleDoc Advisor Environment

IntelleDoc Advisor organizes document information in a collection of work windows. All work windows can be docked near the top of the screen or manually positioned and resized.

Data Window

The Data window displays the datapoint information loaded from the selected data file and is displayed automatically when a data file is opened. This information is used to populate the datapoint fields in the selected document. However, it is not necessary for a document to be opened in order for a data file to be opened and its data values modified.

An asterisk displayed in the Data window’s title bar indicates that data has changed since the data file was opened or last saved.

You can sort datapoint information on the Data Values and Datapoints tabs by clicking on column headers. A sorted column is highlighted yellow.

Sorting the Data Values tab window based on Usage.

Data Values Tab

The Data Values tab of the Data window lists the data values from the current data file. By default, the datapoint names are listed in alphabetical order.

Column	Description
Datapoint Name	Lists the CSi name of the datapoint.
Datapoint Value	Lists the value associated with the datapoint. The value may be modified in the Data window or in the Document window.
Status	Indicates the current state of the datapoint in the document. When the status is superfluous, the datapoint information is shaded blue in the Data window. A superfluous datapoint is one that is not in play for the current transaction values. When the status is missing, the datapoint information is shaded pink. A missing datapoint is one that is required, but has not yet been given a value. When the status is invalid, the datapoint information is shaded red. An invalid datapoint is one that does not satisfy criteria for length or format, or has not passed validation. When the status is inplay, no shading is applied to datapoint information. An inplay datapoint is one that is required in order for the document to be considered complete.
Usage	Indicates the level at which the datapoint is required for the document to be rendered or otherwise affects the structure or content of the document. See Datapoint Usage Types for more information.
Locked	Indicates if the datapoint is protected from modification. When the datapoint is locked, its value is read-only on the open document.
Foreground	Indicates the text color used to display the data value. This color is visible only when the Document window is in Preview mode.
Background	Indicates the color of the field behind the data value text. This color is visible only when the Document window is in Preview mode.
Blank Width	Indicates the width of the datafield when no data value has been entered and when blank fields are enabled.
Alignment	Indicates the alignment of data value text in blank or empty datafields. This is valid for static documents only.
Empty Value	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.

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

Filtering Data

Datapoints in the Data window may be filtered based on the datapoint name or the datapoint value. The Filter text box at the bottom of the window is used to define the filter criteria. For example, entering “state” in the Filter text box limits the display of datapoints with “state” as part of the datapoint name or data value.

To remove the filter and list all datapoints, delete the filter criteria from the Filter text box or click the Delete button.

Data Values Tab Context Menu Commands

The Data Values tab of the Data window includes context menus that provide convenient access to frequently used commands affecting datapoints and their values.

Datapoint Name

Right-clicking on a datapoint name displays a context menu with commands pertaining to adding and removing data values.

Command	Description
Add Value	Adds a new individual data value to the Data window.
Add Suffixed Value	Adds a new suffixed data value to the Data window.
Edit Value	Places the data value in an edit state so that it may be modified.
Remove Value	Removes the selected data value from the Data window.

Value

Right-clicking on a datapoint value can display a context menu with commands affecting the value assigned to a datapoint.

Command	Description
Undo	Not available in this release.
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 text.

Datapoints Tab

The Datapoints tab of the Data window lists all datapoints in the FXL file. The datapoint names are listed in alphabetical order.

Column	Description
Datapoint Name	Lists the CSi name of the datapoint.
Usage	Indicates the usage type for the datapoint. See Datapoint Usage Types[]{#H_9690 .anchor} (on page 52) for more information.
Format	Indicates the CSi format for representing data values. This controls the manner in which numerical entries are formatted. See Datapoint Formats[]{#H_9772 .anchor} (on page 53) for more information.
Default Value	Indicates a predefined datapoint value that is applied in the document when the user does not input a value. Default values, when available, are embedded in the FXL document file.
Blankable	Indicates that the datapoint is approved to have the data value manually entered after the document is printed.
Calculate Only	Indicates that the value of datapoint is derived from calculations rather than user data entry.
Short Description	Provides a brief description of the datapoint.
Long Description	Provides a more detailed description of the datapoint.

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.

Datapoints Tab Context Menu Commands

The Datapoints tab of the Data window includes a context menu that provides convenient access to the Add Value command.

Command	Description
Add Value	Adds a new individual data value to the Data window.

Tree View Tab

The Tree View tab of the Data window arranges all datapoints in the FXL file in an alphabetical, hierarchical structure with suffixed datapoints appearing as sub-branches within the hierarchy.

Data File List

The Data File List allows a directory to be specified from which datapoint files may be more conveniently opened. This list may be docked at the bottom of the application window or it may be manually positioned.

Specifying document file directories:

1. If necessary, display the Data File List window by clicking View > Data File List. It is docked to the bottom of the application window by default, but can be manually moved and closed.

2. Click the Browse button in the Data File List.

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

4. Click OK. The directory is noted at the top of the Data File List and the document files within that directory are listed.

Selecting files from the Data File List:

1. Click on the data file to be used to populate data in the current document.

2. The document name appears bold in the Data File List when open.

If the maximum number of data files is open, you are prompted to close the most recently opened data file before the new document is opened from the Data File List.

Document Window

The Document window displays the current document that is being viewed. The document name and file path appear in the window title bar. The document text is displayed in the window along with highlighted areas denoting data fields where data values may be modified.

The status bar of the Document window notes the name the FXL file. If the FXL is associated with OXL and MXL files, those names are displayed as well.

Understanding IntelleDocs

CSi technology creates different types of electronic documents that can be viewed on screen and printed.

Static documents are constructed using blocks of static text that flow around transaction-specific data values that are entered into the document’s datapoints. The layout and content of these documents does not change based on data input. Even when no data values are supplied, it is possible to view the entire document on screen.

The layout and content of dynamic IntelleDocs varies based on the data values that are provided. Blocks of content may be included or excluded based on the values that are supplied to the datapoints.

Because dynamic IntelleDocs assemble depending on the transaction data that is supplied to the document, opening an IntelleDoc document file (FXL) without basic structural data does not allow the document to be displayed. Instead, any error messages associated with the failure to display the IntelleDoc are listed in the Document window. The error messages describe the missing datapoint values that are necessary for the document to be assembled. See Datapoint Usage Types for more information regarding structural data.

Paging Documents

Paging controls at the bottom of the Document window allow paging through document content.

	Moves to the previous page.
	Moves to the next page.
	Moves to the first page.
	Moves to the last page.

Zooming the Document View

Zoom controls at the bottom of the Document window adjust the zoom level of displayed content.

Actual Size	Adjusts zoom level so that the page displays its full vertical length.
Fit Page	Adjusts zoom level so that the entire page is displayed.
Fit Width	Adjusts zoom level so that the page displays its full horizontal width.
Fit Height	Adjusts the zoom level so that the page displays its full vertical height.
25%	Displays window contents at 25% magnification.
50%	Displays window contents at 50% magnification.
75%	Displays window contents at 75% magnification.
100%	Displays window contents at 100% magnification.
150%	Displays window contents at 150% magnification.
200%	Displays window contents at 200% magnification.
400%	Displays window contents at 400% magnification.

The effect of zooming varies depending on the image resolution set on the Document Options tab of the Tools > Options dialog box. The higher the image resolution, the clearer the document detail appears at higher zoom levels. However, higher image resolution settings result in slower IntelleDoc Advisor performance. See Document Options[]{#H_9779 .anchor} (on page 27) for more information regarding image resolution.

Document File List

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

Specifying document file directories:

1. If necessary, display the Document File List window by clicking View > Document File List. It is docked to the bottom of the application window by default, but can be manually moved and closed.

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

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

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

Selecting files from the Document File List:

1. Click on the document file to be displayed in the Document window.

1. The document name appears bold in the Document File List when open.

If the maximum number of documents is open, you are prompted to close the most recently opened document before the new document is opened from the Document File List.

Events Window

The Events window displays event information generated by document rendering in IntelleDoc Advisor. Click View > Events List to display it.

Options in the Events window specify which IntelleDoc Advisor events are captured in the events list.

Event	Description
Document Rendered	Registers the rendering of documents.
Document Requires Rendering Event	Registers an event when the document requires rendering and auto-rendering is disabled.
Error Events	Registers an event when errors are generated.
Page Focus Events	Registers an event when paging controls in the Document window are used to display a different page.
Data Field Focus Events	Registers an event when the cursor moves between datafields.
Data Field Changed Event	Registers an event when there is a change of datafield values.
Data Field Warning Event	Registers an event when warnings are generated for datafields.
Data Field Invalid Event	Registers an event when an invalid datafield is applied.
Logging Level	Specifies the logging level of information written to the log file necessary to register an event. Options include All, Debug, Info, Warning, Error, Fatal, and Off.
Clear	Removes all information from the events list.
Save As	Saves the log file in the specified directory.

Arranging Windows

There are five windows that may be displayed in the application. All are docked at the top or bottom of the screen by default, and all can be dragged to different locations.

1- Document window,
2 - Data window,
3 - Documents List window,
4 - Data List window.
5 - Events window

To drag a window from its docked location, position your mouse cursor over the window’s title bar, then click and drag the window to undock it. You can then position it elsewhere as a free-standing window. To dock the window again, double-click on the window’s title bar.

All windows can be undocked.

Application Toolbar

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

Tool	Description
	Creates a new blank data file.
	Saves the current data file.
	Displays page setup parameters for either the Document window or the Data window, depending on which window is active when the tool is selected.
	Displays the contents of the Data window as they will be printed. The content displayed is dependent on which tab of the Data window is active when the tool is selected.
	Prints the contents of the Data window or the Document window. The content printed is dependent on which window is active when the tool is selected and, in the case of the Data window, which tab is active when the tool is selected.
	Displays the Properties dialog box for the Document window.
	Displays the Options dialog box.
	Displays the online help for IntelleDoc Advisor.

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

Managing the IntelleDoc Advisor Environment

The Tools > Options command and the Options tool provide access to various application default 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 Advisor 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.
Most recently used data	Specifies the number of recently used data files listed at the bottom of the File menu.
Maximum number of open documents	Specifies how many document files may be opened at once. This feature is not available in this release.
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 Advisor as the warning trigger events occur.
Launch Adobe Acrobat after exporting PDF	Determines if Adobe Acrobat is opened to display the exported PDF file created with the File > Export > PDF command.
Launch default browser after exporting XHTML	Determines if the default system browser is opened to display the exported XHTML file created with the File > Export > XHTML command.

Filepath Options

The Filepaths tab of the Options dialog box includes parameters to set default file paths.

Option	Description
Document	Specifies the default file path used to access document files. Type in a file both or click the Browse button to locate it. Navigate to the necessary directory, then click OK.
Data	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.
TRID Installation Path	Specifies the default file path used to convert a TRID MISMO XML document into the DXL file format. Type in a file path or click the Browse button to locate it. Navigate to the necessary directory, then click OK.

The file paths for document files and data files may also be set in the Document File List window and the Data File List window.

Document Options

The Document Options tab of the Options dialog box determine certain display parameters within the Document window, including the display of a text-based watermark on the pages of the document. The watermark is displayed both in the Document window and the printed pages of the document.

These options affect all open documents immediately after the settings are saved.

Option	Description
Highlight Color - Data	The color of datafields. Different colors may be set for fields that may be modified (read/write) and fields that are read only.
Highlight Color - Invalid Data	The color of invalid datafields. An invalid datafield is one that is populated with data from a DXL file that is not appropriate for its datapoint.
Highlight Color - Null (empty)	The background color in null datafields. A null datafield is one that is empty. Different colors may be set for null datafields that may be modified (read/write) and fields that are read only.
Watermark Text	This edit box allows entry of watermark text.
Watermark Font	Reports the name of the selected font and the point size for watermark text. To modify the selection, click the button and select the font and size to be used.
Watermark Color	Sets the color of the watermark text. To modify the selection, click the color button to display a color palette from which a new color may be selected.
Watermark Placement	Sets the position of the watermark text on the page. Options are Top, Bottom, Middle, TopBottomMiddle, DiagonalDown,and DiagonalUp.
Watermark Opacity	Sets the percentage of opacity used to display the watermark. 100% is completely opaque.
Empty Data Values	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.

Document Defaults

The Document Defaults tab of the Options dialog box includes parameters to control the default behavior of documents when a Document window is opened.

Option	Description
Preview	Determines if Preview mode is the default mode for viewing the contents of the Document window. In Preview mode, data entry is not allowed and document contents are displayed as they will output as print or PDF. When this option is disabled, the contents of the Document window are displayed in Data Entry mode by default. In Data Entry mode, datapoint values may be modified and the document is displayed in a manner to maximize editing. It does not appear as it will output as print or PDF. For more information, see Previewing Documents[]{#H_10242 .anchor} (on page 57).
Blank Fields	Controls the shading style applied to displayed blank fields. Available selections include an underline style or a gray shading of 10-90%. The off option disables blank fields so that they are not displayed in the Document window.
Zoom	Sets the default zoom level for the Document window.
Shrink-to-Fit	Shrink-to-fit 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, set the value to 0 (zero).
Truncation	Truncates text to fit in a datafield when the size of a datafield does not allow all text characters to be displayed.

Data Values Options

The Data Values tab of the Options dialog box includes parameters to control the appearance of datapoints on the Data Values tab of the Data window.

Option	Description
Automatically add missing data values	When active, this option automatically adds the structural datapoints to the Data window that are necessary to render dynamic documents.
Highlight Colors Missing	The color of datapoints that are missing a value.
Highlight Colors Invalid	The color of datapoints that contain an invalid value.
Highlight Colors Superfluous	The color of datapoints that are superfluous.
Highlight Colors Blank	The color of datapoints that are blank.

To modify the selection of any color, click the color button to display a color palette from which a new color may be selected.

Helpers Options

IntelleDoc Advisor allows a supplemental CSi application to be specified to assist in the conversion of data from an older CSi format to the current format. In order for this helper application to perform data conversions, its file path must be specified. Options for specifying this path are accessed by clicking Tools > Options or the Options tool and viewing the Helpers tab.

Most of the helper applications are internal CSi tools that are available only to CSi.

Option	Description
Fao2Fxl	Specifies the file path used to access Fao2Fxl. This application converts an FAO document file to FXL format when the FAO file is opened in IntelleDoc Advisor. Type in a file path or click the Browse button []{#O_7909 .anchor} to locate it. Navigate to the necessary directory and select the file Fao2Fxl.exe, then click Open.
Use Fao2Fxl in database mode…	Determines if the Blank.Bel and Mapping file specified in the Options dialog box are used when converting files from FAO to FXL format.
Blank.bel	Specifies the file path used to access the Blank.BEL file used by Fao2Fxl to convert FAO files into the FXL format. Blank.BEL is a file that lists datapoints that are allowed to be blank in the document and its information is embedded into the FXL file.
Mapping File	Specifies the file path used to access mapping file used by Fao2Fxl to convert FAO files into the FXL format. A mapping file defines the schema mapping paths for all datapoints.
Calculation Engine Path	For partners integrated with the Sherman Calculation Engine, this specifies the file path used to access that calculation engine.

Working with Data

DXL data files may be opened or created in IntelleDoc Advisor.

Creating New Data Files

Creating new data files:

1. Click File > New or click the New tool.

1. A new blank data list is opened in the Data window. If a document is open, structural_required and data_required datapoints are listed.

2. Enter values for datapoints or add new datapoints as necessary.

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

Opening Data Files

Opening data files:

1. Click File > Open > Data.

2. Navigate to the drive and folder containing the DXL 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.

Documents may also be opened from the Data File List.

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

Modifying Data Values

Data values may be modified for datapoints that are read-write. Data may be entered into datafields in the Document window, or it may be entered in the Data window.

When a data value is selected in the Data window, its corresponding datafield is automatically selected in the Document window. Conversely, when the cursor is placed in a datafield in the Document window, its corresponding data value is automatically selected in the Data window so that relationships between datafields and their values are clarified during the data entry process.

Modifying Values in the Document Window

Modifying data values in the Document window:

1. If necessary, view the page on which the datapoint appears.

2. Click to position the cursor in the datafield to be modified, or double-click to select the entire datafield to be modified. In both cases, the datapoint becomes selected in the Data window.

3. Modify the data value in the Document window as necessary. When a value is selected, any text entry will replace the selected value. The left and right arrow keys on the keyboard move the cursor within the datafield. The DELETE key removes text to the right of the cursor. The BACKSPACE key removes text to the left of the cursor. Data modifications made in the Document window are automatically updated in the Data window.

4. To modify the next datafield in sequence, press the TAB key. The next data value is selected.
   OR
   To modify the previous datafield in sequence, press SHIFT-TAB. The previous data value is selected.

5. When finished modifying values, select another tool or window.

The default color of read-write datafields in the Document window may be changed in the Options dialog box.

When a datafield is selected in the Document window, the corresponding data value, if it exists, is selected in the Data window.

Document Window Context Menu Commands

The Document window includes a context menu that provides convenient access to frequently used commands affecting data values.

Command	Description
Undo	Reverses the last data value edit that was made. If Undo has been used, selecting this command again reverses the affect of Undo.
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 text in the datafield.

The Edit > Undo command also reverses the last data value edit made in the Document window.

Modifying Values in the Data Window

Modifying data values in the Data window:

1. Locate the datapoint in the Data Values tab of the Data window.

2. Click on the data value in the Value column to select it. The entire value is highlighted.

3. Type to replace the highlighted entry, or use the left and right arrow keys on the keyboard to position the cursor in the data value. The DELETE key removes text to the right of the cursor. The BACKSPACE key removes text to the left of the cursor. Data modifications made in the Data window are automatically updated in the Document window.

The Edit > Select All command, or CTRL-A, selects the entire value of the datafield that holds the cursor. This is true both in the Document window and the Data window.

Selecting a data value in the Data window also selects the corresponding datafield in the Document window. If the datafield appears on a different page, the Document window will adjust the view to that page.

Modifying data values with Edit Data Value:

1. Locate the datapoint in the Data Values tab of the Data window.

2. Double-click on the datapoint name with the value to be modified. The Edit Data Value dialog box appears.

3. Modify the value as necessary, then click Change.

Adding Values

Data values may be added to the list of datapoints. Individual data values may be added from the Data window, or all unspecified and unsuffixed data values may be added at once using the Data menu.

If a datapoint may be suffixed, its suffix value is automatically appended by IntelleDoc Advisor based on the next available suffix level for that datapoint.

Adding All Optional Data Values

When adding all optional data values, it is possible to control the inclusion of unspecified and unsuffixed structural_optional values.

Option	Description
Include unspecified and unsuffixed structural-optional data values	An unspecified datapoint is one that that is not yet populated with suffix data values. An unsuffixed datapoint is one that contains only a single value. Structural_optional refers to a datapoint that is not required for a document to be considered complete, but affects the structure of the document when values are supplied to it.
Include default data values (if available)	When default data values are included with the FXL file, those values are used.
Set data values to datapoint names	Assigns data values that match the datapoint name.

Adding all optional data values:

1. If necessary, select the Data window.

2. Click Data > Add Optional Data Values. (If the Data window is not active, this menu command is unavailable.)

3. A confirmation dialog box appears with options regarding the addition of data values. It is possible to include all unspecified and unsuffixed data values that are structural optional as well as to include all default data values.

4. Select the appropriate options, then click Add.

Adding Individual Data Values

When adding individual data values, a selection may be made from all datapoints listed in the Data window. If a datapoint may be suffixed, its suffix value is automatically appended based on the next available suffix level for that datapoint.

1. Datapoint drop-down list 2. Suffix level 3. Data value edit box, drop-down list, or check box 4. Indicates the CSi format for the data entry, if one has been specified 5. A short description of the datapoint value.

To facilitate data entry, the value for the datapoint may be indicated with text entry in an edit box, selection of a value from a drop-down list, or with a check box.

Data values presented as a drop-down list.

Data values presented as a check box.

Adding individual data values:

1. If necessary, select the Data window.

2. Click Data > Add Data Value. (If the Data window is not active, this menu command is unavailable.)
   OR
   View the Data Values tab or the Datapoints tab of the Data window and right-click in the Datapoint Name column. Select Add Value from the context that appears.

3. Select a datapoint from the datapoint drop-down list. If the datapoint is suffixed, its suffix level is indicated next to the datapoint name.

4. Specify a data value below the datapoint name, then click Add.

Adding Suffixed Values

A suffixed datapoint value can be quickly added to the datapoint list using the context menu in the Data window. The datapoint’s suffix value is automatically appended based on the next available suffix level for that datapoint.

Adding suffixed values:

1. If necessary, select the Data window.

2. View the Data Values tab of the Data window and right-click in the Datapoint Name column. Select Add Suffixed Value from the context that appears.

3. The datapoint’s name and suffix level are indicated in the Add Data Value dialog box. Enter a data value in the edit box below the datapoint name, then click Add.

1. Datapoint drop-down list
2. Suffix level
3. Data value edit box

1. Enter a data value in the edit box below the datapoint name then click Add.

Removing Values

Data values may be removed from the list of datapoints. Individual data values may be removed from the Data window, or all superfluous and blank data values may be removed at once using the Data menu.

Removing Individual Values

Removing individual values:

1. If necessary, select the Data window.

2. Select the datapoint to be removed , then click Data > Remove Data Value. (If the Data window is not active, this menu command is unavailable.)
   OR
   View the Data Values tab of the Data window and right-click in the datapoint to be removed from the Datapoint Name column. Select Remove Value from the context menu that appears.

3. Click Yes in the confirmation dialog box to delete the datapoint.

Removing Superfluous and Blank Values

The Data > Clean Data Values command removes data values listed from the active DXL data file that are either superfluous for the current document or blank. Such datapoints do not affect a document’s ability to render.

A superfluous data value is one that is not in play for the current transaction values. A blank data value is one that is empty.

Removing superfluous and blank values:

1. If necessary, select the Data window.

2. Click Data > Clean Data Values. (If the Data window is not active, this menu command is unavailable.)

3. Click Clean in the confirmation dialog box to confirm that superfluous values are to be removed. To also remove blank data values, select the Remove Blank Data Values check box before clicking Clean.

If changes to the data file are saved, the file will lose these data values. Data values that superfluous for the current document may not be superfluous for other documents against which the data file may be applied. Exercise caution when saving such changes to the data file.

Removing All Values

The Data > Clear Data Values command removes all data values listed from the active DXL data file. If datapoints are cleared that are required to render the document (structural_required or structural_conditional), the document in the Document window will cease to render and error messages describing the missing datapoints will appear instead.

Removing all values:

1. If necessary, select the Data window.

2. Click Data > Clear Data Values. (If the Data window is not active, this menu command is unavailable.)

3. Click Yes in the confirmation dialog box to confirm that all data values are to be removed.

If changes to the data file are saved, the file will lose its data values.

Cutting and Copying Data Values

Data values 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 menus available in the Document window and Data window.

Context menus for the Document window and Data window

• 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 Document window.

To cut, copy, and paste text from datafields in the Document window and Data window, use the keyboard shortcuts CTRL-X (cut), CTRL-C (copy), and CTRL-V (paste).

Finding and Replacing Data Values

IntelleDoc Advisor includes find and replace features to help you quickly locate data values or datapoint names in the Document window or the Data window.

Using Find

The Find feature is used to locate a data value or a datapoint name in the Document window or Data window.

Command	Description
Find what	An edit box for entering the text to be located.
Find Next	Locates the next instance of the Find text.
Match whole word only	Locates only those instances of the Find text that constitute a complete word. For example, the Find text data will only locate data, not datapoint.
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.
Direction Up	Searches the window from the location of the cursor up to the top of the window.
Direction Down	Searches the window from the location of the cursor down to the bottom of the window.

Using Find:

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

2. Click Edit > Find & 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 Cancel when done.

Using Replace

The Replace feature is used to replace a specified data value or a datapoint name in the Document window or 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 in the window. Match whole word only | Locates only those instances of the Find text that constitute a complete word. For example, the Find text data will only locate data, not datapoint. 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. Find Next | Locates the next instance of the Find 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.

Using Replace:

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

2. Click Edit > Find & Replace > Replace.

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 Cancel when done.

Saving Data Files

Data values loaded from DXL files appear in the Data window. Changes made to read-write datapoints can be saved either in the same DXL file or in a new DXL file.

To update the existing DXL file, make sure that the Data window is selected and click File > Save. To save changes in a new DXL 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 or enter a new file name to preserve existing files.

Working with Documents

Both FXL and FAO document files may be opened in IntelleDoc Advisor. When the helper application Fao2Fxl is specified, FAO files can be converted to FXL format when they are opened.

Only one document may be opened at a time. When an FAO document is opened, it is converted into a temporary FXL file until it is saved by the user. If a second document is opened, IntelleDoc Advisor prompts the user to save the converted FAO document with a user-defined FXL file name.

Opening Documents

Opening documents:

1. Click File > Open > Document.

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

3. Select the file name to be opened. CSi stock documents, both static and dynamic, and custom documents produced by CSi’s Custom Document Editor can be opened. If an FXL file has a corresponding OXL or MXL file associated with it, those files are also loaded. OXL and MXL files are associated with an FXL when a CSi stock document is customized in Custom Document Editor.

Recently-used documents 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 documents listed to be specified. Click Tools > Options to access it.

Documents may also be opened from the Document File List.

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

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

Viewing Document Properties

The Properties window reports information about the current FXL file. It displays data pertaining to the document file and any associated overlay files (OXL files) or script files (MXL files 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:

1. Click the Control tool in the bottom right corner of the Document window.

2. Select Properties from the menu.
   OR
   Click Document > Properties or click the Properties tool

3. When finished, click the Close button to close the Properties window.

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
master	The document is chainable and can be used only as the primary document with slave documents.
slave	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 referenced by a DXL 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

About Mapping Paths

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.

Overlay Information

The Properties window reports overlay information on its Overlays tab. Overlay fields are used to add additional elements to documents. The elements can be text or images. Both static and dynamic CSi documents may have an overlay associated with them. Overlays referenced here are overlays that are embedded and used by the FXL file, not overlays that are referenced by an OXL file. Overlays are embedded in an FXL file when the document is created from scratch in Custom Document Editor.

For more information regarding OXL files and their relationship to FXL files, please see Appendix D - OXL and MXL File Information (”OXL and MXL File Information” on page 56).

Script Information

The Properties window reports script information on its Script tab. This refers to scripts that are embedded in the FXL file, not scripts that are accessed from an accompanying MXL file.

For more information regarding MXL files and their relationship to FXL files, please see OXL and MXL File Information.

Script Type	Description
Manipulation	A single script block containing a series of JavaScript statements that perform manipulation of input data values.
Shared	A script snippet that is not executed as an independent script. Its functions may be used by either data manipulation or data mapping scripts.
Mapping	A script that that contains a list of CSi datapoints and associated scripts that map partner datapoint values to CSi datapoint values. Data mapping scripts can be global or specific to a CSi stock document and assist partner systems when rendering an FXL file with the CSi Compliance Engine.

Ownership Information

When a Deposit FXL document file is loaded, the Ownership tab of the Properties window reports state-specific restrictions for each Deposit ownership type.

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.

OXL and MXL File Information

When new custom documents are created in CSi’s Custom Document Editor as a blank document or from images in image files, overlay field information and script information is saved (embedded) into the FXL file, which also contains information about the datapoints assigned to the overlay fields.

When a CSi stock document is customized, overlay information is saved in a separate OXL file because CSi stock documents are read-only. Script information is saved in an MXL file. This is to preserve the original CSi document in its stock condition and enabling future updates to the document without the loss of its customizations.

![]](MxlAndOxl2.jpg)

The OXL and MXL tabs of the Properties window in IntelleDoc Advisor display information about OXL and MXL files that may be associated with the current FXL document file. They are associated with each other by a common name.

Previewing Documents

The Document window can be viewed in Preview mode or Data Entry mode. Preview mode provides a more accurate display of the document and makes visible the formatting attributes assigned to datapoints. When Preview mode is active, the highlight color set in IntelleDoc Advisor is temporarily hidden and datapoint values cannot be modified by typing in the Document window.

In contrast, Data Entry mode allows datapoint values to be modified. To facilitate data entry, datapoint highlight colors are displayed to make it clear where data entry is allowed. The highlight color also illustrates relative datafield width.

Data Entry mode allows datapoint values to be modified. Datapoint highlight color illustrates where entry is allowed. Preview mode displays the datapoints with their formatting attributes and presents a more accurate visualization of documents, especially dynamic documents.

Viewing document properties:

1. Click the Control tool in the bottom right corner of the Document window.

2. Select Preview from the menu.

3. When finished, click the Control button and select Preview again to return to the Document window to Edit mode.

Managing Overflow Text

The Document window includes options for controlling the display of text that does not fit within the defined size of datafield. These options pertain to static documents.

• Shrink-to-fit 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. The minimum font size that text characters can use can be modified.

• Truncate reduces the number of characters displayed in a datafield when the size of a field does not allow all text characters included in the data value to be displayed.

Managing Shrink-to-fit and Truncate for the current document:

1. Click the Control tool []{#O_10220 .anchor} in the bottom right corner of the Document window.

2. To activate or deactivate truncation, select Truncate from the menu.
   OR
   To modify the minimum font size that text characters can use, enter a font size value. Text shrinks until it fits within the field or until it reaches this minimum size. To disable Shrink-to-Fit for the document, set the value to 0 (zero).

Additional Reading: 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.

Displaying Blank Fields

The Document window includes options for controlling the display of blank fields for the current document. A blank field is a datapoint approved by CSi to have the data value manually entered after the document is printed.

• Blank Fields activates or deactivates the display of blank fields in the Document window.

• Blank Fields Shading controls the shading style applied to displayed blank fields. Available selections include an underline style or a gray shading of 10-90%.

Printing

The contents of the Document window or the Data window may be printed. In the case of the Data window, different output is printed depending on whether the Data Values tab or the Datapoints tab is active when the Print command is used.

Printing:

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

2. Click File > Print or click the Print tool.

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 when printed. The page that is configured with these options may be document pages generated from the Document window or the pages used to list datapoints generated from the Data window.

Page setup options may be set differently for the contents of the Data window and the contents of the Document window. Be sure that the window for which page setup options are to be configured is selected before accessing the Page Setup dialog box.

When used to configure the Document window, Page Setup controls the actual rendering of the document when the document is dynamic. For example, changing the paper size from Letter to Legal may cause a two-page document to render as a one-page document. The display of the dynamic document in the Document window updates based on options selected in Page Setup.

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.

Previewing the Data Window

When the Data window is selected, the File > Print command and Print tool []{#O_10092 .anchor} print the current data values list. The File > Print Preview command and Print Preview tool []{#O_10091 .anchor} provide a preview of this information.

Option	Description
	Outputs the contents of the Data 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.

Exporting

The contents of the Document window may be exported in PDF format, XHTML format, or in the format of common image files. The exported file includes data values specified from the current DXL file. In the case of image file formats, a separate image file is created for each page of the document.

Exporting PDF Files

IntelleDoc Advisor allows the export of both static and fillable PDF files. In the case of static PDF files, the data values are output as static document text that cannot be edited. In the case of fillable PDF files, the datafields are embedded in the static document and their data values may be modified in Adobe Acrobat. You can also specify options related to the use of digital signatures in the PDF.

Exporting a fillable PDF file:

1. Make sure that the Document window is selected, if necessary.

2. Click File > Export > PDF.

3. Enter a directory and file name for the image file, or click the Browse button to navigate to a directory and specify a file name in the Export to PDF dialog box.

4. Select the option Embed Form Fields.

5. If necessary, select options for digital signature fields and the digital signature provider.

6. Click Export.

To view the PDF file immediately after exporting it, select the option Launch Adobe Acrobat after exporting PDF from the General tab of the Tools > Options dialog box.

When form fields are embedded in the PDF file, certain CSi datafield formatting may be replaced by Adobe form field formatting. For example, date formatting may appear differently in Adobe Acrobat than it appears in IntelleDoc Advisor.

PDF Passwords

When a CSi license key is used to access IntelleDoc Advisor functionality, a password feature becomes available in the Export PDF dialog box. This allows CSi users to enter a custom password for accessing PDF documents generated from IntelleDoc Advisor.

Exporting Image Files

IntelleDoc Advisor allows the export of the following image file formats.

BMP	GIF	JPEG
PNG	TIFF

In the case of all image formats, additional options are available to control the quality of the resulting image file. The image format is determined based on the extension that the user gives when entering a file name.

Option	Description
DPI	Determines the number of pixels per inch printed on a page to render the image. Generally, a higher DPI, or dots per inch, results in better image quality and larger file size.
Anti-Aliasing	Determines the method, if any, used to produce anti-aliasing in the image file. Anti-aliasing refers to the process of minimizing the jagged appearance of text characters or graphic areas. Depending on the file format and document content, different anti-aliasing methods may create preferred results.
Text Quality	Determines the method used to produce additional anti-aliasing effects on the document text in the image file.
Bit Depth	Determines the number of bits per pixel used for storing indexed color information in the image file. Generally, a higher bit depth results in better image quality and larger file size.

Image quality is affected by DPI as well as options selected for anti-aliasing and text quality.

Exporting image files:

1. Make sure that the Document window is selected, if necessary.

2. Click File > Export > Image.

3. Enter a directory, file name, and file extension for the image file, or click the Browse button to navigate to a directory and specify a file name and file type in the Export to Image dialog box.

4. Select options for DPI, anti-aliasing, text quality, and bit depth as necessary.

5. Click Export. A hyphen and sequential number are automatically appended to the specified file name to indicate each page of the document.

Exporting XHTML Files

XHTML files may be exported from IntelleDoc Advisor by specifying the path in which the file is to be stored.

Exporting an XHTML file:

1. Make sure that the Document window is selected, if necessary.

2. Click File > Export > Xhtml.

3. Enter a directory and file name for the image file, or click the Browse button to navigate to a directory and specify a file name in the Export to XHTML dialog box.

4. Click Export.

Appendix A - Logging

IntelleDoc Advisor uses an XML text file named advisor.exe.log4net to define the application’s logging behavior. It is stored in the same directory as advisor.exe. By default, this is C:\Program Files\Compliance Systems\CSi IntelleDoc Solutions v7.00.0\advisor. 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.

Appendix B - Features Not Available in This Release

This release includes features that are not yet enabled for use. These features are visible in the application and may be referenced the user guide and online help. They are listed here and will be available in a future release.

Feature	Description
Edit > Undo	This feature does not function in the Data window. It functions in the Document window as described in this document.
Edit > Redo	This feature does not function in the Data window. It functions in the Document window as described in this document.
Tools > Options, General tab, Maximum number of open documents	The release supports the loading of a single FXL file at at time. As a result, this option to control the maximum number of open documents is not enabled.