Bug 18060 - Add onboarding functionality to guide users through setting up labels for the first time
Summary: Add onboarding functionality to guide users through setting up labels for the...
Status: Failed QA
Alias: None
Product: Koha
Classification: Unclassified
Component: Label/patron card printing (show other bugs)
Version: 17.05
Hardware: All All
: P5 - low enhancement (vote)
Assignee: Bugs List
QA Contact: Testopia
URL:
Keywords:
Depends on: 18002
Blocks:
  Show dependency treegraph
 
Reported: 2017-02-06 08:35 UTC by Alex Buckley
Modified: 2019-03-21 05:23 UTC (History)
3 users (show)

See Also:
Change sponsored?: ---
Patch complexity: ---
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:


Attachments
Bug 18060 - Initial label onboarding tool (25.31 KB, patch)
2017-05-07 12:11 UTC, Alex Buckley
Details | Diff | Splinter Review
Bug 18060 - Initial label onboarding tool (25.32 KB, patch)
2017-05-07 13:24 UTC, Alex Buckley
Details | Diff | Splinter Review
Bug 18060 - Initial label onboarding tool with working retrieval of layouts and templates (25.13 KB, patch)
2017-05-07 23:08 UTC, Alex Buckley
Details | Diff | Splinter Review
Bug 18060 - Initial label onboarding tool with working retrieval of layouts and templates (26.29 KB, text/plain)
2017-05-07 23:22 UTC, Alex Buckley
Details
Bug 18060 - Working label onboarding tool for creating a layout and a template (24.34 KB, text/plain)
2017-05-21 08:03 UTC, Alex Buckley
Details
Bug 18060 - Implemented redirect to label-edit-profile.pl after the user has created a template using the label onboarding tool (14.14 KB, text/plain)
2017-05-21 13:18 UTC, Alex Buckley
Details
Bug 18060 - Removed unused form in onboardinginclude3.inc (4.68 KB, text/plain)
2017-05-21 13:20 UTC, Alex Buckley
Details
Bug 18060 - Label onboarding tool to be displayed when no labels or templates exist (45.88 KB, patch)
2017-06-29 23:58 UTC, Alex Buckley
Details | Diff | Splinter Review
Bug 18060 - Label onboarding tool to be displayed when no labels or templates exist (26.69 KB, patch)
2017-07-02 10:29 UTC, Alex Buckley
Details | Diff | Splinter Review
Bug 18060: Followup solving $layout error (1.11 KB, patch)
2017-07-10 08:31 UTC, Alex Buckley
Details | Diff | Splinter Review
Bug 18060: Followup solving $layout error (9.36 KB, patch)
2017-10-06 03:57 UTC, Alex Buckley
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Alex Buckley 2017-02-06 08:35:53 UTC
To help make the process of creating a label for the first time easier this bug report requires the implementation of onboarding tool in the labels area of the staff client to be run the first time the user wants to create a label.

The features of the onboarding tool includes tooltips and modal boxes to be displayed to the user to clarify the process to make a label.
Comment 1 Alex Buckley 2017-05-07 12:11:25 UTC
Created attachment 63224 [details] [review]
Bug 18060 - Initial label onboarding tool
Comment 2 Alex Buckley 2017-05-07 13:24:45 UTC
Created attachment 63225 [details] [review]
Bug 18060 - Initial label onboarding tool
Comment 3 Alex Buckley 2017-05-07 23:08:39 UTC
Created attachment 63228 [details] [review]
Bug 18060 - Initial label onboarding tool with working retrieval of layouts and templates
Comment 4 Alex Buckley 2017-05-07 23:22:09 UTC
Created attachment 63229 [details]
Bug 18060 - Initial label onboarding tool with working retrieval of layouts and templates
Comment 5 Alex Buckley 2017-05-21 08:03:10 UTC
Created attachment 63587 [details]
Bug 18060 - Working label onboarding tool for creating a layout and a template
Comment 6 Alex Buckley 2017-05-21 13:18:06 UTC
Created attachment 63588 [details]
Bug 18060 - Implemented redirect to label-edit-profile.pl after the user has created a template using the label onboarding tool
Comment 7 Alex Buckley 2017-05-21 13:20:18 UTC
Created attachment 63589 [details]
Bug 18060 - Removed unused form in onboardinginclude3.inc
Comment 8 Alex Buckley 2017-05-21 13:38:41 UTC
Test plan:

1. Make sure the creator_layouts, creator_templates and printers_profile database tables are empty 
2. In the Koha staff interface navigate to Tools->Label-creator
3. Notice that a blank screen appears
4. Apply patches attached to this bug report
5. Refresh the label-home.pl page
6. Notice a form to create a layout appears
7. Fill out this layout creation form and submit it
8. Notice another form also on label-home.pl appears to create a template
9. Fill out the template creation form and submit the form
10. Notice you are redirected to label-edit-profile.pl to create a printer profile
11. Test if the label onboarding tool forms are displaying appropriately by clicking on Manage->Label templates and delete the template you just created
12. Now go to label-home.pl and notice that the template creation form is displayed
13. Fill out the form and submit it
14. Notice you are not redirected to label-edit-profile.pl because you have already created a profile which has not been deleted instead a blank label-home.pl is displayed
Comment 9 Alex Buckley 2017-06-29 23:58:28 UTC
Created attachment 64733 [details] [review]
Bug 18060 - Label onboarding tool to be displayed when no labels or templates exist
Comment 10 Lee Jamison 2017-06-30 16:10:28 UTC
The 18002 dependency applies cleanly (tested during this bug as well as tested 18002 independently as well). However, this bug does not apply. See merge conflict message below.

Applying: Bug 18060 - Label onboarding tool to be displayed when no labels or templates exist
Using index info to reconstruct a base tree...
M       C4/Budgets.pm
M       acqui/acqui-home.pl
M       admin/aqbudgetperiods.pl
M       admin/aqbudgets.pl
M       admin/currency.pl
M       koha-tmpl/intranet-tmpl/prog/css/staff-global.css
M       koha-tmpl/intranet-tmpl/prog/en/includes/budgets-active-currency.inc
M       koha-tmpl/intranet-tmpl/prog/en/modules/acqui/acqui-home.tt
M       koha-tmpl/intranet-tmpl/prog/en/modules/admin/aqbudgetperiods.tt
M       koha-tmpl/intranet-tmpl/prog/en/modules/admin/aqbudgets.tt
<stdin>:749: new blank line at EOF.
+
warning: 1 line adds whitespace errors.
Falling back to patching base and 3-way merge...
Auto-merging koha-tmpl/intranet-tmpl/prog/en/modules/acqui/acqui-home.tt
CONFLICT (content): Merge conflict in koha-tmpl/intranet-tmpl/prog/en/modules/acqui/acqui-home.tt
Auto-merging koha-tmpl/intranet-tmpl/prog/en/includes/onboardinginclude3.inc
CONFLICT (add/add): Merge conflict in koha-tmpl/intranet-tmpl/prog/en/includes/onboardinginclude3.inc
Auto-merging koha-tmpl/intranet-tmpl/prog/en/includes/onboardinginclude2.inc
CONFLICT (add/add): Merge conflict in koha-tmpl/intranet-tmpl/prog/en/includes/onboardinginclude2.inc
Auto-merging koha-tmpl/intranet-tmpl/prog/en/includes/onboardinginclude1.inc
CONFLICT (add/add): Merge conflict in koha-tmpl/intranet-tmpl/prog/en/includes/onboardinginclude1.inc
Auto-merging koha-tmpl/intranet-tmpl/prog/css/staff-global.css
CONFLICT (content): Merge conflict in koha-tmpl/intranet-tmpl/prog/css/staff-global.css
Failed to merge in the changes.
Patch failed at 0001 Bug 18060 - Label onboarding tool to be displayed when no labels or templates exist
The copy of the patch that failed is found in:
   /home/vagrant/kohaclone/.git/rebase-apply/patch
When you have resolved this problem run "git bz apply --continue".
If you would prefer to skip this patch, instead run "git bz apply --skip".
To restore the original branch and stop patching run "git bz apply --abort".
Patch left in /tmp/Bug-18060---Label-onboarding-tool-to-be-displayed--p4jDwr.patch
Comment 11 Alex Buckley 2017-07-02 10:29:25 UTC
Created attachment 64766 [details] [review]
Bug 18060 - Label onboarding tool to be displayed when no labels or templates exist

Updated to apply cleanly with bug 18002

Please follow the test plan on comment 8
Comment 12 Marc Véron 2017-07-03 08:43:08 UTC
Sorry, after applying the patch (on top of 18002, refresh memcahed and plack), I get an Internal error.
Plack error log says:

Variable "$layout" is not available at /home/marc/koha/labels/label-home.pl line 55.
Can't call method "get_attr" on an undefined value at /home/marc/koha/labels/label-home.pl line 55.
Comment 13 Alex Buckley 2017-07-10 08:31:43 UTC
Created attachment 64951 [details] [review]
Bug 18060: Followup solving $layout error
Comment 14 Alex Buckley 2017-07-11 01:44:38 UTC
Hi Marc 

Hopefully this attached followup patch solves the issue, it does on my machine
Comment 15 Lee Jamison 2017-07-11 12:44:58 UTC
Hi Alex,

Sorry, but even after applying your followup 64951 patch the same plack error Marc points out still occurs for me. I tested it on a fresh kohadevbox
Comment 16 Katrin Fischer 2017-08-16 17:31:54 UTC
Hi Alex, applied this on top of 18002.

QA tools first:

 FAIL	C4/Creators/Layout.pm
   OK	  critic
   OK	  forbidden patterns
   OK	  git manipulation
   OK	  pod
   FAIL	  pod coverage
		POD is missing for 'retrieve_all'
   OK	  spelling
   OK	  valid

 FAIL	C4/Creators/Profile.pm
   OK	  critic
   OK	  forbidden patterns
   OK	  git manipulation
   OK	  pod
   FAIL	  pod coverage
		POD is missing for 'retrieve_all'
   OK	  spelling
   OK	  valid

 FAIL	C4/Creators/Template.pm
   OK	  critic
   OK	  forbidden patterns
   OK	  git manipulation
   OK	  pod
   FAIL	  pod coverage
		POD is missing for get_next_label_pos
		POD is missing for retrieve_all
   OK	  spelling
   OK	  valid

 FAIL	koha-tmpl/intranet-tmpl/prog/en/modules/acqui/acqui-home.tt
   OK	  forbidden patterns
   OK	  git manipulation
   FAIL	  spelling
		 seperate  ==> separate
   OK	  tt_valid
   OK	  valid_template

Other files came back all green.

Code review: didn't spot anything.

Testing:
When I try to access Tools > Label Creator I get an "internal server error". In the plack logs this translates to:
Variable "$layout" is not available at /home/vagrant/kohaclone/labels/label-home.pl line 56.
Can't call method "get_attr" on an undefined value at /home/vagrant/kohaclone/labels/label-home.pl line 56.
Comment 17 Alex Buckley 2017-10-06 03:57:46 UTC
Created attachment 67663 [details] [review]
Bug 18060: Followup solving $layout error