iDocument

iDocument Overview

iDocument is an application designed to assist technical staff with documenting their iMIS and database instances. It allows you to associate notes and other metadata with various entities in iMIS (i.e. Activities and IQAs), or objects in the database (i.e. Tables or Jobs). 
iDocument can also generate a documentation file containing all of the notes that have been entered, which you can then save as an .html file and include in a website.

iDocument System Requirements

The following system specifications are required to successfully run iDocument:

• Windows 7 or higher or Windows Server 2008/2008R2/2012

• iMIS 15.2 or higher

• SQL Server 2008/2008R2/2012/2014

• Microsoft .Net Framework 4.0

• Browser Recommendation: Internet Explorer 9 or higher

• UDP port 1434 must be open on the SQL server

Useful Terms

Entity Any "top-level" item in the left column (i.e. table, activity, job, or report). 

Field Any "second-level" item in the right column (i.e. column or field).

Metadata Any user-editable information entered for an entity or field. 

Installing iDocument

Note: It is best practice for all users to be on the same version of iDocument.

1. Download iDocument from https://customer.csiinc.com/ to your workstation.

   1. You will need your CSI Website User Name and password. If you do not have this information contact support@csiinc.com

2. Unzip the folder, and navigate to the unzipped folder.

3. Right mouse click on the Setup.exe and run as Administrator.

4. You will be prompted, asking if you want to allow the program to make changes to your computer. Click Yes.

5. The Setup Wizard will open. Click Next.

6. The license Agreement will display. Select "I accept..." and Click Next.

7. Verify the default installation folder. Click Install.

8. A screen will then show, displaying the progress of the install.

9. A screen will confirm that iDocument has been successfully installed. Click Finish.

iDocument Setup

iDocument Launch and Login

1. Launch iDocument from Start > All Programs > CSI Programs > iDocument

2. Log into iDocument using your iMIS user name and password.

   1. Note: If this is your first time using iDocument, you may be prompted for a license key. If so, please enter the one CSI provided. If you need a new license key, please contact support@csiinc.com. If you are simply running iDocument in Trial Mode, select "Start in Trial Mode" and click OK. 

   2. If you select Trial Mode, you will receive the warning below. Click OK to continue: 

   3. 

3. You may be prompted for your database SA credentials. If you do not wish to enter this information, some of the features of iDocument will be limited.

4. The first time you connect iDocument to a database, it must run an initialization script. To work, this script requires table creation rights on the "dbo" object for the iMIS SQL user. Click OK.

You are now ready to use iDocument. 

About the License Key

The first time logging in to iDocument will no longer prompt you for a License Key as the product is designed to auto-license. If you get prompted for a License Key at any point during the installation process, please reach out to our Application Support at support@csiinc.com so we can help troubleshoot!

Using iDocument

iDocument supports creating and storing notes ("metadata") against various iMIS and database-related entities.

Supported Documentation Areas

iDocument includes the following areas for documentation:

iMIS

• Activities

  • View fields for each activity

  • For each field, view: iMIS Prompt, underlying data field and field type

• User Windows

  • View fields included on each window

  • For each field, view: iMIS Prompt, underlying data field and field type, lookup table, source table and field

  • The 

    

     icon will appear in the User Window list next to a window name if the window is a Panel Editor window.

• Business Objects

  • Browse BO folders and view objects in each folder

  • For each business object, view object details including source tables, columns, and branch hierarchy

• IQAs

  • Browse IQA folders and view queries in each folder

  • For each query, view query details including columns, sources, relationships, filters, sorts, and query options

Note: The IQA view filters out the $/WebFormZAttachments/ folder, and all its sub-folders.

• Reports

  • View reports grouped by category and iMIS System

  • For each report, view the iMIS description for the report

• Panel Sources

  • View panel sources created in RiSE Panel Editor interface

  • For each panel source, view the fields for that source and information about the field like its field type

• Panel Definitions

  • View panel definitions, and view the panel layout as it appears in RiSE

  • Foe each field on the panel, view field information and the source object it references

Database

• Tables

  • View columns on each table

• Views*

  • View columns on each view

• Stored Procedures*

  • View parameters on each stored procedure

• Functions*

  • View parameters on each function

• Jobs

  • View steps for each job

  • View last run information, step types, step commands, job state, associated schedule name

• Triggers*

  • View all triggers active in the database, grouped by table or view name

  • For each trigger, view operations (Insert/Update/Delete), when the trigger occurs (On insert, or Instead of), and the source code for the trigger

• View the source code for this object by clicking the "View Source" button after selecting an entity. A new window will open with the source code. On the window, you can select "Word Wrap" to wrap long lines of text, and "Striped View" to highlight every other line of code. 
  Browsing Entities and Fields

  To browse through each category, select a tab on the left side of the application to jump to that category. 
  

  

   
  A list of top-level entities will load in the first list box. Click to view information about that entity. 
  Note: Items with 

  

   indicate that that entity (or one of its fields) contains metadata. 
  Once an entity has been selected, the second list will populate with the entity's fields. 
  When you have clicked on either an entity, or a field, the right-most column will contain information about the selected item, as well as fields for editing the metadata associated with that item. 
  Note: Both top-level entities (such as tables or activities), and fields (such as columns) can have metadata associated with them. Be sure to note which item has been selected from both lists on the left. 
  Tip: To select the parent entity after selecting a field (e.g. to select the parent table after one of its columns has been selected), simply click again on the table name in the list on the left.

  Entering Notes and Other Metadata

  Entering Notes

  You can enter notes in the fields that are displayed in the column to the right.

1. Selecting either an entity or a field.

2. Enter your notes.

   1. Notes are saved automatically.

Editing Notes

After making changes, if you would like to undo your changes and revert to the original notes…

1. Click Cancel.

2. You will be prompted to confirm the cancellation. Click Yes.

Tip: For faster editing/navigation:

• PageUp: selects the previous field in the list

• PageDown: selects the next field in the list

• Ctrl+PageUp: selects the previous entity in the list

• Ctrl+PageDown: selects the next entity in the list.

Remember: iDocument automatically saves your notes, so as soon as you navigate to the next or previous item, your notes will be saved.

Filtering Entities / Fields

You can filter each category independently by clicking on the blue Filter 

• Show all items: Show all items in the system.

• Show only items with metadata: Show only items that have associated notes.

Additionally, the Report category has an additional filter. This is available as a checkbox above the entity list box when viewing the Report category.

• Show All Reports: Shows all reports, not just custom reports. By default, only custom (non-system) reports are shown.

Generating Documentation

To generate documentation:

1. Click the blue "Generate Documentation" button in the lower-right corner of the application.

   1. You will be presented with some options for generating your documentation. 

   2. 

2. First, select the categories/areas you would like to include.

   1. Note: You must include at least one. 

3. Select whether or not you would like to include all items, or only items with metadata.

   1. All Items: Retrieves every item of that type from the system. So, if you select "Tables" and select "All Items", every table in the "dbo" object on the SQL server will be included.

   2. Only items with metadata: Only retrieves an item if it contains metadata. Only applies to entities. For example, if you write notes on 2 prompts for an activity, that activity will be included in the documentation along with all of its prompts (not just those with documentation)

4. Select the type of export you would like to perform.

   1. HTML: Generates an HTML document of the selected items.

   2. PDF: Generates a PDF document of the selected items. Note, this option may take a few minutes to generate the documentation.

   3. Word: By saving the document as a PDF, you can open through word to convert it to a Word documen

5. (Optional) Include text that will be included in the header of the document.

6. Click Generate.

Note: Depending on which options were selected, and your connection speed to the SQL server, this process may take some time.

Options

iDocument Settings

iDocument has user-configurable settings. These can be accessed by clicking Settings in the top-right corner of the application. 

Database Filters

Filters can be independently applied to each of the five types of database entities. 
Filters support the use of wildcards. Use % to match one or more characters, and _ to match a single characters. 
Multiple filters can be applied. Use ; to separate multiple filters. 
Example: To filter out all tables except CSI tables, Name tables and User tables, you would use the filter:
csi_%; Name%; User%; 

HTML Output Options

There are some options available on the HTML document that is generated: 

• Copy to Clipboard: Copies the HTML document onto the clipboard, in order to be pasted into another rich text editor.

• Save…: Opens a Save dialog box so that the generated document can be saved. Available file format options are .htm/.html (for viewing in a web browser), and *.txt (for viewing or modifying the HTML source).

iDocument Troubleshooting

If you have any issues with iDocument, please contact CSI Support at support@csiinc.com. Tickets are normally responded to within 1 to 2 business days after they are submitted.

iDocument Release Notes