Merge pull request #11 from AtlasSystems/feature/33859/UpdateSiteCodeDocumentation

Feature/33859/update site code documentation

Author: amorgan-atlas-sys

Catalog.lua

@@ -10,7 +10,7 @@ settings.AutoRetrieveItems = GetSetting("AutoRetrieveItems");
 settings.RemoveTrailingSpecialCharacters = GetSetting("RemoveTrailingSpecialCharacters");
 settings.AlmaApiUrl = GetSetting("AlmaAPIURL");
 settings.AlmaApiKey = GetSetting("AlmaAPIKey");
-settings.PrimoSiteCode = GetSetting("PrimoSiteCode");
+settings.PrimoCode = GetSetting("PrimoCode");
 settings.IdSuffix = GetSetting("IdSuffix");
 
 local interfaceMngr = nil;
@@ -252,13 +252,13 @@ function PerformSearch(searchInfo)
     end
 
     local searchUrl = "";
-    local encodedSiteCode = Utility.URLEncode(settings.PrimoSiteCode):gsub("%%", "%%%%");
+    local encodedSiteCode = Utility.URLEncode(settings.PrimoCode):gsub("%%", "%%%%");
     local encodedSearchType = Utility.URLEncode(DataMapping.SearchTypes[searchInfo[1]]["PrimoField"]):gsub("%%", "%%%%");
     local encodedSearchTerm = Utility.URLEncode(searchTerm):gsub("%%", "%%%%");
 
     --Construct the search url based on the base catalog url and search style.
     searchUrl = settings.CatalogUrl .. DataMapping.SearchStyleUrls[searchInfo[2]]
-    :gsub("{PrimoSiteCode}", encodedSiteCode)
+    :gsub("{PrimoCode}", encodedSiteCode)
     :gsub("{SearchType}", encodedSearchType)
     :gsub("{SearchTerm}", encodedSearchTerm);
 

Config.xml

@@ -2,7 +2,7 @@
 <Configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <Name>Alma Primo Definitive Catalog Search</Name>
   <Author>Atlas Systems</Author>
-  <Version>1.2.2</Version>
+  <Version>2.0.0</Version>
   <Active>True</Active>
   <Type>Addon</Type>
   <Description>Catalog Search and Import Addon that uses Alma as the catalog and Primo or Primo VE as the discovery layer.</Description>
@@ -39,8 +39,8 @@
     <Setting name="AlmaAPIKey" value="" type="string">
       <Description>API key used for interacting with the Alma API.</Description>
     </Setting>
-    <Setting name="PrimoSiteCode" value="" type="string">
-      <Description>The code that identifies the site in Primo Deep Links. Ex: vid={PrimoSiteCode}</Description>
+    <Setting name="PrimoCode" value="" type="string">
+      <Description>For Primo, the Primo Site Code that identifies the site in Primo Deep Links. Ex: vid={Primo Site Code} For Primo VE, the Primo View Code (including the colon) is also included in this setting. Ex: vid={Primo Site Code}:{Primo View Code}</Description>
     </Setting>
     <Setting name="IdSuffix" value="" type="string">
       <Description>The last four digits of MMS IDs and IE IDs for your institution. This setting is required and should not be left blank.</Description>

DataMapping.lua

@@ -111,8 +111,8 @@ DataMapping.SearchTypes["Catalog Number"] = {
 -- Words in brackets will be replaced by their corresponding settings or values by the addon.
 -- Only one Query and one Browse style URL may be defined. These will be concatenated to the
     -- end of the CatalogUrl setting when searching.
-DataMapping.SearchStyleUrls["Query"] = "search?vid={PrimoSiteCode}&query={SearchType},contains,{SearchTerm},AND&tab=books&search_scope=default_scope&mode=advanced";
-DataMapping.SearchStyleUrls["Browse"] = "browse?vid={PrimoSiteCode}&browseQuery={SearchTerm}&browseScope={SearchType}&innerPnxIndex=-1&numOfUsedTerms=-1&fn=BrowseSearch";
+DataMapping.SearchStyleUrls["Query"] = "search?vid={PrimoCode}&query={SearchType},contains,{SearchTerm},AND&tab=books&search_scope=default_scope&mode=advanced";
+DataMapping.SearchStyleUrls["Browse"] = "browse?vid={PrimoCode}&browseQuery={SearchTerm}&browseScope={SearchType}&innerPnxIndex=-1&numOfUsedTerms=-1&fn=BrowseSearch";
 
 -- Source Fields: Aeon
 -- Only necessary for source fields not associated with a SearchType. To define source fields used in searches, 

README.md

@@ -15,7 +15,7 @@ The addon is located within an request or item record of an Atlas Product. It is
 
 > **CatalogURL:** The base URL that the query strings are appended to. The Catalog URL structure is `{URL of the catalog}/primo-explore/` for Primo and `{URL of the catalog}/discovery/` for Primo VE.
 >
-> **HomeURL:** Home page of the catalog. The Home URL structure is `{URL of the catalog}/primo-explore/search?vid={Primo Site Code}` for Primo and `{URL of the catalog}/discovery/search?vid={Primo Site Code}` for Primo VE.
+> **HomeURL:** Home page of the catalog. The Home URL structure is `{URL of the catalog}/primo-explore/search?vid={Primo Site Code}` for Primo and `{URL of the catalog}/discovery/search?vid={Primo Site Code}:{Primo View Code}` for Primo VE.
 >
 > **AutoSearch:** Defines whether the search should be automatically performed when the form opens. *Default: `true`*
 >
@@ -34,7 +34,7 @@ The addon is located within an request or item record of an Atlas Product. It is
 >
 >**AlmaAPIKey:** API key used for interacting with the Alma API.
 >
->**PrimoSiteCode:** The code that identifies the site in Primo Deep Links. Ex: vid={PrimoSiteCode}
+>**PrimoCode:** For Primo, the Primo Site Code that identifies the site in Primo Deep Links. Ex: `vid={Primo Site Code}` For Primo VE, the Primo View Code (including the colon) is also included in this setting. Ex: `vid={Primo Site Code}:{Primo View Code}`
 >
 >**IdSuffix:** The last four digits of MMS IDs and IE IDs for your institution. These can be found in the URL of any record opened from the results list. This setting is required and should not be left blank.
 
@@ -69,8 +69,8 @@ Below are the default configurations for the catalog addon. The mappings within
 ### SearchTypes
 The search URL is constructed using the formulas defined in *DataMapping.SearchStyleUrls["Query"]* and *DataMapping.SearchStyleUrls["Browse"]*. The default configurations are as follows:
 
->Query: *`{Catalog URL}`search?vid=`{Primo Site Code}`&query=`{Search Type}`,contains,`{Search Term}`AND&search_scope=default_scope&mode=advanced*
->Browse: *`{Catalog URL}`browse?vid=`{Primo Site Code}`&browseQuery=`{Search Term}`&browseScope=`{Search Type}`&innerPnxIndex=-1&numOfUsedTerms=-1&fn=BrowseSearch"*
+>Query: *`{CatalogURL}`search?vid=`{PrimoCode}`&query=`{SearchType}`,contains,`{SearchTerm}`AND&search_scope=default_scope&mode=advanced*
+>Browse: *`{CatalogURL}`browse?vid=`{PrimoCode}`&browseQuery=`{SearchTerm}`&browseScope=`{SearchType}`&innerPnxIndex=-1&numOfUsedTerms=-1&fn=BrowseSearch"*
 
 *Default SearchTypes Configuration:*