-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathees.Rmd
714 lines (407 loc) · 36.4 KB
/
ees.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
---
title: "Using Explore Education Statistics"
---
<p class="text-muted">Guidance for how to use the features in the Explore Education Statistics platform</p>
---
**The EES platform consists of two applications:**
1. The public website, where users access stats
2. The admin website, where production teams create their stats.
<div class="alert alert-dismissible alert-info">
The admin side of EES is only supported in Google Chrome and Microsoft Edge. It will not work correctly in Internet Explorer. The public side does support Internet Explorer, though we still recommend that people use Chrome or Edge instead.
</div>
Both applications were initially released to Minimal Viable Product (MVP) standard, we will be iterating and improving the functionality based on user feedback throughout 2020 and 2021.
Maintenance and BAU running of the platform is supported by the Statistics Development Team.
---
# How to access EES
---
As stated above, EES consists of two parts. We also have four versions (environments) of EES, the banner for the admin part of each environment will inform you which environment you are on, this is also colour coded:
- **Development** - Green - where changes are first merged in, and often the first time different pieces of work from different developers will interact properly
- **Test** - Pink - where our tester carries out manual testing of any new features to make sure things work as expected
- **Pre-production** - Yellow - a sandbox area for admin champions and functionality testing
- **Production** - Red - the real service, anyone creating real releases that they intend to publish to the public should be using this environment
There is no overlap between the environments and content created on one cannot be moved to any other. We recommend that teams use the pre-production environment to familiarise themselves with the platform and test out what is possible, you can dummy publishing a publication to see what it will look like on the public website by following the process for publishing. Publications will go out at 8:30am on the scheduled day on pre-production, mirroring the way that production runs (though one hour earlier).
The core functionality across the environments is identical except for new changes, which are deployed through the different environments in order before they make it to production.
On the pre-production environment, all analysts have full permissions to create publications and releases, and see everything else that other analysts are making. This is unqiue to the pre-production environment, on the production environment analysts will only have access to releases that they have been granted specific access to.
<div class="alert alert-dismissible alert-info">
Jobshare emails can not be used to access EES. Specific personal emails should be used instead, in the same way as you sign in to windows on your machine.
</div>
The Statistics Development Team will be responsible for setting up and maintaining user permissions during the beta phase. Change requests will be monitored via their main mailbox - [email protected].
<div class="alert alert-dismissible alert-danger">
If you are bookmarking links, please be careful to bookmark the links below exactly as they are shown. Often when signing in you will be redirected via other url's as a part of the authentication process, and bookmarking those may lead to errors.
</div>
---
## Production environment
---
Admin - https://admin.explore-education-statistics.service.gov.uk/
Public - https://explore-education-statistics.service.gov.uk/
Access to the production admin service is limited to DfE AD accounts only and users have to have been invited to the service by either the Statistics Development Team (for full access) or an existing user (for pre-release access). Invites to the service are sent out via email using gov.uk Notify.
To be invited to the service for full access teams need to email the [Explore Statistics Mailbox](mailto:[email protected]), stating who needs access, what permissions they require (analyst or approver), and for which publications these apply. Approvers are traditionally DD's though sometimes this responsibility may be delegated. This email should be sent by the Team Leader, or accompanied with the relevant Team Leader’s approval. Once access has been granted you will receive an email inviting you to use the platform.
At first we'll be inviting analysts to the admin site in phases, depending upon when they expect to first publish statistics via EES. This is so we can ensure we're providing sufficient support and have awareness of what releases are going out in the short term.
---
## Pre-production environment
---
Admin pre-production - https://admin.pre-production.explore-education-statistics.service.gov.uk
Public pre-production - https://pre-production.explore-education-statistics.service.gov.uk
Analysts are able to test the service within the EES pre-production environment, and it is recommended that production teams start here until they are confident they know how they want to build their release for real (again, please contact the [Explore Statistics Mailbox](mailto:[email protected]) to request access).
When accessing the pre-production environment you may be asked for a username and password, these are as follows: dfe, dataresearch.
<div class="alert alert-dismissible alert-danger">
The pre-production environment is not suitable for unpublished data. Unpublished data should only be uploaded to the production environment.
</div>
---
## Admin dashboard
---
<div class="alert alert-dismissible alert-warning">
Use Google Chrome or Microsoft Edge to access and use the admin part of Explore Education Statistics.
</div>
When you enter the service you’ll see the admin dashboard, here what you can see will be dependent on your access permissions i.e. you’ll only see the publications that you have been granted access to. Within the test environment users are set up with full permissions (i.e. they can see/do everything) though in our production environment this will be restricted.
The Statistics Development Team will be responsible for setting up and maintaining user permissions during the beta phase. Change requests will be monitored via their EES mailbox - [email protected].
`r knitr::include_graphics("images/EES-admin-dashboard.PNG")`
Within this dashboard you can access existing publications to create/edit their releases. You can use the drop down lists to find releases by theme/topic/publication or use the draft and schedule releases tabs to see releases that are in progress.
Help and guidance for how to use the the admin website is available via the [administrators guide](https://admin.explore-education-statistics.service.gov.uk/documentation){target="_blank" rel="noopener noreferrer"}, this is always accessible from the top bar of the admin side of EES, as shown in the image below.
`r knitr::include_graphics("images/admin_guide_access.png")`
---
# Publications
---
The hierarchy of content within EES is as follows -
```{r, echo=FALSE, fig.align='center'}
knitr::include_graphics("images/ees-hierarchy.PNG")
```
Publications are organised into topics and themes (as shown on the EES Find Statistics page), and then within each publication there are releases - where the latest release includes the latest statistics for that publication. For example:
| Level | Example |
|:------|:------|
| Theme | Pupils and Schools |
| Topic | Pupil absence |
| Publication | Pupil absence in schools in England |
| Release | 2018/19 |
Each publication should have a lead statistician's name and contact details attached to it as a requirement of the Code of Practice. You may use a team email address but the name and telephone number of a named statistician must also be provided.
To request a change to the contact details for a publication contact the [Explore Statistics Mailbox](mailto:[email protected]).
Methodology documentation is also attached at a publication level within EES - meaning one standalone piece should be written to cover all releases for the given publication within the service.
If you want to request a new publication, please be prepared to give the following:
+ The heading and subheading that you want the publication to sit under in our site (take a look at the current structure [here](https://explore-education-statistics.service.gov.uk/find-statistics){target="_blank" rel="noopener noreferrer"}), feel free to either use existing ones, or suggest new ones
+ The exact title of the publication
+ If the methodology already exists elsewhere and you have a URL for it, or if you want to [create one](#Methodology)
+ Team name
+ Team email address
+ Lead statistician name
+ Lead statistician contact number
+ The [year](https://rsconnect/rsc/stats-production-guidance/ud.html#list_of_allowable_time_values){target="_blank" rel="noopener noreferrer"} of the release you’re creating
+ Whether they are National statistics, an ad-hoc publication, or official statistics
+ List of email addresses of analysts who need access to edit the release
+ Email address for whoever is providing [senior sign off](#Signing_off_a_release)
---
# Create new release
---
After finding the publication you want to create a release for, just press the button to create a new release.
Currently the following tyes of release can be created in EES:
* National Statistics (includes OSR tick mark logo at the top of the release page)
* Official Statistics
* Adhoc Statistics
When creating a release you will be asked to fill in some release summary fields, including the scheduled publication date.
<div class="alert alert-dismissible alert-info">
The time period for the release should reflect the time period of the data that this latest release adds to the time series.
</div>
You also have the option to add the 'next expected update date' for which you can provide the planned month and year of the next release within this publication. If this is added but then needs to be changed later in the year it is easy to do so, contact the [Explore Statistics Mailbox](mailto:[email protected]) in the first instance.
<div class="alert alert-dismissible alert-warning">
Whilst in public beta, the Statistics Development Team are the only ones who can create new releases within the production environment – this is so we have awareness of all the early users within the admin site and can supply appropriate support.
</div>
Once you have created your release you will see enter the ‘create release dashboard, here you need to work through the following tabs to create your release:
1. Data and files (uploading data files, ancillary files and creating public metadata)
2. Footnotes (creating footnotes and assigning to relevant data)
2. Data blocks (creating summary tables, charts and key stats indicators)
3. Content (drafting release content)
4. Sign off (moving through the approval process)
5. Pre-release access (invite users to pre-release and create public pre-release list)
---
`r knitr::include_graphics("images/EES-create-release-dashboard.PNG")`
---
# Managing legacy releases
---
Past publications on other services can be added to the previous releases links that appear on the top right of a release page by using the 'Manage legacy releases' section. In here you can add links to previous releases and choose the order in which they appear.
<div class="alert alert-dismissible alert-warning">
For the time being this can only be done by the Statistics Development Team, please get in touch if you'd like us to add any legacy releases for your publication.
</div>
The video below walks through this:
<center>
<video width="640" height="360" controls>
<source src="images/manageLegacyReleases.mp4" type="video/mp4">
</video>
</center>
---
# Uploading data and files
---
## Data uploads
---
Here you will update your tidy data files and accompanying metadata. You need to make sure that the data has passed through our data screener checks before trying to upload it.
<div class="alert alert-dismissible alert-info">
Planning area, School, Provider, and Institution level data will upload as normal to EES, though will not be read into the table tool or data blocks, as they are not yet designed for these levels of data. All data, including these levels are accessible in the downloadable files for users to explore in the same format as they are uploaded. Any data files that only consist of these levels should be uploaded as an ancillary file, rather than as a data file.
</div>
Once you click to upload the file a ‘Status’ will be visible that shows the progress of the import process. It will go through the following stages:
* Queued
* Validating
* Importing
* Complete
This may take a little while depending on the size of your file and if there are numerous files queued for import. You cannot view the dataset or use it to create tables/charts until this status is ‘COMPLETE’.
For data files greater than 80mb we recommend uploading as a ZIP file.
<div class="alert alert-dismissible alert-warning">
If you believe your file is ‘stuck’ please contact [email protected], with details of the file and the release that you are uploading to.
</div>
---
### Subject names
---
You'll need to give a 'subject name' to each data file you upload. The subject name should be a simple user-friendly title for the data included within the file - it is what users will see wherever the file is referenced within EES. The actual file name can include more technical / coverage information.
When adding a subject name think about the general user and how the subjects will appear in the table tool - for example, you don't need to include the publication name in the subject name as this is always already implied within EES.
---
## Ancillary file uploads
---
Any files you want to make available for users to download but aren't intended the table tool should be added as an ancillary file upload. These files will need to meet all requirements of the new [accesibility regulations](https://www.gov.uk/guidance/publishing-accessible-documents) before they can be published.
Examples of ancillary files may be:
* Infographic pages
* Supplementary data that isn't intended for the table tool
* Additional technical documentation
* Images
<div class="alert alert-dismissible alert-info">
Any data files that only consist of Planning area, School, Provider, and/or Institution level data should be uploaded as an ancillary file, rather than as a data file.
</div>
---
## Metadata guidance
---
Here you should also create your [public metadata](https://explore-education-statistics.service.gov.uk/find-statistics/permanent-and-fixed-period-exclusions-in-england/meta-guidance) guidance document, this replaces the information that would have previously been uploaded as a pdf and is designed to help users understand and use the data they download from your release.
`r knitr::include_graphics("images/admin-public-meta-start.PNG")`
The document will automatically update as you add new data files to your release, however you will need to add an overview of all the data included in the release and short summaries for each data file before the release can be published.
A list of variables in each file with an associated label (taken from metadata uploads) will also be displayed with each file.
This template follows a similar format to our previous recommended [metadata template](https://educationgovuk.sharepoint.com/:f:/r/sites/DfEStatisticsCoherence/Shared%20Documents/Templates%20-%20Explore%20Education%20Statistics?csf=1&e=7iJoUy) so for most publications this will involve a copy/paste from existing content.
`r knitr::include_graphics("images/admin-public-meta-detail.PNG")`
<div class="alert alert-dismissible alert-danger">
Releases cannot be published without a completed metadata document. If not filled in an error will be flagged during sign off.
</div>
---
## Replacing data
---
If you notice a mistake in your data file you can replace it with another.
`r knitr::include_graphics("images/replace-data-start.png")`
When replacing a data file the platform will attempt to recreate any data blocks and footnotes that were built using the previous file.
The first step is to upload the new file.
`r knitr::include_graphics("images/replace-data-step1.PNG")`
One you've chosen and uploaded your replacement file it will need to go through the usual import process before it can check if retaining existing data blocks and footnotes will be possible.
`r knitr::include_graphics("images/replace-data-step2.PNG")`
Once the upload is finished a report will appear which highlights whether existing data blocks and footnotes can be replaced successfully. If you want to keep any data blocks and footnotes you've built you will need to make sure that your replacement data file still contains the information (indicators, filters, geographic_levels and time_periods) that was used to create them.
`r knitr::include_graphics("images/replace-data-success.PNG")`
If it's not possible for a data block or footnote to be recreated using the replacing data file a warning will appear and you'll be prompted to either edit or delete them before completing the replacement.
`r knitr::include_graphics("images/replace-data-fail.PNG")`
<div class="alert alert-dismissible alert-danger">
Remember to double check any data blocks or footnotes that were recreated by the platform before publishing your release.
</div>
---
# Adding footnotes
---
To add footnotes, go to the footnotes tab and click 'add another footnote'. Rather than writing multiple tables and assigning individual footnotes, you write footnotes and assign them to certain indicators and filters so they appear when users select them in the table builder. For example in the below, the footnote "This is a footnote" is assigned to "the number of pupils entering each exam" for all filters.
`r knitr::include_graphics("images/footnote_example.PNG")`
Now, when a user goes to build a table with this indicator, the footnote automatically appears.
`r knitr::include_graphics("images/footnote_output_example.PNG")`
If you'd rather, you can assign a footnote to the whole data file by ticking this box.
`r knitr::include_graphics("images/All_indicators.PNG")`
You can assign footnotes across multiple data files.
<div class="alert alert-dismissible alert-danger">
We recommend that you only add footnotes once you are certain the data file is final. If you have to delete the data file, all the assigned footnotes will be deleted alongside it.
</div>
---
# Data block tables
---
Once file imports are complete move to manage data blocks tab and use the admin table tool to create your summary tables. Here you can also use the reorder table headers tool to restructure your table however you want it.
Once you're happy with your table, give it a title and some source information before clicking save.
---
## Table highlights
---
You can also choose to highlight a data block table as a ‘top table’ which means it will show in a list of table highlights within the table tool. This is designed to help users get to tables of interest more quickly (without having to create tables themselves).
There is an option to choose if a table is a 'highlight table' when saving each data block:
`r knitr::include_graphics("images/EES-create-release-table-highlight.PNG")`
Each highlight table will then be listed to the user within the table tool. Highlight tables do not have to be embedded within your release content to be included in this list.
`r knitr::include_graphics("images/EES-table-tool-highlights.PNG")`
---
## Fast track links
---
Any data block tables that are created and saved within the admin app will also be assigned a ‘fast-track link’, this url can then be used throughout your release as a way to direct users to specific tables (within the table tool) more quickly so they can interact and explore the data further. It will appear at the top of the page like this:
`r knitr::include_graphics("images/EES-create-release-fasttrack-url.PNG")`
When your release is published, any embedded data block tables within the release will have an 'explore data button' beneath them which will utilise these fast track links to quickly direct users to the table within the table tool so they can explore the data further. You can also use fast-track links as a hyperlink within release commentary (without having to embed the data block).
<div class="alert alert-dismissible alert-info">
**What is the difference between a fast-track link and a permalink?**
EES also offers 'permalinks' for any table created in the table tool which allows a user to save a link to a permanent, static, version of a table they have created. Analysts can make use of these permalinks when answering queries or in PQ and FOI responses.
Fast-track links are similar to permalinks however instead of linking to a static version of a table they link to an 'active' version of the table within the table tool - meaning users can interact and change what's shown in the table from within the table tool if they choose to.
</div>
---
# Data block charts
---
After building and saving a data block table you will see a 'Chart' tab appears. This tab will take you to the EES chart builder, where you can choose to add a chart to your data block.
The first step to creating a chart is choosing the chart type, currently the EES chart builder can build line charts, horizontal/vertical bar charts (including stacked) and maps. We intend to grow this list over the course of public beta so please let us know if a chart type you want to create is not possible.
After choosing your chart type you then need to work through the following stages and you’ll be shown a live preview as you go:
---
## Chart configuration
---
Within the ‘chart configuration’ tab you can add a title, alt text, move the legend and change chart dimensions.
`r knitr::include_graphics("images/EES-charts-create.PNG")`
Note, within the vertical and horizontal bar chart types you can also create stacked bar charts via the chart configuration options.
---
## Data sets
---
Here is where you add data to the chart. Each series is added one at a time.
`r knitr::include_graphics("images/EES-charts-add-data.PNG")`
---
## Legend
---
You can edit the chart legend, and styling of your series via the Legend tab.
`r knitr::include_graphics("images/EES-charts-legend.PNG")`
---
## X axis (major axis)
---
Here is where you configure the x-axis: You can alter gridlines, labels, sort, limit and add reference lines.
`r knitr::include_graphics("images/EES-charts-xaxis.PNG")`
|Option|What it does|
|---------|---------|
|Size of axis |Change the width of the space given to axis tick labels|
|Group data by |Change how the data within the chart is grouped|
|Show grid lines |Turn grid lines on and off|
|Show axis |Turn the axis on and off, you can also add a unit to the axis tick labels|
|Sorting |Change how the data within the chart is sorted|
|Tick display type |Alter how often axis tick labels are shown, labels will automatically skip values where there are too many to show without overlapping|
|Axis range |Alter the range of data shown in the chart|
|Label |Add an axis label, you can also choose the width for the space given to it|
|Reference lines |Add/remove reference lines to the chart|
---
## Y axis (minor axis)
---
Then follow a similar process for the y axis configuration, play around until the chart looks how you want it to.
`r knitr::include_graphics("images/EES-charts-yaxis.PNG")`
|Option|What it does|
|---------|---------|
|Size of axis |Change the width of the space given to axis tick labels|
|Group data by |Change how the data within the chart is grouped|
|Show grid lines |Turn grid lines on and off|
|Show axis |Turn the axis on and off, you can also add a unit to the axis tick labels|
|Sorting |Change how the data within the chart is sorted|
|Tick display type |Alter how often axis tick labels are shown, labels will automatically skip values where there are too many to show without overlapping|
|Axis range |Alter the range of data shown in the chart|
|Label |Add an axis label, you can also choose the width for the space given to it|
|Reference lines |Add/remove reference lines to the chart|
---
## Changing chart type
---
If you create your chart and then change your mind as to what chart type would be best you can just click to change it and it will try to save all the options that you had applied previously.
`r knitr::include_graphics("images/EES-charts-change-type.PNG")`
You can create maps too, currently this is possible for regional, LA and LAD data, though remember your source table needs to include information for all geographies in your map to be able to map them.
<div class="alert alert-dismissible alert-info">
Remember to save your chart when you’re done.
</div>
---
## Other chart types
---
You should only use complex charts where there is a clear user need, as simple charts are the easiest for users to understand. If you have a an infographic or a chart that is too complex to build within our chart builder you can use the 'Choose an infographic as alternative' option to upload an image to your data block instead. These should be .svg format and you can use the sizing options within the data block editor to size your image appropriately.
`r knitr::include_graphics("images/EES-charts-infographic.PNG")`
<div class="alert alert-dismissible alert-info">
Accessibility matters for infographics too, consider the following if you do need to upload an image -
* Keep them simple
* Use [GDS colours](https://design-system.service.gov.uk/styles/colour/)
* Don't put borders around images
* Ensure there is a high enough colour contrast ratio between elements. You can use a [colour contrast checker](https://contrast-checker.glitch.me/) to check the colours you're using
</div>
---
# Writing content
---
In the manage content tab you can now start creating your release, embedding the datablocks you’ve created as you go.
<!-- potential for gif? -->
You can use the page view toggles, that float in the bottom left of the page, to jump between edit and preview mode.
<!-- potential for gif? -->
Use the ‘Add secondary stats’ button to add a datablock to your headline stats section.
<!-- potential for gif? -->
Use the 'Key stats' options to add key statistic tiles to your release. For each tile you first have to have created a datablock with a only a single number.
`r knitr::include_graphics("images/key-stat.PNG")`
After embedding a key stat tile you can then edit it to add trend information and a description of what the indicator is.
| Element | Content |
|---------|---------|
| Indicator name | Automatically generated from your data |
| Latest value | Automatically generated from your data |
| Trend | A short one-sentence description of the trend; try to avoid only stating the change from the previous year and talk about the longer-term trend where appropriate |
| Guidance title | Should be set to 'What is this?' |
| Guidance text | A simple description in plain English of what the indicator is |
You can then create accordion sections to start adding your main release commentary. These sections are made up of text blocks and data blocks which can be reordered as needed.
Any data tables should be included as data blocks, however you can also embed static html tables within a text box. These should only be used to present textual tables or for any small presentations of data that are not possible to do in a data block at the moment.
You can create static html tables for presenting information that isn't embedded in a datablock. However, remember that *all of the data* included or referred to in your content should be available (or createable) from the downloadable underlying data files.
---
# Signing off a release
---
Once you’re happy with your release you need to go to the sign off page and change it’s status in order to move it through the release pipeline.
There are three statuses:
1. **In draft** (where the production team work on drafting the release)
2. **Ready for higher review** (where the senior statistician checks over the release before approving)
3. **Approved for publication** (after approval has been given, releases in this status will be published on their scheduled date)
<div class="alert alert-dismissible alert-warning">
Only users with ‘responsible statistician’ permissions (usually G6 or above) can sign off the release for publication.
</div>
---
## Release checklist
---
There's quite a few things to remember to do as you build your release so to help ensure you haven't missed anything a release checklist is also available via the sign off page
The checklist can be accessed by clicking to edit release status.
Remember to check over it before you submit your release for approval as a release that has outstanding warnings on it will not be able to be published.
`r knitr::include_graphics("images/ees-release-checklist.PNG")`
---
## How to approve a release
---
Releases are approved via the sign off tab. The release date is also set during this stage of the process. All releases scheduled for a specific date will be published at 9:30am on that day.
`r knitr::include_graphics("images/ees-approving-release.PNG")`
The approver has the ability to approve the release to be published on a specific date or to publish as soon as possible. Publishing as soon as possible is useful for publishing amendments to existing releases.
<div class="alert alert-dismissible alert-info">
This page also gives you the expected release url which may be useful to know for other things, for example, sending to the webteam to add to your gov.uk announcement page.
</div>
---
# Pre-release
---
Prior to each release going live the production team are also able to grant pre-release access to a named group of users 24 hours before it goes live. These users do not require full access to the whole admin service. They will be able to see preview versions of any releases they have been granted access to.
This preview is only accessible for the 24 hours before the publication date, the emails may go out to users before then. We expect teams will continue to send an email at 09:30 on pre-release day, including any additional briefing and the link to the pre-release area.
<div class="alert alert-dismissible alert-info">
Jobshare emails should not be sent invites for pre-release. The personal emails for the specific individuals should be used instead, as jobshare emails do not have active accounts with DfE to access EES.
</div>
<div class="alert alert-dismissible alert-danger">
Pre-release access via Explore Education Statistics is currently limited to DFE users only, if you need to share your release with external users you will need to do so outside of the system.
</div>
---
## Overview
---
<html>
<centre>
<head>
<title>EES PRA one pager</title>
<meta charset="utf-8"/>
</head>
<body><div class="mxgraph" style="max-width:100%;" data-mxgraph="{"highlight":"#0000ff","lightbox":false,"nav":true,"edit":"_blank","xml":"<mxfile host=\"app.diagrams.net\" modified=\"2020-10-20T16:01:02.280Z\" agent=\"5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.75 Safari/537.36\" etag=\"u54yy4Q2arZoT8qL_QMa\" version=\"13.8.1\" type=\"google\"><diagram id=\"GmQ-00HEmiX2ExrvTGiP\" name=\"Page-1\">7Vpbd9o4EP4t+8DpExzfMPBICDQ9J7ubDelu+7RH2AJrY1uuLHPpr98ZWb5hJyRtaNPTkpBIo4tHM59mRiP37Fm0fytIEvzOfRr2LMPf9+zLnmWZjmX18NfwDzll5GrCRjA/JxkVYck+Uz2yoGbMp6mm5STJeShZ0iR6PI6pJxs0IgTfNbuteeg3CAnZ0AYbSFh6JKStbv8wXwaaarqTquGKsk2gHz22RnnDinj3G8GzWD8v5jHNWyJSTKMfmQbE57sayZ737JngXOalaD+jIYq1KbHFA60ly4LG8ikD/r76wO3UCT+Nb4x/d+/+8m5ur/p6GVsSZloUPcsNYb6LNCExci0PWkjupwxZvdgFTNI+NHtAn0KXmIuIhFUHKG3w/43gfuZJxnEeSUmEzMRbGA2FA8+UkvFPgIRE0L6gISUp1ojn0TRVeOFZUvAEi8vZyh+g5VpyaClFUFyvWTC6zPm83AFwgRbIKNTNaxaGMx5yAXWlNiDxWGpwmg7UScg2MVQ8EDEVuVA8Fm+wfYhVKfg9LSbpWfZCffRMNfpsjD8ly3WlaT1uqZB0XyNpJb6lPKJSHKCLbh0O8xGHYvOZA03ZVdAtd1ZQR62mEb1bNuXcFWygoJHzDBSNz4iijzx7ozjYUIm843Q0IixUC4b1Ag2+IYvvkRJQQeuY2jK6g1KFLE/NsKpABnj5Ba8KXrY1fnX4mjyIr1WhrPmHm+s/b+fQa375fja9e/fnH1Be3kFpefdutqzpePWggkFEsqnFlopQkAwcx1Q3RMz3cfiFoCn7TFZqKgPqCWexVIIYXvSGlzhXJnmq1d9Eg+UUdc2L0aFj9XkZHVuThoptu0PDjtWhYftcGi7g1KFilEOnCcGGfi5QNCC2mew7nNDtvH87v55Pl4iN6Ww2X9axkE/+yuBgm0dwMNtwGBv480Jb3mjAwe2Cgz3qgINzNjiYLThc8V0RMJTBQTNmSCWRLAV1pNo1MLT0830CQsP2OUQjRIcjy1pfl0Rou+NVmuTAOaqfREWHqS+AEtK1fAwmXU6kcjNGr+00zmn6R03Lbxhtq+B2wMAangsGVgsG79MMowRw6OAdmYouUd0kSUJcSR++PFbFhPIkpComQNAEZEuV46dxGYf6BaKqQCEPHCpQ7ZhiM48XVmq+JgbzAXn48TVIOW1SnocV+8xYMd2mD3HbNsMcT9pgmZwNLHYLLHcPRoENtW4hmtS6XYOsLAP8MTDNM5H+VDo1bauh06FttnXqjNo6NQ3zXEp1Tod+tzSi0Qrk3BniKZNwFzDcq+oPUXqX+C+lYstA9NYMF6lwQUMPWO+pAypCYU2pj4f8334iP+CaDRiMbKcrPrTHHZ7gbAHBsIWDhdqqAQ2TXH8eCIRgbgiDwWbwWGAhp2XHBIRCIOi6EV3iERMsvT2leQAxqIUXjkGLWGKw4dtBdt8OPJ86rIAsOeYKaC1Onx+xfkPrdGZUDpuHltGwC5W243xLVLod1ulIJdTf0CKO50IGfMNjEs4r6pFEqz7XnCdai/9RKQ9aznhuONLxkRK8TGzLNMULJhFSMIkefUQe2jVIIjBZczJfhKJ5VPPgr2G3bJtJ2pfXYlcS9NlabAj9xVUKqhCHD7pRVT7i5INhUb3c64fltUNR2zNZDoNybRTUqkFYKcZ8S8SMn4gYc/LSkFFDp0KQQ62DPqVXM98goWaDRk7ziDS26vA72d/W66jgmnNQgbdcylfguSsd+8rw/C0xVmDnJMiKGV+LXXo47fn1afUpotSYQCfM/hgqKdJMp/hqZ+THW4ytqAJ2eXDSYfKbEOTwJo/ASOz3ipudPM1enpJJ4xwGTj/N8zB83T5z/0rGP3TXY43HXZH42G7HPO65Yh6rK1P7E1uX8r76pHWxXpV1sdop1i+2LsqsHBmY92l1D5cJZKcrb5bAUtcwiT6n57YjUpZnledueJTUEnUpblJM3xU2qzimM5GieZIs+mVBHrEgztj6/hakndU9r19LvQAO3qFCUbd/604MJtkqZGmgxpW+7c2JfDBDBraMdNwr5Gkr0XGob+L0laQu+mXPfjXBQOfMzpTA+Bn3pOt03r927cmz3bBb7eR5SzdpQBIsski9TVXXxHEGSaLjLqnXZEXDG54ydflmX664lDyCDiE2XJSvUNXEvVYf6KIeNk2T/K0vjA9IUVmzPSLlQvNzGUiJr4tNURLWwvNjZ8AgcF0zQJQYQLwKVJ9g4neBdNisCwhIw76q9DMAdp8hStaIN2vhwtFtEXLvvm9a40GCmHkO4nTG97sAzHSb73DYw47LmSKl2kjkm+e6nbG6Evk/OsCMkwBbUwIeBkz+YuLimB8TT2VWtbgYGjotPI3cNpwK2suj6QmJ12e5ku8iVucopW0VV5g1sY478tnDs4m1fcvy429S++QmDVlMlQ9YC0r7W5iXC+0VADAQ4yzwYnSBYdWX7d0q+ngNMDMnkzbMOi7zCtozYAbV6oXmPJ9ZvTBuz/8H</diagram></mxfile>"}"></div>
<script type="text/javascript" src="https://viewer.diagrams.net/js/viewer-static.min.js"></script>
</body>
</centre>
</html>
---
## Walkthrough
---
Inviting users for pre-release access and building the public pre-release list can be found within the ‘Pre-release access’ tab on the dashboard.
Once the release has been marked as approved, go to the ‘Pre-release access’ tab and add the relevant email addresses to grant pre-release access. All invited users will receive an email to say that they have been given pre-release access and will get a url where the preview release will be available.
`r knitr::include_graphics("images/EES-invite-pra.PNG")`
You should also create the public facing pre-release access page by clicking the ‘Public access list’ tab.
`r knitr::include_graphics("images/EES-public-pra-list.PNG")`
After creating your pre-release access list a text editor will appear where you can list the roles that have been given early access to the release. This list will then appear in the list of file downloads at the top of each release.
`r knitr::include_graphics("images/EES-create-public-pra-list.PNG")`
---
# Methodology
---
Methodologies work in a very similar way to the written content of a release, the text editor and static tables you can use are built on the same foundations.
On the production environment, teams need to request a blank methodology to be created for them, please contact the [Explore Statistics Mailbox](mailto:[email protected]) to arrange this.
Once the drafting has finished, a methodology should be set as 'approved for publication'. After this has happened, it will then appear in the drop down menu to attach to a publication. The methodology will then be published to the public side of the platform with the next release.
On the test environment, teams can test creating methodologies themselves by going into the 'manage methodologies' page that is accessible from the main admin dashboard.
---
# Amending a release
---
If you need to make an amendment to release that has already been published this is now possible to do from within the admin dashboard:
`r knitr::include_graphics("images/EES-amend-release.PNG")`
Creating an amendment of a release will create a new version for which you can make any changes and then choose to republish, either as soon as possible or on a given date.
---
## Release notes
---
When publishing a new amendment you should add a 'release note' to your release so users can be informed of what has changed:
`r knitr::include_graphics("images/EES-release-note.PNG")`