diff --git a/doc/setting_up_orng.html b/doc/setting_up_orng.html index a7f2ca5b..57168d97 100644 --- a/doc/setting_up_orng.html +++ b/doc/setting_up_orng.html @@ -48,12 +48,19 @@
  • Does it work?
  • -
  • Setting up the Gadgets +
  • Changing the gadget configurations
    1. The orng_apps database table
    2. The orng_app_views database table
  • +
  • Additional Considerations +
      +
    1. Re-running the deployment script
    2. +
    3. Resetting the gadget cache
    4. +
    5. Issues with Linked Open Data
    6. +
    +

  • @@ -150,9 +157,16 @@ 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-ORNG requirements: + Here is an example of the setenv.sh file, showing only the Shindig-ORNG requirements:

    export CLASSPATH=/usr/local/vivo/data/shindig/conf
     export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080'
    +

    +

    + Here is the equivalent file for an installation in Windows. +

    set CLASSPATH=C:\vivo\data\shindig\conf
    +set 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-ORNG configuration file in Step I. In fact, it's more common for the setenv file to contain other parameters besides @@ -160,6 +174,11 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080'

    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'

    +

    + Or, for Windows: +

    set CLASSPATH=C:\vivo\data\shindig\conf
    +set CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.headless=true -Xms1024m -Xmx1024m -XX:MaxPermSize=128m'
    +

    I.iv Configure VIVO

    @@ -216,17 +235,77 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.he

    At the command line, from the top level of the VIVO distribution directory, type: -

    -
                    ant orng
    -

    +

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

    +

    + The main VIVO application must also be re-deployed in order to accept the new settings + in deploy.properties. At the command line, from the top level of the VIVO distribution + directory, type: +

                    ant deploy
    + to re-deploy VIVO with the new settings. +

    I.vi Does it work?

    + +

    Startup tests

    +

    - Start VIVO. Enter a search term in the search box, and view the results. Check the gadgets there. - Navigate to a person's profile page. Again, check for the expected gadgets. + Start VIVO, and verify that you can see VIVO's home page in a browser.

    +

    + On startup, VIVO runs a series of self-diagnostics, or "smoke tests". If these tests find + any problems with the OpenSocial configuration, you will see a warning message instead of + the VIVO home page. +

    +

    + Some of VIVO's "smoke tests" are run after the startup is finished, and may take up to a minute + to complete. If one of these tests fails, you will see the warning message as you + navigate from one VIVO page to the next. +

    +

    + If one of the OpenSocial tests fails, you may continue to use VIVO, but it is + likely that no gadgets will be shown. + You can review the warning message by seleting the "Startup Status" + link from the "Site Admin" page. +

    + +

    Search page

    + +

    + If you loaded the example gadgets, you should be able to see the "Google Search" gadget on the + Search Results page in VIVO. +

    +

    + Every VIVO installation comes with a geographic data model, so type "Chile" in the search box, + and view the results. Near the bottom of the page, you should see the "OpenSocial" section heading, + and beneath it, a gadget offering "Full Text Search Results". This gadget does a google search + at UCSF, using the search term that you entered. Again, this gadget is just an example, to show + what is possible with OpenSocial gadgets and VIVO. +

    +

    + The first time you bring up the search page, it may take several seconds for the gadget to + appear. After the first time, the gadget response should be must faster. +

    + +

    Profile page

    + +

    + If your VIVO installation contains profiles of people, you can see several gadgets on their + profile pages. You must be logged in to VIVO, with authority to edit the profile you are + viewing. +

    +

    + Go to a personal profile page in VIVO. If you loaded the example gadgets, you will see + the "OpenSocial" section heading above the property lists, with an assortment of + example gadgets available for experimentation. +

    +

    + As with the search page, the first appearance of the gadgets may be slow. +

    + +

    Troubleshooting

    +

    If the gadgets do not appear as you expect, look for these symptoms, and check for the corresponding possible causes. @@ -236,6 +315,27 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.he Symptoms Possible causes + + +

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

    II. Setting up the Gadgets

    +

    II. Changing the gadget configurations

    VIVO will look at tables in MySQL to determine what gadgets should be made available, @@ -371,8 +471,7 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.he

    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. + It includes the name and ID of the gadget and where the source code is stored on the web.

    @@ -408,7 +507,7 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.he - + @@ -427,6 +526,23 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.he

    II.ii The orng_app_views database table

    +

    + This table tells how, where, and when to display the gadgets that are described in orng_apps. + Each row in this table is a "view", describing a single gadget and the rules that determine whether + the gadget will be displayed on a particular page. +

    + +

    + Note: If a gadget is described and enabled in the orng_apps table, but has no records in the + orng_app_views table, the gadget will be displayed without restriction on all ORNG-enabled + pages. This can be helpful when developing a new gadget. To avoid this, either +

    +

    +
    PersonFilterID int(11)unknowndeprecated - usually set to NULL
    enabled
    @@ -444,14 +560,36 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.he @@ -541,6 +679,46 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.he
    Fieldviewer_req char(1) - unknown + What requirements must the viewer satisfy in order to see this view? +
      +
    • + NULL -- There are no requirements on the viewer. +
    • +
    • + 'U' -- The viewer must be logged in to VIVO. +
    • +
    • + 'R' -- The viewer must be logged in, and must be registered as a user of this gadget. +
    • +
    owner_req char(1) - unknown + What requirements must the owner of this page satisfy in order to see this view? +
      +
    • + NULL -- There are no requirements on the owner of the page. +
    • +
    • + 'R' -- The owner of the page must choose to display this gadget to the public. +
    • +
    • + 'S' -- The viewer must be the owner of the page being viewed. +
    • +
    + +

    III. Additional Considerations

    + +

    + Some things to be aware of when working with OpenSocial gadgets. +

    + +

    III.i. Re-running the deployment script

    + +

    + The OpenSocial framework relies on several of the settings in the deploy.properties file, + in addition to the ones that are explicitly linked to it. +

    +

    + Each time you change the settings in deploy.properties, you should re-deploy + the framework with +

              ant orng
    +

    + +

    III.ii. Resetting the gadget cache

    +

    + For efficiency, VIVO reads the gadget configuration only when it starts up. VIVO keeps + a copy of the database tables in memory, for efficiency. +

    +

    + This means that if you change the gadget configuration in the database tables, you must + either tell VIVO to read the tables again. Direct your browser to + the orng/clearcache page within VIVO. For example, +

            http://localhost:8080/vivo/orng/clearcache
    + VIVO will re-read the gadget configuration, and display the VIVO home page. +

    +

    + You can achieve the same effect by restarting VIVO. +

    + +

    III.iii. Issues with Linked Open Data

    + +

    + TBD +