ECMS - Add Application Plan Dictionary Elements‌

This document explains adding dictionary elements‌ to Application Plans


What are dictionary elements‌

The dictionary is a repository containing all defined screen elements in an application plan. You can capture an unlimited amount of metadata, as well as associate dictionary data elements to document index keys, custom properties, and project properties.

How to add dictionary elements

  1. Go to Application Plan Designer > Dictionary and click the New Field image button.
    • Note: You can also add data elements to the dictionary by using the mouse to highlight the data in the captured window that you want to define and dragging it to the bottom of the data element list in the Dictionary pane.
  2. In the Dictionary Field dialog box, under General, do the following actions:
    • In the Name box, type a unique name for your new data element.
    • Under Processing, do one of the following actions:
      • Macros
        • Click Add, then select Macro.
        • In the Select Macro dialog box, select one of the following predefined macros, then click OK:
          • Alpha Numeric
            • Alphanumeric Characters Only - If you want the system to remove non-alphanumeric characters from the output string, select Alphanumeric Characters Only. This includes all symbols and punctuations.
            • Alpha Characters Only - If you want the system to remove non-alphabetic characters from the output string, select Alpha Characters Only.
            • Numeric Characters Only - If you want the system to remove non-numeric characters from the output string, select Numeric Characters Only.
          • Concatenation - If you want the system to join two dictionary data elements, select Concatenation.
          • Date Conversion - If you want the system to display the date in a specific format, select Date Conversion.
          • Delete Characters - If you want the system to remove specific characters from the output string, select Delete Characters.
          • Fixed Length - If you want the system to limit the number of characters and digits in the output string, select Fixed Length.
          • Line Search - If you want the system to capture a value on a specific line, select Line Search.
          • Number Conversion - If you want the system to display a number string in a specific format, select Number Conversion.
          • Split at Delimiter – If you want the system to capture a value in a string that is separated by a delimiter character, select Split at Delimiter.
          • Static Search - If you want the system to capture a value based on a specific string, select Static Search.
          • Trim Character - If you want the system to remove characters from the output string, select Trim Character. Note - For more information on applying macros, refer to the Processing book in Application Plan Designer Help.
          • Scripts
            • Click Add and then select Script.
            • In the Scripts dialog box, do one of the following:
              • Select the script you want the system to execute on the dictionary field.
              • Click Create and then create the script as you normally would.
              • Click OK. Note - For more information on applying scripts, refer to the Processing book in ImageNow Application Plan Designer Help.
  3. Optional. In the Dictionary Field dialog box, under Sample, do one of the following actions:
    • If you selected a macro as your processing type, type an example of the unaltered data in the Input box. The system displays the expected Results below.
    • If you selected a script as your processing type, type an example of the unaltered data in the Input box. Click Refresh to update the Results and verify the script returns the correct data.
  4. Click OK to save your changes.

Define a dictionary element

The dictionary is a centralized repository containing a single listing of all the data elements available within a single application plan. Data elements are the screen elements that ImageNow captures from the business application. Each data element can be defined for more than one business application screen. For example, if you have an account number on your first host screen and second host screen, you only need to define it once.

Define a dictionary data element using Internet Explorer‌

Use the following procedure to learn a web-based application.

  1. Start your web browser, type the URL of the application you want ImageNow to learn, and then navigate to an active record.
  2. In Application Plan Designer, on the Elements tab, select Internet Explorer from the Method list. The system captures a tree containing the controls on the host screen and displays it in Application Plan Designer.
  3. A list of controls appears in the captured window. Scroll down the list as needed to show the various controls from the program. Each row represents an available control. The left column lists the type of control. The right column of the line displays the current data for the control. The screen identifier is the data on your host screen that uniquely identifies the screen.
  4. Do one of the following actions to add a data element:
    • If the data element is already added to the dictionary, point to the appropriate control you want to define, and then drag it to the appropriate data element in the Dictionary pane.
    • If the data element is not in the dictionary, click the appropriate control you want to add and define, and then drag it to the bottom of the data element list in the Dictionary pane.
  5. In the Dictionary Field dialog box, add the data element as you normally would.

Define a dictionary data element using Terminal Capture

Use the following procedure to learn a terminal emulator program or mainframe program.

  1. Start your terminal emulation program and log in.
  2. Open the screen in the host program that you want ImageNow to learn and navigate to an active record.
  3. In Application Plan Designer, on the Elements tab, select Terminal Capture from the Method list.
  4. Click Settings.
  5. In the Terminal Capture Settings dialog box, do the following actions:
    1. In the Connect Strings box, type the connect string.
    2. In the Retries box, type the number of times you want the system to attempt to connect to the terminal emulation program.
    3. In the Delay (milliseconds) box, type the length of time you want the system to wait between connection attempts.
  6. The system copies the screen contents of the screen and displays it in Application Plan Designer.
  7. Do one of the following actions to add a data element:
    • If the data element is already added to the dictionary, use the mouse to drag a box around the data in the captured window that you want to define, and then drag it to the appropriate data element in the Dictionary pane.
    • If the data element is not in the dictionary, use the mouse to drag a box around the data in the captured window that you want to define, and then drag it to the bottom of the data element list in the Dictionary pane.
  8. In the Dictionary Field dialog box, add the data element as you normally would.
  9. Repeat these steps for each data element you want to define.

Define a dictionary data element using Viewpoint‌

Use the following procedure to learn GUI applications that conform to the Windows interface design.

  1. Complete one of the following actions:
    • Start your Windows business application and open the window that you want ImageNow to learn.
    • Start your web browser and type the URL of the business application you want ImageNow to learn.
  2. Navigate to an active record.
  3. In Application Plan Designer, on the Elements tab, select Viewpoint from the Method list. The system captures a screen shot of the host window and displays it in Application Plan Designer.
  4. Optional. If you are using Viewpoint with a browser-based business application, complete the following steps:
    1. Click the Enable point dialog button.
    2. On the bitmap, position the pointer on the appropriate area where the business application is located and click the mouse. ImageNow removes unrelated browser-based components, such as toolbars and menus, from the bitmap and leaves on the business application you are trying to integrate.
  5. Do one of the following actions to add a data element:
    • If the data element is already added to the dictionary, point to the business application field you want to define, and then drag it to the appropriate data element in the Dictionary pane.
    • If the data element is not in the dictionary, click the business application field you want to add and define, and then drag it to the bottom of the data element list in the Dictionary pane.
  6. In the Dictionary Field dialog box, add the data element as you normally would.
  7. Repeat these steps for each data element you want to define.

Define a dictionary data element using Window Walker

Use the following procedure to learn GUI applications that conform to the Windows interface design.

  1. Start your Windows business application, and open the window that you want ImageNow to learn.
  2. Navigate to an active record.
  3. In Application Plan Designer, on the Elements tab, select Window Walker from the Method list. The system captures a tree containing the controls on the host window and displays it in Application Plan Designer.
  4. You will see a list of window controls displayed in the captured window. Expand the list as needed to show the various controls from the program. Click the PLUS SIGN (+) to expand the tree. Each row in the tree represents an available control. The first part of the row lists the type of control. The second part of the line (to the right of the arrow) displays the current data for the control. For example, [+]...ThunderRT6MDIForm>PSI Higher Ed Demo.
  5. Do one of the following actions to add a data element:
    • If the data element is already added to the dictionary, point to the business application control you want to define, and then drag it to the appropriate data element in the Dictionary pane.
    • If the data element is not in the dictionary, click the business application control you want to add and define, and then drag it to the bottom of the data element list in the Dictionary pane.
  6. In the Dictionary Field dialog box, add the data element as you normally would.
  7. Repeat these steps for each data element you want to define.

Map to a document

After your dictionary data elements are defined, you use document mapping to create and link documents using data from your business application. Document mapping allows you to map your data elements in the dictionary to document keys and custom properties. This mapping enables you to select the data from your business application that is used to categorize and display your documents in ImageNow.

You can quickly map elements by using drag and drop elements from the dictionary to your document keys and custom properties. When the name of your dictionary element matches a custom property name, you can automatically populate the value of your custom properties with the values of your dictionary element. You can also test the mapping you define directly in Application Plan Designer.

  1. In Application Plan Designer, click the Document Map tab.
  2. In the Screens pane, select the screen for which you want to enable document mapping.
  3. Select Enable Document Mapping to allow document mapping for this screen.
  4. For each property that you want to assign a value, do the following:
    • Drawer
      1. Double-click the Drawer document key.
      2. In the Drawer Attributes dialog box, under General, do one of the following:
    • System Drawer
      1. From the Source list, select System Drawer.
      2. From the Drawer list, select the system drawer you want to associate to this document key.
    • System Drawer List
      • If you want to allow the user to select from a list of drawers to which he or she has access, select System Drawer List from the Source list.
    • Dictionary
      1. From the Source list, select Dictionary.
      2. From the Dictionary list, select the dictionary data element you want to associate with this document key. Note - Dictionary is only an option if you have data elements defined in the dictionary.
    • Folder, Tab, Field3, Field4, and Field5
      1. Double-click the Folder, Tab, Field3, Field4, or Field5 property.
      2. In the <Property> Attributes dialog box, under General, do one of the following:
        • If you want this property to share a value with a data element in the dictionary, select Dictionary from the Source list, and then select the appropriate data element from the Value list. Note - Dictionary is only an option if you have data elements defined in the dictionary.
        • If you want the value of this property to be empty, select Undefined from the Source list.
        • If you want to apply a literal value to this property, select Literal from the Source list, and then type the value in the Value box.
        • If you want the user to enter a value for this property during the linking process, select User Entry from the Source list.
        • If you want the user to select from a list of predefined values during the linking process, select Predefined List from the Source list, and then select the appropriate list from the Value list.
        • If you want to set the value of this property to the name of the current user, select Username (Current) from the Source list.
        • If you want to set the value of this property to the name of a user from a predefined list, select Username (Select) from the Source list.
        • If you want to assign the current date to this property, select Current Date/Time from the Source list.
        • If you want to use a published sequence to acquire a new value for this property, select Sequence Number from the Source list, and then select the appropriate sequence from the Value list.
        • If you want the system to provide a unique ID to this property, select Unique ID from the Source list.
      • Document Type
        1. Double-click the Document Type property.
        2. In the <Property> Attributes dialog box, do one of the following:
      • Document Type
        1. From the Source list, select Document Type.
        2. From the Value list, select the document type you want to associate with this property.
      • Document Type List
        1. Select Document Type List from the Source list.
        2. From the Value list, select the document type list you want to associate with this property. Note - Click Edit List if you want to edit the selected document type list.
      • Dictionary
        1. From the Source list, select Dictionary.
        2. From the Dictionary list, select the dictionary data element to which you want to associate with this property. Note* - Dictionary** is only an option if you have data elements defined in the dictionary.
  5. Optional. Under Advanced, do the following:
    • If you want the system to display something other than the default label, enter the name in the Alternate label box.
    • If you want the system to associate a script to this property, select the script from the Script list.
    • If the value of the property can be empty, select Allow empty.
    • If the value of the property can be modified by the current user during the linking process, select User modifiable.
    • If you want ImageNow to remember the last user-modifiable value, select Remember last value.
    • If you want this property to overwrite the proposed key, select Overwrite proposed key.
  6. Click OK.
  7. Close Application Plan Designer.

Map to a project

After your dictionary data elements are defined, you use project mapping to automatically create new projects during the linking process. This mapping enables you to select the data from your business application that is used to categorize and display your projects in ImageNow.

If a project already exists for a defined type and name, ImageNow automatically adds the document to that project. You can also specify which type of project (or document) to create and which custom properties can be automatically populated. In Application Plan Designer, click the Project Map tab.

  1. In the Screens pane, select the screen for which you want to enable project mapping.
  2. Select Enable Project Mapping to allow project mapping for this screen.
  3. For each property that you want to assign a value, do the following:
    • Project Name
      1. Double-click the Project Name property. Note - When you clear the Enable Document Mapping check box on the Document Map tab, the Document Custom Property and the Document Key options do not appear in the Source list.
      2. In the Project Name Attributes dialog box, under General, do one of the following:
        • If you want this property to map to a document key, select Document Key.
        • If you want this property to map to a document custom property, select Document Custom Property. Note - Document Custom Property only appears in the Source list if a custom property is linked to the selected document type.
        • If you want this property to share a value with a data element in the dictionary, select Dictionary from the Source list, and then select the appropriate data element from the Value list. Note - Dictionary is only an option if you have data elements defined in the dictionary.
        • If you want the value of this property to be empty, select Undefined from the Source list.
        • If you want to apply a literal value to this property, select Literal from the Source list, and then type the value in the Value box.
        • If you want the user to enter a value for this property during the linking process, select User Entry from the Source list.
        • If you want the user to select from a list of predefined values during the linking process, select Predefined List from the Source list, and then select the appropriate list from the Value list.
        • If you want to set the value of this property to the name of the current user, select Username (Current) from the Source list.
        • If you want to set the value of this property to the name of a user from a predefined list, select Username (Select) from the Source list.
        • If you want to assign the current date to this property, select Date/Time from the Source list.
        • If you want to use a published sequence to acquire a new value for this property, select Sequence Number from the Source list, and then select the appropriate sequence from the Value list.
        • If you want the system to provide a unique ID to this property, select Unique ID from the Source list.
    • Project Type
      1. Double-click the Project Type property. Note - When you clear the Enable Document Mapping check box on the Document Map tab, the Document Custom Property and the Document Key options do not appear in the Source list.
      2. In the Project Type Attributes dialog box, under General, do one of the following:
    • Document Key
      1. From the Source list, select Document Key.
      2. From the Value list, select the document key you want to associate to this property.
    • Document Custom Property‌
      1. From the Source list, select Document Custom Property. Note - Document Custom Property only appears in the Source list if a custom property is linked to the selected document type.
      2. From the Value list, select a document custom property.
    • Project Type
      1. From the Source list, select Project Type.
      2. From the Value list, select the project type you want to associate to this property.
    • Project Type List
      1. Select Project Type List from the Source list.
      2. From the Value list, select the project type list you want to associate to this property. Note - Click Edit List if you want to edit the selected project type list.
    • Dictionary
      1. From the Source list, select Dictionary.
      2. From the Dictionary list, select the dictionary data element you want to associate with this property. Note - Dictionary is only an option if you have data elements defined in the dictionary.
  4. Optional. Under Advanced, do the following:
    • If you want the system to display something other than the default label, enter the name in the Alternate label box.
    • If the value of the property can be empty, select Allow Empty.
    • If the value of the property can be modified by the current user during the linking process, select User Modifiable.
    • If you want ImageNow to remember the last user-modifiable value, select Remember last value.
    • If you want this property to overwrite the proposed key, select Overwrite proposed key.
  5. Click OK.
  6. Close Application Plan Designer.



Keywords:Imaging Imaging System WebNow ImageNow perceptive content ecm ecms enterprise content management imaging imagenow perceptive add dictionary elements‌ application paln   Doc ID:62002
Owner:Guy S.Group:ECMS
Created:2016-03-17 09:20 CDTUpdated:2016-05-02 19:43 CDT
Sites:DoIT Help Desk, ECMS
Feedback:  0   0