IGC Loader Configuration Tool USER S GUIDE

Transcription

1 IGC Loader Configuration Tool USER S GUIDE LAST UPDATED, MONDAY, FEBRUARY 02, 2015

2 Table of Contents Loader Config Tool User Guide... 5 Overview... 6 Launching the Tool... 6 Using the Loader Configuration Tool... 7 Editing Parameters... 7 Changing File Associations... 9 Adding Extension Associations Updating Configuration Files Troubleshooting iii

3 LOADER CONFIG TOOL USER GUIDE VERSION INFORMATION The IGC Loader Configuration Tool is used with the following products: Brava ActiveX Viewers for Version 7.3 including: Brava! Enterprise, Brava! Enterprise.NET, Brava! Desktop Redact-It Desktop 2.3 Redact-It Enterprise 7.3 Blazon Enterprise 7.3 Copyright All rights reserved. If you need information on integrating and customizing your product, or if you experience any problems or have general inquiries, please feel free to contact us. When used with Brava! Desktop for SmartPlant Markup Plus or with other Intergraph information management products, contact Intergraph Customer Support ( E. Cactus Road, Suite 445 Scottsdale, Arizona Phone: (602) M - F 5am to 5pm, Arizona time info@infograph.com Web: 5

4 Loader Configuration Tool User's Guide OVERVIEW This document provides details on how to use the IGC Loader Configuration Tool to customize the editable properties of the loader configuration files. Prior to the 7.3 product version release, loader configuration was done through the myrdrv.ini INI file. This single file contained all of the different parameters for all of the different loaders, as well as the association information for which loaders should be used for which extensions and required manual editing for any changes needed. The new Loader Configuration Tool is a standalone executable that provides a simple user-friendly interface to the multiple XML configuration files that control loader behavior. As the Tool starts up, it compares the latest installed "source" loader configuration files with the current user's "target" loader files. If it finds a difference in versions, it updates the user's files with the installed source files, and displays a dialog reporting the changes, if any were made. Once this initial check is complete, it displays the installed loaders and their parameters in a tree format. Individual loaders can be selected and parameters can be changed without concern about which source file the changes affect, or how to format the underlying XML. Values entered for the parameters are validated against the format information stored in the XML and the user is notified if they attempt to enter incorrect values (e.g. a non-numeric value for a field that requires an integer value). LAUNCHING THE TOOL NOTE: In both client and server environments, browse to [installation location]\smartplant\markup \Bin if working with Brava! Desktop for SmartPlant Markup Plus. To launch the Loader Configuration Tool in Desktop products, browse to your installed product directory (e.g., C:\Program Files (x86)\igc\brava! Desktop or Redact-It Desktop) and double-click on the file igc.loaders.configuration.exe. In Server (Enterprise) products, browse to your installed job processor igc.loaders directory (e.g., C:\Program Files (x86)\common Files\IGC\JobProcessor\Igc.Loaders) and double-click on the file igc.loaders.configuration.exe. The tool displays as a tree list of available loader names on the left panel and a description area on the right-hand panel. The list of loaders available for editing will vary, depending on which product and license type you have installed. (The loader files themselves are stored in the <product install folder>\igc.loaders directory.) Clicking the + on each loader name expands to expose the version, associated format extensions, and parameter information for that loader. Clicking on any item of the left panel reveals a description on the right panel. If options are available for editing, the Change button becomes available. 6

5 USING THE LOADER CONFIGURATION TOOL EDITING PARAMETERS NOTE: Inso2dl.dll, inso2dl-config.xml, outsidein.dll, outsidein2dl.dll, and outsidein2dl.config are not delivered with Brava! Desktop for SmartPlant Markup Plus. When using the Loader Configuration Tool for editing, the parameter in question should be selected in the tree on the left. When a parameter is selected, a brief description of the parameter displays in the right-hand panel. Selecting Change Value provides a dialog box to enter a new value for the selected parameter. 7

6 Loader Configuration Tool User's Guide Once a parameter has been changed from its default value, it will show in bold in the tree. The Reset to Default button will also be enabled. Hitting Rest to Default will change the value of that parameter back to the predefined default value. Certain types of parameters are compound parameters, such as HybridExtensions on Dwg2dl, which is a list of file extensions. On the left tree, a list displays in [] brackets, with each entry separated by a comma. When editing a list, the Edit Parameter dialog (shown below) allows adding new entries [Add New ], rearranging of entries by moving them up [Move Up] or down [Move Down], removing an entry entirely [Remove], or changing a selected item [Change]. 8

7 CHANGING FILE ASSOCIATIONS The Loader Configuration Tool allows you to change which loader a particular file type is associated with. This is an uncommon operation, but it is occasionally useful to open a file with a different loader if the content is compatible (such as opening HTML or XML files with the text loader, to show the raw HTML). To change a file association: 1. From the Loader Configuration dialog, select the loader and Associated Extensions in the left tree view. 9

8 Loader Configuration Tool User's Guide 2. After selecting the specific extension to change, the Loader Configuration dialog buttons change to Disable, Change Association, and Reset to Default. 3. Click the Change Association button; a Choose Loader dialog prompts you for a new loader to associate the extension with. 10

9 4. Select OK to change the association or Cancel to exit the dialog. 11

10 Loader Configuration Tool User's Guide 5. The special System entry at the top of the list of the dialog shown below contains parameters that can affect all loaders. It cannot have extensions associated with it, but does report a version. This is the version of the underlying Common Display List (CDL) library that the loaders are working with. 6. After making any changes, close the Loader Configuration Tool by clicking Done (or closing the window). If you have made any changes, you will be prompted to save all changes. You can enter Yes (save all changes and exit), No (discard all changes and exit), or Cancel (do not save any changes yet and do not exit the tool). 12

11 ADDING EXTENSION ASSOCIATIONS The Loader Configuration tool not only allows you to edit current file associations (as described in the previous section), but it also allows you to add CUSTOM extensions. This is sometimes necessary if you want to open a file with an extension that is not already listed in the loader XML file. To add a CUSTOM extension: 1. From the Loader Configuration dialog, select the loader and Associated Extensions in the left tree view. 2. Click the Add Association button to display the Add Extension Association dialog. 3. In the Extension field, type the extension that you want to add, along with a corresponding Description. Clicking OK adds the new extension to the loader Associated Extensions list in the left tree view. 13

12 Loader Configuration Tool User's Guide 4. This type of change generates a message and, upon running the Loader Configuration Tool, the log will report the new extension. UPDATING CONFIGURATION FILES In desktop products (vs. server), loader configuration files are stored in a user-writable folder as per-user settings. The files are copied into the product's configuration folder from the product's installation folder as needed, if they do not exist there already. If they do exist already, the files are not copied. If a new loader is installed, with new or changed configuration options, these options will not be copied into the per-user settings folder automatically. The Loader Configuration Tool should be used to force the peruser settings files to be updated. On start-up, the Loader Configuration Tool will check both folders and make updates to the per-user copy based on the installed copy. In most cases, the only update needed will be to update the loader version. This will cause a log message dialog to display, reporting any updated loaders. At the point at which the log message displays, these changes have been made and saved into the user's copy. There is no option to avoid updating the user's configuration, or to skip saving these changes. 14

13 If the new loader has different parameters than the old loader, there will also be messages reporting the addition or removal of parameters. In this example situation, the parameter "MissingFontWarning" had been removed from the user's configuration file, and a false parameter of "ExampleParameterToDelete" had been added. Upon running the Loader Configuration Tool, the removed parameter was restored and the false parameter removed. It also should be noted that the version in the user's configuration file was modified as well. No updating of parameters occurs if the version of the installed file matches the version of the user's copy. 15

14 Loader Configuration Tool User's Guide If the installed configuration file has a different default value than the user's default value, and the user's parameter was set to the user's default value, the Loader Configuration Tool will change the parameter to the new default value. This would only rarely happen, if the loader author has decided that the previous default value was no longer the best default (perhaps because of changes in a new release of the software the file is associated with). This type of change will also generate a message. 16

15 TROUBLESHOOTING The versions of the installed loaders are displayed in the tree beneath each loader. This can be reported to technical support to assist in determining if a newer version may resolve an issue. The version of CDL installed is also displayed under the System component at the top of the list. If the user installs a new loader by copying in a new DLL but does not copy in the corresponding config.xml file, the Loader Configuration Tool will report a version mismatch. In this example, the DLL was dropped into an installation of The message reports that the configuration is still expecting , but the actual DLL version is

16 Loader Configuration Tool User's Guide If the user installs only the config.xml for the new loader but not the actual DLL, a similar version mismatch will be reported. The new config file will also be accepted, because it is the installed file, so any parameter changes will take place. The version mismatch will still be reported every time the Loader Configuration Tool is run, until it is corrected. As described above under Editing Parameters, any parameters that are not currently set to the default value for that parameter will display in bold in the tree. Technical support will want to know the values being used for any of these, and may want them to be reset to default values by hitting the Reset to Default button on each such parameter. As a trouble-shooting technique to reset all entries to default values, it is possible to navigate to the user's configuration folder and delete all of the XML files there. On the next launch of the product, the installed XML files will automatically be copied over, with their default values. 18