roadmap icon indicating copy to clipboard operation
roadmap copied to clipboard

Plan creation wizard rework

Open sjDCC opened this issue 5 years ago • 49 comments

Several users / unis have reported confusion over the plan creation wizard. It's not always intuitive to know how to get institutional templates. Perhaps we need to adjust the layout of this wizard so institutional templates are immediately visible beneath the org box (once selected) and it shows as an either/or to select a uni template or a funder one?

Dutch users have asked to discuss this at the next user group as they have a slightly different position emerging. ZonMw and NWO are allowing researchers to use uni templates when they are approved. This means DMPonline will need to change the logic for this use case to present relevant options. We can configure it as an option that's switched off for others.

Thoughts from US examples welcome @mariapraetzellis

sjDCC avatar Jan 05 '20 15:01 sjDCC

We've also had requests to allow a one-click plan creation type feature for organizational templates.

briri avatar Jan 06 '20 16:01 briri

The main preference to come out of the user group was having basic filters for orgs and funders which then bring up a dropdown list of all possible options. Admin users would like to configure the names and order of that list to align with local policy e.g. use the TU Delft template

Picture1

sjDCC avatar Apr 20 '20 14:04 sjDCC

relates to: https://github.com/DMPRoadmap/roadmap/issues/2835

magdalenadrafiova avatar Mar 12 '21 14:03 magdalenadrafiova

Adding a recent comment from a user:

When creating a DMP, selecting a template is gated by the primary funding organization. It might be nice to have an option to use an alternative organization's template (e.g., the DOT template is not accessible if I list FAA as my primary research organization).

mariapraetzellis avatar Aug 03 '21 19:08 mariapraetzellis

Not sure whether we discuss the same here @mariapraetzellis (might be) but we got suggestion that when a plan is created and the funder is selected the funder template will appear in the list of templates the researcher can choose. rather than automatically be presented with the funder template. In Netherlands the funders often approve institutional templates, and this is quite clear from their naming conventions but the institutional template would not appear the second funder template is selected/ Therefore having a list of templates where researchers could select one would be better way to go forward

magdalenadrafiova avatar Aug 30 '21 15:08 magdalenadrafiova

Linking another set of issues that should be considered as part of this work: #3088 #2886 #2218 #2925

pherterich avatar Mar 11 '22 10:03 pherterich

I have started on this. I see it is quite complex, so may take some time to understand functionality and then change it. As I need to understand current functionality to understand what may be feasible.

johnpinto1 avatar May 25 '22 10:05 johnpinto1

Adding a recent comment from a user:

When creating a DMP, selecting a template is gated by the primary funding organization. It might be nice to have an option to use an alternative organization's template (e.g., the DOT template is not accessible if I list FAA as my primary research organization).

@mariapraetzellis a question regarding the user's suggestion. So in the quote cited is the user wanting to see all publicly available templates from other orgs too?

johnpinto1 avatar May 25 '22 10:05 johnpinto1

@mariapraetzellis a question regarding the user's suggestion. So in the quote cited is the user wanting to see all publicly available templates from other orgs too?

Yes, this is one of the issues we will need to address, some funders allow institutional templates to be used, so while the current approach is helpful to narrow it down to the right template, it can be too restrictive in cases. The initial mock-up suggests something like a few recommended templates but also the option to use "other" and search for more. We probably need to narrow things down to exactly what we want where, but this is the general challenge.

pherterich avatar May 25 '22 10:05 pherterich

@pherterich All such input is helpful as I study and play around with the code.

johnpinto1 avatar May 25 '22 10:05 johnpinto1

It may be worth having @benjaminfaure show us their plan creation workflow in more detail. They have a custom approach that I believe is more flexible than the baseline Roadmap approach

briri avatar May 25 '22 15:05 briri

@briri can you arrange it?

johnpinto1 avatar May 25 '22 15:05 johnpinto1

@johnpinto1 and @pherterich, I'm excited to start working on this feature. A larger Roadmap team meeting to discuss approaches to implementing this would be helpful. I will propose some times via Slack.

mariapraetzellis avatar May 26 '22 23:05 mariapraetzellis

Just a note that we should be sure to make it easy for a user to generate a plan based on the generic/default template.

mariapraetzellis avatar Jun 01 '22 15:06 mariapraetzellis

Started a google document to record our ideas

mariapraetzellis avatar Jun 01 '22 15:06 mariapraetzellis

@briri @gjacob24 Please look at code in commit, especially, the new_plans_controllerhttps://github.com/DMPRoadmap/roadmap/commit/786d87f3b0448430312c450c3260862a8e74d7c2 and provide feedback. I followed your suggestions at the last chat we had.

I have added a button to Create Plans page named Try New Plan Creation Wizard to link to new functionality Selection_012

The new page has only one check box now, namely, the one for mock plans. Org and funder no longer required only title and template are required fields and the first template pre-selected is the default template. Selection_013

johnpinto1 avatar Jun 24 '22 14:06 johnpinto1

The changes look good @johnpinto1 overall. I added some comments for a few minor changes. The primary change is to the Funder and Org lists you are loading. Don't restrict the funder list to only include funders with templates and don't restrict the research orgs based on their org_type. We want to know who the true values for these.

briri avatar Jun 24 '22 15:06 briri

@briri I think I have done the changes you suggested. Please double check https://github.com/DMPRoadmap/roadmap/commit/c645381aa213621640e07c9cdcd33dd2b23e8fd0. Creating Test and other plans seem to work.

johnpinto1 avatar Jun 27 '22 11:06 johnpinto1

@briri I have updated the code https://github.com/DMPRoadmap/roadmap/commit/fc5ac7e6f85db40f2d19e7b373365f39099fff4e . So the required asterisk appears beside template selection with associated tooltip and screen reader read only text.

Selection_023

johnpinto1 avatar Jun 30 '22 09:06 johnpinto1

Shouldn't there be a place for administrative data? I mean: "primary research organisation" and "funder" look in the wizard like fields that do not have anything to do the selection of a template. A different layout would make that more clear:

Choose your template:

by primary research organisation

by funder

Some of our users are confused that about these fields..

nicolasfranck avatar Aug 05 '22 13:08 nicolasfranck

Or:

Choose your template

--Select your primary research organisation-- --Select your funder-- --Select your template--

All of them would have to be select boxes, and each of them is changed based on the value of the select box above.

Every select box should have an empty value (with instructions), so one must select a value, even if it is just one. This way one knows what template was selected

e.g. if neither primary research organisation nor funder is chosen, then the dcc template is added to the list of templates.

nicolasfranck avatar Aug 05 '22 13:08 nicolasfranck

@nicolasfranck Thanks will incorporate one of the suggestions when I revisit code next week.

johnpinto1 avatar Aug 05 '22 13:08 johnpinto1

We have run into problems with users not selecting an appropriate template because they were trying to be as administratively correct as possible in the 'create plan' page, while they should actually be selecting the most appropriate template. This is a serious risk because this also means that they do not fill out the privacy list of questions (which is an institutional customisation to the template) we want them to answer.

We could think of 3 distinct functionalities where organisations and funders can be selected/entered in the DMP application

  • Purpose 1: org to which the DMP belongs in db: important for visibility, org admins etc. This should not be modifiable
  • Purpose 2: select a suitable template with tailored guidance
    • This is what you do in 'create plan' page and you want to make it as fool-proof as possible that users select the correct template with the instructions you want them to have. And you also want to make sure there is no confusion: this merely serves to select a template and guidance, not to have the most complete administrative information (see purpose 3)
  • Purpose 3: administrative details about your project regarding organisation and funder
    • This is not limited to available templates and guidances, there can be many more affiliations or funding sources. Just as is now the case for the funder information on the 'project details': this does not influence the funder template as entered in 'create plan', nor the available customisations eg question specific guidance.
    • A field similar to Funder could be added to Project Details to indicate the Research Organisation (or even call this 'affiliation' to not use the same terminology as 'organisation' in the application).
    • In an ideal world, this information is standardized by selecting from RoR supplemented by an 'Other' field in which free text can be entered

laurastandaert avatar Aug 05 '22 14:08 laurastandaert

Shouldn't there be a place for administrative data? I mean: "primary research organisation" and "funder" look in the wizard like fields that do not have anything to do the selection of a template. A different layout would make that more clear:

Choose your template:

by primary research organisation

by funder

Some of our users are confused that about these fields..

@nicolasfranck I looked at your suggestion and realised that: this is not what the DCC & UC3 asked for. They want to the user to choose any template, with a default template being initially selected.

johnpinto1 avatar Aug 08 '22 08:08 johnpinto1

We have run into problems with users not selecting an appropriate template because they were trying to be as administratively correct as possible in the 'create plan' page, while they should actually be selecting the most appropriate template. This is a serious risk because this also means that they do not fill out the privacy list of questions (which is an institutional customisation to the template) we want them to answer.

We could think of 3 distinct functionalities where organisations and funders can be selected/entered in the DMP application

* **Purpose 1**: org to which the DMP belongs in db: important for visibility, org admins etc. This should not be modifiable

* **Purpose 2**: select a suitable template with tailored guidance
  
  * This is what you do in 'create plan' page and you want to make it as fool-proof as possible that users select the correct template with the instructions you want them to have. And you also want to make sure there is no confusion: this merely serves to select a template and guidance, not to have the most complete administrative information (see purpose 3)

* **Purpose 3**: administrative details about your project regarding organisation and funder
  
  * This is not limited to available templates and guidances, there can be many more affiliations or funding sources. Just as is now the case for the funder information on the 'project details': this does not influence the funder template as entered in 'create plan', nor the available customisations eg question specific guidance.
  * A field similar to Funder could be added to Project Details to indicate the Research Organisation (or even call this 'affiliation' to not use the same terminology as 'organisation' in the application).
  * In an ideal world, this information is standardized by selecting from RoR supplemented by an 'Other' field in which free text can be entered

@laurastandaert as I pointed out to @nicolasfranck it looks like the requirements suggested by DCC & UC3 are different from your suggestions. I think we need @mariapraetzellis , @dsisu and @briri to come up with something that reconciles their requirement with your suggestions. I know of one of them being currently on holiday.

johnpinto1 avatar Aug 08 '22 09:08 johnpinto1

@briri @dsisu @gjacob24 @laurastandaert @mariapraetzellis @martaribeiro @nicolasfranck

We have deployed code for the first iteration of the New Plan Creation wizard to https://dmponline-dev.dcc.ac.uk/ (Please note because of expired certificate on site you will get warnings which you should ignore to create account and login.) Then go to "Create Plan" page (this is the current page). On the page there is a button "Try New Plan Creation Wizard" which will take you to the new functionality for you to critique for forthcoming meeting.

Warning to ignore: Selection_049

Current "Create Plan" page with button button "Try New Plan Creation Wizard" to link to new functionality Selection_047

New Plan Creation page Selection_048

johnpinto1 avatar Aug 25 '22 12:08 johnpinto1

@pengyin-shan @benjaminfaure see John's note above about the new create plan page.

briri avatar Aug 25 '22 14:08 briri

@pengyin-shan @benjaminfaure see John's note above about the new create plan page.

Great! unfortunately I cannot log in because I don't know the name and password...but the flow looks good to me. Just FYI that DMP Assistant does not use Funder in workflow, so we always commented out the part that shows 'Select the primary funding organization'. We allow users to input anything in the 'funder' field when creating a new plan. This field will be a 'unmanaged' organization that saved to database without any other information

pengyin-shan avatar Aug 25 '22 17:08 pengyin-shan

@johnpinto1 I'm wondering if we need to add a typeahead in the Template field. DMPTool has many (+40) templates shared between all organizations, and some orgs have numerous institutional templates on top of this. So, a user will be presented with a long list of templates to scroll through. Adding a filter or typeahead could be a way to find the template they want quickly.

mariapraetzellis avatar Aug 25 '22 20:08 mariapraetzellis

@pengyin-shan You just create a new email account on server to login. Choose any Org - it is just for access. Good luck!

johnpinto1 avatar Aug 29 '22 09:08 johnpinto1