Version 10, last updated by markcopenhaver at December 18, 2010 18:08 UTC
Creating a Component Version
Once you have a setup exutable, you can load it into an instance of EncounterPRO using the component configuration screens. The is a two-step process:
- Create a new Component Definition
- Create a new Component Version
If this is the first time you are loading any version of this component, then you need to start by creating a Component Definition. To do this, go to the Configuration tab and navigate to System/Components/Component Types. The double click the appropriate component type and select "New Component" from the popup menu. You will need to provide a name for the new component. The name must not be in use by any other component. You may later publish new versions of this component but the name will remain the same.
Once you have created your Component Definition, you will need to load your component installer into EncounterPRO-OS by creating a Component Version. If you have just created a new Component Definition, you should be looking at the Properties tab on the Component Definition screen. If the Component Definition is already there, you can get to the Component Definition Properties screen by going to the Configuration tabs and navigating to System/Components/Component Types/<Your Component Type>. If you see your component listed under the appropriate component type, then right or double click on it and the Component Definition screen be displayed.
From the Properties tab on the Component Definition screen you should see a "New Version" button. Click this button and answer the questions about your new component version:
| Version Description | Enter a description of what has changed in this version of the component. This is an optional field but it is highly recommended to put useful information here, though it may be left blank for the first version. |
| Assembly Display Name | Enter the complete display name of your assembly (e.g. EncounterPRO.OS.Component, Version=1.0.0.1, Culture=neutral, PublicKeyToken=e3e395c42bd8c0d4, processorArchitecture=MSIL). This is the information that EncounterPRO-OS will use to instantiate your component using late binding. You can get the display name by finding your assembly in the GAC, click on it an press ctrl-I. That will put the display name into the copy/paste buffer. |
| Component Class | Enter the complete class name of the component. This should have been created as a descendent of the appropriate EncounterPRO-OS Component Base Class. E.g. EncounterPRO.OS.Component.Document.JMJDocument |
| Release Status | Select the appropriate release status. If this component is going to be deployed to other sites, this will affect the visibility of your component in those sites. "Testing" components will only visible in testing databases that contain no actual patient data. |
| Minimum Database Modification Level | Enter the minimum database modification level that your component needs in order to run. The default is the current modification level of the database where you are loading this component version. This is used to keep your component from being used in installations where some of the database objects you depend on have not yet been created. |
| Assembly Version | This should be the version of your component assembly. This is not used to instantiate the component but it is used to display this version on EncounterPRO-OS screens and will be useful to system managers and troubleshooters if it is accurate. |
| Installer Executable | Using the windows file open dialog box, browse to your executable setup program and click "Open". |
Once you have answered all of the questions, you should see a tab for your new version.
IMPORTANT NOTE: IF THIS IS NOT THE INITIAL VERSION THEN YOUR COMPONENT VERSION IS NOT YET READY TO BE USED BY ENCOUNTERPRO-OS.
When you load the first version for a component, EncounterPRO-OS will automatically set that version as the one for all computers to use. After that, however, EncounterPRO-OS will not automatically use the new version. In order to make your new component version ready for EncounterPRO-OS to use it, you must go to the version tab (the tab labeled with the assembly version of your component) and click the "Use This Version" button.