From 1800ff067243c851e799eff0b9f2e98c28683c19 Mon Sep 17 00:00:00 2001 From: Raymond Lutz Date: Mon, 14 Oct 2024 18:15:29 -0700 Subject: [PATCH] Improve definitions for job, district, election audit --- docs/user-guide/glossary.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/docs/user-guide/glossary.md b/docs/user-guide/glossary.md index 72d409d..4be31a0 100644 --- a/docs/user-guide/glossary.md +++ b/docs/user-guide/glossary.md @@ -376,7 +376,18 @@ This file should be reviewed by the auditing team, particularly to adjust the 'b ### Election Record -Within the AuditEngine app, within a given district, there may be multiple elections defined. The "Election Record" is the information related to that election, and will eventually include files uploaded appropriate for that election and used by one or more Audits. +Within the AuditEngine app, within a given [District](#district-record), there may be multiple elections defined. The "Election Record" is the information related to that election, and will eventually include files uploaded appropriate for that election and used by one or more [Audit Jobs][#audit-jobs]. + +In AuditEngine, we have established a standard naming convention for elections, as follows: + +​ CC_SS_District_YYYYMMDD + +Where: + +- CC -- is the standard two-character country code, typically always **US** (United States of America or if US, then sometimes left out). [Full List](https://www.iban.com/country-codes) +- SS -- is the standard two-character State code, such as **AZ** (Arizona), **CA** (California), and **FL** (Florida) [Full List](https://www.faa.gov/air_traffic/publications/atpubs/cnt_html/appendix_a.html) +- District -- is the District name, typically a County, but sometimes a State (Alaska). +- YYYYMMDD -- is the date of the election, such as 20241105.

Election Management System (EMS)

@@ -523,9 +534,9 @@ This is a discrepancy attribute. Sometimes not all the images are provided and s

job_name

-This is the name of the AuditEngine job to differentiate it from other jobs, and determines where the files are stored. The format of the _job_name_ has been standardized internal to AuditEngine as **ST_County_YYYYMMDD**, where **ST** is the two-character state abbreviation, **County** is the County Name without spaces or special characters, and YYYYMMDD is the the data of the election when the polls closed. It may also have the two-digit country code as a preface, such as "US\_" +This is the name of the AuditEngine job to differentiate it from other jobs, and determines where the files are stored. The format of the _job_name_ has been standardized internal to AuditEngine for the [Election](#election-record), such as **ST_County_YYYYMMDD**, where **ST** is the two-character state abbreviation, **County** is the County Name without spaces or special characters, and YYYYMMDD is the the data of the election when the polls closed. It may also have the two-digit country code as a preface, such as "US\_" -Thus, **GA_Bartow_20201103** is the job for the 2020 General Election in Bartow County, GA. It is okay to add additional tags to the end, like **\_LAT** if it is the job to process the [Logic and Accuracy Test](#logic-and-accuracy-test-lat) ballot images in that same election, or for other purposes. NOTE: The job_name can't be changed very easily once it is set. It cannot have spaces or special characters other than underscore. See also _[Audit Job](#audit-job)_. +Thus, **GA_Bartow_20201103** is the job for the 2020 General Election in Bartow County, GA. It is okay to add additional tags to the end, like **\_LAT** if it is the job to process the [Logic and Accuracy Test](#logic-and-accuracy-test-lat) ballot images in that same election, or for other purposes. NOTE: The job_name can't be changed very easily once it is set. It cannot have spaces or special characters other than underscore. See also _[Audit Job](#audit-job)_, *[Election](#election-record)*, and *[District](district-record)*. Sometimes, jobs may be created from other jobs using the 'clone_job' function. The name of the cloned job must have a similar name, with the same name given to the Election, and then a suffix modifier, like _clone, _functest, etc. For example, **GA_Bartow_20201103_clone**.

Job Settings