From 730d25ae7218d731590b322d4f419a7df6d4e4fb Mon Sep 17 00:00:00 2001 From: Matthew Somerville Date: Thu, 30 Apr 2020 13:56:31 +0100 Subject: Add ability to disallow updates in a category. Add a tickbox to the category admin, and do not allow updates on reports made in those selected categories. --- docs/_includes/admin-tasks-content.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/_includes/admin-tasks-content.md') diff --git a/docs/_includes/admin-tasks-content.md b/docs/_includes/admin-tasks-content.md index 7e3d47efe..a846b73cc 100644 --- a/docs/_includes/admin-tasks-content.md +++ b/docs/_includes/admin-tasks-content.md @@ -560,14 +560,14 @@ and staff users — can filter reports when viewing them on the site. From the Admin menu, click on ‘Categories’. You’ll see a table of existing categories, and below that, a form by which you can create new ones. - Input a title for the category, and the email address to which reports in that category should be forwarded. When creating a category, these are the only fields required. You can also choose a variety of options – whether to automatically hide any reports made in this category, whether to prevent form submission when this -category is selected, or what parent category or categories a particular -category is in. See below for information on creating/editing extra notices and questions for a category. -- cgit v1.2.3 From f6d807fd5217a19ac488f652d1f0853a7891231f Mon Sep 17 00:00:00 2001 From: Matthew Somerville Date: Fri, 1 May 2020 15:42:01 +0100 Subject: Add way to disallow report reopening in a category Add a tickbox to the category admin, and do not allow reopening on reports made in the selected categories. --- docs/_includes/admin-tasks-content.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/_includes/admin-tasks-content.md') diff --git a/docs/_includes/admin-tasks-content.md b/docs/_includes/admin-tasks-content.md index a846b73cc..765e96370 100644 --- a/docs/_includes/admin-tasks-content.md +++ b/docs/_includes/admin-tasks-content.md @@ -566,6 +566,7 @@ forwarded. When creating a category, these are the only fields required. You can also choose a variety of options – whether to automatically hide any reports made in this category, whether to prevent form submission when this category is selected, whether updates are allowed on reports in this category, +whether members of the public can reopen fixed/closed reports in this category, or what parent category or categories a particular category is in. See below for information on creating/editing extra notices and -- cgit v1.2.3 From 0bc94341afa4909f56e94ced03f282a158a0341c Mon Sep 17 00:00:00 2001 From: Matthew Somerville Date: Wed, 6 May 2020 16:26:37 +0100 Subject: [Docs] Heatmap, tidy stats section. --- docs/_includes/admin-tasks-content.md | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) (limited to 'docs/_includes/admin-tasks-content.md') diff --git a/docs/_includes/admin-tasks-content.md b/docs/_includes/admin-tasks-content.md index 765e96370..5b570aa27 100644 --- a/docs/_includes/admin-tasks-content.md +++ b/docs/_includes/admin-tasks-content.md @@ -770,12 +770,13 @@ above, ‘Creating a template’. Additionally you can delete the template from Permissions required: User must be marked as staff -When you first log in to the Admin area, you’ll see some top-level stats at the foot of the page, -including the number of reports published on the site, the number of updates, the number of -alerts set up and the number of user questionnaires sent out. This can be useful for a quick -snapshot of activity. +When you log in to the Admin area and click Stats in the admin navigation, +you’ll see some top-level statistics, including the number of reports published +on the site, the number of updates, and the number of alerts set up. This can +be useful for a quick snapshot of activity. -For a more detailed breakdown, visit the stats dashboard. This can be accessed by typing +For a more detailed breakdown, visit the stats dashboard. This can be accessed +by going to "Summary statistics" from the admin stats page, or by typing ‘/dashboard’ on the end of your FixMyStreet url. From here, you can access statistics on: @@ -797,6 +798,16 @@ You can also group the results by: Android device or via an iOS device). These statistics can be downloaded as a CSV document, suitable for use in a spreadsheet program -such as Excel. +such as Excel or your own reporting tools. + +#### Heatmap + +Also accessible from the admin stats page is our heatmap. This can provide an +overview of reporting in your area, filtered by state, category, or ward, for a +particular date range: + +Screenshot of Bromley heatmap showing clusters in the north and north west. + -- cgit v1.2.3 From 60b0ccde85228080b81387292f6c98c3293a0f57 Mon Sep 17 00:00:00 2001 From: Matthew Somerville Date: Wed, 6 May 2020 16:29:22 +0100 Subject: [Docs] Clarify a few different sections of manual. --- docs/_includes/admin-tasks-content.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) (limited to 'docs/_includes/admin-tasks-content.md') diff --git a/docs/_includes/admin-tasks-content.md b/docs/_includes/admin-tasks-content.md index 5b570aa27..91ba8f3d8 100644 --- a/docs/_includes/admin-tasks-content.md +++ b/docs/_includes/admin-tasks-content.md @@ -4,9 +4,11 @@ When you're logged in as an administrator the 'admin' button is in the navigation menu -If your Administrator has already given you staff permissions, you’ll see additional admin button -on the top menu when you’re logged in. If not, your Administrator can add these permissions at -any time: see ‘[Creating a Staff Account](#adminstrating-staff-accounts)’. +If your Administrator has already given you staff permissions, you may see +additional admin button on the top menu when you’re logged in. If not, your +access may be only in the frontend (e.g. moderation does not require any +backend admin access), or your Administrator can add these permissions at any +time: see ‘[Creating a Staff Account](#adminstrating-staff-accounts)’.
@@ -18,14 +20,15 @@ any time: see ‘[Creating a Staff Account](#adminstrating-staff-accounts)’. If you want to view everything that’s been reported within the council area, here’s the quickest way. -Click on ‘all reports’ in the top menu. You’ll see the boundaries of your council area on the map, -and a list of all reports listed, with the most recent reports at the top, on the left hand panel. +Click on ‘all reports’ in the top menu. You’ll see the boundaries of your +council area on the map, and a list of all reports listed, with the most +recently updated reports at the top, in the left hand panel. Click all reports in the top menu to view all reports in an area Note that staff members can be allocated one or more category (e.g. potholes, streetlights, etc) by the Administrator — see ‘[Creating a Staff Account](#adminstrating-staff-accounts)’ for more details. When logged in, these staff -members will see reports within these categories by default. +members will only see reports within those categories by default.
@@ -538,9 +541,11 @@ mySociety. #### Note -If your FixMyStreet Pro installation has been integrated with a CRM system, this -section does not apply. In such cases, categories are managed from within the CRM, and -FixMyStreet will be set up to work with these. +If your FixMyStreet Pro installation has been integrated with a CRM system, +this section might not fully apply; it is possible categories are managed from +within the CRM, and FixMyStreet will be set up to work with these. Some +installations only integrate on some categories, and some sections such as form +disabling can still be used on top of an integration. -- cgit v1.2.3 From 8898170c9ac6127329a1f17d855dae8ea7472f86 Mon Sep 17 00:00:00 2001 From: Matthew Somerville Date: Wed, 6 May 2020 16:52:30 +0100 Subject: [Docs] Add info about user timeline. --- docs/_includes/admin-tasks-content.md | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-) (limited to 'docs/_includes/admin-tasks-content.md') diff --git a/docs/_includes/admin-tasks-content.md b/docs/_includes/admin-tasks-content.md index 91ba8f3d8..16329e7e8 100644 --- a/docs/_includes/admin-tasks-content.md +++ b/docs/_includes/admin-tasks-content.md @@ -114,25 +114,16 @@ to access the full report admin editing page.
-### Searching for a user +### User admin Permissions required: User must be marked as staff; “Edit users' details/search for their reports” must be ticked -Click on ‘admin’ in the top menu bar. - -Enter any part of the user’s name or email address in the ‘Search users’ box. - -
- -
- -### Editing a user’s information - -Permissions required: User must be marked as staff; "Edit users' details/search for their reports" must be ticked. - -Click on ‘Edit’ beside any user to view or change their account details. -Or, click the user’s email address to view a list of all reports and updates made by that user. +In the admin, enter any part of the user’s name or email address in the ‘Search +users’ box. You may click on ‘Edit’ beside any user to view or change their +account details, click the user’s email address to view a list of all reports +and updates made by that user, or click ‘Timeline’ to see a timeline of that +user’s activities on the site.
-- cgit v1.2.3 From 97e52222eccc441e4fcb2a444d04eb411c3a1eee Mon Sep 17 00:00:00 2001 From: Matthew Somerville Date: Wed, 6 May 2020 16:52:40 +0100 Subject: [Docs] Add info about two-factor auth. --- docs/_includes/admin-tasks-content.md | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'docs/_includes/admin-tasks-content.md') diff --git a/docs/_includes/admin-tasks-content.md b/docs/_includes/admin-tasks-content.md index 16329e7e8..98a2780bc 100644 --- a/docs/_includes/admin-tasks-content.md +++ b/docs/_includes/admin-tasks-content.md @@ -522,6 +522,17 @@ staff user only deals with reports of a specific type. To remove an account, the Administrator-level member of staff should make contact with mySociety. +#### Two-factor authentication + +Any staff user can choose to set up two-factor authentication on their account. +To do this, they will need an app on their phone that can generate time-based +authentication keys, such as Google Authenticator or a password manager. Then. +they can visit their account page on the site and select ‘Activate two-factor +authentication’ to receive a QR code to scan with the app. + +If you wish your organisation to have mandated two-factor authentication, +please get in touch. +
-- cgit v1.2.3 From 54c089dce3f02edbafba02161307fbe32f571cce Mon Sep 17 00:00:00 2001 From: Matthew Somerville Date: Wed, 6 May 2020 16:54:31 +0100 Subject: [Docs] Bit on staff-only categories. --- docs/_includes/admin-tasks-content.md | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs/_includes/admin-tasks-content.md') diff --git a/docs/_includes/admin-tasks-content.md b/docs/_includes/admin-tasks-content.md index 98a2780bc..b68a09d81 100644 --- a/docs/_includes/admin-tasks-content.md +++ b/docs/_includes/admin-tasks-content.md @@ -579,6 +579,11 @@ for information on creating/editing extra notices and questions for a category. +Categories can be made ‘staff only’, where they are only available to logged-in +members of staff, not members of the public. This could be used for e.g. +contact centre staff to leave reports in categories that you still want to be +phoned in. + You can set up as many or as few categories as you like, and each category can have its own email address attached to it, so for example, reports about potholes may go to one council email address, while reports about road signs go to another. More than one category may share the -- cgit v1.2.3 From bf179ad7dc57b371d45742c3df675bd1bc285a8d Mon Sep 17 00:00:00 2001 From: Struan Donald Date: Wed, 13 May 2020 09:45:22 +0100 Subject: [Docs] document per category anonymous reporting Also update the category page screenshot to include the new options --- docs/_includes/admin-tasks-content.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/_includes/admin-tasks-content.md') diff --git a/docs/_includes/admin-tasks-content.md b/docs/_includes/admin-tasks-content.md index b68a09d81..ac9e81f9e 100644 --- a/docs/_includes/admin-tasks-content.md +++ b/docs/_includes/admin-tasks-content.md @@ -579,6 +579,10 @@ for information on creating/editing extra notices and questions for a category. +You may also be able to configure categories to allow anonymous +reporting if you have this option available. If this is not available then +contact us to discuss it. + Categories can be made ‘staff only’, where they are only available to logged-in members of staff, not members of the public. This could be used for e.g. contact centre staff to leave reports in categories that you still want to be -- cgit v1.2.3 From ed0002b0d76560cc3d5b1e62f8395bbfae74403c Mon Sep 17 00:00:00 2001 From: Chris Mytton Date: Wed, 8 Apr 2020 14:39:19 +0100 Subject: Add photo upload field to inspector form This adds the code for photo uploads from the regular update form to the inspector form, and adds details to the documentation. --- docs/_includes/admin-tasks-content.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs/_includes/admin-tasks-content.md') diff --git a/docs/_includes/admin-tasks-content.md b/docs/_includes/admin-tasks-content.md index ac9e81f9e..cd6043c25 100644 --- a/docs/_includes/admin-tasks-content.md +++ b/docs/_includes/admin-tasks-content.md @@ -350,6 +350,9 @@ If ‘Create reports/updates as the council’ is ticked in the staff user’s a updates will be labeled as from the council rather than the staff member’s name. For the sake of staff privacy, this is usually preferable. +Staff with appropriate permissions can also attach an image to the update, which will then be +displayed publicly alongside the text update. + This option is also available via the general 'Update' box under the main report. #### Requests for more information -- cgit v1.2.3 From 5a0dd3f573f7aba771fe916a65138dfbbb258982 Mon Sep 17 00:00:00 2001 From: Dave Arter Date: Thu, 30 Jul 2020 19:14:42 +0100 Subject: [Docs] Add instructions & example for including HTML in notice fields For https://github.com/mysociety/fixmystreet-commercial/issues/1905 --- docs/_includes/admin-tasks-content.md | 44 +++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) (limited to 'docs/_includes/admin-tasks-content.md') diff --git a/docs/_includes/admin-tasks-content.md b/docs/_includes/admin-tasks-content.md index cd6043c25..13ee4aa51 100644 --- a/docs/_includes/admin-tasks-content.md +++ b/docs/_includes/admin-tasks-content.md @@ -656,6 +656,50 @@ selected. This can be used to provide extra information about the category, point specific cases elsewhere (e.g. a phone number for urgent enquiries), or anything else you think the reporter may find useful. +##### HTML content in notices + +Sometimes it can be helpful to use different text formatting or include images +in the notices shown to users. You could, for example, include photos that +illustrate the sorts of issues users should report in a particular category. + +Screenshot illustrating how the notice can include guidance for the user as well as a comparison photo. + +The **Notice text** field allows you to include HTML tags to apply text +formatting, add links, or include images in the notice shown to the user. The +above notice was generated from this HTML: + +```html +We take different action depending on how a drain is blocked.
+ +A blockage on the surface of a drain could be caused by leaves or litter. These blockages can usually be cleared by carrying out street sweeping.
+ +Compared with a surface blockage, an internal blockage could be caused by leaves, mud, or stones and need specialist equipment. + +``` + +The following HTML tags are allowed for use: + + - `p` + - `ul` + - `ol` + - `li` + - `br` + - `b` + - `i` + - `strong` + - `em` + - `a` + - The following attributes are allowed: `href`, `style`, `target="_blank"`, `title` + - `img` + - The following attributes are allowed: `src`, `alt`, `width`, `height`, `hspace`, `vspace`, `align`, `sizes`, `srcset` + - **NB** The `alt` attribute is required if you're giving information only present in the image. + - `span` + - The following attributes are allowed: `style` + +Any other tags or attributes not allowed by the above list will be stripped out +when you save your changes on the form. + #### Questions A question can ask the user to provide some specific additional information -- cgit v1.2.3 From 2eb0d9b6ef151662dcd0a48f0fdf0023de6e672e Mon Sep 17 00:00:00 2001 From: Dave Arter Date: Tue, 15 Sep 2020 17:29:23 +0100 Subject: [Docs] Add instructions for automatic export of dashboard CSV --- docs/_includes/admin-tasks-content.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'docs/_includes/admin-tasks-content.md') diff --git a/docs/_includes/admin-tasks-content.md b/docs/_includes/admin-tasks-content.md index 13ee4aa51..d0d5e4935 100644 --- a/docs/_includes/admin-tasks-content.md +++ b/docs/_includes/admin-tasks-content.md @@ -863,6 +863,23 @@ Android device or via an iOS device). These statistics can be downloaded as a CSV document, suitable for use in a spreadsheet program such as Excel or your own reporting tools. +#### Importing dashboard data automatically + +You may wish to automatically import data from the dashboard into your system on a regular basis. +Once you set your chosen criteria on the dashboard page, make a note of the URL of the "Reports" +or "Updates" link in the "Export as CSV" section. +Then you should generate an access token by visiting your account page and then "Security" and +generating a token from there. + +You can then specify that token either by appending it to the URL as an `access_token` parameter, +or including it as an `Authorization: Bearer ` HTTP header in the request from your system. + +The `export` must be present in the URL, and controls how the CSV is generated. +Reports can take some time to generate, so there are two different values for the parameter: + + - `export=1`: the response will wait until the file is ready and then provide it + - `export=2` (the default): you will immediately get a 202 HTTP response with a redirect to the location where the file will be once it has finished processing. This is more robust. + #### Heatmap Also accessible from the admin stats page is our heatmap. This can provide an -- cgit v1.2.3 From ab983c0445fde36a5338b199c7d3996580872e7c Mon Sep 17 00:00:00 2001 From: Dave Arter Date: Fri, 7 Aug 2020 17:33:27 +0100 Subject: Enable HTML in updates from staff users This also extends to response templates. --- docs/_includes/admin-tasks-content.md | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'docs/_includes/admin-tasks-content.md') diff --git a/docs/_includes/admin-tasks-content.md b/docs/_includes/admin-tasks-content.md index d0d5e4935..aa1225cfc 100644 --- a/docs/_includes/admin-tasks-content.md +++ b/docs/_includes/admin-tasks-content.md @@ -825,6 +825,15 @@ Click on ‘Templates’ in the admin menu. You will see a table of existing tem beside the status you wish to change. You may alter any of the fields as described in the section above, ‘Creating a template’. Additionally you can delete the template from this page. + +#### HTML content in templates + +HTML tags are permitted in response templates, which makes it possible to include +images or rich text formatting in the updates which are added to reports. + +Refer to the section ["HTML Content in notices"](#html-content-in-notices) above for details of +what tags and attributes are allowed. +
-- cgit v1.2.3 From 245f12237ad2c796667d5d4736483474c1b481ce Mon Sep 17 00:00:00 2001 From: Dave Arter Date: Tue, 11 Aug 2020 09:18:12 +0100 Subject: Enable HTML in update alert emails. --- docs/_includes/admin-tasks-content.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'docs/_includes/admin-tasks-content.md') diff --git a/docs/_includes/admin-tasks-content.md b/docs/_includes/admin-tasks-content.md index aa1225cfc..0fdc259e9 100644 --- a/docs/_includes/admin-tasks-content.md +++ b/docs/_includes/admin-tasks-content.md @@ -829,7 +829,11 @@ above, ‘Creating a template’. Additionally you can delete the template from #### HTML content in templates HTML tags are permitted in response templates, which makes it possible to include -images or rich text formatting in the updates which are added to reports. +hyperlinks or rich text formatting in the updates which are added to reports. + +Be aware that response templates are emailed to users as well as being shown on +the site, so it's best to keep any HTML formatting quite light-touch due to the +quirks of email clients' rendering of HTML message. Refer to the section ["HTML Content in notices"](#html-content-in-notices) above for details of what tags and attributes are allowed. -- cgit v1.2.3 From 5554f089315fd65429d0143c33a5a61c1bed5138 Mon Sep 17 00:00:00 2001 From: M Somerville Date: Fri, 9 Oct 2020 17:50:53 +0100 Subject: [Docs] Improve text on staff creating as others. --- docs/_includes/admin-tasks-content.md | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) (limited to 'docs/_includes/admin-tasks-content.md') diff --git a/docs/_includes/admin-tasks-content.md b/docs/_includes/admin-tasks-content.md index 0fdc259e9..234565587 100644 --- a/docs/_includes/admin-tasks-content.md +++ b/docs/_includes/admin-tasks-content.md @@ -147,20 +147,22 @@ recognition of your staff role.
-### Creating reports on behalf of another user/ the council +### Creating reports/ updates on behalf of another user/ the council Permissions required: User must be marked -as staff; one or more of ‘Create reports/updates on a user's behalf’, ‘Create -reports/updates as anonymous user’ and ‘Create reports/updates as the council’ -must be ticked. - -If a resident makes a report by phone or in person, staff members with the appropriate -permissions can add it to FixMyStreet on their behalf. The report may bear the resident’s name; or -it may be anonymous (i.e. the report-maker’s name is not published on the site, but will still be -available in the admin interface). Alternatively, reports can be made as if from the council itself. -In such cases, staff should make a new report just as a member of the public would — see ‘[The +as staff; optionally, one or more of ‘Create reports/updates on a user's +behalf’, ‘Create reports/updates as anonymous user’ and ‘Create reports/updates +as the council’ can be ticked. + +If a resident makes a report or update by phone or in person, staff members +with the appropriate permissions can add it to FixMyStreet on their behalf. The +report will be anonymous on the site, but the resident’s name will still be +available in the admin interface. Reports can also be made as if from the +council. + +Staff should make a new report just as a member of the public would — see ‘[The citizen’s experience](/pro-manual/citizens-experience/)'. Those with the appropriate permissions will see a dropdown box in -the report-making interface, labeled ‘Report As’. Select ‘the council’, ‘yourself’, ‘anonymous’ or +the report-making interface, labeled ‘Report As’. Select either the council, ‘yourself’, ‘anonymous’ or ‘another user’. If a user has the ‘Default to creating reports/update as the council’ @@ -168,6 +170,12 @@ permission then the dropdown will default to reporting as the council. Staff with the ’Markup problem details’ permission will also default to reporting as the council. +When a staff member makes an update on the site, it will not be publicly +displayed with the staff member’s name, but the name of the body to which the +user is attached. Staff members with the ‘See user detail for reports created +as the council’ permission will be able to see the staff user’s name on the +report or update, but other staff and the public will not. +
-- cgit v1.2.3 From 9150a5f72725d58055f9b5e60d339a781f9440f1 Mon Sep 17 00:00:00 2001 From: Struan Donald Date: Fri, 16 Oct 2020 15:11:50 +0100 Subject: allow bulk removal of staff status from users Bulk option to remove body, roles and permisions, and disable login in admin for users. Fixes mysociety/fixmystreet-commercial#2025 --- docs/_includes/admin-tasks-content.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'docs/_includes/admin-tasks-content.md') diff --git a/docs/_includes/admin-tasks-content.md b/docs/_includes/admin-tasks-content.md index 234565587..410caf272 100644 --- a/docs/_includes/admin-tasks-content.md +++ b/docs/_includes/admin-tasks-content.md @@ -528,6 +528,20 @@ maintenance) to a staff user by editing the user and checking the relevant categ staff user, when logged in, will then only see reports within those categories. This is useful where a staff user only deals with reports of a specific type. +#### Removing staff status from accounts + +To remove the staff status from an account visit the user page and +uncheck the ‘staff’ checkbox. To prevent a user from logging in uncheck +the ‘email verified’ checkbox. + +You can do this in bulk on the Users screen by selecting the checkbox +next to the user's name on the users page, selecting the ‘Remove staff +permission’ checkbox and clicking submit. + +Note that if a user has access to the email address associated with an +account they can re-enable their account, but will not have staff +permissions. + #### Removing accounts To remove an account, the Administrator-level member of staff should make contact with -- cgit v1.2.3