|
The information and data pack provides extensions to the Essential Meta Model and Essential Viewer to support Information and Data Management and Architecture activities. These extensions are packaged together into a single installer that guides you through the process of applying the pack. This install guide describes the installation process in detail.
If you have not already done so, download the installer from the Community area of the Essential Project website.
Internet Explorer may try to change the name of 'essentialInfDataPack.jar' to 'essentialInfDataPack.zip' when downloading. If so, please be sure to save the file as 'essentialInfDataPack.jar'.
The installation process is made up of two steps:
- Install the Information and Data Views into Essential Viewer and save the Essential Meta Model update scripts to your computer.
- Running the Essential Meta Model update scripts.
Prerequisites
Although not required, we recommend that you apply Essential Viewer Patch Update 1 before adding the Information and Data Pack to your Essential Architecture Manager installation.
Preparation
Before running the installer, we recommend that you make a backup of your Essential Viewer installation in your Java Web Application. e.g. for Apache Tomcat, the webapps/essential_viewer folder.
Although the Information and Data Pack introduces new Views and does not update existing views, if you have made any changes to 'essential.css', you should back up this file and re-apply your changes after the installer has completed.
Additionally, before running the Essential Meta Model update scripts, please make a backup of your Essential Architecture Manager Repository. For multi-user installations, we recommend that you stop the Protege Server process and apply the update to your repository running in stand-alone mode.
Using the installer
To start the installer, double click on the installer, essentialInfDataPack.jar, and follow the on-screen instructions.
Steps 1 - 3
The opening three steps of the installer provide important information about the Information and Data Pack.
Step 4
At this point, you must select the modules that you wish to install. The installer includes the two components of the pack, the Information and Data Views and the Essential Meta Model update scripts.
By default, both components are selected, but you can use the installer to apply each individually, should you wish. For example, if you have multiple Essential Viewer environments, must run the installer to deploy the Information and Data Views to each of these environments individually, whilst the meta model update scripts are only required by your active Essential Architecture Manager repository.
Step 5
You must tell the installer which Essential Viewer environment to which it should deploy the Information and Data Views. Use the 'Browse' button to select the root folder of the chosen Essential Viewer environment, e.g. <Apace Tomcat>/webapps/essential_viewer.
Step 6
You must tell the installer where to deploy the Essential Meta Model Update scripts. Choose a location on your computer that is easy to find and navigate to. You will be referring to this location when you need to run the update scripts.
The installer only deploys the scripts to your selected location. It does not run the update scripts.
Steps 8 - 10
The installer will present a summary of what it is about to do. Click 'Next' and it will deploy the Information and Data Views to your chosen Essential Viewer environment and the Essential Meta Model Update Scripts to your chosen location.
When the installer has completed, you are ready to apply the Essential Meta Model update scripts, to add the new meta classes of the Information and Data Pack.
Meta Model Update
The second stage of installing the Information and Data Pack is to apply the extensions to your Essential Architecture Manager repository.
The meta model update is provided as a set of Python scripts that are run in the Protege Script Console tab. For more background about this approach, please see the Meta Model Update Packs article.
Before you start
When constructing a meta model update script, every effort is made to ensure that the update will be compatible with all Essential Meta Models. Extensive testing is performed against the baseline repositories and repositories that have applied meta model extension packs. However, the Essential Meta Model is open-source and easily extended and it is possible that an update pack may have adverse affects on custom extensions that have been made or fail to complete because of custom extensions. In such cases, please contact the Essential Project Team for support.
Before you start applying the update pack, please ensure that any new edits to the Essential repository are saved and that you have backed up your repository. Where a database backend is being used to manage the repository, make a backup of the relevant database before proceeding.
Applying the Information and Data Meta Model Pack
The Information and Data Pack introduces a large number of new meta classes and updated relationships to existing meta classes and due to the limitations of the scripting environment is split into a number chunks.
Each chunk must be applied in the correct order and each is named to show its position in the order. In addition, an apply-all script, applyInfoAndData.py is provided that runs each chunk in the correct order.
Due to the way the Protege Script Console works, running the applyInfoAndData.py script may require large amounts of memory. You may find that running each chunk in the correct order, manually, completes the installation faster.
There are, therefore, two options for applying the meta model updates.
- Using the apply-all script
- Running each update script individually
Using the Apply-all Script
This is the simplest option to use but may take considerably longer for Protege to complete. In addition, this option has higher memory requirements and if the Java environment in which Protege is running has less than 1GB RAM available, it may fail to complete and hang Protege.
Before you run the apply-all script, you must edit it to define the path to where the Information and Data Meta Model update scripts were stored by the installer, e.g. "C:/Essential/Info and Data Pack"
Set path
The apply-all script needs to know where you have stored all the script chunks when you unpacked the update pack. Before executing the apply-all, you must edit the path to specify the full path to the folder in which you have stored the update script chunks. By default, this is set to 'YOUR_FULL_PATH/' and if you do not edit this, a help message will be displayed and the apply-all will terminate. Replace 'YOUR_FULL_PATH/' with the full path to the location of the folder containing your scripts, including the last '/' character. e.g.
path = "C:/Essential/Info and Data Pack/"
Note that even on Windows platforms, you need to use the '/' character as a path separator and the '"' characters are required.
Run the update
Once you have updated the path variable, save the apply-all and open your Protege project containing the Essential repository that is to be updated.?? Ensure that the Script Console tab is enabled. If it is not, enable it by using the Project->Configure menu and selecting the Script Console Tab from the list of available tab plugins.?? At the command prompt, enter the following command:
execfile("<PATH TO APPLY-ALL>/applyInfoAndDataPack.py")
and press enter.
Where <PATH TO APPLY-ALL> is the full path the folder containing the apply-all script.?? Depending on the nature of the update, which may include complex tasks that need to be applied to every meta class in the meta model, the update can take several minutes to run.
When the scripts have all been run successfully, a success message will be reported on the console.
Running the Scripts Individually
As an alternative - in particular if you experience problems running the apply-all script or are not confident modifying it, you can run each of the separate meta model scripts individually, IN THE CORRECT ORDER.
Ensure that the Script Console tab is enabled. If it is not, enable it by using the Project->Configure menu and selecting the Script Console Tab from the list of available tab plugins.
At the command prompt, enter the following command:
execfile("<PATH TO INFO DATA PACK>/infoAndDataPack00.py")
and press enter.
Where <PATH TO APPLY-ALL> is the full path the folder containing the Information and Data Pack meta model update scripts.
Repeat this process for all of the infoAndDataPackNN.py scripts, in order, until you have run the last one, infoAndDataPack13.py.
When the last script has completed, a success message is reported on the Script Console.
You can use the UP cursor key at the command prompt to see and edit the last command that you ran. This means that you only need to use the UP cursor key and then edit the number to run each script.
Essential Architecture Manager Migration Script
Once the Information and Data Pack has been applied successfully to your Essential Architecture Manager repository, you should save it, e.g. using File->Save in Protege.
The Information and Data pack represents a powerful and significant change to the way in which knowledge about the Information and Data in your enterprise is captured and managed. In particular, the way in which relationships between Business Processes and Applications make use of Information has been improved and changed significantly.
A migration script is provided to migrate any Information instances and relationships from the Essential Meta Model baseline v1.2 (included in the standard Essential Architecture Manager installation) to use the new Information and Data classes and relationships.
We recommend that any repository that has existing Information instances and relationships to Business Processes and Applications uses this migration script.
Before you start
As with the Information and Data Pack update scripts, we recommend that you save your work and backup your Essential Architecture Manager repository before using the migration script.
Running the Migration Script
Go to the Protege Script Console and at the command line type the following:
execfile("<PATH TO INFO DATA PACK>/migrateInfoRelations.py")
and press enter.
Where <PATH TO APPLY-ALL> is the full path the folder containing the Information and Data Pack meta model update scripts.
A success message will be reported on the script console when the script completes successfully.
Troubleshooting
If any of the update scripts reports any errors or exceptions, please run each script chunk individually to identify where the exception or error has occurred.
Please contact the Essential Project Team for further support in applying this update.
|
Documentation 
