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 @@
- 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'+
@@ -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 orngto 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. +
- 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. +
+ ++ 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. +
+ ++ 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. +
+ +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
Unable to load properties: shindig.orng.properties+
Unable to load properties: shindigorng.properties
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
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.
PersonFilterID | int(11) | -unknown | +deprecated - usually set to NULL | ||||
enabled | @@ -427,6 +526,23 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.he
Field | @@ -444,14 +560,36 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.heviewer_req | char(1) |
- unknown
+ What requirements must the viewer satisfy in order to see this view?
+
|
---|---|---|---|
owner_req | char(1) |
- unknown
+ What requirements must the owner of this page satisfy in order to see this view?
+
|
|
+ Some things to be aware of when working with OpenSocial gadgets. +
+ ++ 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+ + +
+ 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. +
+ ++ TBD +