Custom Document Editor User Guide

About Custom Document Editor

Custom Document Editor is an application dedicated to the creation of custom documents based on existing CSi documents, image files, PDF documents, or blank documents. It offers a rich visual environment for designing financial forms with the sophisticated and unique visual identity required by individual financial institutions. In addition, Custom Document Editor provides convenient access to data dictionaries so that datapoints may be easily assigned to a static document.

Getting Started

Custom Document Editor is added to the Start menu upon its installation. It is started by clicking Start > All Programs > Compliance Systems > CSi Custom Document Editor v7.00.0 > Custom Document Editor. By default, the application is installed in C:\Program Files\Compliance Systems\CSi Custom Document Editor v7.00.0\editor.

To exit Custom Document Editor, click File > Exit.

Starting Custom Document Editor from the Command Prompt

Custom Document Editor may be launched from the command prompt. This allows the application to be shell-executed and opened with a specific FXL file.

When the document to be opened is a CSi stock document, a check is automatically performed for any accompanying customizations in an OXL file (overlay customizations) or MXL file (script customizations). If such files are found, they are automatically loaded with the FXL file.

When the document to be opened is not a CSi stock document, no check is performed for accompanying customization files. This is because overlay and script information is embedded in the FXL file itself. If separate OXL or MXL customizations have been manually created for such a document, then the OXL or MXL file must be manually imported into Custom Document Editor after it is launched and the FXL opened.

Starting Custom Document Editor from the command prompt:

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

  2. Specify the directory location of editor.exe.

  3. Type editor.exe [filename] where filename is the name of the FXL to be opened in Custom Document Editor. Press ENTER.

Specifying Data Locations

In order to access standard, partner, or custom datapoint dictionaries, it is necessary to specify those dictionary locations in Custom Document Editor’s preference settings. Those dictionary locations are checked when Custom Document Editor is started. If those dictionaries cannot be located, an information dialog box is displayed.

Custom Document Editor also checks for three schema files on startup, cdedatapointlist.xsd, CDESchemaDatapointList.xsd, and oxl.xsd. The schema files are provided as part of the Custom Document Editor installation and by default are stored in the same directory as the executable file editor.exe. If Custom Document Editor cannot locate them, an information dialog box is displayed.

The schema files are validated with any datapoint dictionaries specified in Custom Document Editor’s preference settings. If the validation fails, an information dialog box is displayed.

Working in the Custom Document Editor Environment

Custom Document Editor includes work windows and toolbars for managing documents and their overlay elements.

Work Windows

All work windows can be positioned so they are floating or docked under the menu bar and any docked toolbars. When floating, the work windows can be resized.

Document Window

The Document window displays the current document that is being customized. The name of the document appears in the window title bar.

Datapoints Window

The Datapoints window displays datapoint information. Click Window > Datapoints to display it.

  • The Current tab lists datapoints added as overlays in the Document window. It automatically updates as datapoints are added or removed from the document.

  • The FXL tab lists datapoints that were saved in the custom document file.

  • The Standard Dictionary tab displays a read-only list of datapoints from the CSi dictionary specified in Preferences. The tab does not appear if this dictionary has not been specified.

  • The Partner Dictionary tab displays a read-only list of datapoints from the partner dictionary specified in Preferences. The tab does not appear if this dictionary has not been specified.

  • The Custom Dictionary tab displays a read-write list of datapoints from the custom dictionary specified in Preferences. The tab does not appear if this dictionary has not been specified.

Depending on which Datapoints tab is active, different window options and information columns are displayed.

Double-click a column’s right boundary to automatically resize it so that the row with the most characters is fully displayed.

Properties Window

The Properties window displays properties specific to the selected overlay field. Click Window > Properties to display it. When multiple overlay fields are selected, the properties of the primary overlay field are displayed. The primary overlay field is the first overlay selected in a sequence of multiple overlay selections.

Data in the Properties window can be presented by category or alphabetically.

  • Properties are presented alphabetically within these categories:
  • Properties are sorted alphabetically without any category designation.

Click the plus sign (+) next to a category or data set to display its related data controls. Click the minus sign (-) to hide the controls.

Preview Window

The formatting attributes selected as an overlay field’s properties are visible in Custom Document Editor’s Preview window, along with the text entered as data for fixed text overlay fields. Click Window > Preview to display it.

In order to maximize performance, the Preview window display does not automatically refresh as overlay fields are added, modified, or deleted in a document. When you are ready to update the Preview window display, click the Refresh button.

The Preview window’s Error tab displays any errors, invalid datapoints, and missing datapoints in the document or the data loaded for it.

The Preview window can be resized. Click and drag on the window’s edges.

Preview Sample Data

The Preview window includes an edit box that allows you to specify a sample transaction data file for use in previewing the custom document. In order to evaluate the appearance and behavior of data elements added to a custom document, CSi recommends testing the effect of sample values for those data elements in the Preview window.

Data files use either the TXL or DXL file extension and are based on the XML format. They contain data values along with the associated layout directives for values that are displayed.

Loading sample data:

  1. If necessary, display the Preview window by clicking Window > Preview and view the Preview tab.

  2. Click the Browse button .

  3. Locate the TXL or DXL file with the sample data values you want to use in the Preview window.

  4. Click Open.

  5. Click the Refresh button to update the Preview window display with the sample data values.

Viewing data errors:

  1. If necessary, display the Preview window by clicking Window > Preview and view the Error tab.

  2. Resize columns or click on column headers to sort information for more convenient reference.

Clipboard Window

The Window > Show Clipboard command displays the Clipboard window. The window describes the contents of the last item cut or copied to the Windows clipboard.

The Supported Format drop-down list allows the selection of a data format with which to view the clipboard contents.

Toolbar

The toolbar may be divided into several groups of related tool functions.

  • The File tools include commands for creating, opening, saving, and printing documents.
  • The Edit tools include commands for cutting, copying, pasting, and deleting.
  • The Overlay tools include commands for selecting and creating overlay fields.

Status Bar

The status bar at the bottom of the application window provides information about the file and current operations, including:

  • the name of the current FXL file
  • the name of the active tool
  • the current zoom setting
  • the x/y location of the mouse
  • page size measured in thousands of an inch

Setting Preferences

The Edit > Preferences command provides control of various application default settings.

The original default settings for all Preference options may be reinstated by clicking the Restore Defaults button at the bottom of the Preferences dialog box.

Using Restore Defaults reinstates the original default settings for all options with the exception of the following:

  • Standard Dictionary path information on the Dictionary tab.
  • Partner Dictionary path information on the Dictionary tab.
  • Custom Dictionary path information on the Dictionary tab.
  • License Key information on the General tab.

Defaults Tab

Option Description
Font The default font, font color, and font size used for fixed and mergable text overlay fields. Click the Browse button to open the Font dialog box. Make necessary changes and click OK.
Shrink-to-fit Forces the size of text characters to shrink to fit in a mergable text overlay field when the size of the field does not allow all text characters to be displayed.
Minimum Size The minimum font size that text characters can use when Shrink-to-fit is active. Text shrinks until it fits within the field or until it reaches this minimum size.
Truncate Truncates text to fit in a mergable text overlay field when the size of an overlay field does not allow all text characters to be displayed.
Expand The manner in which an image is resized if it is smaller than the field size. The options are Proportional, Fill, and None. None does not expand the image.
Shrink The manner in which an image is resized if it is larger than the field size. The options are Proportional and Fill.
Text Alignment Vertical The vertical character alignment of field text.
Text Alignment Horizontal The horizontal character alignment of field text.
Image Alignment Vertical The vertical image alignment within a field.
Image Alignment Horizontal The horizontal image alignment within a field.
Padding Vertical Defines the amount of vertical space to insert between the border of an overlay field and its content. Space is measured in 1000/inch.
Padding Horizontal Defines the amount of horizontal space to insert between the border of an overlay field and its content. Space is measured in 1000/inch.
Text/Image Border Color The color of the field border for mergable, fixed text, and image overlays. Click the Color box to view the CSi color controls. Click the drop-down arrow to select the Custom, Web, or System color palette. Select a color and click OK. A color may also be selected by manually editing the color values.
Text/Image Border Thickness The width of the field border for mergable, fixed text, and image overlays, measured from 1-10. Width is measured in 1000/inch.
Text/Image Background Color The color in the field behind the text or image for mergable, fixed text, and image overlays. Click the Color box to view the CSi color controls. Click the drop-down arrow to select the Custom, Web, or System color palette. Select a color and click OK. A color may also be selected by manually editing the color values.
Shape Border Color The color of the field border for lines, rectangles, and elliptical shapes. Click the Color box to view the CSi color controls. Click the drop-down arrow to select the Custom, Web, or System color palette. Select a color and click OK. A color may also be selected by manually editing the color values.
Shape Border Thickness The width of lines, rectangles, and ellipse shapes, measured from 1-10. Width is measured in 1000/inch.
Shape Background Color The fill color for rectangles and elliptical shapes. Click the Color box to view the CSi color controls. Click the drop-down arrow to select the Custom, Web, or System color palette. Select a color and click OK. A color may also be selected by manually editing the color values.

Setting the Default Font

The default font used by Custom Document Editor is set on the Defaults tab of the Preferences dialog box. The default font is used to format text values populating

A font may be selected either from a list of system fonts or from lists of printer-resident fonts.

Setting the default font:

  1. Click Edit > Preferences and view the Defaults tab.

  2. If necessary, click on the Source arrow to select a source list.

  3. Set the font name, color, and size as necessary.

  4. Click OK in the Font dialog box, then click OK in the Preferences dialog box when done.

Use printer fonts when creating overlays that will be printed with line printers.

Working with Line Printers

Custom Document Editor allows customization with printer fonts to optimize document printing with the line printers used by tellers. These are frequently dot-matrix printers, where performance speed is degraded when Windows installed fonts are used to send document information. CSi recommends the use of printer fonts only when customizing documents for the teller environment.

Document Tab

Option Description
Overlay field display highlight color The fill color used to visualize overlay fields in Custom Document Editor’s Document window. Click the Color box []{#O_711 .anchor} to view the CSi color controls. Click the drop-down arrow to select the Custom, Web, or System color palette. Select a color and click OK. A color may also be selected by manually editing the color values.
Show overlay name When active, overlay field names are displayed in the overlay fields in the Document window.
Nudge value The distance overlay fields are moved when nudged, measured in pixels.
Preferred zoom level Sets the default zoom level for the Document window.
Image quality Controls the DPI of the bitmap representation of the document in the Document window. The higher the quality, the better the representation of the document in the Document window and the better the quality of printing from the Document window. However, document rendering on screen is slower with the higher quality settings.

The Overlay field display highlight color option controls the color used to visualize overlays in Custom Document Editor only. This is not the background color reported in Properties for the overlay field, and this color is not saved with the OXL file for use in visualizing the overlay fields in other applications. To control the default background color, use the Background color option located on the Preferences Defaults tab instead.

Dictionary Tab

The Dictionary tab allows specification of the file location used to import XML partner datapoints.

Type in a file path or click the appropriate Browse button to search for it. The data from the dictionaries specified here is used to populate the Partner Dictionary tab of the Datapoints window.

Option Description
Standard Dictionary Allows a CSi Schema datapoint dictionary to be selected. These data elements are used to populate the Standard Dictionary tab of the Datapoints window.
Partner Dictionary Allows a partner dictionary to be selected for access to read-only partner datapoints. These datapoints are used to populate the Partner Dictionary tab of the Datapoints window. When the limit attribute is set to true in the partner dictionary file, the name of a datapoint in the Datapoints window must come from the known list of partner datapoints.
Custom dictionary Allows a second partner dictionary to be selected for access to partner datapoints which may be customized in Custom Document Editor. These datapoints are used to populate the Custom Dictionary tab of the Datapoints window. Note that if the custom dictionary file is accessed from a network location by multiple users, modifications to the dictionary are only saved by the last user to exit the dictionary.

The selected files must pass internal validation in order to be opened. If a file does not contain valid XML information, an error message appears.

For more information, see Specifying Datapoint Dictionaries.

Licensing Tab

Option Description
License key Enables full access to all Custom Document Editor features. If no license key is set or a license key without Custom Document Editor support is set, then Custom Document Editor switches to Lite mode.

Script Editor Tab

Scripts may be used to manipulate and map datapoint values before they are applied to a customized document. Script Editor preference settings control the appearance and behavior of the Script Editor window.

General Options Description
Vertical scroll bar Displays and hides the vertical scroll bar in the Script Editor window.
Horizontal scroll bar Displays and hides the horizontal scroll bar in the Script Editor window.
Forced Causes the vertical and horizontal scroll bars to be displayed at all times, regardless of the amount of content in the Script Editor window.
Show gutter Displays and hides the gutter in the Script Editor window.
Show margin Displays and hides the margin in the Script Editor window.
Gutter width Sets the width of the gutter in the Script Editor window. Width is measured in character spaces. Values 0-9 may be entered.
Margin width Sets the width of the margin in the Script Editor window. Width is measured in character spaces. Values 0-99 may be entered.
Show line numbers Displays and hides the line numbers in the Script Editor window using the margin area.
Display on gutter When line numbers are displayed, this option positions them on the gutter area of the Script Editor window.
Fonts and Colors Options Description
Font Sets the font style for the selected script display item.
Size Sets the font size for the selected script display item.
Display items Allows selection of the script display item to be assigned display attributes.
Description Assigns a description to the selected display item.
Fore color Sets the text color of the selected script display item.
Back color Sets the background color of the selected script display item. Background color cannot be set for the hypertext and spelling display items.
Bold Applies bold to the selected script display item.
Italic Applies italics to the selected script display item.
Underline Applies underlining to the selected script display item.
Additional Options
Tab size Defines the number of spaces inserted in the Script Editor window when the TAB key is used. Values 0-9 may be entered.
Insert spaces Converts TAB characters present in text into character spaces in the script file.
Keep tabs Preserves TAB characters present in text as TAB characters in the script file.

Color Values

The Defaults tab and Datapoints tab in Edit > Preferences as well as the Properties window allow color values to be set for various overlay field elements, such as background color. Colors may be selected from the Custom, Web, or System palettes, which include selections for black, white, and transparent. Colors may also be manually entered using the RGB color space or as hexadecimal values. To obtain black, white, or transparent with hexadecimal, use the color values listed here.

Color Value
Black #FF000000
White #FFFFFFFF
Transparent #00FFFFFF

Working with Documents

When new custom documents are created as a blank document or from PDF or image files, overlay field information and data manipulation 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 an 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.

Data calculation scripts are always saved in the custom dictionary file specified in Preferences.

Creating Documents

Only one document can be opened at a time. If a document is already open when another document is created, you are prompted to save any changes to it before it is closed.

Creating Documents from PDF Files

Custom Document Editor supports the use of PDF files to form the basis of new documents. Acrobat form fields in the PDF are converted to overlay fields in Custom Document Editor so that they may be modified further by the document designer.

PDF files opened in Custom Document Editor are saved in FXL format so that they may be processed like other CSi documents with CSi’s Compliance Engine. Acrobat form fields become embedded data fields after they are saved in the FXL format.

Creating a document from a PDF:

  1. Click File > New > From PDF File.

  2. Select the PDF file to be used.

  3. Click Open.

Creating Documents from Image Files

Custom Document Editor supports the use of EMF, WMF, BMP, GIF, JPEG, PNG, and TIFF files to form the basis of new documents. These image files also can be used to append additional pages to a document. Basing a new document on an image file allows the document designer to position overlay fields relative to the position of static text represented on the image. The image can be output with the overlays, or it can be omitted if the designer’s intention is to create a set of overlays that will print on pre-printed stock.

When creating a new document, multiple image files may be selected to create a multiple-page document. The page order is determined by an alphanumeric sort of the selected image files. The image file arranged first in the alphanumeric sort determines the default document name as well as the document size. The names of the subsequent image files are not displayed.

To ensure that pages are arranged in the proper order, image files may need to be renamed prior to their use in Custom Document Editor. For example, a series of 10 image files may comprise a document. The files are named so that the page number is indicated at the beginning of the name, like 1bal, 2bal, etc. In this case, page 10, 10bal, will be placed before 2bal. Instead, place the page number at the end of the file name: bal01, bal02, etc.

In the case of other image files, a single file may be selected to create a one-page cut-sheet document.

Creating a document from image files:

  1. Click File > New > From Image File.

  2. Under Files of type, select the image file format corresponding to the image file type to be used.

  3. Select the image file to be used. Multiple files may be selected.

  4. Click Open.

Image files should be of the same size and page orientation for a given document.

Creating Documents from Scratch

Creating documents from scratch:

  1. Click File > New > Blank.

  2. Enter the page size and orientation for the document. To use a custom size, click the Customized size option and enter dimensions for Width and Height in pels. (A pel is a unit of measure that CSi defines as 1,000th of an inch.)

  3. Click OK. The blank document appears in the Document window.

Click the Blank tool []{#O_646 .anchor} to create a document from scratch.

Opening Documents

Only one document can be opened at a time. If a document is already open when you open another document, you are prompted to save any changes to it before it is closed.

In the case of dynamic FXL files, you are prompted to open a valid data file (DXL or XML) when you open the FXL file. This is necessary to give the document a structure to render. Compressed FXL files are not supported for use with Custom Document Editor.

CSi does not recommend customizing dynamic documents. Dynamic documents use variable data to render the form and populate its variable fields.

Opening files

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

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

  3. Select a file name, then click Open. If the FXL file has been extended in Custom Document Editor, its OXL file is automatically loaded with it. If the FXL file is dynamic, you are prompted to load its data file (DXL, TXL, or XML).

Recently used files are listed at the bottom of the File menu. Open them by clicking on their names.

Working with Dynamic Documents

While CSi does not recommend customization of dynamic documents it is possible to open them in Custom Document Editor.

If pages are removed from a dynamic document in Custom Document Editor and overlays were defined for those removed pages, then options for managing those overlays are presented when the document is opened and its overlays are loaded from its accompanying OXL file.

Ignore discards overlays that are specified for pages that do not exist in the document.

Continue loads all overlay information. Overlays that are specified for pages that do not exist only become accessible if pages are added to the document that allow the specified positions to be realized.

If the overlay page position is specified as all pages (-1) and last page (0), then those overlays are always imported.

Adding Document Pages

New pages can be added to a document. The new pages may be based on content from an existing image file, or they may be added as new blank pages.

Adding document pages:

  1. Click Document > Add Pages.

  2. To select an image file with the additional document page, click the Browse button to locate it. Navigate to the directory containing the file(s) and specify the necessary file type. To select one file, click on the file name. To select multiple files, hold down the CTRL key and click on the file names. When the proper file(s) are selected, click Open.

OR

To add a single blank page, do not click Browse to select image files.

  1. To add the new page(s) before the current page, click the Before the current page option. Otherwise, the new page is added after the current page.

  2. Click Add.

To ensure that new pages are arranged in the proper order, image files may need to be renamed prior to their use in Custom Document Editor. Page order is determined by an alphanumeric sort of the selected image files.

Pages cannot be added to a CSi stock document.

Replacing Document Pages

Document pages can be replaced with content from an existing image file, or they may be replaced with blank pages.

Replacing document pages:

  1. Make sure that the active page in the Document window is the first page you want replaced in the document.

  2. Click Document > Replace Pages.

  3. To select a file with the additional document page, click the Browse button []{#O_9348 .anchor} to locate it. Navigate to the directory containing the file(s) and specify the necessary file type. To select one file, click on the file name. To select multiple files, hold down the CTRL key and click on the file names. When the proper file(s) are selected, click Open.

OR

To replace the page with a blank page, do not click Browse to select image files.

  1. Click Replace. The first replaced page corresponds to the active page in the Document window. If you selected multiple replacement image files, the replaced pages are those that succeed the active page.

To ensure that replacement pages are arranged in the proper order, image files may need to be renamed prior to their use in Custom Document Editor. Page order is determined by an alphanumeric sort of the selected image files.

Pages cannot be replaced in a CSi stock document.

Deleting Document Pages

Deleting document pages:

  1. Click Document > Delete Pages.

  2. Use the scroll arrows to specify the page range to be deleted from the document. Because a document must contain at least one page, it is not possible to delete all pages from a document.

  3. Click OK. The specified pages are deleted from the document.

The Delete Page command is not available if the document contains only one page.

Pages cannot be deleted from a CSi stock document.

Managing Document Properties

Document > eDoc Properties reports information about the current document. It also provides background printing control of the FXL background image. This applies to static documents only: those created in the Custom Document Editor (from scratch, from PDFs, or from image files) and CSi static documents.

To create a mergable-only overlay for pre-printed documents such as cashier’s checks, set the Print Background option to No. The Print Background option is disabled and set to No when creating blank documents. It is disabled and set to Yes when customizing CSi stock documents.

Exporting Document Information

You can export overlay field information into an OXL file and export script information into an MXL file. Exporting overlay and script information allows it to be shared among multiple documents. For example, a series of overlays can be exported from one document and imported into another that requires the same customizations.

Exporting overlay information:

  1. Click File > Export.

  2. Select MXL to export script information or OXL to export overlay information.

  3. Select the location 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.

Importing Document Information

You can import overlay field information from OXL files and script information from MXL files to use in documents you are customizing with Custom Document Editor. Importing information allows it to be shared in multiple documents that require similar customizations.

A document must be open before OXL or MXL information may be imported.

Imported overlays from an OXL file may overwrite or be appended to those in the open file. The import of an MXL file overwrites any existing data manipulation script information in the open file.

When the imported OXL file specifies overlay positions on pages that do not exist in the document, those overlays are not imported. If the overlay page position is specified as all pages (-1) and last page (0), then those overlays are always imported.

Importing document information:

  1. Click File > Import.

  2. Select MXL or OXL.

  3. Navigate to the drive and folder containing the MXL or OXL file from which you want imported overlay fields.

  4. Select the file name, then click Open.

  5. If overlays from an OXL file are being imported, you are prompted to indicate if existing overlays in the document should be kept or discarded.

  6. If existing overlays are not kept (No), the imported overlays are added to the document. If existing overlays are kept (Yes), you are prompted to select Append or Overwrite to determine the management of overlay tab order.

Append retains the tab order designated for the existing overlays and assigns the first overlay (tab value 1) in the imported file with the next available number in the tab sequence. Overwrite replaces the tab order designated for the existing overlays with the tab sequence of the imported overlays. The first existing overlay (tab value 1) is assigned the next available number in the tab sequence established by the imported overlays.

If no overlays exist in the document, you are not prompted to select Append or Overwrite. The tab order of the overlay fields will begin at 1.

Saving Files

The manner in which overlay information is saved depends on the source of the document.

  • If the document is not a CSi stock document, Custom Document Editor saves overlay information in the FXL file.

  • If the document is a CSi stock document, Custom Document Editor saves overlay information in an OXL file.

When a new document is created from PDF, an image file, or from a blank document, Custom Document Editor creates an FXL that contains information about the datapoints assigned to the overlay fields as well as the overlay information itself.

If a file has been saved before in Custom Document Editor, click File > Save to update the file with recent changes or click the Save tool.

The File > Save As command is used to enter a file name and select a directory for the file. If an FXL file with that name already exists in the selected directory, a prompt appears to confirm the replacement of the files.

If the file is being saved for the first time, use either Save or Save As.

Saving files with Save As:

  1. Click File > Save As.

  2. Select the location to save the file.

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

  4. Click Save. If necessary, confirm the replacement of existing files with the same name or enter a new file name to preserve existing files.

Closing Files

The File > Close command closes the current file without exiting Custom Document Editor. You are prompted to save any changes to the file.

Paging Through Documents

Paging controls at the bottom of the Document and Preview windows 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.

The PAGE UP and PAGE DOWN keys move the display to the previous and next page, respectively. CTRL-PAGE UP and CTRL-PAGE DOWN move the display to the first and last page, respectively.

Zooming the Document View

Zoom controls at the bottom of the Document and Preview windows 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.

ALT-UP ARROW key on the keyboard increases the current zoom level. ALT-DOWN ARROW key decreases the current zoom level. The HOME key changes the zoom level so that an entire page is visible in the Document window.

Printing

Different information about the open document can be printed depending on which work window is active.

  • When the Datapoints window is active, printing outputs a list of datapoints for the selected tab.

  • When the Document window is active, printing outputs a bitmap image of the document with the overlay fields. The print DPI is dependent on the DPI of the Document window, which is set in Preferences > Document.

  • When the Preview window is active, printing outputs the rendered preview image with any loaded sample data. The print DPI is controlled by the Compliance Engine and is 300 DPI.

  • When the Script Editor window is active, printing outputs the script data currently in the window.

If documents are to be printed on a line printer, you may select a default font from a list of printer-resident fonts. See Setting the Default Font for more information.

Printing:

  1. View the window that 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.

Right-click in the Document window and select Print to output an image with the overlay fields.

Right-click in the Script Editor window and select Print to output the script.

Managing Page Setup

The File > Page Setup command provides control over how document data appears when printed.

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.

Printing Script Information

When printing information from the Script Editor window, additional controls are available for configuring the output on the page. Click the Options button in the Print dialog box to access them.

Command Description
Print selection Prints only the data selected in the Script Editor window.
Header Includes a header in the printed output. The header centers text describing the script type (Data Manipulation Script, Shared Script, Data Mapping Script) in the header area of the document.
Footer Includes a footer in the printed output. The footer centers the page number in the footer area of the document.
Line Numbers Prints the script line numbers.
Page Numbers Prints page numbers in the footer area of the document.
Word Wrap Wraps text in the printed output to fit the dimensions of the Script Editor window.
Syntax Print Specifies that lexical analysis should be used for the document being printed.
Color Print Sends color information to the printer so that color coding associated with the script may be output on color printers. In order for script content to be output in color, it is also necessary for the Syntax Print option to be selected.
Display Progress Displays a progress meter describing the status of the print job.

Understanding Resolution and Overlay Position

The location of overlays on a custom document is affected by the screen resolution of the workstation. If there is a difference in resolution between the workstation on which overlays were created and the workstation on which the overlays are currently being viewed, it is possible that the overlays will shift in position so that they are no longer properly aligned with static document text. It is recommended that all workstations used in the management of custom documents use the same screen resolution.

Creating Overlay Fields

Overlay fields are used to add custom elements to documents. The elements can be text or images. All overlays can be manually drawn in the Document window using the tools on the Tools toolbar.

  • Draws mergable text overlays. These hold a single piece of transaction data, like an account number or a date.
  • Draws fixed text overlays. These hold strings of static text that will always appear the same way every time the document is used.
  • Draws image overlays. These hold a graphic image, like a bank logo.
  • Draws lines.
  • Draws rectangles.
  • Draws ellipses.

By default, mergable text overlay fields and image overlay fields are labeled unnamed. An overlay field’s datapoint name can be changed in the Properties window, unless a partner data dictionary has been presented and it is limited (restricted). Datapoint names are checked internally as they are entered to ensure that they conform to CSi IntelleDoc Solutions™ datapoint naming conventions.

If a partner datapoint dictionary is present and limited, only datapoints from that list can be entered into the Datapoint Name field. The Datapoint Name field performs validation on the text entry. To see a list of available datapoint names, display the Datapoints window and view the Partner Dictionary tab.

Mergable overlays can also be created automatically when you drag datapoints into a custom document from the Datapoints window.

Mergable Overlay Fields

Mergable text fields represent a datapoint for variable data. The datapoint name appears in the mergable text field in the Document window. It is modified either in the Properties window or directly in the Document window.

Creating mergable text overlay fields:

  1. Click the Mergable Text tool.
    OR
    Click Tools > Mergable Text.

  2. Click and drag in the Document window to position the text field.

  3. Make changes to its properties as appropriate.

  4. Continue adding text fields as necessary, then select another tool or menu item when done.

Mergable overlay fields can also be dragged into the Document window from the Datapoints window. For more information, see Adding and Modifying Document Datapoints[]{#H_8016 .anchor} (”Adding Datapoints from Dictionaries” on page 76).

Fixed Text Overlay Fields

Fixed text fields hold static text labels. They may also hold variable datapoints inserted as part of the field text data. This text is may be entered in the Properties window for a selected fixed text overlay field.

Creating fixed text overlay fields:

  1. Click the Fixed Text tool []{#O_641 .anchor}.
    OR
    Click Tools > Fixed Text.

  2. Click and drag in the Document window to position the text field.

  3. Make changes to its properties as appropriate. Use the Text section in the Properties window to add the static text that is to appear in the field.

  4. Continue adding text fields as necessary, then select another tool or menu item when done.

Text for fixed text overlay fields can also be added directly in the Document window. For more information, see Entering Fixed Text in the Document Window[]{#H_8017 .anchor} (on page 55).

Image Overlay Fields

Image fields will display images. Images are specified as the data in the datapoint.

Creating image overlay fields:

  1. Click the Image tool []{#O_642 .anchor}.
    OR
    Click Tools > Image.

  2. Click and drag in the Document window to position the image field.

  3. Make changes to its properties as appropriate.

  4. Continue adding image fields as necessary, then select another tool or menu item when done.

Hold down the SHIFT key while dragging to draw a square image field.

Images and DPI

If an image file is used as the background image for a document page or is used as an image overlay or logo in dynamic document, it is rendered at its internal DPI. If its internal DPI does not exist or is set to zero (0), the default of 300 DPI is used.

The examples below assume that no shrinking or expanding options affect rendered image size.

BMP image Renders
300 x 600 with a DPI of 100 3 inches by 6 inches
300 x 600 with a DPI of 300 1 inch by 2 inches
300 x 600 with a DPI of zero (0) Defaults to 300 DPI and renders 1 inch by 2 inches

Transparent TIFF files are not supported.

Shape Overlay Fields

Shape fields do not hold datapoints or static text labels. They are used to add graphic elements to the document.

  • Draws lines.
  • Draws rectangles.
  • Draws ellipses.

When drawing lines, the starting cursor position defines the coordinates of its start point. When the mouse is released, coordinates are defined for the end point.

Drag to define the line's length

When the mouse is released, the end point coordinates are defined

Rectangle and ellipse overlay fields are drawn by defining the rectangular display frame that is used to identify and select them.

Drag to define the frame's size

In the case of an ellipse, the diameter of the shape is equal to the width of the frame.

Creating shape overlay fields:

  1. Click the shape tool that corresponds to the field shape to be created: Line, Rectangle, or Ellipse.
    OR
    Click the Tools menu, then click the command corresponding to the field shape to be created.

  2. Click and drag in the Document window to position the shape field.

  3. Continue adding shape fields as necessary, then select another tool when done.

Hold down the SHIFT key while dragging with the Rectangle or Ellipse tools to draw a square or a circle, respectively. Hold down the SHIFT key while dragging with the Line tool to draw lines at 45-degree angles.

Working with Overlay Fields

The properties of overlay fields can be modified after they are created. The position and size of overlay fields in the document can also be modified.

About Primary Overlay Fields

It is possible to select more than one overlay at a time. Some commands require selection of multiple overlays in order to function, and in those cases it is necessary to define the primary overlay that controls the outcome of that function. Primary overlays can also serve as the properties standard for other overlays.

The primary overlay is the first overlay selected. It is distinguished with a red bounding box. Overlays selected after the primary are distinguished with a blue bounding box.

Selecting Overlay Fields

In order to change either the properties or layout of an overlay field, it is necessary to first select the overlay fields that are to be modified.

The Selection tool selects overlay fields. Click on the tool, and then click on the field to be selected.

  • Hold down the CTRL key to select multiple fields with the Selection tool.

  • Use the Selection tool to click and drag a selection box around fields to be selected. Fields do not need to fall entirely within the selection box to be selected.

  • Hold down the CTRL key while clicking and dragging to select multiple fields while keeping any existing field selections.

  • Click anywhere in the window where there are no fields to deselect all fields.

  • Click Edit > Select All to select all overlay fields on the current page.

When the cursor is in a text field, CTRL-A selects all the text.

Overlay fields may also be selected with any active overlay field drawing tool.

Multiple Selection and Primary Overlays

If a selected overlay field is designated as the primary overlay, holding down the CTRL key and selecting additional overlay fields may change the primary designation. When you drag a selection box around overlay fields:

  • If a primary overlay field is already designated and it is inside the selection box you define, it remains primary.

  • If a primary overlay field is designated and you define a selection box that does not include it, but does include a previously selected secondary overlay field, that secondary becomes the primary.

  • If no overlay fields are selected and you drag to define a selectionbox, the overlay field closest to the initial click becomes the primary.

If you deselect the primary overlay when multiple overlays are selected, then the second overlay that was selected becomes the new primary overlay.

Cutting and Copying

  • Edit > Cut and the Cut tool remove the selected overlay object and place it on the internal clipboard.
  • Edit > Copy and the Copy tool copy the selected overlay object and place it on the internal clipboard.
  • Edit > Paste and the Paste tool place copies of the item from the clipboard into the Document window. Pasted overlay copies are offset from their original document position. To view clipboard contents, click Window > Show Clipboard.

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

Deleting

Deleting:

  1. Select the overlay field to be deleted.

  2. Click Edit > Delete or click the Delete tool

The DELETE key also deletes the selected overlay field.

Managing Overlay Field Properties

Overlay fields have various associated properties based on their field type. Many of these properties can be propagated, or duplicated, from one overlay field to another. This is discussed later in the section Propagating Overlay Field Properties (on page 61).

Changes to overlay field properties are visible in Custom Document Editor’s Preview window. It displays the formatting attributes for an overlay field, along with the text entered as data for fixed text overlay fields.

Modifying properties for a selected overlay field:

  1. Select the overlay field to be modified.

  2. If necessary, click Window > Properties to display the Properties window.

  3. Make any necessary changes to the properties of the overlay field. The field is automatically updated.

Press the ENTER key to display the Properties window for the selected overlay field or the primary overlay field when multiple fields are selected. Double-clicking on a selected overlay field also displays its Properties window.

Mergable Text Properties

Property Description Propagates from primary
Background Color The color in the field behind the text. The default color is transparent. Click the Options arrow to select the Custom, Web, or System color palette. Select a color and click OK. A color may also be selected by manually editing the color values. Yes
Border Color The color of the field border. The default color is transparent. Click the Options arrow to select the Custom, Web, or System color palette. Select a color and click OK. A color may also be selected by manually editing the color values. Yes
Border Thickness The width of the field border, measured from 1-10. Width is measured in thousandths of an inch. Yes
Font Color The color of text. The default color value creates black text. Click the Options arrow to select the Custom, Web, or System color palette. Select a color and click OK. A color may also be selected by manually editing the color values. Yes
Font Name The font face of field text. All installed system fonts are available for selection. Click the Options arrow to make a selection. Yes
Font Size The point size of field text, measured from 8-72. Click the Options arrow to make a selection. A numeric value may also be manually entered in the field. Yes
Font Source The source from which fonts are being made available for use. The source is either Windows (system installed fonts) or an available printer (printer fonts). Yes
Format The CSi format description. This controls the manner in which numerical entries are formatted. Click the Options arrow to make a selection. Yes
Text Alignment Horizontal The horizontal character alignment of field text (Left, Center, Right, Justified). Click the Options arrow to make a selection. Yes
Text Alignment Vertical The vertical character alignment of field text (Top, Middle, Bottom). Click the Options arrow to make a selection. Yes
Minimum Font Size The minimum font size that text characters can use when ShrinkToFit is active, measured from 1-255. Text shrinks until it fits within the field or until it reaches this minimum size. Yes
ShrinkToFit When True, forces the size of text characters to shrink to fit in an overlay field when the size of the field does not allow all text characters to be displayed. Click the Options arrow to make a selection. Yes
Tab Order Defines the order in which the field receives focus for data input. No
Truncate When True, truncates text to fit in an overlay field when the size of an overlay field does not allow all text characters to be displayed. Click the Options arrow to make a selection. Yes
Datapoint Name The datapoint used for the field. No
Description The tool tip text used to describe the field. No
Locked When True, protects the datapoint value from modification. When the overlay field is locked or when the data value supplied is locked, the overlay field is read-only in CSi’s Viewer Control or in PDF forms. By default, overlay fields are not locked. No
Max Chars The maximum number of characters that may be entered in the field. The default value of zero allows unlimited number of characters. Yes
Location X and Y The X/Y location of the field, measured in 1000/inch. No
Padding X and Y Defines the amount of horizontal (X) and vertical (Y) space to insert between the border of an overlay field and its content. Space is measured in 1000/inch. Yes
Page The page on which the field is located. 0 indicates all pages;-1 indicates the last page; current page indicates the page that is currently viewed. No
Size Width The width of the field, measured in 1000/inch. No
Size Height The height of the field, measured in 1000/inch. No

Rendered Truncation Markers

Shrink and Truncate options can be applied to mergable text overlay fields. When these are enabled and the text of the datapoint cannot fit within the defined size of the fixed text overlay field, the truncation symbol (§) appears in the lower right of the field to indicate that data is truncated.

These options can be applied to new mergable text overlay fields by default, and they can be set for individual fields using the Properties window.

Naming Mergable Overlay Fields

The names of mergable overlay fields are used to assign datapoints to them. Names may be entered for mergable text overlay fields in Properties window, and they may also be entered directly in the Document window.

Naming overlay fields:

  1. Select the overlay field to be named.

  2. Display its Properties window and enter a name in the Datapoint field:
    OR
    Click a second time on the selected overlay field while holding down the ALT key. The field edit box is displayed:

  3. Enter a name in the edit box, then select another tool or menu item when done.

General Datapoint Naming Conventions

Datapoint names can consist of the following characters:

  • letters
  • numbers
  • dash (-)
  • underscore (_)
  • period (.)

Datapoint names must not begin with a period (.). Two periods in succession (..) are not allowed anywhere in a datapoint name.

CSi recommends that partners using custom datapoint names begin those names with a company abbreviation prefix to avoid namespace conflicts.

Datapoint names beginning with underscore (_) are reserved for CSi datapoint names.

Fixed Text Properties

Property Description Propagates from primary
Background Color The color in the field behind the text. The default color is transparent. Click the Options arrow to select the Custom, Web, or System color palette. Select a color and click OK. A color may also be selected by manually editing the color values. Yes
Border Color The color of the field border. The default color is transparent. Click the Options arrow to select a color from the Custom, Web, or System palette. Yes
Border Thickness The width of the field border, measured from 1-10. Width is measured in thousandths of an inch. Yes
Font Color The color of text. The default color value 1,1,1 creates black text. Click the Options arrow to select the Custom, Web, or System color palette. Select a color and click OK. A color may also be selected by manually editing the color values. Yes
Font Name The font attributes of field text. Click the Browse button []{#O_708 .anchor} to make selections in the Font dialog box, then click OK. Yes
Font Size The point size of field text, measured from 8-72. A numeric value may also be manually entered in the field. Yes
Font Source The source from which fonts are being made available for use. The source is either Windows (system installed fonts) or an available printer (printer fonts). Yes
Text Alignment Horizontal The horizontal character alignment of field text (Left, Center, Right, Justified). Click the Options arrow to make a selection. Yes
Text Alignment Vertical The vertical character alignment of field text (Top, Middle, Bottom). Click the Options arrow to make a selection. Yes
CSiScript When set to True, allows CSi script tags to be recognized as tags so that their respective functions can be performed. When the option is set to False, the tags appear in the fixed text overlay field as characters. No
Text The static text or label to appear in the field. To enter text, click the Data arrow , then type or modify text in the box that appears. Click on another control or window area when done. No
Location X and Y The X/Y location of the field, measured in 1000/inch. No
Padding X and Y Defines the amount of horizontal (X) and vertical (Y) space to insert between the border of an overlay field and its content. Space is measured in 1000/inch. Yes
Page The page on which the field is located. 0 indicates all pages;-1 indicates the last page; current page indicates the page that is currently viewed. No
Size Width The width of the field, measured in 1000/inch. No
Size Height The height of the field, measured in 1000/inch. No

Fixed Text Data

Fixed text data is the static text or label that appears in the rendered field. It can be entered in the Properties window or directly in the Document window. The Properties window includes an option to recognize CSi script tags in the text.

Entering Fixed Text in Properties

To enter fixed text, display the Properties window, click in the Text field and begin typing. Click the Entry arrow to display a larger field for data entry. Click on another control or window area when done.

The CSiScript option allows CSi script tags to be recognized as tags so that their respective functions can be performed. When the option is set to False, the tags appear in the fixed text overlay field as characters.

Entering Fixed Text in the Document Window

To enter fixed text in the Document window, click on a fixed text overlay to select it, then click on it a second time while holding down the ALT key to place the text in an edit state. Make changes to the text as necessary, then click another tool or menu item when done.

| | —|—|— | |

Line Properties

Property Description Propagates from primary
Color The color of the line. Click the Options arrow to select the Custom, Web, or System color palette. Select a color and click OK. A color may also be selected by manually editing the color values. Yes
Line Width The width of the line, measured in 1000/inch. Yes
End Point X The X coordinate of the line end point, measured in 1000/inch. No
End Point Y The Y coordinate of the line end point, measured in 1000/inch. No
Start Point X The X coordinate of the line start point, measured in 1000/inch. No
Start Point Y The X coordinate of the line start point, measured in 1000/inch. No
Page The page on which the field is located. 0 indicates all pages;-1 indicates the last page; current page indicates the page that is currently viewed. No

Image Properties

Property Description Propagates from primary
Alignment Horizontal and Vertical The image alignment within the field. This is set horizontally (Left, Right, Center) and vertically (Top, Middle, Bottom). Click the Options arrow to make a selection. Yes
Border Color The color of the field border. The default color is transparent. Click the Options arrow to select the Custom, Web, or System color palette. Select a color and click OK. A color may also be selected by manually editing the color values. Yes
Border Thickness The width of the field border, measured from 1-10. Width is measured in 1000/inch. Yes
Expand The manner in which the image is resized if it is smaller than the field size. The options are Proportional, Fill, and None. None does not expand the image. Click the Options arrow to make a selection. Yes
Shrink The manner in which the image is resized if it is larger than the field size. The options are Proportional and Fill. Click the Options arrow to make a selection. Yes
Datapoint The datapoint name used for the field. No
Description The tool tip text used to describe the field. No
Locked When True, protects the datapoint value from modification. When the overlay field is locked or when the data value supplied is locked, the overlay field is read-only in the Viewer Control or in PDF forms. By default, overlay fields are not locked. No
Location X and Y The X/Y location of the field, measured in 1000/inch. No
Padding X and Y Defines the amount of horizontal (X) and vertical (Y) space to insert between the border of an overlay field and its content. Space is measured in 1000/inch. Yes
Page The page on which the field is located. 0 indicates all pages;-1 indicates the last page; current page indicates the page that is currently viewed. No
Size Width The width of the field, measured in 1000/inch. No
Size Height The height of the field, measured in 1000/inch. No

Rectangle Properties

Property Description Propagates from primary
Background Color The color that fills the rectangle. Click the Options arrow to select the Custom, Web, or System color palette. Select a color and click OK. A color may also be selected by manually editing the color values. Yes
Border Color The color of the rectangle’s border. Click the Options arrow to select the Custom, Web, or System color palette. Select a color and click OK. A color may also be selected by manually editing the color values. Yes
Border Thickness The width of the rectangle’s border, measured from 1-10. Width is measured in 1000/inch. Yes
Location X The X coordinate of the rectangle’s upper left corner, measured in 1000/inch. No
Location Y The Y coordinate of the rectangle’s upper left corner, measured in 1000/inch. No
Page The page on which the field is located. 0 indicates all pages;-1 indicates the last page; current page indicates the page that is currently viewed. No
Size Height The height of the rectangle, measured in 1000/inch. No
Size Width The width of the rectangle, measured in 1000/inch. No

Ellipse Properties

Property Description Propagates from primary
Background Color The color that fills the ellipse. Click the Options arrow to select the Custom, Web, or System color palette. Select a color and click OK. A color may also be selected by manually editing the color values. Yes
Border Color The color of the ellipse’s border. Click the Options arrow to select the Custom, Web, or System color palette. Select a color and click OK. A color may also be selected by manually editing the color values. Yes
Border Thickness The width of the ellipse’s border, measured from 1-10. Width is measured in 1000/inch. Yes
Location X The X coordinate of the ellipse’s center, measured in 1000/inch. No
Location Y The Y coordinate of the ellipse center, measured in 1000/inch. No
Page The page on which the field is located. 0 indicates all pages;-1 indicates the last page; current page indicates the page that is currently viewed. No
Size Height The height of the ellipse, measured in 1000/inch. No
Size Width The width of the ellipse, measured in 1000/inch. No

Rendered Overlay Markers

When an overlay is applied to a document, it is possible for the overlay contents to impact the intended meaning or use of text in the original non-overlayed document. As a result, a watermark is placed at the lower right of all document pages of a CSi stock document when an overlay is applied. The watermark is a 6-point, grayscale version of the CSi logo and cannot be suppressed.

Propagating Overlay Field Properties

Overlay field properties can be copied from a primary overlay field to secondary overlay fields. This helps to ensure that overlay fields share the same appearance and behavior attributes.

Properties may be propagated only among fields of the same type. Propagate All copies all properties eligible for propagation from the primary overlay to the selected secondary overlays. Propagate duplicates only those properties eligible for propagation that were modified while the overlay fields were selected.

Propagating overlay field properties:

  1. Select the primary overlay field with the properties to be propagated and the secondary overlay fields that are to use the properties.

  2. If necessary, click Window > Properties display the Properties window.

  3. Click Propagate All to propagate all properties.
    OR
    Make new modifications to the properties as necessary. The modifications affect the primary overlay. Click Propagate to propagate all modified properties.

Press the ENTER key to display the Properties window for the selected overlay field or the primary overlay field when multiple fields are selected. Or, right-click on a selected overlay field to display its Properties window.

Controlling Layout

Commands on the Field menu provide control over of the physical position of overlay fields in a document. The Selection tool can also be used to manually position overlay fields.

Moving Overlay Fields

The Selection tool moves overlay fields. Click on the tool, then click and drag on the overlay to be moved.

  • Selected overlay fields can be nudged using the arrow keys on the keyboard. The nudge increment is set in the Preferences dialog box.
  • When multiple fields are selected, dragging one of them moves all of them.

The distance that an overlay field moves when it is nudged depends on the current zoom level of the document as well as the nudge value that is set on the Document tab of the Edit > Preferences window.

Aligning Overlay Fields

Selected overlay fields can be aligned with commands on the Field > Align submenu. Alignment is based on the primary overlay. For example, when aligning left sides, the overlay fields’ left sides align with the left side of the primary overlay.

  • Left
  • Right
  • Top
  • Bottom
  • Vertical
  • Horizontal

Right-click on a selected overlay field and select alignment options from the Align submenu.

Centering Overlay Fields

Overlay fields can be centered on the document page. Select the overlay fields, then click Field > Center and select a specific command.

  • Vertical centers the field between the top and bottom of the page.
  • Horizontal centers the field between the left and right edge of the page.
  • Both centers the field vertically and horizontally.
Vertical Vertical Horizontal Horizontal Both Both

Right-click on a selected overlay field and select centering options from the Center submenu.

Spacing Overlay Fields

Overlay fields can be evenly distributed so that there is uniform space between them. Select the overlay fields, then click Field > Distribute and select:

  • Vertical to evenly distribute the fields between the uppermost selected overlay field and bottommost selected overlay field.
  • Horizontal to evenly distribute the fields between the leftmost selected overlay field and rightmost selected overlay field.

Right-click on a selected overlay field and select spacing options from the Distribute submenu.

Resizing Overlay Fields Manually

An overlay field can manually resized by dragging its selection handles or by using the keyboard to change the field size using the nudge increment set in Preferences. Selection handles appear on the bounding box of a selected overlay. They can be used to resize the overlay.

Resizing overlays with the mouse:

  1. Click the Selection tool .

  2. Select the overlay that is to be resized.

  3. Position the cursor over one of the selection handles.

  4. Click and drag toward the center of the overlay field to decrease its size. Click and drag away from the center of the overlay field to increase its size. Hold down the SHIFT key when dragging to constrain resizing proportionally.

Resizing overlays with the keyboard:

  1. Click the Selection tool.

  2. Select the overlay that is to be resized.

  3. Use the keyboard to change the overlay size:

  4. Decrease height by nudge value CTRL-UP ARROW

  5. Increase height by nudge value CTRL-DOWN ARROW

  6. Decrease width by nudge value CTRL-LEFT ARROW

  7. Increase width by nudge value CTRL-RIGHT ARROW

Resizing Overlay Fields Based on Primaries

Primary overlay field can be used as the standard by which to resize other overlay fields.

Resizing overlays based on the primary overlay:

  1. Select the overlay that is to serve as the primary overlay, then select the overlays to be resized.

  2. Click Field > Size.

  3. Select Height to apply the height of the primary overlay to the secondary overlays.
    OR
    Select Width to apply the width of the primary overlay to the secondary overlays.
    OR
    Select Both to resize the secondary overlays so they use both the height and the width of the primary overlay.

Right-click on a selected overlay field and select sizing options from the Size submenu.

Controlling Field Stack Order

Overlay fields are stacked in a document based on their order of creation. Each overlay that is created is positioned on top of previously created overlays.

When overlays overlap, the order in which overlays are stacked can be changed. Selected overlays can be moved up or down one level at a time.

Overlay 1 is moved up one level

A selected overlay can also be moved to the top or bottom of the stack order.

Overlay 1 is moved to the top of the stack order

Stack order result Command
Selected field is moved to the top of the stack order. Field > Order > Bring to Front
Selected field is moved to the bottom of the stack order. Field > Order > Send to Back
Selected field is moved up one level in the stack order. Field > Order > Bring Forward
Selected field is moved down one level in the stack order. Field > Order > Send Backward

Right-click on a selected overlay field and select ordering options from the Order submenu.

Managing Tab Order

The order in which mergable text overlays are accessed with the TAB key is referred to as the tab order. The default tab order of mergable text overlays is based on their order of creation and is automatically modified to accommodate new overlays, pasted overlays, or deleted overlays. This order also may be manually modified to structure a document for optimal onscreen usability.

Tab order affects the usability of documents, as seen here in the CSi IntelleDoc Advisor™

Viewing Tab Order

The Tools > Tab Order command activates Tab Order mode. This mode displays flags on mergable text overlay fields indicating their respective tab order. It also allows the tab order to be modified in the Document window.

Flag appearance when the tab order is not modified.

Flag appearance when the tab order is modified.

The tab order of an individual mergable field overlay is displayed in the Properties window.

Tab Values

Tab order is indicated with a unique number, either whole or decimal. The use of decimal numbers is meant to facilitate the customization of CSi stock documents, where a tab order exists for data entry fields that cannot be modified in Custom Document Editor. Decimal numbers allow mergable text overlays to be joined at any point in the existing sequence. For example, an overlay can be made the second field in a stock document’s tab sequence by assigning it the tab value 1.5.

Understanding Tab Order

Only one overlay field may occupy a given position in the tab order. As a result, tab order values must be unique within a given document. Changing the tab order value for one mergable text overlay affects the tab order of other overlays. Custom Document Editor automatically reassigns tab values in a manner that respects the original tab order of the fields.

For example, overlays 1, 2, 3, 4, and 5 exist in a document. Manually assigning the value 2 to field 4 results in field 2 changing to 3 and field 3 changing to 4.

Original tab order.

Tab order after changing 4 to 2.

Manually assigning the value 4 to field 2 results in field 4 changing to 3 and field 3 changing to 2.

Original tab order.

Tab order after changing 2 to 4.

Fields on Multiple Pages

The Page property of a mergable text field can be set so that the field appears on all pages of a document. In such cases, the tab order defined for the field on one page may not be logical on other pages.

When a field is set to appear on all document pages, Custom Document Editor sets its tab order to -1. This results in a tab order calculation based on the x, y position of the field on each page.

Modifying Tab Order

Modifying tab order with the Properties window:

  1. Select the mergable overlay field to be modified.

  2. If necessary, click Window > Properties to display the Properties window.

  3. Change the value in the TabOrder field as necessary. The field is automatically updated.

Press the ENTER key to display the Properties window for the selected overlay field or the primary overlay field when multiple fields are selected. Double-clicking on a selected overlay field also displays its Properties window.

Modifying tab order with Tab Order mode:

  1. Click Tools > Tab Order to activate Tab Order mode.

  2. To automatically assign values beginning with 1 and continuing sequentially, begin clicking on fields. The first field that is clicked is assigned 1, the second field click is assigned 2, etc.
    OR
    To assign values beginning with a selected number and continuing sequentially, hold down the CTRL key and click the field with the highest value that is to remain unchanged. This sets the base number. Continue holding down the CTRL key and click on each field that is to change. Those fields are assigned sequential numbers occurring after the base number.

  3. Click Tools > Tab Order when done to deactivate Tab Order mode.

Resetting Tab Order

The Edit > Reset Tab Order command alters the document tab order so that mergable text fields revert to their last defined tab order in the document.

![Before resetting tab order](ResettingTabOrder1.jpg)
Before resetting tab order
![After resetting tab order](ResettingTabOrder2.jpg)
After resetting tab order

Working with Datapoints

Datapoints hold the data that is used to populate documents with variable transaction data.

Datapoints can be added to a custom document by drawing them in the custom document with the Mergable Text tool or by dragging them into custom document from the Datapoints window.

Specifying Datapoint Dictionaries

Specifying a CSi standard dictionary:

  1. Make sure that a document is not open and that the Datapoints window is closed.

  2. Click Edit > Preferences and view the Dictionary tab.

  3. In the Standard Dictionary field, enter the file path for the dictionary or click the Browse button to search for it.

  4. Click OK. The imported datapoint dictionary is listed on the Standard Dictionary tab of the Datapoints window.

Specifying a partner datapoint dictionary:

  1. Make sure that a document is not open and that the Datapoints window is closed.

  2. Click Edit > Preferences and view the Dictionary tab.

  3. In the Partner Dictionary field, enter the file path for the dictionary or click the Browse button to search for it.

  4. Click OK. The imported datapoint dictionary is listed on the Partner Dictionary tab of the Datapoints window.

Specifying a custom datapoint dictionary:

  1. Make sure that a document is not open and that the Datapoints window is closed.

  2. Click Edit > Preferences and view the Dictionary tab.

  3. In the Custom Dictionary field, enter the file path for the dictionary or click the Browse button to search for it.

  4. Click OK. The imported datapoint dictionary is listed on the Custom Dictionary tab of the Datapoints window.

Sorting and Filtering Datapoints

Datapoints may be sorted by clicking on any column header on any Datapoints window tab.

Datapoints may be filtered for easier reference in the Datapoints window. All tabs except for the Standard Dictionary tab include a Filter text box at the bottom of the window is used to define the filter criteria. For example, entering “borrower” in the Filter text box limits the display of datapoints to those that include “borrower” in their name or description.

When the Use regular expressions option is active, regular expressions may be used to define the filter.

Working with the Standard Dictionary

The CSi Data Schema organizes transaction data into schema categories to efficiently manage the data that is required for a given transaction to be completed.

The Standard dictionary is a dictionary of data elements provided by CSi. It contains the data elements that appear on the CSi documents to which a business partner has mapped its data based on its location in the CSi Data Schema. The dictionary includes a CSi schema mapping path for each element. When transaction values are supplied to a custom document using these data elements, the values map to the correct location in the CSi Data Schema.

Because the Custom Document Editor is dedicated to the creation and maintenance of static documents, suffixed datapoints (which iterate for each instance of a repeated transaction value) are not supported. The CSi Standard dictionary is initially structured to include two instances of any given suffixed datapoint. For example, the dictionary includes two instances of last name for an account owner (c_gnl_name_misc_depositacctholderlastname_1 and c_gnl_name_misc_depositacctholderlastname_2) so that two account owners may be accommodated on the custom document.

Additional instances of suffixed data elements can be added as needed and saved in the Custom dictionary.

Standard Dictionary Content

The Standard Dictionary tab includes columns for information unique to schema-backed data elements. This information is helpful in locating and identifying the correct data elements to incorporate into a custom document.

Option Description
Entity Role Reports the Entity Role associated with the data element. Entity Roles refer to the function that an entity serves in a transaction.
Hierarchy Path Reports the simple path corresponding to the data elements location in the CSi Data Schema.

About Entity Roles

Entity Roles refer to the function that an entity serves in a transaction. For example, the ESADepositor in a Coverdell ESA transaction may also function as the ESAResponsibleIndividual in that transaction.

The use of Entity Roles mirrors real-world transaction characteristics, where a given element may function in multiple capacities in a particular transaction. Rather than document information pertaining to the entity multiple times, the CSi Data Schema captures it once and carries it forward for reference whenever it is required.

Standard Dictionary Filters

The Standard Dictionary tab includes filtering tools to help locate the correct data element to be incorporated into a custom document.

When AccountOwner is selected as the Entity Role and “last” is entered as the Text Search string, the Standard Dictionary list is filtered to those four data elements associated with the Entity Role AccountOwner that also include “last” in the data element name or description.

Option Description
Entity Role Allows specification of the Entity Role with which the data element is associated.
Text Search Allows specification of a text string that appears in the name or description of the data element.
Hierarchy Groups The CSi Data Schema organizes transaction data into schema categories to efficiently manage the data that is required for a given transaction to be completed. Hierarchy Groups allows specification of a schema location where the data element is located. For example, specification of Underwriting/Loan/Liability/CurrentMortgageOrRent lists only those data elements that are part of that schema group.
Clear All Filters Removes all filters so that the full Standard Dictionary list is displayed.

Standard Dictionary filters are cumulative. For example, setting an Entity Role and entering text in the Text Search field means that the data elements listed in the window must be associated with the specified Entity Role and contain the text string in their name or description.

Adding New Instances of Suffixed Data Elements

The CSi Standard dictionary is initially structured to include two instances of any given suffixed datapoint. For example, the dictionary includes two instances of last name for an account owner (c_gnl_name_misc_depositacctholderlastname_1 and c_gnl_name_misc_depositacctholderlastname_2) so that two account owners may be accommodated on the custom document.

Additional instances of suffixed data elements can be added as needed and saved in the Custom dictionary.

The Standard dictionary is read-only. While new instances are created from data elements on the Standard Dictionary tab, they are saved in the custom dictionary and appear on the Custom Dictionary tab.

Adding new instances of suffixed data elements:

  1. If necessary, view the Standard Dictionary tab or the Custom Dictionary tab of the Dictionary window.

  2. Right-click on the standard suffixed datapoint for which the additional instance is to be created.
    Suffixed datapoints included in the CSi Standard dictionary always end with an underscore and the number 1 or 2. For example, c_gnl_addr_misc_depositacctholderzip_2 is the ZIP code for the second instance of the suffixed deposit account holder. Suffixed datapoints included in the Custom dictionary may use a different naming scheme to indicate their suffixing sequence.

  3. Select New Instance from the context menu that appears.

  4. In the New Datapoint Instance window that appears, specify the name, description, and instance number for the new iteration of that data element. Generally, it is recommended that the number following the underscore in the datapoint name is made synchronous with the instance number. For example, name the third instance of a given datapoint datapoint_name_3.

  5. Click OK in the New Datapoint Instance window when done. The new datapoint is saved in the Custom dictionary file.

Adding Datapoints from Dictionaries

Datapoints are added to a custom document by manually drawing and naming them, or by dragging them into the document from the Datapoints window. Most of the time, the datapoints you add are included in a dictionary and can be dragged into documents.

The location of datapoint dictionaries must be set in Preferences before the dictionaries can be made available in the Datapoints window.

Dragging datapoints onto a document:

  1. If necessary, click Window > Datapoints to display the Datapoints window.

  2. View the FXL tab to add additional instances of datapoints that have already been saved in the custom document file.
    OR
    View the Standard, Partner, or Custom Dictionary tabs to add datapoints from a dictionary.

  3. Locate the datapoint on the list in the Datapoints window, then drag and drop it into a blank area in the Document window to create a new mergable text overlay field. Resize the new overlay field as necessary. The initial width of the overlay field is determined by the maximum number of characters allowed for the datapoint when that number is less than 51. When the maximum number of characters allowed is greater than 51, a width of 50 is used.
    OR
    Drag and drop the datapoint onto a mergable text overlay field that was already created.

You can drag multiple datapoints into the Document window. Click in the row selection bar to select the first datapoint, then hold down the CTRL key to select additional datapoints. To select a contiguous range of datapoints, click in the row selection bar to select the first datapoint, then hold down the SHIFT key to select the last datapoint.

Modifying Custom Datapoint Dictionaries

Datapoints can be added and removed from the Custom Dictionary tab in the Datapoints window.

All information on the Custom Dictionary tab can be modified, including the datapoint name, description, format, and maximum number of characters. To make a modification to existing datapoint information, click in the field that contains the text to be changed. The text is selected.

  • Press the BACKSPACE key to delete the selected text, then enter new text.

  • Click a second time in the field to position the cursor. Use the left and right arrow keys to move the cursor. Use the BACKSPACE key to remove individual characters to the left of the cursor. Enter new characters as necessary.

  • Press the TAB key to select the contents of the next text field.

  • Press SHIFT-TAB to select the contents of the previous text field.

Note that if the custom dictionary file is accessed from a network location by multiple users, modifications to the dictionary are only saved by the last user to exit the dictionary.

If the cursor is placed in a field for text modification, the context menu that appears when you right-click displays commands for Cut, Copy, and Paste. A Select All command is available if text in the field is not selected. A Delete command is available if text in the field is selected.

Adding and Removing Datapoints in Custom Dictionaries

The last row displayed on the Custom Dictionary tab of the Datapoints window is flagged with an asterisk in the gray selection bar. This row is a placeholder for new datapoint information.

Click in the placeholder row to define a new datapoint for the custom dictionary. By default, the new datapoint is named Unnamed. Make modifications to the datapoint as necessary.

A context menu is available when you right-click in the Custom Dictionary tab. It provides access to commands that support datapoint modifications in the custom dictionary.

Command Description
Add Adds a new row to the Custom Dictionary tab for the inclusion of a new datapoint. By default, the new datapoint is labeled Unnamed.
Delete Removes the selected datapoint from the Custom Dictionary tab. A prompt appears to confirm the deletion.

When a row is selected, the CTRL-INSERT and CTRL-DELETE key combinations add and delete datapoints, respectively.

If the cursor is placed in a field for text modification, the context menu that appears when you right-click and displays commands for Cut, Copy, and Paste. A Select All command is available if text in the field is not selected. A Delete command is available if text in the field is selected.

Creating Datapoint Calculation Scripts

A datapoint calculation script is JavaScript that is designed to calculate a value for a custom datapoint, usually from other datapoint values included in the transaction data set. The script is associated with the custom datapoint in question and automatically saved with the custom dictionary file. This allows the script to be available to any custom document in which the custom datapoint is incorporated.

The Custom Document Editor’s Script Editor window is used to author the JavaScript. When the Calculation Script command is used to open the window, the window initially opens with template content to begin the calculation script.

The last statement in the script must express the calculated value. For example:

This JavaScript block illustrates what a datapoint calculation script may look like, where CSi values of 1, 2, 3, and 4 are translated to more meaningful text labels:

var mappedValue : String = "";
var externValue : String = dataValues.GetValue( "LoanStatus" );
switch( externValue )
  {
    case "1":
      mappedValue = "Application";
    break;
    case "2":
      mappedValue = "Closing";
    break;
    case "3":
      mappedValue = "Denial";
    break;
    case "4":
      mappedValue = "Underwriting";
    break;
  }
value = mappedValue;

Creating datapoint calculation scripts:

  1. If necessary, view the Custom Dictionary tab of the Dictionary window.

  2. Right-click on the custom datapoint with which the calculation script is to be associated.

  3. Select Calculation Script from the context menu that appears.

  4. Enter the calculation script in the Script Editor window that appears.

  5. Click Save in the Script Editor window when done. The script is saved into the custom dictionary file.

When a script is associated with a custom datapoint, a small asterisk appears to the left of its name in the Custom Document tab of the Dictionary window.

Scripting

Scripts may be used to manipulate datapoint values before they are applied to a customized document. That scripting information can then be executed by the host.

A data manipulation script is a single script block containing a series of JavaScript statements that perform manipulation of input data values.

Creating and modifying data manipulation or shared scripts:

  1. Click Script > Data Manipulation.

  2. Make changes as necessary in the Script Editor window.

  3. To reference a datapoint name from the Datapoints window drag the datapoint from the Datapoints window to the Script Editor window.

  4. To perform a JavaScript validation check of the script syntax, click Validate.

  5. Click Save when finished.

Working in the Script Editor

A context menu is available when you right-click in the Script Editor window. It provides access to commands that support the scripting process.

Command Description
Undo Reverses the last action in the Script Editor window.
Redo Reinstates the last reversed action in the Script Editor window.
Cut Removes the selected text and places it on the internal clipboard.
Copy Copies the selected text and places it on the internal clipboard.
Paste Pastes copies of the selected text from the internal clipboard.
Delete Removes selected text from the Script Editor window.
Select All Selects all text in the Script Editor window.
Find Opens a dialog box for entering the text to be located. Enter it and click OK.
Replace Opens a dialog box for entering the text to be located and text to be used as its replacement. Enter the Find text and Replace text, then click Find to find the next instance of that text; Replace to replace the selected instance of that text; or Replace All to replace all instances of that text.
Go to Opens a dialog box for entering a line number. The Script Editor window scrolls so that the specified line number is at the top of the window. Enter the number, then click OK.
Print Opens the Print dialog box for printing the contents of the Script Editor window. The Options button in the Print dialog box provides additional control over the output.

The Script Editor window can be resized. Click and drag on the window edges.

Find and Replace

The Find/Replace dialog box includes options to refine the data search performed within the Script Editor window.

Command Description
Find what An edit box for entering the text to be located in the Script Editor window. Click the drop-down arrow to select from previous entries.
Replace with An edit box for entering the text to be substituted for the located text in the Script Editor window. Click the drop-down arrow []{#O_707 .anchor} to select from previous entries. 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: Clicking the button displays a list of tagged expressions that may be added to the Replace with edit box:
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 data will only locate data, not datapoint.
Search hidden text This option is not functional in this version of Custom Document Editor.
Search up Searches the Script Editor window from the location of the cursor up to the top of the window.
Use regular expressions Allows a list of regular expressions to be displayed and selected for inclusion as text characters to be located in the Script Editor window.
Prompt on replace Provides a confirmation dialog box before making a substitution of the Find text with the Replace text.
From cursor Searches the Script Editor window beginning at the cursor location.
Entire scope Searches the entire Script Editor window when Selection Only is not active. When Selection Only is active, the search is performed within the selection.
Selection Only Searches the selected content in the Script Editor window.
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.
Mark All Selects all instances of the Find text.

Debugging Scripts

Syntactical errors in a script can be identified by clicking the Debug button in the Script Editor window. If sample data is specified, the script is executed based on those data values.

The results appear in the lower portion of the window in the Results tab and Errors tab.

Using Sample Data

Sample data can be specified for the purposes of debugging a script. Click the Data button in the Data Manipulation Script window.

The data can be manually entered for the datapoints referenced in the script, or it can be loaded from an existing DXL file.

Option Description
Load Opens a dialog box to browse for the DXL file containing sample data to be used in testing the script.
Save Opens a dialog box for saving the sample data in a DXL file.
Datapoint Name The Datapoint Name list initially displays the datapoints referenced in the script. When a datapoint is selected from the list, its name and associated value, if any, appear in the edit boxes below the list. The value can be modified and updated. The datapoint name can be changed and added to the list as a new datapoint.
Value The Value list displays the values, if any, associated with datapoints. The value of a selected datapoint can be modified as necessary in the edit box below the list. Click the Update button when done to record the modified value.
Clear Removes all datapoints that appear in the Datapoint Name list.
Remove Deletes the selected datapoint from the window.
Update / Add Update records the modification made to a datapoint value. Add places a new datapoint on the list. Select a datapoint from the list and modify its name. Click the Add button to append it to the Datapoint Name List.
Close Closes the Data Values window.

Spelling Check

The contents of the Script Editor window may be checked for spelling errors. In the Script Editor window, click the Spelling button.

Command Description
Text Being Checked Highlights the text identified as potentially misspelled in the context of the script.
Replace with An edit box for entering the text to be substituted for the highlighted text. Type the replacement text here, then click the Replace or Replace All button.
Suggestions Displays potential substitutions for the highlighted text. Click on a suggested substitution to select it. It is copied to the Replace with edit box.
Ignore Disregards the highlighted instance of the text. If the text occurs again in the Script window, the Spelling check will prompt you again for a correction.
Ignore All Disregards the highlighted instance of the text and all subsequent instances of it in the Script window.
Add Places the text in the application dictionary. The text is then recognized as a correctly spelled word in spelling checks.
Replace Substitutes the selected text with the text entered in the Replace with edit box.
Replace All Substitutes the selected text and all subsequent instances of it with the text entered in the Replace with edit box.
Options Displays additional options for configuring the spelling check.

Spelling Options

Additional options for configuring the spelling check are available through the Options button in the Spell Check dialog box. The controls are displayed on the General tab.

Command Description
Ignore Words with Digits Disregards text strings that incorporate numeric characters from the spelling check.
Ignore Words in All Upper Case Disregards text strings typed in upper case letters from the spelling check.
Ignore HTML Tags Disregards HTML tags when performing the spelling check.
Maximum Suggestion Count Limits the substitution suggestions in the Spell Check dialog box to the number entered in the associated edit box.

Dictionary Information

To view information about the dictionary used by the application’s Script Editor, click the Spelling button in the Script Editor window, then click the Options button in the Spell Check dialog box.

  • The Dictionary tab displays dictionary copyright information.
  • The Versions tab displays version information.

Data Manipulation Script Sample

The sample script fragment below is constructed to perform the following functions:

  • Concatenate city, state, and ZIP code input values into a single datapoint value

  • Shift beneficiary names higher on the page to eliminate blank lines

// if cityStateZip datapoint has an empty value, create a value from the
// individual datapoints.

if( dataValues.GetValue("SIGAuthorizedSignerCityStateZip").Trim().Length == 0 )
{
  dataValues.SetValue( "SIGAuthorizedSignerCityStateZip",
    dataValues.GetValue("CustomerCity") + "," +
    dataValues.GetValue("CustomerState") + " " +
    dataValues.GetValue("CustomerZip") );
}

// if the first line has no value, bump up the following values
if( dataValues.GetValue("BName1").Trim().Length == 0 )
{
  dataValues.SetValue( "BName1", dataValues.GetValue("BName2") );
  dataValues.SetValue( "BName2", dataValues.GetValue("BName3") );
  dataValues.SetValue( "BName3", dataValues.GetValue("BName4") );
  dataValues.SetValue( "BName4", "" );
}

Keyboard Shortcuts and Modifier Keys

Many keyboard shortcuts and modifier keys available in Custom Document Editor. For more information about a particular command, refer to its description in the appropriate topic.

Keyboard Shortcuts

File menu Keys
Open CTRL-O
Save CTRL-S
Print CTRL-P
Edit menu Keys
Cut CTRL-X
Copy CTRL-C
Paste CTRL-V
Delete DELETE
Select All CTRL-A
Help menu Keys
CSi Custom Document Editor Help F1
Document Window Keys
Move to previous page PAGE UP
Move to next page PAGE DOWN
Move to first page CTRL-PAGE UP
Move to last page CTRL-PAGE DOWN
Zoom in ALT-UP ARROW
Zoom out ALT-DOWN ARROW
Fit to page HOME
Nudge selected overlay fields ARROW keys
Decrease height of selected field by nudge value CTRL-UP ARROW
Increase height of selected field by nudge value CTRL-DOWN ARROW
Decrease width of selected field by nudge value CTRL-LEFT ARROW
Increase width of selected field by nudge value CTRL-RIGHT ARROW
Display Properties window for selected overlay field or the primary overlay field when multiple fields are selected ENTER
In Tab Order mode, assign tab values based on a selected number and continue sequentially with each mouse click CTRL
Script Editor Window Keys
Find CTRL-F
Replace CTRL-H
Go to Line CTRL-G
Datapoints Window, Custom Dictionary tab Keys
Add datapoint CTRL-INSERT
Delete datapoint CTRL-DELETE

Modifier Keys

Document Window Keys
Select multiple overlay fields. Hold down CTRL and click; hold down CTRL and click and drag.
Constrain rectangle overlay field to a square as it is drawn. Hold down SHIFT and click and drag.
Constrain ellipse overlay field to a circle as it is drawn. Hold down SHIFT and click and drag.
Constrain line overlay field to angles of 45 degrees. Hold down SHIFT and click and drag.
Constrain resizing of overlay fields so that it is proportional. Hold down SHIFT and click and drag.
Rename a mergable text overlay field. Hold down ALT and click to put the overlay in rename mode. Type the name of the datapoint.
Enter text in a fixed text overlay field. Hold down ALT and click to put the overlay in edit mode. Type the text.
Datapoints Window Keys
Select multiple, non-contiguous datapoints to drag into the Document window. Hold down CTRL and click on datapoints to be selected.
Select multiple contiguous datapoints to drag into the Document window. Hold down SHIFT and click on the first and last datapoints in the contiguous series to be selected.

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.

hexadecimal

System using 16 rather than 10 as the base for representing numbers. The hexadecimal system uses the digits 0 through 9 and the letters A through F to represent the decimal numbers 0 through 15. For example, 1 is represented as 01 and 10 is represented as 0A or A. To prevent confusion with decimal numbers, hexadecimal numbers are usually followed by H or preceded by &, \$, #, or 0x.

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.

OCX

The ActiveX control file object representing the eDoc Utilities implementation in a platform system on a workstation via a container application.

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.

Appendix A – Datapoint Schema for Dictionary Tab

The datapoint schema specifies the manner in which datapoints appear in the Datapoint window’s Partner tab.

The limit attribute determines if only the specified datapoints are to be allowed. It is false by default.

Name Required. The name of datapoint.
Description Optional. A description of the datapoint. It becomes the basis of the mouse over help.
Format Optional. A CSi format identifier. For a list of formats, please see Datapoint Formats[]{#H_1040 .anchor} (see “Appendix D – Datapoint Formats” on page 113).
Maxcharacters Optional. Use 0 (zero) for unlimited or use any positive value. This value also controls the initial size of mergable text fields created when you drag datapoints from the Partner tab into a document.

Layout

<?xml version="1.0" encoding="UTF-8"?>
<datadictionary limit="true|false" >
  <datapoints>
    <datapoint>
      <name> ...datapoint name... </name>
      <description> ...datapoint descrition... </description>
      <format> ...CSi format name... </format>
      <maxcharacters> ...###... </maxcharacters>
    </datapoint>
    <!-- unbound list of datapoint -->
  </datapoints>
</datadictionary>

Schema

<?xml version="1.0" encoding="UTF-8"?>
<!-- edited with XMLSpy v2006 sp1 U (http://www.altova.com) by Keith McCreery (Compliance Systems, Inc.) -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
    <xs:element name="datapointdictionary">
        <xs:complexType>
            <xs:all>
                <xs:element ref="datapointlist"/>
                <xs:element ref="datatypelist" minOccurs="0"/>
            </xs:all>
        </xs:complexType>
    </xs:element>
    <xs:element name="datapointlist">
        <xs:complexType>
            <xs:sequence>
                <xs:element ref="datapoint" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:element name="datatype">
        <xs:complexType>
            <xs:all>
                <xs:element ref="hint"/>
                <xs:element ref="errormessage"/>
                <xs:element ref="valuelist" minOccurs="0"/>
            </xs:all>
            <xs:attribute name="name" use="required">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                        <!-- <xs:enumeration value="ActivityType"/>
                        <xs:enumeration value="DollarAmount"/>
                        <xs:enumeration value="EntityType"/>
                        <xs:enumeration value="EventType"/>
                        <xs:enumeration value="Number"/>
                        <xs:enumeration value="Ownership"/>
                        <xs:enumeration value="ProductType"/>
                        <xs:enumeration value="SocialSecurityNumber"/>
                        <xs:enumeration value="State"/>
                        <xs:enumeration value="TINStatus"/>
                        <xs:enumeration value="YesNo"/>
                        <xs:enumeration value="InstitutionType"/>
                        <xs:enumeration value="TFAProductType"/>
                        <xs:enumeration value="OneBasedNumber"/>
                        <xs:enumeration value="ZeroBasedNumber"/>
                        -->
                    </xs:restriction>
                </xs:simpleType>
            </xs:attribute>
        </xs:complexType>
    </xs:element>
    <xs:element name="datatypelist">
        <xs:complexType>
            <xs:sequence>
                <xs:element ref="datatype" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:element name="datatypename">
        <xs:simpleType>
            <xs:restriction base="xs:string">
                <!-- <xs:enumeration value="ActivityType"/>
                <xs:enumeration value="AlphaNumeric"/>
                <xs:enumeration value="DollarAmount"/>
                <xs:enumeration value="EntityType"/>
                <xs:enumeration value="EventType"/>
                <xs:enumeration value="Number"/>
                <xs:enumeration value="Ownership"/>
                <xs:enumeration value="ProductType"/>
                <xs:enumeration value="SocialSecurityNumber"/>
                <xs:enumeration value="State"/>
                <xs:enumeration value="TINStatus"/>
                <xs:enumeration value="YesNo"/>
                <xs:enumeration value="InstitutionType"/>
                <xs:enumeration value="TFAProductType"/>
                <xs:enumeration value="OneBasedNumber"/>
                <xs:enumeration value="ZeroBasedNumber"/>
                -->
            </xs:restriction>
        </xs:simpleType>
    </xs:element>
    <xs:element name="datapoint">
        <xs:complexType>
            <xs:all>
                <xs:element ref="shortdescription" minOccurs="0"/>
                <xs:element ref="longdescription" minOccurs="0"/>
                <xs:element ref="usagetype" minOccurs="0"/>
                <xs:element ref="datatypename" minOccurs="0"/>
                <xs:element ref="charactercount" minOccurs="0"/>
                <xs:element ref="defaultvalue" minOccurs="0"/>
                <xs:element ref="presentation" minOccurs="0"/>
            </xs:all>
            <xs:attribute name="name" use="required">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="static" type="xs:boolean" use="optional"/>
            <xs:attribute name="dynamic" type="xs:boolean" use="optional"/>
        </xs:complexType>
    </xs:element>
    <xs:element name="shortdescription">
        <xs:simpleType>
            <xs:restriction base="xs:string"/>
        </xs:simpleType>
    </xs:element>
    <xs:element name="longdescription">
        <xs:simpleType>
            <xs:restriction base="xs:string"/>
        </xs:simpleType>
    </xs:element>
    <xs:element name="usagetype">
        <xs:simpleType>
            <xs:restriction base="xs:string">
                <xs:enumeration value="structural_required"/>
                <xs:enumeration value="structural_conditional"/>
                <xs:enumeration value="structural_optional"/>
                <xs:enumeration value="data_required"/>
                <xs:enumeration value="data_conditional"/>
                <xs:enumeration value="optional"/>
            </xs:restriction>
        </xs:simpleType>
    </xs:element>
    <xs:element name="defaultvalue"/>
    <xs:element name="charactercount">
        <xs:complexType>
            <xs:attribute name="min" type="xs:integer" use="optional" default="1"/>
            <xs:attribute name="max" type="xs:integer" use="optional" default="0"/>
        </xs:complexType>
    </xs:element>
    <xs:element name="presentation">
        <xs:complexType>
            <xs:all>
                <xs:element ref="blankwidth" minOccurs="0"/>
                <xs:element name="format" type="formatType" minOccurs="0"/>
                <xs:element name="overflow" minOccurs="0">
                    <xs:complexType>
                        <xs:attribute name="shrinkToFitSize" type="xs:integer" use="optional" default="4"/>
                        <xs:attribute name="truncate" type="xs:boolean" use="optional" default="true"/>
                    </xs:complexType>
                </xs:element>
                <xs:element ref="alignment" minOccurs="0"/>
            </xs:all>
        </xs:complexType>
    </xs:element>
    <xs:element name="blankwidth"/>
    <xs:element name="alignment">
        <xs:simpleType>
            <xs:restriction base="xs:string">
                <xs:enumeration value="left"/>
                <xs:enumeration value="right"/>
                <xs:enumeration value="center"/>
                <xs:enumeration value="justified"/>
            </xs:restriction>
        </xs:simpleType>
    </xs:element>
    <xs:element name="hint">
        <xs:simpleType>
            <xs:restriction base="xs:string"/>
        </xs:simpleType>
    </xs:element>
    <xs:element name="errormessage">
        <xs:simpleType>
            <xs:restriction base="xs:string"/>
        </xs:simpleType>
    </xs:element>
    <xs:element name="value">
        <xs:complexType mixed="true">
            <xs:attribute name="label">
                <xs:simpleType>
                    <xs:restriction base="xs:string"/>
                </xs:simpleType>
            </xs:attribute>
        </xs:complexType>
    </xs:element>
    <xs:element name="valuelist">
        <xs:complexType>
            <xs:sequence>
                <xs:element ref="value" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
            <xs:attribute name="min" type="xs:integer" use="optional"/>
            <xs:attribute name="max" type="xs:integer" use="optional"/>
        </xs:complexType>
    </xs:element>
    <xs:simpleType name="formatType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="alphadate"/>
            <xs:enumeration value="alphadollar"/>
            <xs:enumeration value="alphamonth"/>
            <xs:enumeration value="alphanumber"/>
            <xs:enumeration value="alphaordinal"/>
            <xs:enumeration value="capitalize"/>
            <xs:enumeration value="dollar"/>
            <xs:enumeration value="dollarroundup"/>
            <xs:enumeration value="dollarrounddown"/>
            <xs:enumeration value="dollarroundnearest"/>
            <xs:enumeration value="exactpercent"/>
            <xs:enumeration value="fourdecimaldown"/>
            <xs:enumeration value="fourdecimalround"/>
            <xs:enumeration value="fourdecimalup"/>
            <xs:enumeration value="mm dd yyyy"/>
            <xs:enumeration value="mm/dd/yyyy"/>
            <xs:enumeration value="mmm dd, yyyy"/>
            <xs:enumeration value="mmm. dd, yyyy"/>
            <xs:enumeration value="noformat"/>
            <xs:enumeration value="notarydate"/>
            <xs:enumeration value="notarydatenumericday"/>
            <xs:enumeration value="number"/>
            <xs:enumeration value="numericordinal"/>
            <xs:enumeration value="odometer"/>
            <xs:enumeration value="percent"/>
            <xs:enumeration value="phone"/>
            <xs:enumeration value="ssn"/>
            <xs:enumeration value="tid"/>
            <xs:enumeration value="yieldpercent"/>
            <xs:enumeration value="zip"/>
        </xs:restriction>
    </xs:simpleType>
</xs:schema>

Appendix B – Feature Availability

Custom Document Editor is available in two modes, Full and Lite. All release features are available in Full mode. Certain features are not available in Lite mode and are described below. When the application is run using Lite mode, the application title bar refers to Custom Document Editor Lite.

Only files created in Lite mode can be opened in Custom Document Editor Lite. When Custom Document Editor is used in Full mode, all files created with Custom Document Editor can be opened.

To enable Full mode, a valid license key must be entered on the Licensing tab of the Preferences dialog box. See the topic Licensing Tab (on page 24) for information about entering license key information in Custom Document Editor Preferences.

Features Unavailable in Lite Mode

  • Document input and output

    • File > New > From Image File.
    • File > New > From PDF File.
    • File > New > Blank There are restrictions on page size. The width of new documents may be no greater than 8500 pels (8.5 inches) and the height of new documents may be no greater than 11,000 pels (11 inches).
    • Document > Add Page.
    • Document > Replace Page.
    • Document > Delete Page.
  • Overlay fields

    • Image overlay fields cannot be created.
    • Shape overlay fields (Line, Rectangle, and Ellipse) cannot be created.
  • Datapoints

    • The Datapoints window does not include the FXL tab or the Current tab.
  • Context menus

    • The context menus (accessed by right-clicking) are not available for overlay fields or for the Document window.

Appendix C – Logging

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

Appendix D – Datapoint Formats

Datapoint formats supported in CSiScript and available for selection as a property of mergable text overlays are described below.

Name Format Description/Example
alphadate Month dd, Year January 1, Two Thousand and Two
alphadollar Two Thousand Four Hundred Fifty-seven and 35100 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,5682
If data entered is = 4567.49 Expected display = 4,568
dollarrounddown XXX,XXX,XXX If data entered is = 4567.56 Expected display = 4,5672
If data entered is = 4567.49 Expected display = 4,567
dollarroundnearest XXX,XXX,XXX If data entered is = 4567.56expected display = 4,5682
If data entered is = 4567.4 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

Appendix E – Fixed Text Embedded Datapoints and Character Attributes

Datapoints may be embedded in fixed text overlay fields using the Data section of the Properties window. When the CSiScript option is set to True, CSi script tags are recognized as tags so that their respective functions can be performed.

In addition, certain character attributes may be embedded with the data in a datapoint or with the static text labels within a fixed text overlay field. Attributes may be combined in any sequence as long as an attribute’s tag pairing is maintained.

Attribute Tag Example Output
Datapoint insertion <datapoint name=“dp”/> Today’s date: <datapoint name=“date_datapoint” /> Today’s date: January 1, 2006.
Bold <bold> </bold> The <bold>lazy</bold> dog. The lazy dog.
Italics <ital> </ital> The <ital>lazy</ital> dog. The lazy dog.
Strikeout <strike> </strike> The <strike>lazy<strike> dog. The lazy dog.
Subscript <sub> </sub> The <sub>lazy</sub> dog. The lazy dog.
Superscript <super> </super> The <super>lazy</super> dog. The lazy dog.
Underline <under> </under> The <under>lazy</under> dog. The lazy dog.
New line <printline/> The lazy dog.<printline/>The quick fox. The lazy dog.
The quick fox.
Tab <tab/> <tab/>The lazy dog.     The lazy dog.