Need your input for better docmntation of Participant Status - Count, Class, etc

[reperry]

I'd like to update the Civi manual with better documentation about Participant Status, including how you can change which Participant Statuses appear in the hover window that pops up when you click on Participants on the Manage Events screen. Is the following all true?

When you use the Manage Participants page in CiviEvent, hovering over Participants in the right column for an event will give you two choices to click on. Either you can click on the participants likely to come, or those likely not to come. By default, a number of participant statuses are considered "likely to come".

These include

   

• Registered
• Confirmed
• Attended
• Awaiting Approval
• Pending from Waitlist
• Pending from Approval

The rest fall into the "unlikely to come" category. You can determine which statuses are in which category by changing settings for "count" in the Participant Statuses.

Anyone who knows how the following things work and want to pipe in would be welcome to here --- I'll synthesize it and put it into the manual as well, especially Class which I don't understand well at all.

Documentation needed for all of these:

• Class
• Counted
• Weight
• Visibility

[John.K]

Is there any documentation around for the 'Class' of a participant status? I think these options do need a little info mark with some popup help =]

[Dave Greenberg]

There's a bit of explanation below the field when adding or adding Participant Status options (Administer > CiviEvent > Participant Statuses).

"The general class of this status. Participant counts are grouped by class on the CiviEvent Dashboard. Participants with a 'Pending' class status will be moved to 'Expired' status if Pending Participant Hours has elapsed (when the ParticipantProcessor.php background processing script is run)."

So the 1st sentence is pretty clear. The second sentence which really explains that the only class  status which has programmatic importance is "Pending" probably needs some examples - e.g. Pending from waitlist status is assigned the Pending class. This means that participants with that status will be automatically moved to Expired status after a set period of time.

Also, that sentence needs to be updated to refer to the "Update Participant Status" Scheduled Job.

If you're up for doing a re-write - and ideally submitting a PR (patch) to that template file (templates/CRM/Admin/Form/ParticipantStatus.tpl) - that would be great.