Configuring the Word Component

This section describes how to configure the Word component.

  1. Double-click the Word component icon .
    The Word Component Editor appears.
  2. From the Word Component Editor, determine if you want to use an existing Microsoft Word document as a template or create a new document:

    • To open an existing document:

      In the Starting Document area, click Browse and navigate to the document that you want to use.

      Microsoft Word starts with the document opened. When an existing document is opened, it is copied into the system temporary directory and all modifications are made to that document. The original document remains unchanged.

    • To create a new document:

      In the Starting Document area, click the button.

      Microsoft Word starts with a new file opened.

    You can open only one document at a time in the Word Component Editor. If you open another existing document or create another document, Isight closes the previously opened document.

    Important: If you manually close the Microsoft Word document that was opened by the editor, the editor does not recognize your action. You must click OK to close the editor and re-open the editor.

  3. (optional) Map parameters individually:
    1. Select the area or place the mouse pointer in the document where you want the parameter value to appear.
    2. You can insert parameter values into a Microsoft Word table in the document by selecting the cell locations.
    3. Bring the component editor back into the foreground.
    4. In the Parameter to insert list, click a parameter.

      You can sort the parameters in the list by component. Right-click in the list, and select Group Parameters. The setting is saved as a preference for this component. There is a Preference option to set the initial default for this option for all applicable component editors. You can also choose to not group parameters for the currently selected component. For more information about Preference options, see Setting Parameter Preferences in the Database in the Isight User’s Guide.

      To create new parameters, click the button. Once created, you can map the parameter into the document.

      For scalar parameters, if you want the parameter to be inserted in the format <name> = <value>, click the Insert as <name> = <value> check box. Otherwise, Isight inserts only the parameter value.

      To insert the contents of a file (image files only) into the document, select an appropriate file parameter.

      For array parameters, specify the starting index and ending index of the part of the array that you want to insert. The parameter value for every specified element will be inserted with a line break between each element.

    5. Click the button.

      The parameter is mapped, and the parameter name is displayed in the document in highlighted text.

    6. Repeat the above steps for each parameter that you want to map.
  4. (optional) Map all available parameters:
    1. Select the area or place the mouse pointer in the document where you want the parameter value to appear.

      You can insert parameter values into a Microsoft Word table in the document by selecting the cell locations.

    2. Bring the component editor back into the foreground.
    3. Click the button to insert a <name> = <value> list.

      Isight adds a name-value pair table to the document in the location specified. All supported parameters in the component are listed.

  5. (optional) Execute any macros that are defined within the specified document.
    1. In the Instructions area, click the Macros subtab.

      Note: If Microsoft Word security settings or document password protection do not allow the macros to be accessed from Isight, a message appears in the Macros panel providing instructions on how to allow access to the macros.

    2. Select a macro that you want to execute (only those that are specified to be public are available).
    3. Enter any arguments that must be supplied to the macro.
    4. Click the button to add the macro.

      Click the button to remove a macro.

      Note: Macros are executed after any parameter mappings that have been defined.

  6. (optional) In the Document Produced area, click Also save to disk to save the updated document as an output file parameter following execution.

    Specify a location for the file in the corresponding text box. You can either type a location, or click Browse to navigate to a location.

    Isight appends the string “ Output” to the name of the saved output parameter. For example, if your input file parameter is named Word 10.doc, Isight names the output file parameter Word 10 Output.doc on the Design Gateway Files tab.

    Note: The modified document is provided as an output file parameter from this component even if you choose not to save it to a specific location on your disk.

  7. Click Show Word during execution if you want the document visible during the model execution.
  8. In the Close Word document list, determine when you want Microsoft Word to close the opened document:

    • when job completes. This option closes the document after the entire Isight job executes.

    • after each execution. This option closes the document after each execution of the Word component. The Word component may be executed numerous times during a single job.

    If you do not select a Close Word document option, Microsoft Word and the document remain open after the model executes.

  9. Click OK to save your changes and to close the Word Component Editor.

    Note: If you created a new document, Isight prompts you for a location to save the document. If you do not specify a name and location for the new document, Isight adds the file to the component as a file parameter with a default name provided by the Word component.

    During execution, the parameters mapped to the document are replaced by their respective values. After execution, the document is provided as a new/modified output file parameter from this component.