Recent changes to Toolkit-Overview

WikiPage Toolkit-Overview modified by Bill Majurski

Bill Majurski — Wed, 19 Dec 2012 14:24:35 -0000

--- v8
+++ v9
@@ -16,26 +16,26 @@
 The most important property is

 ~~~~
-    External\_Cache=/var/lib/tomcat\_ttt/ttt/external_cache    
+    External_Cache=/var/lib/tomcat_ttt/ttt/external_cache    
 ~~~~

 the location of the External Cache. Note: in the future this properties file
-will be scaled back and only contain the External\_Cache property with the others moving
-to secondary files within the External\_Cache.
+will be scaled back and only contain the External_Cache property with the others moving
+to secondary files within the External_Cache.

 Looking at all the properties:

 ~~~~
     Toolkit_Host=hit-testing.nist.gov
-    Toolkit\_TLS\_Port=9443
-    Toolkit\_Port=9100
+    Toolkit_TLS_Port=9443
+    Toolkit_Port=9100
 ~~~~

 define the web location of the toolkit. These are used when addressing simulators
 defined by the toolkit.

 ~~~~
-    Default\_Environment=EURO2012
+    Default_Environment=EURO2012
 ~~~~

 The default environment setting.  This controls the certificates used when initiating
@@ -75,26 +75,26 @@
 be modified:

 ~~~~
-    Enable\_all\_ciphers=false
-    Use\_Actors\_File=true
-    Gazelle\_Config\_URL=
+    Enable_all_ciphers=false
+    Use_Actors_File=true
+    Gazelle_Config_URL=
 ~~~~

 The administrative password needed to edit the properties file from the UI.  The
 default value, as shown, is very easy to remember.

 ~~~~
-    Admin\_password=easy
+    Admin_password=easy
 ~~~~

 The location of the *External Cache* as described above.

 ~~~~
-    External\_Cache=/var/lib/tomcat\_ttt/ttt/external\_cache
+    External_Cache=/var/lib/tomcat_ttt/ttt/external_cache
 ~~~~

 Since this file is delivered inside the WAR file it must be edited each time the WAR
-file is updated. For this reason, all parameters other than External\_Cache will 
+file is updated. For this reason, all parameters other than External_Cache will 
 eventually move to a more stable location.

WikiPage Toolkit-Overview modified by Bill Majurski

Bill Majurski — Wed, 19 Dec 2012 14:22:19 -0000

--- v7
+++ v8
@@ -9,11 +9,15 @@

 The WAR file contains the primary configuration file: 

-> WEB-INF/toolkit.properties  
+~~~~~
+    WEB-INF/toolkit.properties  
+~~~~~

 The most important property is

-> External\_Cache=/var/lib/tomcat\_ttt/ttt/external_cache    
+~~~~
+    External\_Cache=/var/lib/tomcat\_ttt/ttt/external_cache    
+~~~~

 the location of the External Cache. Note: in the future this properties file
 will be scaled back and only contain the External\_Cache property with the others moving
@@ -21,21 +25,24 @@

 Looking at all the properties:

->Toolkit_Host=hit-testing.nist.gov
->Toolkit\_TLS\_Port=9443
->Toolkit\_Port=9100
+~~~~
+    Toolkit_Host=hit-testing.nist.gov
+    Toolkit\_TLS\_Port=9443
+    Toolkit\_Port=9100
+~~~~

 define the web location of the toolkit. These are used when addressing simulators
 defined by the toolkit.

-> Default\_Environment=EURO2012
+~~~~
+    Default\_Environment=EURO2012
+~~~~

 The default environment setting.  This controls the certificates used when initiating
 SOAP based connections and the Affinity Domain configuration for XD* profiles.  The 
 value defines a directory name in the *External Cache*:

-Inside
-*environment* are directories naming the selectable environments. An environment contains
+Inside *environment* are directories naming the selectable environments. An environment contains
 a Java keystore holding a private key for initiating a TLS connection, the password for 
 this keystore is kept in the password file. The codes.xml file contains the Affinity
 Domain configuration to be used for validating metadata-carrying messages. This 
@@ -50,14 +57,16 @@
                    keystore.properties
 ~~~~~~

-NA2013 is the name of the environment (selectable on the UI)   
-codes.xml is the Affinity Domain configuration   
-keystore is the Java keystore file   
-keystore.properties contains the keystore password
+ * NA2013 is the name of the environment (selectable on the UI)   
+ * codes.xml is the Affinity Domain configuration   
+ * keystore is the Java keystore file   
+* keystore.properties contains the keystore password

 The contents of the keystore.properties file looks like

-> keyStorePassword=changeit
+~~~~
+    keyStorePassword=changeit
+~~~~

 If multiple environments are defined then they are also defined below the *environment*
 directory and are selectable from the UI.
@@ -65,18 +74,24 @@
 The following properties are used only in very special situations and should not
 be modified:

-> Enable\_all\_ciphers=false
-> Use\_Actors\_File=true
-> Gazelle\_Config\_URL=
+~~~~
+    Enable\_all\_ciphers=false
+    Use\_Actors\_File=true
+    Gazelle\_Config\_URL=
+~~~~

-> Admin\_password=easy
-
-This is the administrative password needed to edit the properties file from the UI.  The
+The administrative password needed to edit the properties file from the UI.  The
 default value, as shown, is very easy to remember.

-> External\_Cache=/var/lib/tomcat\_ttt/ttt/external\_cache
+~~~~
+    Admin\_password=easy
+~~~~

 The location of the *External Cache* as described above.
+
+~~~~
+    External\_Cache=/var/lib/tomcat\_ttt/ttt/external\_cache
+~~~~

 Since this file is delivered inside the WAR file it must be edited each time the WAR
 file is updated. For this reason, all parameters other than External\_Cache will

WikiPage Toolkit-Overview modified by Bill Majurski

Bill Majurski — Wed, 19 Dec 2012 13:52:00 -0000

--- v6
+++ v7
@@ -1,83 +1,89 @@
-Overview
-========
+Configuration Guide
+===================

-Toolkit is a Java application used to test standards-based infrastructures in several environments. The resulting binary releases of the toolkit are labeled differently depending on which program they support.  In IHE it is called the XDS Toolkit.  In the ONC/Direct/Meaningful Use program it is called the Transport Testing Tool (TTT). Within ONC/NwHIN it uses the XDS Toolkit label.
+Toolkit is controlled by several configuration files which are documented on this
+page.

-These environments are supported by different Google Groups based mailing lists:
- * IHE/XD* - ihe-xds-implementors@googlegroups.com
- * ONC/Direct/Meaningful Use - transport-testing-tool@googlegroups.com
+toolkit.properties
+------------------

-
-Technologies
-=======
-
-The implementation is based on these technologies:
- * Java
- * Servlets
- * Google Web Toolkit (GUI/Ajax front end)
- * Apache Axis2 (SOAP)
- * Bouncycastle (SMTP/S-MIME etc.) 
-
-
-Major Deployments
-================
-
-The major components comprising toolkit depend on whether it is deployed to support IHE
-or ONC/MU 2 testing.
-
-IHE Deployment
---------------
-For the IHE deployment, toolkit has the following components:
- * WAR file - for installation in a Servlet container (I use Tomcat). 
- * External Cache - a local directory that holds your data. Having this separate
- keeps new installation of the WAR file from overwriting all of your data.
-In this deployment mode the toolkit is called the XDS Toolkit or XD* Toolkit.
- 
-MU2 Deployment
---------------
-For the ONC/MU2 (Meaningful Use) deployment the toolkit as the following additional
-components:
- * Listener - Listens for incoming SMTP connections on port 25 and coordinates data
- with the rest of the toolkit through the External Cache.
- * Additional content in the External Cache to support the MU 2 specific functionality.
-
-Organization of the Display
----------------------------
-The toolkit is a typical AJAX JavaScript application that lives in a single tab of your
-browser.  The browser *back* button is never used.  The **Home** page is a large menu
-displayed as a table.  Each column of the table contains links to other *tabs* that
-are related functionally.  Each column has a title in bold that labels the purpose
-of the column. Across the top of the page is a row of links/selections that are
-referred to as the top menu. They are documented in another section on this page.
-
-Each link, when selected, opens a new tab in the toolkit. Again, these are not
-browser tabs but tabs within this toolkit package.  The open tabs are listed 
-across the top in blue. An open tab can be left open for later use as needed. If 
-useful, multiple copies of the same tab can be opened by selecting the appropriate
-link on the Home page a second time.  These two tabs are then supported by the same
-functionality but contain different data (perform queries against two different 
-Document Registries etc.).
-
-Configuration Files
--------------------
-
-### toolkit.properties ###
-
-In all configurations, the WAR file contains its primary configuration file: 
+The WAR file contains the primary configuration file: 

 > WEB-INF/toolkit.properties  

 The most important property is

-> External_Cache=/var/lib/tomcat_ttt/ttt/external_cache    
+> External\_Cache=/var/lib/tomcat\_ttt/ttt/external_cache    

-the location of the External Cache. There are other properties stored here that will be
-discussed in the Configuration Guide.  Note: in the future this properties file
-will be scaled back and only contain the External_Cache property with the others moving
-to secondary files within the External_Cache.
+the location of the External Cache. Note: in the future this properties file
+will be scaled back and only contain the External\_Cache property with the others moving
+to secondary files within the External\_Cache.

-### actors.xml ###
+Looking at all the properties:

-Located at the top level of the External Cache, this file holds the SOAP endpoint
-configurations.  It is usually not hand edited but instead edited using the 
-*Site/Actor Configuration* in the toolkit.
+>Toolkit_Host=hit-testing.nist.gov
+>Toolkit\_TLS\_Port=9443
+>Toolkit\_Port=9100
+
+define the web location of the toolkit. These are used when addressing simulators
+defined by the toolkit.
+
+> Default\_Environment=EURO2012
+
+The default environment setting.  This controls the certificates used when initiating
+SOAP based connections and the Affinity Domain configuration for XD* profiles.  The 
+value defines a directory name in the *External Cache*:
+
+Inside
+*environment* are directories naming the selectable environments. An environment contains
+a Java keystore holding a private key for initiating a TLS connection, the password for 
+this keystore is kept in the password file. The codes.xml file contains the Affinity
+Domain configuration to be used for validating metadata-carrying messages. This 
+directory structure looks like:
+
+~~~~~~
+   environment/
+           NA2013/
+               codes.xml
+               keystore/
+                   keystore
+                   keystore.properties
+~~~~~~
+
+NA2013 is the name of the environment (selectable on the UI)   
+codes.xml is the Affinity Domain configuration   
+keystore is the Java keystore file   
+keystore.properties contains the keystore password
+
+The contents of the keystore.properties file looks like
+
+> keyStorePassword=changeit
+
+If multiple environments are defined then they are also defined below the *environment*
+directory and are selectable from the UI.
+
+The following properties are used only in very special situations and should not
+be modified:
+
+> Enable\_all\_ciphers=false
+> Use\_Actors\_File=true
+> Gazelle\_Config\_URL=
+
+> Admin\_password=easy
+
+This is the administrative password needed to edit the properties file from the UI.  The
+default value, as shown, is very easy to remember.
+
+> External\_Cache=/var/lib/tomcat\_ttt/ttt/external\_cache
+
+The location of the *External Cache* as described above.
+
+Since this file is delivered inside the WAR file it must be edited each time the WAR
+file is updated. For this reason, all parameters other than External\_Cache will 
+eventually move to a more stable location.
+
+
+
+
+
+

WikiPage Toolkit-Overview modified by Bill Majurski

Bill Majurski — Mon, 17 Dec 2012 22:29:06 -0000

--- v5
+++ v6
@@ -8,8 +8,7 @@
  * ONC/Direct/Meaningful Use - transport-testing-tool@googlegroups.com

-
-General
+Technologies
 =======

 The implementation is based on these technologies:
@@ -19,3 +18,66 @@
  * Apache Axis2 (SOAP)
  * Bouncycastle (SMTP/S-MIME etc.) 

+
+Major Deployments
+================
+
+The major components comprising toolkit depend on whether it is deployed to support IHE
+or ONC/MU 2 testing.
+
+IHE Deployment
+--------------
+For the IHE deployment, toolkit has the following components:
+ * WAR file - for installation in a Servlet container (I use Tomcat). 
+ * External Cache - a local directory that holds your data. Having this separate
+ keeps new installation of the WAR file from overwriting all of your data.
+In this deployment mode the toolkit is called the XDS Toolkit or XD* Toolkit.
+ 
+MU2 Deployment
+--------------
+For the ONC/MU2 (Meaningful Use) deployment the toolkit as the following additional
+components:
+ * Listener - Listens for incoming SMTP connections on port 25 and coordinates data
+ with the rest of the toolkit through the External Cache.
+ * Additional content in the External Cache to support the MU 2 specific functionality.
+
+Organization of the Display
+---------------------------
+The toolkit is a typical AJAX JavaScript application that lives in a single tab of your
+browser.  The browser *back* button is never used.  The **Home** page is a large menu
+displayed as a table.  Each column of the table contains links to other *tabs* that
+are related functionally.  Each column has a title in bold that labels the purpose
+of the column. Across the top of the page is a row of links/selections that are
+referred to as the top menu. They are documented in another section on this page.
+
+Each link, when selected, opens a new tab in the toolkit. Again, these are not
+browser tabs but tabs within this toolkit package.  The open tabs are listed 
+across the top in blue. An open tab can be left open for later use as needed. If 
+useful, multiple copies of the same tab can be opened by selecting the appropriate
+link on the Home page a second time.  These two tabs are then supported by the same
+functionality but contain different data (perform queries against two different 
+Document Registries etc.).
+
+Configuration Files
+-------------------
+
+### toolkit.properties ###
+
+In all configurations, the WAR file contains its primary configuration file: 
+ 
+> WEB-INF/toolkit.properties  
+  
+The most important property is
+
+> External_Cache=/var/lib/tomcat_ttt/ttt/external_cache    
+
+the location of the External Cache. There are other properties stored here that will be
+discussed in the Configuration Guide.  Note: in the future this properties file
+will be scaled back and only contain the External_Cache property with the others moving
+to secondary files within the External_Cache.
+
+### actors.xml ###
+
+Located at the top level of the External Cache, this file holds the SOAP endpoint
+configurations.  It is usually not hand edited but instead edited using the 
+*Site/Actor Configuration* in the toolkit.

WikiPage Toolkit-Overview modified by Alan Viars

Alan Viars — Fri, 14 Dec 2012 20:04:14 -0000

WikiPage Toolkit modified by Bill Majurski

Bill Majurski — Mon, 26 Nov 2012 14:57:38 -0000

--- v3
+++ v4
@@ -7,14 +7,7 @@
  * IHE/XD* - ihe-xds-implementors@googlegroups.com
  * ONC/Direct/Meaningful Use - transport-testing-tool@googlegroups.com
 
-IHE
-===
 
-ONC/NwHIN
-=========
-
-ONC/Direct
-==========
 
 General
 =======

WikiPage Toolkit modified by Bill Majurski

Bill Majurski — Mon, 26 Nov 2012 14:06:48 -0000

--- v2
+++ v3
@@ -4,7 +4,7 @@
 Toolkit is a Java application used to test standards-based infrastructures in several environments. The resulting binary releases of the toolkit are labeled differently depending on which program they support.  In IHE it is called the XDS Toolkit.  In the ONC/Direct/Meaningful Use program it is called the Transport Testing Tool (TTT). Within ONC/NwHIN it uses the XDS Toolkit label.
 
 These environments are supported by different Google Groups based mailing lists:
- * IHE/XD* - ihe-xds-implementors+owner@googlegroups.com
+ * IHE/XD* - ihe-xds-implementors@googlegroups.com
  * ONC/Direct/Meaningful Use - transport-testing-tool@googlegroups.com
 
 IHE

WikiPage Toolkit modified by Bill Majurski

Bill Majurski — Mon, 26 Nov 2012 13:55:19 -0000

--- v1
+++ v2
@@ -1,3 +1,12 @@
+Overview
+========
+
+Toolkit is a Java application used to test standards-based infrastructures in several environments. The resulting binary releases of the toolkit are labeled differently depending on which program they support.  In IHE it is called the XDS Toolkit.  In the ONC/Direct/Meaningful Use program it is called the Transport Testing Tool (TTT). Within ONC/NwHIN it uses the XDS Toolkit label.
+
+These environments are supported by different Google Groups based mailing lists:
+ * IHE/XD* - ihe-xds-implementors+owner@googlegroups.com
+ * ONC/Direct/Meaningful Use - transport-testing-tool@googlegroups.com
+
 IHE
 ===
 
@@ -9,3 +18,11 @@
 
 General
 =======
+
+The implementation is based on these technologies:
+ * Java
+ * Servlets
+ * Google Web Toolkit (GUI/Ajax front end)
+ * Apache Axis2 (SOAP)
+ * Bouncycastle (SMTP/S-MIME etc.) 
+

WikiPage Toolkit modified by Bill Majurski

Bill Majurski — Mon, 26 Nov 2012 13:41:53 -0000

IHE === ONC/NwHIN ========= ONC/Direct ========== General =======