Administrative

Requirements

1. The script should be executable from the command-line, and should accept inputs from the command line.

Input(s)

The script should be able to take the following input:

1.  CSV file containing a paired columns of labels and labelnames in the archive organization (for example, column order in a file could be: series, seriesname, subseries, subseriesname, etc.)

   1. the odd-numbered columns of the CSV must contain label (for example: 1)

   2. the even-numbered column of the CSV must contain labelname (for example:  Organizational correspondence)

2. prefix the name of label column with "arrange:<label>" and the name of labelname column with "arrange:<labelname>"(case-sensitive, exclude the quotes)

3. the text string following "arrange:<label>" will be used as a property name to query the database and text string following "arrange:<labelname>" will be used as a property name to add the labelname in the admin metadata profile

Interface

The script will be a command-line utility that will serve the requirements as outlined above.

Invocations of the script would look like this:

python3 administrative.py [OPTION]... -f CSV

OPTION represents a the following set of switches that can be applied to modify the default behaviour of the script:

Behavior and Implementation

The script (adminsitrative.py) performs the following high-level operations:

1. Parse command line arguments

   1. set variables in accordance with the arguments

   2. inform user about errors in the arguments, print help, and exit

2. Read CSV file

   1. validate header structure

   2. parse 'arrange' information from header

   3. error if the label and labelname are not in pairs(even number of columns in csv) and print the message in error csv.

3. Read metadata property names from labels.json

   1. store all labels within a Python object

4. Read controlled vocabulary from vocab.json

   1. store the vocabulary as a Python object

5. Create a connection to the database

6. For each row in the CSV:

   1. extract the 'arrange' info (for the admin metadata profile)

   2. query the database for the matching values of all labels in this row

      1. if no documents in the database match this query, print message in error csv

      2. for each returned document record,

         1. error if the label and labelname are not in pairs(even number of columns in csv) and print the message in error csv.

         2. if document already has labelnames for every label in the query, print message in error csv.

         3. update the document with labelnames for all labels on the current row of the CSV file

         4. Add a metadata enrichment event to the PREMIS profile for this document.

Output(s)

The script should, of course, be able to carry out the mapping of labelname to the corresponding label as specified in the csv, but also print helpful information in case errors were encountered. Errors to be reported include errors in command usage, as well as any errors encountered while mapping the csv entry to the document. Error csv name: "admin_profile_errors_<timestamp>.csv"

Test cases / Validation

1. No header in the csv file should print an error.

2. One entry of data in the csv file with at least one label-labelname pair. [[does this mean one data row in the csv? how many columns]]

3. Multiple entries of data in the csv file with at least one label-labelname pair. [[does this mean multiple data rows in the csv? how many columns?]]

4. Document not available in the database should print an error.

5. Admin Profile already present for the document in the database with missing labelnames.

6. Admin Profile already present for labels with labelnames. [[what should the script do here?]]