RMIM Designer Documentation (Batch)

From HL7Wiki
Jump to navigation Jump to search
Overview   2010/11 Updates   VocabMIF   DataTypeReleases   BatchProcess   CommandLine   Errors/Install   Vis2002-3-7-10-13    

BatchMenuOptions ·  (UpgradeToVis2003-7 ·  RevertToVis2002 ·  DataTypeConversion) ·  DesignValidation ·  GraphicExport ) CompositeConversions

Batch Menu Invocation

Batch processing refers top a set of HL7 Menu options that allow the user to select a particular process, and a set of files in a single directory on which to perform the selected process. To date, these processes (detailed in the following sections) are:

  • Conversion between Visio Versions 2002 and 2003-7-10 (supported only in Visio 2003, 2007, or 2010)
  • Conversion of data types to a specific release.
  • Validation of models against a RIM
  • Exporting PNG graphics, thumbnails, and an HTML overlay to the PNG to provide "clickable graphics"

The batch menu options are not on the main HL7 menu attached to each drawing. They are in a variant of the HL7 Menu that appears when the Visio "Stencil" is selected. The stencil is the separate pane from which design shapes are dragged and dropped on the primary drawing. Clicking on the title bar of this pane will cause the Visio Menus to change (fewer entries), and the HL7 Menu that appears for the stencil is different from the one that appears when the main menu is selected.

When the stencil menu is showing, select Menu...HL7...Batch conversion/export to see the set of batch options.

(NOTE: The stencil cannot be selected if it is "docked" to the drawing. To undock it, Drag it away from its docked position. Also, note that if there is no drawing window open, the stencil menu options may be "grayed" out. It will be necessary to open an empty design window in order to activate these options.)

Upgrade drawings from 2002 up to 2003-7 format

This option is only available in Visio 2003, 2007 or 2010. It is selected as: Menu...HL7...Batch conversion/export...Upgrade drawings from 2002 up to 2003 format (Batch). Once this option is started, it will:

  • Present a pane to verify the desired action
  • Present a file browser dialog in which to select one or more files (select multiple files using "Shift-Click" or "Ctrl-Click" as appropriate)
  • Upgrade any of the selected files that are in Visio 2002 format to Visio 2003-7 format.
  • Replace the original file with the upgraded version by saving over the old.
  • Note: Visio 2010 uses the same file formats as Visio 2003 and 2007.

Note that if any files have data types releases different from the loaded RIM, their data types will also be converted as a composite action.

Revert drawings from 2003 back to 2002 format

This option is only available in Visio 2003 or Visio 2007. It is selected as: Menu...HL7...Batch conversion/export...Revert drawings from 2003 back to 2002 format (Batch). Once this option is started, it will:

  • Present a pane to verify the desired action
  • Present a file browser dialog in which to select one or more files (select multiple files using "Shift-Click" or "Ctrl-Click" as appropriate)
  • Revert any of the selected files that are in Visio 2003-7 format back to Visio 2002 format.
  • Replace the original file with the reverted version by saving over the old.

Note that if any files have data types releases different from the loaded RIM, their data types will also be converted as a composite action.

Batch Conversion of Data Types

This option is available in all supported Visio releases. It is selected as: Menu...HL7...Batch conversion/export...Perform Batch Conversion of Data Types to align with currently loaded RIM. As with manually opened files, the data types will be converted (if necessary) to the data type release set by the RIM that has been loaded into the RMIM Designer. ([[RMIM_Designer_Documentation_(DatatypeReleaseSupport)#Data_Types_Release_Governed_by_RIM_Loaded_in_RMIM_Designer | See also.))

Once this option is started, it will:

  • Present a pane to verify the desired action, including specifying the target data types release
  • Present a file browser dialog in which to select one or more files (select multiple files using "Shift-Click" or "Ctrl-Click" as appropriate)
  • Convert the data types (if they differ from the loaded RIM) in the models of the selected files.
  • Replace the original file with the converted version by saving over the old.
  • At the end of conversion, the "Error Pane" will display listing all attributes whose converted data types are not proper valid restrictions on the RIM data type for that attribute. These are listed by FILE, CLASS within file, and ATTRIBUTE within class. An option on the error pane allows saving these to a text file.

Note that if you are running in Visio 2003-7 and any of the files are in Visio 2002 format, these will also be upgraded to Visio 2003-7 as a composite action. If you are running Visio 2002 and attempt to use a Visio 2003-07 model, the process will fail as it is unable to load these files.

Batch Validation Against RIM

This option is available in all supported Visio releases. It is selected as: Menu...HL7...Batch conversion/export...Perform Batch validation against currently loaded RIM. This is designed to work with a set of files that are on the same Visio release as the RMIM Designer and whose data types have all been converted to align with the currently loaded RIM.

Once this option is started, it will:

  • Present a pane to verify the desired action, including an option to "Validate Vocabulary"
  • Present a file browser dialog in which to select one or more files (select multiple files using "Shift-Click" or "Ctrl-Click" as appropriate)
  • Validate the models of the selected files.
  • Close the file without saving.
  • At the end of validation, the "Error Pane" will display listing all validation exceptions that were noted. These are listed by FILE, CMET, CHOICE or CLASS within file, and ATTRIBUTE within class. An option on the error pane allows saving these to a text file.

Note that if you are running in Visio 2003-7 and any of the files are in Visio 2002 format, these will also be upgraded to Visio 2003-7 as a composite action. However this mode has not been tested and the code will not suppress the dialogs that usually accompany such conversion. Therefore one should avoid opening files whose Visio format does not match the Visio running the RMIM Designer.

Export PNG Graphics And HTML Map

This option is available in all supported Visio releases. It is selected as: Menu...HL7...Batch conversion/export...Process VSD to HTML Graphics Only (Batch). This is designed to work with a set of files that are on the same Visio release as the RMIM Designer and whose data types have all been converted to align with the currently loaded RIM.

Once this option is started, it will:

  • Present a pane to verify the desired action, including an option to set the pixel width of the thumbnail.
  • Present a file browser dialog in which to select one or more files (select multiple files using "Shift-Click" or "Ctrl-Click" as appropriate)
  • Generate PNG files for the designs and clickable graphic maps in HTML.
    Be advised that these new files will be saved in an editable directory that will be created as a sibling of the source directory for the VSD files.

One should avoid opening files whose Visio format does not match the Visio running the RMIM Designer.

Composite Actions - Changing Both Visio and Data Types

As noted above, several of these processes can cause a composite action to be performed - both a data type conversion and a Visio version conversion in a single pass. Thus, if you upgrade a set of models from Visio 2002 to Visio 2003-7 and have loaded a data types release R2 RIM, but the models are based on data types R1, the designs will have their data types converted as they are upgraded. Similarly, if you are reverting a set of models defined in Visio 2002, from data types Release 2 back-to data types release R1, but you are also doing this on an RMIM Designer running in Visio 2007, the models will have their data types reverted to R1, and they will be upgraded to Visio 2003-7 during the same pass.

These composite actions have been tested for changes in which data types conversion and Visio version changes are combined, and no errors attributable to these combined processes were detected.

However, the composite action has not been tested for processes in which a batch Validation run may also cause a data type conversion or a Visio upgrade.