Disclaimer

ENCompass 3.6 User Criteria Saver

Instructions

• Always back up a file before making changes!!!
• Just to be safe, comment out, don't delete, existing code before you make changes to your copy.
• Instructions are in bold
• Explanations are italicized.
• Enough with the warnings, here are the instructions.

1. Download the JavaScripts from http://lib-serv.tccd.edu/code/encompass/encompass_criteria3.6.zip
   
   
2. Drop the file "tcc.js" in your javascript directory.
   (by default, the javascript directory for ENCompass 3.6 is located at /m1/encompass/yourcollection/tomcat/default/context/logicrouter/js36ui)
   These are the javascripts that do all the work.
   
   
3. In head_enc36ui.xslt find:
   
   <script language="JavaScript1.2" src="{$jsDir}validate.js">
      <xsl:text> </xsl:text>
   </script>
   
   Below it, add this line:
   
   <script language="JavaScript1.2" src="{$jsDir}tcc.js">
      <xsl:text> </xsl:text>
   </script>
   
   This allows the javascripts to be used from the Basic Search and Advanced Search forms.
   
   
4. In header_footer_enc36ui.xslt find:
   
   </body>
   
   ABOVE the </body> tag, add:
   
   <script language="Javascript">
      setChecks();
      removeHierCookie();
   </script>
   
   This reads the cookies once the page has loaded and sets the input fields based on the cookies.
   
   
5. In child_logic_enc36ui.xslt find the last two (2) instances of:
   
   <img src="{$imageDir}minus.gif" alt="collapse thread" border="0" class="hidden"/>
   and
   <img src="{$imageDir}plus.gif" alt="expand thread" border="0" class="hidden"/>
   
   DO NOT change the instance under <xsl:template name="DoChildGroupLogic">!
   
   The first instance is under <xsl:template name="DoThreadLogic">
   Replace them to read:
   
   <img src="{$imageDir}minus.gif" alt="collapse thread" border="0" class="hidden" onClick="getChecks()"/>
   <xsl:call-template name="FormatHierCookies">
      <xsl:with-param name="hier_val" select="@hier"/>
      <xsl:with-param name="object_id">
         <xsl:value-of select="*[name()=$object_ID]"/>
      </xsl:with-param>
   </xsl:call-template>
   
   and
   <img src="{$imageDir}plus.gif" alt="expand thread" border="0" class="hidden" onClick="getChecks()"/>
   <xsl:call-template name="FormatHierCookies">
      <xsl:with-param name="hier_val" select="@hier"/>
      <xsl:with-param name="object_id">
         <xsl:value-of select="*[name()=$object_ID]"/>
      </xsl:with-param>
   </xsl:call-template>
   
   The second instance is under <xsl:template name="DoPubThreadLogic">
   Replace them to read:
   
   <img src="{$imageDir}minus.gif" alt="collapse thread" border="0" class="hidden" onClick="getChecks()"/>
   <xsl:call-template name="FormatHierCookies">
      <xsl:with-param name="hier_val" select="@hier"/>
      <xsl:with-param name="object_id">
         <xsl:value-of select="*[name()=$object_ID]"/>
      </xsl:with-param>
   </xsl:call-template>
   
   and
   <img src="{$imageDir}plus.gif" border="0" alt="Open Item" onClick="getChecks()"/>
   <xsl:call-template name="FormatHierCookies">
      <xsl:with-param name="hier_val" select="@hier"/>
      <xsl:with-param name="object_id">
         <xsl:value-of select="*[name()=$object_ID]"/>
      </xsl:with-param>
   </xsl:call-template>
   
   This runs the scripts when the user clicks a "+" or "-" that collects all the current data and stores it in a cookie.
   
   
6. In misctools_enc36ui.xslt, find:
   
   <!-- ############################################################################ -->
   
      <xsl:template name="FormatHier">
         <xsl:param name="hier_val"/>
         <script language="javascript">jsIndent("<xsl:value-of select="$hier_val"/>")</script>
      </xsl:template>
   
   <!-- ############################################################################ -->
   
   Below this, add:
   
      <xsl:template name="FormatHierCookies">
         <xsl:param name="hier_val"/>
         <xsl:param name="object_id"/>
         <script language="javascript">hierCookie("<xsl:value-of select="$hier_val"/>", "<xsl:value-of select="$object_id"/>")</script>
      </xsl:template>
   
   <!-- ############################################################################ -->
   
   This takes information sent from the xsl:call-template added in step 6 above and calls a javascript that creates a cookie with hierarchy information.
   
   That should do it for saving criteria when users click the "+" and "-" buttons.

There are a couple of other features and scripts included that you may want to take advantage of:
• To set default collections,
  1. Open your default ENCompass search page in your web browser.
  2. Click the View XML button.
  3. Make note of the <OI>#</OI> numbers associated with the collections you wish to be defaults.
  4. Now open tcc.js and find Set Default Collections Here
  5. Follow the instructions you find there.
• To set default search types (Global, Subject, Name, Title) in the Advanced Search form:
  1. Open tcc.js.
  2. Find Set default search types.
  3. Follow the examples.
• To add a "Set All Checks" button:
  • In basic_search_enc36ui.xslt or advanced_search_enc36ui.xslt where you would like the button to appear, add:
    
    <input type="button" value="Set All" onclick="setAllChecks(true);" />
    
    (Note that this button must be between the <form></form> tags)
    
    
• To add a "Clear All Checks" button:
  • In basic_search_enc36ui.xslt or advanced_search_enc36ui.xslt where you would like the button to appear, add:
    
    <input type="button" value="Clear All" onclick="setAllChecks(false);" />
    
    (Note that this button must be between the <form></form> tags)
    
    
• To add a "Reset All To Defaults" button:
  • In basic_search_enc36ui.xslt or advanced_search_enc36ui.xslt where you would like the button to appear, add:
    
    <input type="button" name="Reset" value="Reset" onclick="clearChecks();"/>
    
    (Note that this button must be between the <form></form> tags)
    
    
• For Example...
  In basic_search_enc36ui.xslt, replace
  <input type="hidden" name="api_1" value="COLLECTION_REPOLOGIN"/>
  <xsl:call-template name="SearchButton"/>
  with
  <input type="hidden" name="api_1" value="COLLECTION_REPOLOGIN"/>
     <tr>
        <td colspan="2">
           <table border="0">
              <tr>
                 <td><input type="button" value="Set All" onclick="setAllChecks(true);" /></td>
                 <td><input type="button" value="Clear All" onclick="setAllChecks(false);" /></td>
                 <td><input type="button" name="Reset" value="Reset" onclick="clearChecks();"/></td>
              </tr>
           </table>
        </td>
     </tr>
  <xsl:call-template name="SearchButton"/>
  
  
  In advanced_search_enc36ui.xslt, replace
  <input type="hidden" name="pm_BT" value=""/>
  <tr>
     <td nowrap="" class="fieldLabel">
        <xsl:text>Display: </xsl:text>
  with
  <input type="hidden" name="pm_BT" value=""/>
  <tr>
     <td colspan="2">
        <table border="0">
           <tr>
              <td><input type="button" value="Set All" onclick="setAllChecks(true);" /></td>
              <td><input type="button" value="Clear All" onclick="setAllChecks(false);" /></td>
              <td><input type="button" name="Reset" value="Reset" onclick="clearChecks();"/></td>
           </tr>
        </table>
     </td>
  </tr>
  <tr>
     <td nowrap="" class="fieldLabel">
        <xsl:text>Display: </xsl:text>
  

How It Works

When the user clicks a "+" or "-" to open or close a collection, the getChecks() javascript and the FormatHierCookies.xslt template are called. These scripts gather the values of each input field, checkbox, and hierarchy name and value and create name-value strings, which it stores as cookies on the user's browser.

The page then reloads with the altered state of the collection (open or closed.) After the page loads (or near the end of the load), the setChecks() javascript is called. This script reads and parses the cookies, then sets all the values to the state before the page refreshed.

With these scripts, we can also set default values for the user's first visit to the page. We can also make it easy for the user to set every checkbox, to clear every checkbox, and to reset the forms to the default states.

A Trick for Replacing "Search Native Interface"

In objecttools_enc36ui.xslt, find
   <xsl:variable name="getObjLink" select="/ENCOMPASS/ENCOMPASS_BATCHQUERY/GET_OBJECT_XML/SETTAGS/OXML/EncRepoObject/ObjectLink"/>
Right below it, add
   <xsl:variable name="db-name" select="/ENCOMPASS/ENCOMPASS_BATCHQUERY/FULLRECORD_HISTORY/CURRENT/SETTAGS/RN"/>

Now find (in the same file)
   <xsl:text>Search Native Interface</xsl:text>
Replace it with
   <xsl:choose>
      <xsl:when test="$db-name != ''">
         Search <xsl:value-of select="$db-name"/>
      </xsl:when>
      <xsl:otherwise>
         <xsl:text>Search Native Interface</xsl:text>
      </xsl:otherwise>
   </xsl:choose>

This will replace Search Native Interface with, for example, Search Academic Search Premier (whatever you've called your database in ENCompassSA).

Troubleshooting

Questions can be sent to Jim Robinson at Tarrant County College, but the help I can provide is limited due to time constraints and lack of access to your system for debugging... ;-)

Some hints about debugging javascripts:

• If a script isn't working as you'd expect, try putting an alert message in the function to see if the code is being reached and that it is returning what you expect. For example:
  function testFunction() {
     var myForm = document.forms['myForm'];
     alert("myForm="+myForm);
     other code...;
  }
  
• If the code isn't being called, check the syntax, the path to the javascript source, and your objects. Don't be afraid to stick an object in an alert message to make sure it's an object.
• Download a free Firefox browser and choose Tools->JavaScript Console.
• Download an Opera browser (http://www.opera.com) and turn on "Report JavaScript Errors".
• Remember: browser detection is poor coding...object detection will serve you much better.