Overview
| Table of Contents | ||
|---|---|---|
|
The incident management module designed to record any incidents that happen to a player/member, primarily during the case of a game but has been extended to report incidents that may have happened externally including training or other sports. Incidents Categories/Types can be related to but not limited to Injuries, Discipline,Scoring, Substitutions for example
Incident Categories
Incident Categories and will always be the primary dropdown/selection when recording an incident next to a member/player.
Description: Name of category. No character limit, however it should be short and concise.
Short Description: Abbreviated form of above where space is limited.
Icon/Color: You can use Font Awesome Icon Short Codes to display an icon e.g
Penalty Try if setup like:
would display like: (on referee browser input)
Score Field: Tick this box if a member/player getting this incident category would influence the score of the game, however if this category is a collection of different types of scores, then you can leave this unticked and tick it in the Incident Type (secondary dropdown)
Score Value: Enter the value of this score e.g 1 for a goal in soccer, 5 for a try in rugby, 6 for a touchdown in NFL etc
Publish to API: Tick this box if you wish to send the information in this incident to the public API which allows this incident to be displayed to the public. e.g you may tick for a Score Incident, but for for a Medical incident where the public should not be informed.
Permissions: Here you can say which users/roles can access this Incident Category. If left blank then all users will be able to add this category of Incident. The different user types are:
Officials: Each type of Official e.g Referee, Umpire, AR1, Commisioner can be selected
Association: Allows a logged in user/club to add this Category
AssociationChild: Similiar to Association but individual access created in ‘Manage User Accounts’
Member: Allows the person who registered the member, normally themselves or a parent, to add an incident:
Coach: Allows a designated Coach on a Panel/Roster to add incidents for Members of that panel
Custom Fields:
This will list the range of custom fields you have setup elsewhere on the system. If you wish any of them to appear when this category is selected, regardless of type (second dropdown), then select them here. You can also leave it blank and select each of them for each type in the next section
Incident Types
Incident Types are a subset of Categories and can are broadly setup very similiar, however they do allow you to alter that Status of the Member, e.g update a player to ‘Suspended’ if given a red card, ‘Inactive’ if in concussion protocol etc
Incident Category: Select the parent Category of this type
Name: No character limit, however it should be short and concise.
Description: Abbreviated form of above where space is limited.
Auto Update Member Status: If ticked, this will automatically change the membership status of the player/member given this type immediately after incident is created.
Status to update Member To:
Active: Makes the member ‘Active’
Inactive: Makes the member ‘Inactive’, they will not be able to join a teamsheet primarily but other membership functionalities could be affected also, e.g transfering, upgrading, uploading credentials, purchasing events.
Suspended: Similiar to above.
Icon/Color: You can use Font Awesome Icon Short Codes to display an icon e.g
Penalty Try if setup like:
would display like: (on referee browser input)
Score Field: Tick this box if a member/player getting this incident type would influence the score of the game.
Score Value: Enter the value of this score e.g 1 for a goal in soccer, 5 for a try in rugby, 6 for a touchdown in NFL etc
Publish to API: Tick this box if you wish to send the information in this incident to the public API which allows this incident to be displayed to the public. e.g you may tick for a Score Incident, but for for a Medical incident where the public should not be informed.
Permissions: Here you can say which users/roles can access this Incident Category. If left blank then all users will be able to add this category of Incident. The different user types are:
Officials: Each type of Official e.g Referee, Umpire, AR1, Commisioner can be selected
Association: Allows a logged in user/club to add this Category
AssociationChild: Similiar to Association but individual access created in ‘Manage User Accounts’
Member: Allows the person who registered the member, normally themselves or a parent, to add an incident:
Coach: Allows a designated Coach on a Panel/Roster to add incidents for Members of that panel
Custom Fields:
This will list the range of custom fields you have setup elsewhere on the system. If you wish any of them to appear when this type is selected.
Incident Causes/Actions
These two sections are similar and allow you to create dropdowns immediately below Incident Categories and Types. Each Cause and Action created will appear as a dropdown option.
Description: Give name of the cause/action that will appear in dropdown.
Action/Cause Code: Short version of above.
Icon: Similiar to Categories and Types
Include in incident file: Tick this box if you wish to send the information in this incident to the public API which allows this incident to be displayed to the public. e.g you may tick for a Score Incident, but for for a Medical incident where the public should not be informedadd an attachment upload box for this action.
Categories and Types:
Here you should see a tab for each category you have and below each type in that category. You can tick each type or select all you want this cause/action to be available to answer to
Custom Fields:
This will list the range of custom fields you have setup elsewhere on the system. If you wish any of them to appear when this cause/action is selected.
Incident Custom Fields
This section allows you the most flexibility is creating a very custom form for the incident, e.g you may want multiple answers to a specific question or the question to be a checkbox or multiple choice etc.
Field Name: * Lower Case, No Spaces, e.g lower_case_no_spaces version of what you want this custom_field to called. This is to allow us to store it correctly in the database and report later.
Description: The name of the custom field, this will appear as the question.
Required: Can the user save this incident with or without this answered.
Field Type:
Text: Simple text input
Numeric: Whole numbers only
Checkbox: True/False checkbox
Dropdown: Allows you to create list of options and sort them numberically
Place the name of the option in the box on the left and use the arrows to move the options up down if editing later.
Attachment: File Upload Box
Content Page: Tick box that can be linked to conten page, Terms and Conditions for example (in progress)
Date: Date Picker
Time: Time Input
Bigger Text: Allows for a larger text input
Player List: Allows to select from list of players on own team or opponent team (or text input if not related to a game)
User/Member/Coach View
Referee View (Needs work)
Referee App View
