From 930c5ee915bdefe30cfdbea26f98758fc6df2882 Mon Sep 17 00:00:00 2001 From: j2blake Date: Sun, 24 Jun 2012 18:08:07 +0000 Subject: [PATCH] NIHVIVO-3772 Add license tag. --- doc/setting_up_orng.html | 51 ++++++++++++++++++++++------------------ 1 file changed, 28 insertions(+), 23 deletions(-) diff --git a/doc/setting_up_orng.html b/doc/setting_up_orng.html index 53acd05f..a7f2ca5b 100644 --- a/doc/setting_up_orng.html +++ b/doc/setting_up_orng.html @@ -30,7 +30,7 @@

ORNG supports gadgets using a modified version of Apache Shindig. - These instructions tell you how to install the ORNG Shindig web application, + These instructions tell you how to install the Shindig-ORNG web application, and how to configure it to work with VIVO.

@@ -50,8 +50,8 @@
  • Setting up the Gadgets
      -
    1. The shindig_apps database table
      2. -
    2. The shindig_app_views database table
      3. +
    3. The orng_apps database table
      4. +
    4. The orng_app_views database table
    • @@ -62,17 +62,17 @@

    I.i. Create database tables and procedures

    - Shindig uses several database tables in MySQL to store its data: + Shindig-ORNG uses several database tables in MySQL to store its data: which gadgets appear on which pages, how large are the gadgets, what information applies to each individual, and more. - Shindig also creates stored procedures in MySQL. These are small + Shindig-ORNG also creates stored procedures in MySQL. These are small pieces of code that simplify the use of the database tables.

    In the VIVO distribution directory, a file called vitro-core/opensocial/shindig_orng_tables.sql contains SQL commands that create the tables and - stored procedures for Shindig to use. + stored procedures for Shindig-ORNG to use.

    Tell MySQL to process this file with a command like this: @@ -116,7 +116,7 @@

    - Shindig uses an encryption key to insure that the communication + Shindig-ORNG uses an encryption key to insure that the communication between the gadget and the server is secure. You should create a file that contains the encryption key, and store that file in the shindig/openssl directory that you created. @@ -138,7 +138,7 @@

    I.iii. Modify Tomcat settings

    - The Shindig application must know where to find the configuration file that you created in + The Shindig-ORNG application must know where to find the configuration file that you created in Step I. It must also know its own URL, so that URL can be inserted into the gadgets.

    @@ -150,13 +150,13 @@ If this file does not exist in Tomcat's bin directory, you can create it.

    - Here is an example of the setenv file, showing only the Shindig requirements: + Here is an example of the setenv file, showing only the Shindig-ORNG requirements: 

    export CLASSPATH=/usr/local/vivo/data/shindig/conf
 export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080'
    This assumes that your setenv file was empty before starting this process, - and that you used the default location for the Shindig configuration file in Step I. + and that you used the default location for the Shindig-ORNG configuration file in Step I. In fact, it's more common for the setenv file to contain other parameters besides - those used for Shindig. In that case, it might look more like this: + those used for Shindig-ORNG. In that case, it might look more like this: 
    export CLASSPATH=/usr/local/vivo/data/shindig/conf
 export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.headless=true -Xms1024m -Xmx1024m -XX:MaxPermSize=128m'

    @@ -165,7 +165,7 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.he

    In the VIVO distribution directory, the file called deploy.properties contains configuration options for the VIVO application. - You must set some additional parameters so VIVO will be able to communicate with Shindig. + You must set some additional parameters so VIVO will be able to communicate with Shindig-ORNG.

    @@ -179,7 +179,7 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.he @@ -190,7 +190,7 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.he @@ -219,7 +219,7 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.he 

                    ant orng

    - to configure the ORNG Shindig application and deploy it to Tomcat's webapps directory. + to configure the Shindig-ORNG application and deploy it to Tomcat's webapps directory.

    I.vi Does it work?

    @@ -317,7 +317,7 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.he
  • vivo.all.log contains an error message: - 
    MySQLSyntaxErrorException: Table 'vivo.shindig_apps' doesn't exist
    + 
    MySQLSyntaxErrorException: Table 'vivo.orng_apps' doesn't exist
    • @@ -364,11 +364,16 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.he parameters.

    - The tables are named shindig_apps and shindig_app_views, + The tables are named orng_apps and orng_app_views, and are described in the following sections.

    -

    II.i The shindig_apps database table

    +

    II.i The orng_apps database table

    +

    + This table acts as a dictionary of the available gadgets. + Includes the name and ID of the gadget and where the source code is stored on the web. + Also a flag for disabling the gadget, and some additional fields. +

    - The base URL that VIVO will use when contacting the ORNG Shindig application. + The base URL that VIVO will use when contacting the Shindig-ORNG application. Usually, this is the same host and port number as VIVO itself, with a context path of shindigorng
    - The host name and port number of the Token Service that ORNG shindig creates. + The host name and port number of the Token Service that Shindig-ORNG creates. Note that a value of localhost or 127.0.0.1 will not work. You must provide the actual host name of your machine, followed by :8777
    @@ -382,7 +387,7 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.he @@ -410,17 +415,17 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.he - +
    Identifies the gadget. In particular, this will be used to determine which rows in the - shindig_app_views table should apply to this gadget. + orng_app_views table should apply to this gadget.
    tinyint(1) If set to 0, this gadget will never be displayed. - If set to 1, it is displayed according to the rules in the shindig_app_views table. + If set to 1, it is displayed according to the rules in the orng_app_views table.
    channels varchar(255)unknownKeywords that identify the communication channels between the gadget and VIVO.
    -

    II.ii The shindig_app_views database table

    +

    II.ii The orng_app_views database table

    @@ -432,7 +437,7 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.he
    appid int(11) - Determines which gadget in shindig_apps is affected by this rule. + Determines which gadget in orng_apps is affected by this rule.