Documentation for the new Self Admin

Transcription

1 Documentation for the new Self Admin The following documentation describes the structure of the new Self Admin site along with the purpose of each site section. The improvements that have been made to the admin site include: Speed the site has been redesigned from a front end JavaScript application that inefficiently called multiple APIs on startup (independant of which functionality the user was trying to access), into a server side app which only loads the data required for the page being viewed Routing moving the application server side has allowed us to add full path routing so that we can now provide URLs to customers to access specific pages in the admin site. This will be particularly useful when customers are working with support staff to alter configuration settings and can now be directed to the individual pages required Cleaner code as part of the rebuild we have refactored the code to make it easier to work with, maintain and extend Permissions the admin site now supports granular permissions, for example allowing users with the petition admin permission to login to the Self admin but only access the petitions moderation page and not any of the other more powerful functionality, whilst a full admin would be able to see everything New apps we have also released the initial versions of two new apps: Page Builder The page builder allows admins to create new pages in their Self sites. This includes the URL path on which the page should appear, whether the page should have a navigation item and what it should be called, what permission groups the user must belong to in order to see the page, what scripts and styles to load on the page and what the page should contain. Initially, in the first version of the app, the contents of the page will just be a free html field but in future updates we will add a layout builder interface and allow the different sections of the layout to show either html or the result of an integration transform pair Notifications This app allows admins to specify the conditions under which different notifications will show. These conditions can include globals e.g. current date or time, user specific tokens e.g. date of birth or uprn, and in a future update to the app the ability to use the result of an integration transform pair. After setting the condition, admins can then provide the text that should be shown in the notification, select the style of the notification (both the colour and whether it shows as an element under the navigation bar or a popup overlay element in the corner of the window), and

2 choose whether the notification will display permanently whilst the condition is met or if the user is able to close it and not have it reappear The list below contains the initial structure and set of pages available in the new Self admin. The remaining pages of this document go into detail about the functionality available on each of these pages. The new Self Admin site structure Site Settings General Registration Profile Content Page Components Account Pages System Pages Apps Navigation Navigation Items App Management Service Rating App System Forms AchieveForms New AchieveForms Reports Self Statistics Service Rating App Management Services My Accounts My Requests Dashboard Petitions FAQs Notifications Page Builder Please note : When using the functionality on each of the following pages don t forget to click the update/save button in the top right corner before moving on to keep any changes you have made.

3 Site Settings General This page allows admins to edit the general site settings. 1. From this page you can change, upload or remove the site favicon and header logo. To upload or change the image simply click the Select Files button and browse through your local files to find the image you wish to use. To remove the image altogether, select the remove option at the end of the row 2. You can also personalise the SELF UI and iframe UI with your own CSS files by providing the path to them in the respective text boxes 3. You can add a site title URL, which becomes the link of the toolbar, site title and site logo 4. In the head HTML box you can add the meta tags for your self site and their respective parameters 5. You can also specify the page URL that the user is redirected to after signing out

4 Registration This page edits the settings for the registration of a user. 1. You can disable profile registration by checking the corresponding box 2. For both the registration and verification you can enable or disable automatic s being sent out and specify the address that will appear as the sender. You can change the content of these s in the Content > Account Pages section 3. This section specifies the minimal strength of any user passwords. You can choose whether a strength indicator appears by checking the first tick box, and modify the message the user sees when their password does not meet the necessary criteria. The password strength options allow you to choose the minimum length the user s password has to be and the different characters that need to appear in their password

5 Profile This page customises the user profile settings. 1. Here you can select the change of address form to be filled in by the user from your current forms. Users can access this by clicking on the right hand side of the toolbar and selecting change address 2. You can disable/enable showing an alternative number field on the user profile by checking/unchecking the tick box. Note: this field is not used in new Self sites as the profile form is customisable 3. By enabling Consent To Share, this gives the user the option to consent to share their profile information when filling out their profile. You can name the field for which this option is given by filling in the text box 4. This JSON input field enables you to fully customise the My Profile fill in form. Note: this field is not used in new Self sites as the profile form selected in field #1 is customisable 5. Clicking the Tokens button opens a reference guide for each profile field and its respective data name attribute for an input field to be inserted into your JSON configuration

6 Content Page Components In this page you can customise general page components. 1. Here you can specify the title of your Self site which appears in the top left of the toolbar. Leaving the entry field blank will use the original value Self 2. For each of the elements listed you can customise your site by entering your own HTML code in the right hand boxes. If you wish to use the originals/default values then you can copy and paste the code specified in the left hand boxes. However, leaving any field blank will not revert to the original value

7 Account Pages The two tabs are used to edit the s which are automatically sent. In the current tab you can edit the registration confirmation The content of the s can be customised by editing the right side html code 2. The subject of the automatic can be specified in the right hand text box 3. The next tab is for editing the verification sent to the users for them to verify their account

8 System Pages From this page you can edit the modal seen by users who are not signed in. 1. Here you can edit the title of the modal. 2. By entering html in the right hand box you can edit the instructions for anonymous users, like the benefits of signing up compared to continuing anonymously. 3. Here you can edit the text of the different anonymous elements in the modal by entering the text in the right hand text box.

9 Apps In this tab you edit the services content. 1. Here you can edit the title displayed when the user selects My Services 2. You can edit the HTML in the right box. This HTML displayed when no services are available

10 This tab is used for editing My Account content. 1. In the right hand text box you can add your own HTML code which will be displayed in the left hand column of the My Accounts page 2. In these two fields you can edit the heading title and login prompt text shown on the My Accounts page. The original value is shown on the left 3. By editing the HTML on the right hand side you can customise what appears as an error message and what is displayed when account signup is enabled/disabled

11 In the Dashboard content tab you can edit the text that appears for each different element listed by entering your preferred value into the text boxes on the right.

12 In the petitions content tab you can customise the main, create and sign petition pages. 1. Editing the text box on the right customises the title of the petitions page 2. By entering HTML code into the right hand side box you can customise the description and guidance text displayed on the main petitions page 3. For each of petitions page you can edit the elements listed by specifying the value in the right text boxes using the left hand data as a guideline

13 The last apps tab edits the View Data app content. For each field you can customise the text displayed by filling in the right hand text boxes, or copy over the left hand boxes to keep the original value. Navigation Navigation Items On this page you can drag and drop the different rows to reorder the navigation menu links.

14 App Management For each application, you can check the tick boxes in its row. Checking the tick box in the Enabled column enables this application, otherwise the application is not available to users. Checking the box in the Display Anonymous column displays enabled applications for users who are not logged in, if this is not checked users will need to sign in to see the application. Service Rating App For each form you can chose whether the service rating is available or not. Any forms that are whitelisted will redirect to the service rating after the user has filled in the form whereas

15 any form that has Blacklist checked will not. For each form, one of the boxes has to be checked and you can t check both boxes. System Forms AchieveForms On this page you can blacklist old AF forms. 1. Entering a old form group id will whitelist the form group, so the form group will be available. Entering 0 whitelists all old AF form groups 2. To blacklist an old AF form group, enter the id for the group in this text box 3. In this dropdown menu you can choose which stylesheet mode to use for the old AF forms

16 New AchieveForms On this page you can choose which new AF forms are available. 1. If this checkbox is not selected, then the respective form will be disabled and won t be visible to users 2. If this checkbox is not checked the user won t have to login to fill in the form. If a form requires a user to be logged in to fill it in then this box should be checked 3. This column can be used to override the previous Auth Required column, if this column is ticked then the login modal will not appear 4. Checking this column restricts the form to certain user groups. Which user groups can/can t use the selected forms can be set in the permissions manager

17 Reports Self Statistics This page displays a pie chart to show the percentage of registered users who are self registered compared to CSA registered. The data is automatically entered. Service Rating This page displays information from the service ratings filled in by the users.

18 1. This bar chart shows the number of stars that users have rated the form 2. Here you can select individual forms to see how the users have rated them, selecting a form will change the bar chart (#1) 3. You can select a specific time period to show the ratings. You can enter the dates manually or clicking in the field reveals a calendar from which to select a date. Selecting a time period will automatically adjust the bar chart (#1) 4. You can press this button to download the displayed bar graph as a CSV file 5. To reset the fields filled in (#2 & #3) click this cross icon 6. Here you can view the comments users have left with the time the comment was made and how many stars the user gave. For security reason only 15 are shown, if more than 15 comments have been made, a warning will appear prompting you to download additional comments if necessary

19 App Management Services On the first services tab you can manage the service groups. 1. If this is enabled then the My Services page will display tabs for each group added. If this is disabled then it will simply load all the forms under the services heading (this admin page remains unchanged however so you can easily enable your previous groups later) 2. This is the default/first group. When this group is selected on the My Services page, any form which is not selected in another group will be displayed. You can name this group and give it a description by filling in the relevant text boxes 3. For each additional group you can name the group and give it a description 4. In the drop down menu you can select which forms to add to this group 5. Any form that is already in this group will be listed above the drop down menu. Clicking the X will remove it from this group. Any form listed will not display in the default/first group, however, the form can be selected in multiple additional service groups. 6. You can add another group by clicking this button 7. To delete any extra service groups simply click this button on the group you wish to remove

20 In the second service tab you can manage the external services available to your users. 1. To add a new external service click the Add button 2. For each external service you need to fill in a title for the service and its URL. If you want the external service to open in a new window rather than redirect the current page, check the corresponding tick box. To delete the external service click the red button at the end of the row

21 My Accounts On this page you can select from the drop down menu which form to use for account sign up. When a form is selected you can select the X at the end of the field to remove it as the designated sign up form. To enable a promotional page on the My Accounts widget, check the corresponding checkbox, then enter the HTML code you would like on this promotional page in the box provided.

22 My Requests On this page you specify where the user is redirected to when submitting or cancelling the stage of a form they entered from the My Requests app. The default link returns the user to My Requests, to redirect to another page of the site specify the path of the page starting with a forward slash, i.e. to redirect to the FAQs app, enter /FAQs. On this page you can blacklist a form/period for certain time periods. 1. Select a form/process from the drop down list to add a period for which this service is unavailable

23 2. For each form you can fill in the dates for which the form is to be blacklisted. You can have multiple time periods where the form is blacklisted, to add a new period simply click the Add Period button. Any time the current date is inside one of these time periods the form will be blacklisted and not visible to users. To have no start date to the time period you can leave the first text box blank which will default to Infinity. Similarly to have no end date leave the second text box empty for +Infinity. To remove an individual time period select the delete button attached to the text boxes 3. To remove all time periods for which the form/process is blacklisted select the corresponding red button and the end of the row On this page you can choose the number of requests shown in the My Requests widget which can be embedded in the custom homepage content.

24 Dashboard On this page you can manage the new Dashboard app. 1. To go to the old dashboard management you can click here. If you aren t sure which version of the Dashboard app you are running, it is probably the older version but you can call our support team who can tell you what is installed on your site. 2. To have tabs for New/Old forms check the relevant check boxes and to view the tabs for each click on the respective tabs 3. Any existing tabs are displayed in this table. You can reorder them by clicking on the three lines in the sort column to drag and drop them into the required order. For each tab the title, permissions, processes and columns on the tab are shown. To edit any of these you can simply click the edit button, or to remove this tab select the delete button 4. Selecting the new tab button will open this modal. Here you can give your new tab a title, select the permission groups for this tab, and choose the settings for the tabs by checking/unchecking the relevant text boxes. The tasks drop down lets you choose whether, all, completed or open processes are shown and the assignee drop down menu lets you choose whether any or just the current CSA/User assigned processes are displayed. You can also choose the redirect URL of the process by entering a page URL in this relevant text box (which must start with a forward slash). To select the process(es) begin typing the name of the process to search for it, then select the required process from the list. You should do

25 this for each process you wish to include. To remove a process simply click the X at the start of the process name. At the bottom of the modal you can select the columns that are present in the tab by checking the tickbox before the column title. You can drag and drop the three lines by each column title to order the columns. Additional columns will be added at the bottom depending on the processes chosen. For any date column you can check the Include Time checkbox for the exact time to be added rather than just the date. Finally, to save the tab click the save changes at the bottom of the modal, or close to discard any changes. Petitions On the first tab of Petitions in App Management you can approve or reject petitions created by users by clicking the respective buttons on the right hand side. You can also click View Full Details to see the name and address of the user who created the petition, and the title, description and date the petition was created.

26 The Open Petition, Closed and Rejected tabs all have similar formats. The open petitions tab shows the petitions that are open at the moment. 1. The table shows the ID, title, opened date, expiry date, author and number of signatures for each petition. At the bottom of the table you can go to the next, previous or a specific page of petitions 2. You can search through the petitions by typing the ID, title, opened date, expiry date or author of the petition(s) you wish to find 3. To delete a petition you can check the delete box in the row of the petition and then click the delete petitions button at the top right of the page. You can select multiple petitions to delete before clicking the delete petitions button to remove several petitions at once 4. In the actions column clicking the i reveals more information on the selected petition. the pencil button reveals the information on those who have signed the petitions and gives you the option to download the list of signatures as a CSV file. The arrow with a letter button allows you to respond to the author of the petition. If this button is green a response has already been sent The format is the same for the next two petitions tabs, closed and rejected petitions.

27 On the configuration tab: 1. Enter the address that any notifications should be sent to. Enter each address on a separate line 2. The thresholds are the number of signatures before an is sent to the addresses 3. The petition lifespan is the number of days until an is sent to say a petition has expired In the last tab you can edit the s sent regarding petitions. For petitions created, approved, rejected and responses you can enter the subject of the and the text of the .

28 FAQs In this page you view and edit FAQs. 1. To create an FAQ click the Create button 2. You can select how many FAQs are shown, how they are sorted, and which FAQs are displayed using these drop down options 3. You can also search for an FAQ by entering its ID or part of its title and then pressing enter on your keyboard 4. For each FAQ you can view the FAQ ID, question, tag status, visibility and the date it was last modified. Clicking the question/title of the FAQ displays the answer 5. You can edit the FAQ by clicking the Edit button at the end of the row. This will switch to the edit FAQ view where you can edit the question, whether it is live or a draft, the visibility, the answer to the question and the tags. To return to view the FAQs click the View and Edit tab (after pressing the save button if you want to keep any changes). To delete an FAQ click the delete button at the end of the FAQ s row

29 On this FAQs settings tab you can set the URL of the enquiry form for the user to fill in. Notifications From here you can edit the notifications. 1. To add a new notification click the Add New button 2. The current notifications are listed here and can be deleted by clicking the delete button at the end of the row

30 3. When a notification is selected from the list or a new notification is made you can edit the name in this field 4. Selecting the checkbox next to either bootstrap or toastr changes the type of the notification. If bootstrap is selected you can see a preview of your notification in the notification preview area. If toastr is selected then a preview will display on the page. In the drop down menu you can select the type of notification as either success, info, warning or error, which changes the notification s colour 5. The message displayed to the user can be edited in this text box 6. The conditions for when the notification is shown are added here. If AND is active then both conditions need to be true for the notification to occur, if OR is selected then only one of the statements need be true. To add a rule click the Add rule button. You can add groups within the parent AND/OR statement which will have another AND/OR relationship. So, you can setup scenarios where both rule 1 and group 1 have to be true, but in group 1 either rule 2 or rule 3 have to be true for group 1 to be true. To add a condition for a notification you need to add the required conditions on this page by clicking the conditions tab at the top of the page. 1. When you click Add condition this modal is displayed. Here you can create a condition by choosing the field type, if general is selected then the condition will be based on the time or date. If profile is selected the condition depends on data from the user s profile 2. The available conditions to use are displayed in this list

31 Page Builder On the page builder app management page you can create your own custom pages. 1. The current custom pages you have made are displayed in this list. To edit or view a custom page click on it 2. To save any changes to the custom page select the Save button and to add a new custom page click the Add button 3. If you want to enable this custom page tick the Enabled checkbox. Otherwise, this custom page won t be visible to users 4. Fill in the title, heading and path fields with the corresponding values of your custom page 5. To create a navigation menu item for this custom page check this checkbox and fill in the title. Here you can also choose whether the navigation item is displayed to anonymous users or if the users need authentication to view the content 6. Here you can add the meta tags for your custom page 7. From the dropdown menu you can select the permission groups the user must belong to in order to view this custom page

32 The layouts page is currently under development and will be updated in future releases. Please watch the weekly release notes for information on this. In this page you can add your own scripts and styles for your custom page. 1. To add a script click the Add Script button and insert the destination of the JS file you wish to use. To add another script simply click the button again 2. To add a style click the Add Style button and insert the destination of the CSS file you wish to use. To add another style simply click the button again