This repository has been archived by the owner on Oct 6, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathees.html
1449 lines (1345 loc) · 72.9 KB
/
ees.html
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
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta http-equiv="X-UA-Compatible" content="IE=EDGE" />
<title>Using Explore Education Statistics</title>
<script src="site_libs/jquery-3.6.0/jquery-3.6.0.min.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link href="site_libs/bootstrap-3.3.5/css/bootstrap.min.css" rel="stylesheet" />
<script src="site_libs/bootstrap-3.3.5/js/bootstrap.min.js"></script>
<script src="site_libs/bootstrap-3.3.5/shim/html5shiv.min.js"></script>
<script src="site_libs/bootstrap-3.3.5/shim/respond.min.js"></script>
<style>h1 {font-size: 34px;}
h1.title {font-size: 38px;}
h2 {font-size: 30px;}
h3 {font-size: 24px;}
h4 {font-size: 18px;}
h5 {font-size: 16px;}
h6 {font-size: 12px;}
code {color: inherit; background-color: rgba(0, 0, 0, 0.04);}
pre:not([class]) { background-color: white }</style>
<script src="site_libs/jqueryui-1.11.4/jquery-ui.min.js"></script>
<link href="site_libs/tocify-1.9.1/jquery.tocify.css" rel="stylesheet" />
<script src="site_libs/tocify-1.9.1/jquery.tocify.js"></script>
<script src="site_libs/navigation-1.1/tabsets.js"></script>
<link href="site_libs/highlightjs-9.12.0/default.css" rel="stylesheet" />
<script src="site_libs/highlightjs-9.12.0/highlight.js"></script>
<link href="site_libs/font-awesome-5.1.0/css/all.css" rel="stylesheet" />
<link href="site_libs/font-awesome-5.1.0/css/v4-shims.css" rel="stylesheet" />
<link rel="shortcut icon" href="images/duck_guidance.png"/>
<script>
// Define dataLayer and the gtag function.
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
// Default ad_storage to 'denied' as a placeholder
// Determine actual values based on your own requirements
gtag('consent', 'default', {
'ad_storage': 'denied',
'analytics_storage': 'granted'
});
</script>
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-KBJCBD114T"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
/*
The tracking number below MUST be replaced with a unique number, contact the statistics development team to set this up.
*/
gtag('config', 'G-KBJCBD114T');
</script>
<style type="text/css">
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
span.underline{text-decoration: underline;}
div.column{display: inline-block; vertical-align: top; width: 50%;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list{list-style: none;}
</style>
<style type="text/css">code{white-space: pre;}</style>
<script type="text/javascript">
if (window.hljs) {
hljs.configure({languages: []});
hljs.initHighlightingOnLoad();
if (document.readyState && document.readyState === "complete") {
window.setTimeout(function() { hljs.initHighlighting(); }, 0);
}
}
</script>
<link rel="stylesheet" href="images/acalat_theme.css" type="text/css" />
<style type = "text/css">
.main-container {
max-width: 940px;
margin-left: auto;
margin-right: auto;
}
img {
max-width:100%;
}
.tabbed-pane {
padding-top: 12px;
}
.html-widget {
margin-bottom: 20px;
}
button.code-folding-btn:focus {
outline: none;
}
summary {
display: list-item;
}
details > summary > p:only-child {
display: inline;
}
pre code {
padding: 0;
}
</style>
<style type="text/css">
.dropdown-submenu {
position: relative;
}
.dropdown-submenu>.dropdown-menu {
top: 0;
left: 100%;
margin-top: -6px;
margin-left: -1px;
border-radius: 0 6px 6px 6px;
}
.dropdown-submenu:hover>.dropdown-menu {
display: block;
}
.dropdown-submenu>a:after {
display: block;
content: " ";
float: right;
width: 0;
height: 0;
border-color: transparent;
border-style: solid;
border-width: 5px 0 5px 5px;
border-left-color: #cccccc;
margin-top: 5px;
margin-right: -10px;
}
.dropdown-submenu:hover>a:after {
border-left-color: #adb5bd;
}
.dropdown-submenu.pull-left {
float: none;
}
.dropdown-submenu.pull-left>.dropdown-menu {
left: -100%;
margin-left: 10px;
border-radius: 6px 0 6px 6px;
}
</style>
<script type="text/javascript">
// manage active state of menu based on current page
$(document).ready(function () {
// active menu anchor
href = window.location.pathname
href = href.substr(href.lastIndexOf('/') + 1)
if (href === "")
href = "index.html";
var menuAnchor = $('a[href="' + href + '"]');
// mark the anchor link active (and if it's in a dropdown, also mark that active)
var dropdown = menuAnchor.closest('li.dropdown');
if (window.bootstrap) { // Bootstrap 4+
menuAnchor.addClass('active');
dropdown.find('> .dropdown-toggle').addClass('active');
} else { // Bootstrap 3
menuAnchor.parent().addClass('active');
dropdown.addClass('active');
}
// Navbar adjustments
var navHeight = $(".navbar").first().height() + 15;
var style = document.createElement('style');
var pt = "padding-top: " + navHeight + "px; ";
var mt = "margin-top: -" + navHeight + "px; ";
var css = "";
// offset scroll position for anchor links (for fixed navbar)
for (var i = 1; i <= 6; i++) {
css += ".section h" + i + "{ " + pt + mt + "}\n";
}
style.innerHTML = "body {" + pt + "padding-bottom: 40px; }\n" + css;
document.head.appendChild(style);
});
</script>
<!-- tabsets -->
<style type="text/css">
.tabset-dropdown > .nav-tabs {
display: inline-table;
max-height: 500px;
min-height: 44px;
overflow-y: auto;
border: 1px solid #ddd;
border-radius: 4px;
}
.tabset-dropdown > .nav-tabs > li.active:before {
content: "";
font-family: 'Glyphicons Halflings';
display: inline-block;
padding: 10px;
border-right: 1px solid #ddd;
}
.tabset-dropdown > .nav-tabs.nav-tabs-open > li.active:before {
content: "";
border: none;
}
.tabset-dropdown > .nav-tabs.nav-tabs-open:before {
content: "";
font-family: 'Glyphicons Halflings';
display: inline-block;
padding: 10px;
border-right: 1px solid #ddd;
}
.tabset-dropdown > .nav-tabs > li.active {
display: block;
}
.tabset-dropdown > .nav-tabs > li > a,
.tabset-dropdown > .nav-tabs > li > a:focus,
.tabset-dropdown > .nav-tabs > li > a:hover {
border: none;
display: inline-block;
border-radius: 4px;
background-color: transparent;
}
.tabset-dropdown > .nav-tabs.nav-tabs-open > li {
display: block;
float: none;
}
.tabset-dropdown > .nav-tabs > li {
display: none;
}
</style>
<!-- code folding -->
<style type="text/css">
#TOC {
margin: 25px 0px 20px 0px;
}
@media (max-width: 768px) {
#TOC {
position: relative;
width: 100%;
}
}
@media print {
.toc-content {
/* see https://github.com/w3c/csswg-drafts/issues/4434 */
float: right;
}
}
.toc-content {
padding-left: 30px;
padding-right: 40px;
}
div.main-container {
max-width: 1200px;
}
div.tocify {
width: 20%;
max-width: 260px;
max-height: 85%;
}
@media (min-width: 768px) and (max-width: 991px) {
div.tocify {
width: 25%;
}
}
@media (max-width: 767px) {
div.tocify {
width: 100%;
max-width: none;
}
}
.tocify ul, .tocify li {
line-height: 20px;
}
.tocify-subheader .tocify-item {
font-size: 0.90em;
}
.tocify .list-group-item {
border-radius: 0px;
}
</style>
</head>
<body>
<div class="container-fluid main-container">
<!-- setup 3col/9col grid for toc_float and main content -->
<div class="row">
<div class="col-xs-12 col-sm-4 col-md-3">
<div id="TOC" class="tocify">
</div>
</div>
<div class="toc-content col-xs-12 col-sm-8 col-md-9">
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-bs-toggle="collapse" data-target="#navbar" data-bs-target="#navbar">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">Statistics Production Guidance</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
Learning and development
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="l+d.html">General resources</a>
</li>
<li>
<a href="sql.html">SQL</a>
</li>
<li>
<a href="r.html">R</a>
</li>
<li>
<a href="git.html">Git</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
Creating statistics
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="rap.html">Processes and RAP</a>
</li>
<li>
<a href="rap_managers.html">RAP for managers</a>
</li>
<li>
<a href="ud.html">Open data standards</a>
</li>
<li>
<a href="cd.html">Writing and visualising</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
Publishing statistics
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="pub.html">How to publish</a>
</li>
<li>
<a href="ees.html">Using EES</a>
</li>
<li>
<a href="examples.html">EES examples</a>
</li>
<li>
<a href="dashboards.html">Dashboards</a>
</li>
<li>
<a href="embedded-charts.html">Embedded R-Shiny charts</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
Understanding users
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="user_eng.html">User engagement</a>
</li>
<li>
<a href="user_an.html">EES analytics</a>
</li>
</ul>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="mailto:[email protected]">
<span class="fa fa-envelope"></span>
</a>
</li>
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
<div id="header">
<h1 class="title toc-ignore">Using Explore Education Statistics</h1>
</div>
<p class="text-muted">
Guidance for how to use the features in the Explore Education Statistics platform
</p>
<hr />
<p>Explore Education Statistics (EES) is the Department’s official statistics dissemination platform, designed to make DFE’s published statistics and data easier to find, access, use and understand.</p>
<p><strong>The EES platform consists of two applications:</strong></p>
<ol style="list-style-type: decimal">
<li><p>The <a href="https://explore-education-statistics.service.gov.uk/">public</a> website, where users access stats</p></li>
<li><p>The <a href="https://admin.explore-education-statistics.service.gov.uk/">admin</a> website, where production teams create their stats</p></li>
</ol>
<div class="alert alert-dismissible alert-info">
<p>The majority of the admin side of EES is only supported in Google Chrome and Microsoft Edge and will not work correctly in Internet Explorer. The public website and pre-release previews of releases in admin can be viewed using Internet Explorer, though we still recommend that people use Chrome or Edge instead.</p>
</div>
<p>Both applications were released to Minimal Viable Product (MVP) standard in March 2020, we will be iterating and improving the functionality based on user feedback throughout 2020 and 2021.</p>
<p>Maintenance and use of the platform is supported by the <a href="mailto:[email protected]">Statistics Development Team</a>.</p>
<hr />
<div id="accessing-ees" class="section level1">
<h1>Accessing EES</h1>
<hr />
<div id="environments" class="section level2">
<h2>Environments</h2>
<hr />
<p>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:</p>
<ul>
<li><p><strong>Development</strong> - Green - where changes are first merged in, and often the first time different pieces of work from different developers will interact properly</p></li>
<li><p><strong>Test</strong> - Pink - where our developers can carry out manual testing of any new features to make sure things work as expected</p></li>
<li><p><strong>Pre-production</strong> - Yellow - a sandbox area for analysts to carry out functionality testing</p>
<p>Admin pre-production - <a href="https://admin.pre-production.explore-education-statistics.service.gov.uk" class="uri">https://admin.pre-production.explore-education-statistics.service.gov.uk</a></p>
<p>Public pre-production - <a href="https://pre-production.explore-education-statistics.service.gov.uk" class="uri">https://pre-production.explore-education-statistics.service.gov.uk</a></p></li>
<li><p><strong>Production</strong> - Red - the real service, anyone creating real releases that they intend to publish to the public should be using this environment</p>
<p>Admin - <a href="https://admin.explore-education-statistics.service.gov.uk" class="uri">https://admin.explore-education-statistics.service.gov.uk</a></p>
<p>Public - <a href="https://explore-education-statistics.service.gov.uk" class="uri">https://explore-education-statistics.service.gov.uk</a></p></li>
</ul>
<p>There is no overlap between the environments and content created on one cannot be moved to any other.</p>
<div class="alert alert-dismissible alert-danger">
<p>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.</p>
</div>
<p>Teams can use the pre-production environment to familiarise themselves with the platform and test out what is possible. The core functionality across the environments is identical except for new changes, which are deployed through the different environments before they make it to production.</p>
<p>On the pre-production environment, all analysts have full permissions to create publications and releases, and can see everything else that other analysts are making. This is unique to the pre-production environment, on the production environment analysts will only have access to releases that they have been granted specific access to.</p>
<p>When accessing the pre-production environment you may be asked for a username and password, these are as follows: dfe, dataresearch.</p>
<div class="alert alert-dismissible alert-danger">
<p>The pre-production environment is not suitable for unpublished data. Unpublished data should only be uploaded to the production environment.</p>
</div>
<div id="getting-access-to-admin" class="section level3">
<h3>Getting access to admin</h3>
<p>Access to the production and pre-production admin services 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.</p>
<p>To be invited to the service for full access teams need to email the <a href="mailto:[email protected]">Explore Statistics Mailbox</a>, stating who needs access, what permissions they require (analyst or approver), and for which publications these apply. 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.</p>
<div class="alert alert-dismissible alert-info">
<p>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.</p>
</div>
<hr />
</div>
</div>
<div id="roles-and-permissions" class="section level2">
<h2>Roles and permissions</h2>
<hr />
<!-- need to include methodologies in this section? -->
<p>The Statistics Development Team are responsible for setting up and maintaining user permissions during the beta phase. Change requests will be monitored via their main mailbox - <a href="mailto:[email protected]" class="email">[email protected]</a>.</p>
<p>The following roles exist within EES admin and are assigned to a specific release:</p>
<ul>
<li><p><strong>Pre-release</strong></p>
<p>Any user invited for pre-release is given a pre-release user role. During the hours of pre-release they can:</p>
<ul>
<li>Preview the release page, including downloading files</li>
<li>Preview the table tool page for that release</li>
</ul></li>
</ul>
<p><br></p>
<ul>
<li><p><strong>Analyst - contributor</strong></p>
<p>Any analyst working on a release within EES admin will have the contributor role. They can:</p>
<ul>
<li>Edit release details</li>
<li>Upload data and other files</li>
<li>Create footnotes, datablocks and charts</li>
<li>Edit and comment on release content</li>
<li>Invite PRA users</li>
<li>Move the release status between draft and ready for higher review</li>
</ul></li>
</ul>
<p><br></p>
<ul>
<li><p><strong>Analyst - approver</strong></p>
<p>The responsible statistician for a statistics release will have the approver role, allowing them to sign off releases for publication. This will usually be the responsible G5 or G6 for the statistics publication. They can do everything a contributor can, as well as:</p>
<ul>
<li>Move the release status between draft, ready for review and approved</li>
<li>Schedule the release for publication (either immediately or for a specific date)</li>
</ul></li>
</ul>
<p><br></p>
<p>There is also a publication owner role, which is assigned at publication level to a users account:</p>
<ul>
<li><p><strong>Publication owner</strong></p>
<p>This permissions level gives publication owners control over their publications. They can do anything a contributor can for all releases within the publication. On top of this the publication owner also has access to:</p>
<ul>
<li>Manage publication level details</li>
<li>Create new releases within a publication</li>
<li>Create an amendment of the latest published release within a publication</li>
<li>Cancel an amendment before it is published</li>
</ul></li>
</ul>
<p><br></p>
<ul>
<li><p><strong>BAU</strong></p>
<p>The administrative role:</p>
<ul>
<li>This role is assigned to a user and gives full access including administrative tools, typically only used by the Statistics Development Team and EES developers.</li>
</ul></li>
</ul>
<p>See below for a diagram of the responsibilities of each role as part of the publication process in EES:</p>
<p><img src="images/EES_roles.svg" style="display: block; margin: auto;" /></p>
<hr />
</div>
<div id="requesting-a-new-publication" class="section level2">
<h2>Requesting a new publication</h2>
<hr />
<p>If you have not published on EES before, or if you’re creating a brand new publication, you will need to contact us to create the publication for you before you can get started.</p>
<p>The hierarchy of content within EES is as follows -</p>
<p><img src="images/ees-hierarchy.PNG" style="display: block; margin: auto;" /></p>
<p>Publications are organised into topics and themes (as shown on the EES <a href="https://explore-education-statistics.service.gov.uk/find-statistics">Find Statistics page</a>), and then within each publication there are releases - where the latest release includes the latest statistics for that publication. For example:</p>
<table>
<thead>
<tr class="header">
<th align="left">Level</th>
<th align="left">Example</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td align="left">Theme</td>
<td align="left">Pupils and Schools</td>
</tr>
<tr class="even">
<td align="left">Topic</td>
<td align="left">Pupil absence</td>
</tr>
<tr class="odd">
<td align="left">Publication</td>
<td align="left">Pupil absence in schools in England</td>
</tr>
<tr class="even">
<td align="left">Release</td>
<td align="left">2018/19</td>
</tr>
</tbody>
</table>
<p>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 should also be provided.</p>
<p>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.</p>
<p>If you want to request a new publication, please be prepared to give the following:</p>
<ul>
<li>The heading and subheading that you want the publication to sit under in our site (take a look at the current structure <a href="https://explore-education-statistics.service.gov.uk/find-statistics" target="_blank" rel="noopener noreferrer">here</a>), feel free to either use existing ones, or suggest new ones</li>
<li>The exact title of the publication</li>
<li>A summary of less than 160 characters (including spaces) that describes your publication series</li>
<li>If the methodology already exists elsewhere and you have a URL for it, or if you want to <a href="#Methodology">create one</a></li>
<li>Team name</li>
<li>Team email address</li>
<li>Lead statistician name</li>
<li>Lead statistician contact number</li>
<li>The <a href="ud.html#List_of_allowable_time_values">time period</a> of the release you’re creating</li>
<li>Whether they are National statistics, an ad-hoc publication, or official statistics</li>
<li>List of email addresses of analysts who need access to the release and at what <a href="#Roles_and_permissions">permission levels</a></li>
</ul>
<p>Publication details can be <a href="#Publication_management">managed by publication owners</a> or via requests to the <a href="mailto:[email protected]">Explore Statistics Mailbox</a>.</p>
<hr />
</div>
<div id="admin-dashboard" class="section level2">
<h2>Admin dashboard</h2>
<hr />
<div class="alert alert-dismissible alert-warning">
<p>Use Google Chrome or Microsoft Edge to access and use the admin part of Explore Education Statistics.</p>
</div>
<p>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.</p>
<p>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 - <a href="mailto:[email protected]" class="email">[email protected]</a>.</p>
<p><img src="images/EES-admin-dashboard.PNG" /><!-- --></p>
<p>Within this dashboard you can view and manage existing publications, including creating and editing their releases. You can use the drop down lists to find releases by theme/topic/publication or use the draft and scheduled releases tabs to see releases that are in progress.</p>
<hr />
</div>
<div id="external-user-access" class="section level2">
<h2>External user access</h2>
<hr />
<p>Access to EES for users outside of DfE is difficult as the authentication and security on the service relies on the DfE Azure Active Directory and associated infrastructure. It is possible to request that external users from other government organisations have access, and they can then be added as collaborating analysts on a release or as pre-release viewers.</p>
<p>If you have external users you’d like to request access for, please send the following to <a href="mailto:[email protected]" class="email">[email protected]</a>, <em>at least two weeks</em> in advance of requiring access. Due to the dependency on DfE’s digital security we cannot guarantee access or how long it may take.</p>
<ul>
<li>Email addresses of users to be added</li>
<li>Reason for access</li>
<li>Length of time access is needed</li>
</ul>
<hr />
</div>
</div>
<div id="creating-releases" class="section level1">
<h1>Creating releases</h1>
<hr />
<p>New releases can be <a href="#Create_new_release">created by publication owners</a> or via requests to the <a href="mailto:[email protected]">Explore Statistics Mailbox</a>. If you’re requesting a new release via the mailbox, please give the following:</p>
<ul>
<li>Name of the publication (including theme and topic that it sits under)</li>
<li>Time period for the release</li>
<li><a href="ud.html#List_of_allowable_time_values">Time identifier</a> for the release</li>
<li>Type of release (National, Official, Ad-hoc etc)</li>
</ul>
<p>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:</p>
<ol style="list-style-type: decimal">
<li><p>Data and files (uploading data files, ancillary files and creating data guidance)</p></li>
<li><p>Footnotes (creating footnotes and assigning to relevant data)</p></li>
<li><p>Data blocks (creating summary tables, charts and key stats indicators)</p></li>
<li><p>Content (drafting release content)</p></li>
<li><p>Sign off (moving through the approval process)</p></li>
<li><p>Pre-release access (invite users to pre-release and create public pre-release list)</p></li>
</ol>
<p><img src="images/EES-create-release-dashboard.PNG" /><!-- --></p>
<hr />
<div id="data-and-files" class="section level2">
<h2>Data and files</h2>
<hr />
<p>Here you will update your data files and accompanying metadata. You need to make sure that the data has passed through our <a href="https://rsconnect/rsc/dfe-published-data-qa/">data screener checks</a> before trying to upload it.</p>
<div class="alert alert-dismissible alert-info">
<p>All data files are accessible in the downloadable files for users to explore in the same format as they are uploaded.</p>
</div>
<hr />
<div id="subject-titles" class="section level3">
<h3>Subject titles</h3>
<hr />
<p>You’ll need to give a ‘subject title’ 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 and data guidance can include more technical / coverage information.</p>
<p>When adding a subject name think about the general user and how the subjects will appear in the service:</p>
<ul>
<li><p>You don’t need to include the publication name in the subject name as this is always already implied within EES</p></li>
<li><p>You don’t need to list what filters are in each file in the title, users can see this in the data guidance</p></li>
<li><p>You don’t need to include the date ranges covered in each file in the title, users can see this in the data guidance</p></li>
<li><p>Your subject names should be short and snappy, clearly explain what is in each file. Some good examples of this in practice are included below:</p>
<ul>
<li>Early years provision by provider type</li>
<li>Exclusions and suspensions by pupil characteristics</li>
<li>ITT new entrants by subject and training route</li>
</ul></li>
</ul>
<p>You can make changes the subject title for your data file after it has been uploaded if needed using the ‘Edit title’ option.</p>
<hr />
</div>
<div id="uploading-files" class="section level3">
<h3>Uploading files</h3>
<hr />
<p>When uploading files you have a choice between uploading as separate CSV files or as a combined ZIP file.</p>
<p>For data files greater than 80mb we recommend uploading as a ZIP file.</p>
<p>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:</p>
<ul>
<li>Queued</li>
<li>Validating</li>
<li>Importing</li>
<li>Complete</li>
</ul>
<p>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’.</p>
<div class="alert alert-dismissible alert-warning">
<p>If you believe your file is ‘stuck’ please contact <a href="mailto:[email protected]" class="email">[email protected]</a>, with details of the file and the release that you are uploading to.</p>
</div>
<hr />
</div>
<div id="ordering-filters-and-indicators" class="section level3">
<h3>Ordering filters and indicators</h3>
<hr />
<p>To save time when creating tables and charts, and to aid users who view your data themselves via the table tool, you can now save custom orders for your filters and indicators. You can do this in the data and files page after uploading underlying data files, via the ‘reorder filters and indicators’ tab. Once there just choose which file you want to reorder and then click and drag the items until they’re in the order you want them to show in the table tool. This then becomes the default order for this filter or indicator and will apply in all charts and tables automatically.</p>
<p><img src="images/order-filters-indicators.png" /><!-- --></p>
<hr />
</div>
<div id="ancillary-file-uploads" class="section level3">
<h3>Ancillary file uploads</h3>
<hr />
<p>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 <a href="https://www.gov.uk/guidance/publishing-accessible-documents">accesibility regulations</a> before they can be published.</p>
<p>Examples of ancillary files may be:</p>
<ul>
<li>Infographic pages</li>
<li>Supplementary data that isn’t intended for the table tool</li>
<li>Additional technical documentation</li>
</ul>
<p>For ensuring that spreadsheets are accessible see the guidance from <a href="https://gov.wales/how-create-accessible-excel-spreadsheets">.gov.wales</a>, and this <a href="https://gss.civilservice.gov.uk/blog/accessibility-empathy-for-users-of-spreadsheets/">blog post</a> that walks you through some ways that you can recreate the experience of using spreadsheets.</p>
<div class="alert alert-dismissible alert-info">
<p>Any data files that only consist of Planning area, and/or Institution level data should be uploaded as an ancillary file, rather than as a data file.</p>
</div>
<hr />
</div>
<div id="public-data-guidance" class="section level3">
<h3>Public data guidance</h3>
<hr />
<p>Here you should also create your <a href="https://explore-education-statistics.service.gov.uk/find-statistics/permanent-and-fixed-period-exclusions-in-england/meta-guidance">public data guidance</a> 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.</p>
<p><img src="images/admin-public-meta-start.PNG" /><!-- --></p>
<p>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.</p>
<p>A list of variables in each file with an associated label (taken from metadata uploads) and associated footnotes will also be displayed for each file.</p>
<p><img src="images/admin-public-meta-detail.PNG" /><!-- --></p>
<div class="alert alert-dismissible alert-danger">
<p>Releases cannot be published without a completed metadata document. If not filled in an error will be flagged during sign off.</p>
</div>
<hr />
</div>
<div id="replacing-data" class="section level3">
<h3>Replacing data</h3>
<hr />
<p>If you just need to change the subject title for your data file you do not need to go through the whole replacement process, just click the ‘Edit title’ option.</p>
<p>However, if you notice a mistake in your data file you can replace it with another. When replacing a data file the platform will attempt to recreate any data blocks and footnotes that were built using the previous file.</p>
<div class="alert alert-dismissible alert-warning">
<p>The replacement file must contain the exact same column names and types as the original. For example, a character column named “date” must also be replaced with a character column named “date”. A numeric column named “date” will not work in the replacement.</p>
</div>
<p><img src="images/replace-data-start.png" /><!-- --></p>
<p>The first step is to upload the new file.</p>
<p><img src="images/replace-data-step1.PNG" /><!-- --></p>
<p>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.</p>
<p><img src="images/replace-data-step2.PNG" /><!-- --></p>
<p>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.</p>
<p><img src="images/replace-data-success.PNG" /><!-- --></p>
<p>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.</p>
<p><img src="images/replace-data-fail.PNG" /><!-- --></p>
<div class="alert alert-dismissible alert-danger">
<p>Remember to double check any data blocks or footnotes that were recreated by the platform before publishing your release.</p>
</div>
<hr />
</div>
</div>
<div id="footnotes" class="section level2">
<h2>Footnotes</h2>
<hr />
<p>Footnotes are added via footnotes tab - 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 “Headcount” indicator for all options within the “School type” filter.</p>
<p><img src="images/footnote_example.PNG" /><!-- --></p>
<p>If you’d rather, you can assign a footnote to the whole data file by ticking this box.</p>
<p><img src="images/All_indicators.PNG" /><!-- --></p>
<p>You can assign the same footnote across multiple data files.</p>
<div class="alert alert-dismissible alert-danger">
<p>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.</p>
</div>
<hr />
</div>
<div id="data-blocks-tables-and-charts" class="section level2">
<h2>Data blocks (tables and charts)</h2>
<hr />
<p>A data block is a smaller cut of data from your original file that you can embed into your publication as a presentation table, build charts from, or link users directly to.</p>
<hr />
<div id="tables" class="section level3">
<h3>Tables</h3>
<hr />
<p>Here you can create data blocks, using the admin table tool to create and save your summary tables. Remember to use the reorder table headers tool to restructure your table however you want it before you save.</p>
<p>Once you’re happy with your table, give it a title and some source information before clicking save. The source should be the source of the data used to create the data file that was then used for the data block table, for example ‘School Census’.</p>
<p>The manage data blocks page will list all the data blocks you have created, highlighting which have charts, are used in content and are saved as highlight tables.</p>
<p><img src="images/ees-manage-data-blocks.PNG" /><!-- --></p>
<hr />
<div id="featured-tables" class="section level4">
<h4>Featured tables</h4>
<hr />
<p>You can also choose to highlight a data block table as a ‘featured table’ which means it will show in a list of featured tables within the table tool. This is designed to help users get to tables of interest more quickly (without having to create tables themselves).</p>
<p>There is an option to choose if a table is a ‘featured table’ when saving each data block, here you can name the table and add a description giving the table coverage:</p>
<p><img src="images/EES-create-release-table-highlight.PNG" /><!-- --></p>
<p>Each featured table will then be listed to the user within the table tool. Featured tables do not have to be embedded within your release content to be included in this list.</p>
<p><img src="images/EES-table-tool-highlights.PNG" /><!-- --></p>
<hr />
</div>
<div id="fast-track-links" class="section level4">
<h4>Fast track links</h4>
<hr />
<p>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:</p>
<p><img src="images/EES-create-release-fasttrack-url.PNG" /><!-- --></p>
<p>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).</p>
<p>In your fast-track titles, you don’t want to overload information, but still want to direct the user to the right place. Remember they can go back to the table tool through your featured tables to change filters and indicators as needed.</p>
<p>Fast-track titles should explain:</p>
<ul>
<li><strong>What</strong> the table is showing in the simplest terms</li>
<li><strong>Who/Where</strong> the data covers (e.g. characteristic groups and geography levels)</li>
<li><strong>When</strong> the data in the table is reported for</li>
</ul>
<p>Here are a few examples of good fast-track titles in EES:</p>
<ul>
<li>Number of Schools and Pupils, by School Type, 2015/16 to 2020/21</li>
<li>Absence Rates by School Type, 2016/17 to 2020/21</li>
<li>Free School Meals, by Region, 2015/16 to 2020/21</li>
</ul>
<div class="alert alert-dismissible alert-info">
<p><strong>What is the difference between a fast-track link and a permalink?</strong></p>
<p>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.</p>
<p>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.</p>
</div>
<hr />
</div>
</div>
<div id="charts" class="section level3">
<h3>Charts</h3>
<hr />
<p>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.</p>
<p>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 clustered) and maps.</p>
<p>After choosing your chart type you then need to work through the following stages to build your chart. In each stage you’ll be shown a live preview as you make changes.</p>
<hr />
<div id="chart-configuration" class="section level4">
<h4>Chart configuration</h4>
<hr />
<p>Within the ‘chart configuration’ tab you can add a title, alt text, move the legend and change chart dimensions.</p>
<div class="alert alert-dismissible alert-info">
<p>Make sure to review your chart dimensions before you publish. Users should be able to read the labels on the axes and see the legend without having to scroll.</p>
</div>
<p><img src="images/EES-charts-create.PNG" /><!-- --></p>
<p>Note, within the vertical and horizontal bar chart types you can also create stacked bar charts by clicking the ‘Stacked bars’ option within the chart configuration tab</p>
<hr />
</div>
<div id="data-sets" class="section level4">
<h4>Data sets</h4>
<hr />
<p>Here is where you add data to the chart. You can add each series one at a time or all together.</p>
<p><img src="images/EES-charts-add-data.PNG" /><!-- --></p>
<hr />
</div>
<div id="legend" class="section level4">
<h4>Legend</h4>
<hr />
<p>You can edit the chart legend, and styling of your series via the Legend tab.</p>
<p><img src="images/EES-charts-legend.PNG" /><!-- --></p>
<div class="alert alert-dismissible alert-info">
<p>To select specify custom colours outside of the defaults, you can double click on the colour codes at the bottom of the colour picked until you get to the type of code you’re wanting to input (e.g. hex code) and then enter the code manually.</p>
</div>
<hr />
</div>
<div id="x-axis-major-axis" class="section level4">
<h4>X axis (major axis)</h4>
<hr />
<p>Here is where you configure the x-axis: You can alter gridlines, labels, sort, limit and add reference lines.</p>
<p><img src="images/EES-charts-xaxis.PNG" /><!-- --></p>
<table>
<colgroup>
<col width="50%" />
<col width="50%" />
</colgroup>
<thead>
<tr class="header">
<th>Option</th>
<th>What it does</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>Size of axis</td>
<td>Change the width of the space given to axis tick labels</td>
</tr>
<tr class="even">
<td>Show grid lines</td>
<td>Turn grid lines on and off</td>
</tr>
<tr class="odd">
<td>Show axis</td>
<td>Turn the axis on and off, you can also add a unit to the axis tick labels</td>
</tr>
<tr class="even">
<td>Sorting</td>
<td>Change how the data within the chart is sorted</td>
</tr>
<tr class="odd">
<td>Tick display type</td>
<td>Alter how often axis tick labels are shown, labels will automatically skip values where there are too many to show without overlapping</td>
</tr>
<tr class="even">
<td>Axis range</td>
<td>Alter the range of data shown in the chart</td>
</tr>
<tr class="odd">
<td>Label</td>
<td>Add an axis label, you can also choose the width for the space given to it</td>
</tr>
<tr class="even">
<td>Reference lines</td>
<td>Add/remove reference lines to the chart</td>
</tr>
</tbody>
</table>
<hr />
</div>
<div id="y-axis-minor-axis" class="section level4">
<h4>Y axis (minor axis)</h4>
<hr />
<p>Then follow a similar process for the y axis configuration, play around until the chart looks how you want it to.</p>
<p><img src="images/EES-charts-yaxis.PNG" /><!-- --></p>
<table>
<colgroup>
<col width="50%" />
<col width="50%" />
</colgroup>
<thead>
<tr class="header">
<th>Option</th>
<th>What it does</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>Size of axis</td>
<td>Change the width of the space given to axis tick labels</td>
</tr>
<tr class="even">
<td>Group data by</td>
<td>Change how the data within the chart is grouped</td>
</tr>
<tr class="odd">
<td>Show grid lines</td>
<td>Turn grid lines on and off</td>
</tr>
<tr class="even">
<td>Show axis</td>
<td>Turn the axis on and off, you can also add a unit to the axis tick labels</td>
</tr>
<tr class="odd">
<td>Sorting</td>
<td>Change how the data within the chart is sorted</td>
</tr>
<tr class="even">
<td>Tick display type</td>
<td>Alter how often axis tick labels are shown, labels will automatically skip values where there are too many to show without overlapping</td>
</tr>
<tr class="odd">
<td>Axis range</td>
<td>Alter the range of data shown in the chart</td>
</tr>
<tr class="even">
<td>Label</td>
<td>Add an axis label, you can also choose the width for the space given to it</td>
</tr>
<tr class="odd">
<td>Reference lines</td>
<td>Add/remove reference lines to the chart</td>
</tr>
</tbody>
</table>
<hr />
</div>
<div id="changing-chart-type" class="section level4">
<h4>Changing chart type</h4>
<hr />
<p>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.</p>
<p><img src="images/EES-charts-change-type.PNG" /><!-- --></p>
<div class="alert alert-dismissible alert-info">
<p>Remember to save your chart when you’re done.</p>
</div>
<hr />
</div>
<div id="maps" class="section level4">
<h4>Maps</h4>
<hr />
<p>You can create maps too, currently this is possible for regional, LA and LAD data.</p>
<p>You can change the boundaries you are plotting onto via the “chart configuration” tab, the latest boundary file will automatically be selected, but if you are visualising historic data, you may want an older boundary file. Please <a href="mailto:[email protected]">contact us</a> if the boundary you want to plot is unavailable.</p>
<p><img src="images/map_config.png" /><!-- --></p>