? ? ? Pending

User tests: Successful: Unsuccessful:

avatar chmst
chmst
11 Jun 2020

Summary of Changes

A sample workflow is added to sample data.

workflow-sample3

Testing Instructions

You need a fresh installation with a clean database.

Tip: you can copy the empty database (phpmyadmin) in case you need again an empty database.

Apply the patch, go to the main dashboard and install blog samole data.

Refresh the Screen (because the workflow must be loaded into the menu). Then you should have a new workflow in your content area:

workflow-sample

avatar chmst chmst - open - 11 Jun 2020
avatar chmst chmst - change - 11 Jun 2020
Status New Pending
avatar joomla-cms-bot joomla-cms-bot - change - 11 Jun 2020
Category Administration Language & Strings Front End Plugins
avatar chmst chmst - change - 11 Jun 2020
Title
[4.0][WIP] Add a sample workflow to blog sample data
[4.0] Add a sample workflow to blog sample data
avatar chmst chmst - edited - 11 Jun 2020
0a981a6 11 Jun 2020 avatar chmst phpcs
avatar chmst chmst - change - 11 Jun 2020
Labels Added: ? ?
avatar chmst
chmst - comment - 11 Jun 2020

Thank you @brianteeman

avatar chmst
chmst - comment - 11 Jun 2020

Thank you @richard67

avatar richard67
richard67 - comment - 12 Jun 2020

@chmst I've just applied the patch of this PR and then made a blog sample data installation. The good thing: There are no PHP errors or warnings or notices, and no SQL errors. And in general it looks fine.

Only one thing confuses me. Can it be that the names and target states of the 2 transitions "Trash" and "Set on Hold" are mixed up?

j4-example-workflow

I would expect transition "Trash" end with the "Trashed" state, and "Set on Hold" end with the "On Hold" state.

Maybe just the language strings for the titles of those 2 (transitions 7 and 8) have been mixed up.

avatar chmst chmst - change - 12 Jun 2020
The description was changed
avatar chmst chmst - edited - 12 Jun 2020
avatar chmst
chmst - comment - 12 Jun 2020

Thanks, the titles were swapped, as you said.
I have added another transition to make an article from "on hold" to "idea" again.

avatar richard67
richard67 - comment - 12 Jun 2020

I have added another transition to make an article from "on hold" to "idea" again.

Yes, that would have been my next question, if there is a way away from "On Hold", but you already solved it ?

avatar richard67
richard67 - comment - 12 Jun 2020

@chmst I've just tested what happens if I have a multilingual site and install the Blog Sample Data two times, one time with backend language = English (GB) and one time with German (DE).

For the articles, the language code is appended in brackets at the end of the titles on a multilingual site, so I have e.g. "Your Template (de-DE)" and "Your Template (en-GB)". Similar with categories.

The sample workflow is also inserted 2 times, one time for English (GB) and one time with German (DE), but the titles of workflow, stages and transitions are all the same.

I am not sure now what would be better, insert one time for each language but the with different titles? In this case @infograf768 could advise you what to do in the sample dara code.

Or should the sample workflow be inserted only one time?

Meanwhile I think it should be inserted only one time because workflows and transitions are not language-specific (they have no language column in database, as far as I remember), and their titles and descriptions are translated anyway.

avatar bembelimen
bembelimen - comment - 12 Jun 2020

Each time the sample data are running, a new workflow has to be created, because:

  • it's not possible to find the workflow, created with the previous run
  • the created workflow could be changed already
avatar richard67
richard67 - comment - 12 Jun 2020

I see.

avatar infograf768
infograf768 - comment - 13 Jun 2020

Missing lang strings
Screen Shot 2020-06-13 at 09 55 02

avatar chmst chmst - change - 13 Jun 2020
The description was changed
avatar chmst chmst - edited - 13 Jun 2020
avatar infograf768
infograf768 - comment - 13 Jun 2020

Drone is not happy and it concerns token.php ??

avatar chmst
chmst - comment - 13 Jun 2020

@infograf768 no clue ?? I did not touch tokens

avatar infograf768
infograf768 - comment - 13 Jun 2020

No clue at all.

avatar wilsonge
wilsonge - comment - 13 Jun 2020

PR I merged yesterday with some bad code style. I already fixed it and retriggered drone. should have a new result in about 10-15 minutes

avatar softforge softforge - test_item - 13 Jun 2020 - Tested successfully
avatar softforge
softforge - comment - 13 Jun 2020

I have tested this item successfully on 5734378

Works great


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/29573.

avatar wilsonge
wilsonge - comment - 13 Jun 2020

Largely seems good but I wonder after expert revision whether it should be able to go straight to published? I don't really understand the intent of the "Content Revision" step.

Also I wonder if this should be applied to the blog category as part part of the sample data. Before we setup the blog articles and then run the blog articles through the workflow stages (so editing existing sample data blog articles gives users the same experience)

avatar chmst
chmst - comment - 13 Jun 2020

Well, I had in mind that somone must check the html and accessibility (alt-texts, captions) before setting it online. Maybe a description would help?
There are much more or other tranitions and roles possible, for example translators - but then the example is to big.

I also did not know if I can add this sample workflow to the blog category, because the workflow is disabled by default.


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/29573.

avatar chmst
chmst - comment - 13 Jun 2020

Well, I had in mind that somone must check the html and accessibility (alt-texts, captions) before setting it online. Maybe a description would help?
There also much more or other tranitions and roles possible, for example translators - but then the example is to big.

I also did not know if I can add this sample workflow to the blog category, because the workflow is disabled by default.


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/29573.

avatar particthistle
particthistle - comment - 28 Jun 2020

@chmst, as discussed in BFH channel, I gave this a test yesterday, and the PR passed in what it's designed to do, but I think there's some changes that might fix some of the things I encountered.

@wilsonge wrote:

Also I wonder if this should be applied to the blog category as part part of the sample data. Before we setup the blog articles and then run the blog articles through the workflow stages (so editing existing sample data blog articles gives users the same experience)

I agree, as there's a step that needed to be done to enable the workflow that would not be intuitive to those just clicking the "Install Blog Sample Data".

@chmst wrote in Glip:

There is one thing where I also did not realise - changing a category does not change the workflow where the article is stored. It is not a bug - because: the article was in a workflow maybe in stage "confirmed". Then you change the category and the new category has only the default stages and transitions. So to which stage the article should be mapped?

The change below outlines perhaps the overview of how to implement the sample data so that the workflow applies on installation.

Before the proposed changes

  • When the Blog Sample Data is installed, the Blog Category doesn't have the Blog Workflow applied by default
  • Once the Blog Workflow is applied to the category, existing sample articles still have the default workflow applied
  • You currently need to use the batch tool to change the workflow on the sample blog articles to change the assigned workflow for the article to the sample blog workflow

Proposed changes
There may be more discovered by those testing scenarios.

  • If possible, check and set workflow is active when the blog sample data is installed
  • Set the blog category to have the blog workflow assigned on install
  • Set the blog articles to use the blog workflow on install, with the appropriate Published stage set.

After the proposed changes

  • Workflow status is checked and enabled when the Blog Sample Data is installed
  • Blog category has the Blog Workflow assigned to it when created
  • Blog articles have the Blog Workflow assigned to them when created

There may be a need to further develop a 3rd sample data option: Blog Sample Data with Workflow
Not sure if this is already able to be done?

I'm keen to also learn more on creating sample data sets that can be installed via the extension manager. That would enable workflow scenarios to be developed as samples that can be downloaded to install via documentation, or developed by third party extension developers to allow them to package workflows or workflow examples for their extensions if they're looking at implementing Workflow in their components.

avatar chmst chmst - change - 12 Jul 2020
Labels Added: ?
avatar chmst chmst - change - 12 Jul 2020
Labels Added: ?
Removed: ?
avatar chmst
chmst - comment - 12 Jul 2020

@particthistle Thank you very much for testing and feedback. I have implemented your proposals. Could you re-test?

  • Sample workflow is joined with the blog category
  • workflow is enabled for com_content
  • articles in category workflow are set to default stage.

@infograf768: Hopefully I did not break any mulitlingual concerns

avatar chmst chmst - change - 12 Jul 2020
Labels Removed: ?
avatar chmst
chmst - comment - 12 Jul 2020

Thank you @brianteeman - seems I have closed some proposals too quickly. But will revise ;) the language files

avatar particthistle particthistle - test_item - 18 Jul 2020 - Tested successfully
avatar particthistle
particthistle - comment - 18 Jul 2020

I have tested this item successfully on d44d20d

Tested updates successfully. Specifically:

  • Sample workflow is the assigned workflow for the blog category
  • workflow is applied to articles in the blog category at the time the sample data is installed
  • articles in category workflow are set to default stage.
    This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/29573.
avatar particthistle particthistle - test_item - 1 Aug 2020 - Tested successfully
avatar particthistle
particthistle - comment - 1 Aug 2020

I have tested this item successfully on 2b36990


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/29573.

Testing again following language change.

avatar richard67 richard67 - alter_testresult - 8 Aug 2020 - particthistle: Tested successfully
avatar richard67
richard67 - comment - 8 Aug 2020

Last update was only a clean update to latest changes in the base branch, so the previous test result is still valid. I've restored it in the issue tracker.

avatar richard67
richard67 - comment - 8 Aug 2020

@chmst The diagram says that an article can go to "On Hold" from any stage (except trashed). But only when in the "Idea" stageI get "On Hold" as possible target, for the others not. Is that expected and the diagram is not up to date, or am I doing something wrong?

avatar chmst
chmst - comment - 9 Aug 2020

@richard67 thank you for testing, I am on it. The resume should be possible from any stage.


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/29573.

avatar richard67
richard67 - comment - 9 Aug 2020

@richard67 thank you for testing, I am on it. The resume should be possible from any stage.

@chmst Sure you mean "resume"? Or shouldn't it be "set on hold"?

avatar chmst chmst - change - 10 Aug 2020
The description was changed
avatar chmst chmst - edited - 10 Aug 2020
avatar chmst chmst - change - 10 Aug 2020
The description was changed
avatar chmst chmst - edited - 10 Aug 2020
avatar richard67
richard67 - comment - 10 Aug 2020

@particthistle Could you test again, this time with checking if the possible transitions depending on the current stage are as shown as in the diagram in the testing instructions? Thanks in advance. I will try to find time, too, but it may take a while.

avatar particthistle
particthistle - comment - 14 Aug 2020

@chmst we're getting very close - it's probably a pass when you watch the GIF below, but, the transitions available when you "Publish and Feature" might need an addition... though they're also not shown in the workflow flow chart either.
image
Currently the only transition that is available when the article reaches "Published and Featured" is "Set on Hold" when the following options may be better:

  • Unfeature - unsets the feature flag (and only just noticed Featured feature has changed)
  • Archive - sets status to archived (which is what it looks like Set on Hold actually does to the article)
  • Trash - Trashes the article (you could also add Trash as universal transition as they might choose to delete an idea at any stage)

Resetting the article to On Hold where it then goes to an Archived status then resets the workflow back to Idea and starts the flow again. Just trying to get the example to be as comprehensive as it can be to assist with selling the workflow feature.

29573

avatar chmst
chmst - comment - 14 Aug 2020

@particthistle thank you very much for your patience in testing! I'll check again.

avatar chmst chmst - change - 13 Oct 2020
Labels Added: ?
avatar chmst chmst - change - 13 Oct 2020
Labels Added: ?
Removed: ?
avatar chmst chmst - change - 13 Oct 2020
The description was changed
avatar chmst chmst - edited - 13 Oct 2020
avatar chmst
chmst - comment - 13 Oct 2020

@particthistle Following your suggestion I have added a stage unpublished. The article now can be unpublished and published again.

avatar flo-the-cat flo-the-cat - test_item - 16 Oct 2020 - Tested successfully
avatar flo-the-cat
flo-the-cat - comment - 16 Oct 2020

I have tested this item successfully on cd90af9

It has Patricks additions and works well. Good job


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/29573.

avatar particthistle particthistle - test_item - 17 Oct 2020 - Tested successfully
avatar particthistle
particthistle - comment - 17 Oct 2020

I have tested this item successfully on cd90af9

Excellent work @chmst!

All the scenarios outlined in the flowchart work.


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/29573.

avatar wilsonge wilsonge - change - 17 Oct 2020
Status Pending Fixed in Code Base
Closed_Date 0000-00-00 00:00:00 2020-10-17 11:11:16
Closed_By wilsonge
Labels Added: ?
Removed: ?
avatar wilsonge wilsonge - close - 17 Oct 2020
avatar wilsonge wilsonge - merge - 17 Oct 2020
avatar wilsonge
wilsonge - comment - 17 Oct 2020

Thanks for being patient with this @chmst !! much appreciated!

Add a Comment

Login with GitHub to post a comment