LP1517298: Simplifying and cleaning up matomo implementation

Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>

diff --git a/Open-ILS/src/sql/Pg/950.data.seed-values.sql b/Open-ILS/src/sql/Pg/950.data.seed-values.sql
index ff5b49a..887069d 100644 (file)
--- a/Open-ILS/src/sql/Pg/950.data.seed-values.sql
+++ b/Open-ILS/src/sql/Pg/950.data.seed-values.sql
@@ -1940,8 +1940,8 @@ INSERT INTO permission.perm_list ( id, code, description ) VALUES
     'View booking resource types', 'ppl', 'description')),
  ( 622, 'VIEW_BOOKING_RESOURCE', oils_i18n_gettext(622,
     'View booking resources', 'ppl', 'description')),
- ( 623, 'UPDATE_ORG_UNIT_SETTING.opac.analytics.use_matomo', oils_i18n_gettext(623,
-    'Set OPAC to use Matomo tracking', 'ppl', 'description'))
+ ( 623, 'MATOMO_UPDATE_SETTINGS', oils_i18n_gettext(623,
+    'Allows a user to configure Matomo Analytics org unit settings', 'ppl', 'description'))
 ;
 
 

diff --git a/Open-ILS/src/sql/Pg/upgrade/xxxx.data.support_matomo.sql b/Open-ILS/src/sql/Pg/upgrade/xxxx.data.support_matomo.sql
index a90e83b..9fef212 100644 (file)
--- a/Open-ILS/src/sql/Pg/upgrade/xxxx.data.support_matomo.sql
+++ b/Open-ILS/src/sql/Pg/upgrade/xxxx.data.support_matomo.sql
@@ -1,34 +1,31 @@
-       BEGIN;
+      BEGIN;
 
-       SELECT evergreen.upgrade_deps_block_check('xxxx', :eg_version);
+      SELECT evergreen.upgrade_deps_block_check('xxxx', :eg_version);
+
+      INSERT INTO permission.perm_list ( id, code, description ) VALUES
+      ( 623, 'MATOMO_UPDATE_SETTINGS', oils_i18n_gettext(623,
+         'Allows a user to configure Matomo Analytics org unit settings', 'ppl', 'description'))
+      ;
 
        INSERT into config.org_unit_setting_type
-       ( name, grp, label, description, datatype, fm_class ) VALUES
-      ( 'opac.analytics.matomo_id', 'opac',
+       ( name, grp, label, description, datatype, fm_class, update_perm ) VALUES
+       ( 'opac.analytics.matomo_id', 'opac',
           oils_i18n_gettext('opac.analytics.matomo_id',
-               'Requires the Matomo ID',
+               'The Matomo Site ID',
                'coust', 'label'),
           oils_i18n_gettext('opac.analytics.matomo_id',
-               'Requires the Matomo ID',
+               'The Site ID for your Evergreen catalog. You can find the Site ID in the tracking code you got from Matomo.',
                'coust', 'description'),
-          'string', NULL),
-      ( 'opac.analytics.matomo_url', 'opac',
+          'string', NULL, 623),
+       ( 'opac.analytics.matomo_url', 'opac',
           oils_i18n_gettext('opac.analytics.matomo_url',
-               'Requires the url to the Matomo software',
+               'The url to the Matomo software',
                'coust', 'label'),
           oils_i18n_gettext('opac.analytics.matomo_url',
-               'Requires the url to the Matomo software',
+               'The URL for your the Matomo software. Be sure to include the trailing slash, e.g. https://my-evergreen.matomo.cloud/',
                'coust', 'description'),
-          'string', NULL)
+          'string', NULL, 623)
       ;
 
-      INSERT INTO permission.perm_list ( id, code, description ) VALUES
-      ( 623, 'UPDATE_ORG_UNIT_SETTING.opac.analytics.use_matomo', oils_i18n_gettext(623,
-         'Set OPAC to use Matomo tracking', 'ppl', 'description')),
-      ;
-
-      UPDATE config.org_unit_setting_type SET update_perm = 623 WHERE name = 'opac.analytics.matomo_id';            
-      UPDATE config.org_unit_setting_type SET update_perm = 623 WHERE name = 'opac.analytics.matomo_url';
-
       COMMIT;
 

diff --git a/Open-ILS/src/templates/opac/parts/base.tt2 b/Open-ILS/src/templates/opac/parts/base.tt2
index ea47a60..835c672 100644 (file)
--- a/Open-ILS/src/templates/opac/parts/base.tt2
+++ b/Open-ILS/src/templates/opac/parts/base.tt2
@@ -22,11 +22,10 @@
         [% '<style>'; custom_css ; '</style>' %]                                          
         [% END %]
 
-        [% IF ctx.get_org_setting(ctx.search_ou, 'opac.analytics.use_matomo') == 1 %]
+        [% matomo_id = ctx.get_org_setting(ctx.search_ou, 'opac.analytics.matomo_id'); %]
+        [% matomo_url = ctx.get_org_setting(ctx.search_ou, 'opac.analytics.matomo_url'); %]  
+        [% IF matomo_id && matomo_url %]
            [% matomo_enabled = 1; %]
-           [% matomo_id = ctx.get_org_setting(ctx.search_ou, 'opac.analytics.matomo_id'); %]
-           [% matomo_url = ctx.get_org_setting(ctx.search_ou, 'opac.analytics.matomo_url'); %]  
-           [% INCLUDE 'opac/parts/matomo_analytics.tt2' %]                                       
         [% END %]
 
         [%- libname = ctx.get_aou(ctx.search_ou).name;

diff --git a/docs/RELEASE_NOTES_NEXT/Administration/lp1517298_matomo.adoc b/docs/RELEASE_NOTES_NEXT/Administration/lp1517298_matomo.adoc
index 79f977e..69216d7 100644 (file)
--- a/docs/RELEASE_NOTES_NEXT/Administration/lp1517298_matomo.adoc
+++ b/docs/RELEASE_NOTES_NEXT/Administration/lp1517298_matomo.adoc
@@ -1,5 +1,6 @@
 Matomo Support
 ^^^^^^^^^^^^^^
+
 Support for the open source web analytics platform Matomo is now 
 native to Evergreen. Support is on an org unit level so different 
 libraries can have separate or no analytics. Once you setup 
@@ -17,12 +18,6 @@ _paq.push(['setSiteId', '1']);
 In this case the number 1 will be your site ID.  
 
 These are set by YOAUSes opac.analytics.matomo_url and 
-opac.analytics.matomo_id respectively. There is also a boolean 
-setting called opac.analytics.use_matomo which determines if 
-it is used at all. Three new permsisions control access to 
-these: 
+opac.analytics.matomo_id respectively.  A new permsision,
+MATOMO_UPDATE_SETTINGS, controls access to these.
 
-UPDATE_ORG_UNIT_SETTING.opac.analytics.matomo_id
-UPDATE_ORG_UNIT_SETTING.opac.analytics.matomo_url
-UPDATE_ORG_UNIT_SETTING.opac.analytics.use_matomo
- 

diff --git a/docs/admin_initial_setup/designing_your_catalog.adoc b/docs/admin_initial_setup/designing_your_catalog.adoc
index a6b4797..ad5cde0 100644 (file)
--- a/docs/admin_initial_setup/designing_your_catalog.adoc
+++ b/docs/admin_initial_setup/designing_your_catalog.adoc
@@ -579,6 +579,20 @@ information. To use Matomo Analytics you need to:
 
 . Set up a hosted instance of Matomo
 . Add your Evergreen catalogue as a site
+. Use the Library Settings Editor to add a Matomo URL and Site ID for your library.
+
+Typically, Matomo will give you a block of javascript you can insert into
+web sites. One line will look like:
+
+var u="http://mylibrary.lib/matomo/";
+
+The full URL in the double quotes will be your URL.  Another line
+will look like:
+
+_paq.push(['setSiteId', '1']);
+
+In this case the number 1 will be your site ID.
+
 
 NoveList
 ~~~~~~~~