improve importTable() and process of uploading a new table of data into ActivityInfo

[Ryo-N7]

currently the process of:

• having an Excel/CSV file, uploading the schema (or more time-consumingly building the schema in the user interface), and then finally uploading the data is a bit cumbersome

alongside the changes to improve how we manipulate the form/database schemas in issue #32 and #31 we should think of ways to streamline this process

[Ryo-N7]

importTable() needs a reader for NARRATIVE long-form text field types

Getting form c5e73092971 schema returned with status 200: success
Error in prepareImport(schema$elements[[fieldIndex]], columnName, data[[columnName]]) :
Field 'Descripcion' has unsupported type 'NARRATIVE'

[Ryo-N7]

for importTable() would like to be given the Job ID so then the user can look up the server error themself (given proper permissions etc.)

Getting form c736c52093c schema returned with status 200: success
POST request to https://www.activityinfo.org/resources/jobs returned with status 200: success
GET request to https://www.activityinfo.org/resources/jobs/ahBlfmFjdGl2aXR5aW5mb2V1chALEgNKb2IYgICA7beLpgsM returned with status 200: success
Waiting for importRecords job to complete: 0%
GET request to https://www.activityinfo.org/resources/jobs/ahBlfmFjdGl2aXR5aW5mb2V1chALEgNKb2IYgICA7beLpgsM returned with status 200: success
Waiting for importRecords job to complete: 0%
GET request to https://www.activityinfo.org/resources/jobs/ahBlfmFjdGl2aXR5aW5mb2V1chALEgNKb2IYgICA7beLpgsM returned with status 200: success
Waiting for importRecords job to complete: 0%
Error in executeJob("importRecords", descriptor = list(formId = formId, :
Job failed. Code: SERVER_ERROR, Message: Server error

[Ryo-N7]

maybe also a way to pick/choose the correct column label (or specify it with the field code when importTable() gives you an error because of ambiguous field labels?

[Ryo-N7]

ideal pain-free process:

1. get table/form made in Excel or whatever can be ingested
2. find out the field names + field types of each column
3. using that info create a activityinfo compliant schema based off of the Excel/whatever file table given (schema helper functions)
4. upload that new schema as a new form into ActivityInfo db (addForm() function) --- what does addForm() return currently??
5. With that completed, it'll give me back the ID of the newly created form
6. using form ID i can use add/updateRecord() or even importTable() to fill in the data values

[nickdickinson]

So I think now you can do item 2, 3 and 4 with the form field schema functions.

For example:

fmSchm <- formSchema(databaseId = databaseId, label = paste0("R form with multiple fields test ", cuid()))

fmSchm <- fmSchm |> 
  addFormField(multilineFieldSchema(label = "A narrative")) |>
  addFormField(textFieldSchema(label = "A text field")) |>
  addFormField(quantityFieldSchema(label = "A water quantity field", unit = "litres per day"))

dbMetadata <- addForm(databaseId = databaseId, schema = fmSchm)

fmSchm2 <- getFormSchema(formId = fmSchm$id)

From that moment, you should be able to import your data using as in item 6. You can try it if you run from https://github.com/bedatadriven/activityinfo-R/tree/version-4.32

I'll try to make a vignette with a reproducible example before Wednesday.

ideal pain-free process:

1. get table/form made in Excel or whatever can be ingested
2. find out the field names + field types of each column
3. using that info create a activityinfo compliant schema based off of the Excel/whatever file table given (schema helper functions)
4. upload that new schema as a new form into ActivityInfo db (addForm() function) --- what does addForm() return currently??
5. With that completed, it'll give me back the ID of the newly created form
6. using form ID i can use add/updateRecord() or even importTable() to fill in the data values

[Ryo-N7]

databaseId <- "c5xypudl7oni7c52"


fmSchm <- formSchema(databaseId = databaseId, label = paste0("newform_yay", cuid()))

fmSchm <- fmSchm %>% 
  addFormField(multilineFieldSchema(label = "A narrative")) %>% 
  addFormField(textFieldSchema(label = "A text field")) %>% 
  addFormField(quantityFieldSchema(label = "A water quantity field", unit = "litres per day")) %>% 
  addFormField(userFieldSchema(label = "THIS_DUDE_RIGHT_HERE", databaseId = databaseId)) %>% 
  addFormField(singleSelectFieldSchema(label = "select from one of these options", 
                                       values = list("jeff", "goldblum", "tevez", "horatio", "jimothy")))

• userFieldSchema(): does 'databaseId' really need to be set here since it's going to be passed into a form schema that has the db ID anyway? i understand that generating the JSON to create this field type means it'll need to reference the db ID to formulate the 'range' parameter list(list(formId = sprintf("%s@users", databaseId))) in the function but since it's never going to be used by itself it seems redundant to have users put it in again

• singleSelectFieldSchema(): in documentation it's called "options" but the actual argument in the function is called "values". Also i tried to define it as a list() and with c() but I get an error >>> failed with code 400 and http status INVALID_JSON: Your request was not well-formed JSON, or did not conform to the expected schema

in general the error messages seem way to vague but i'm not sure how to improve it from the API's p.o.v. since everything underneath is really a JSON related message

[Ryo-N7]

documentation for ALL of the field schema function in one place makes sense.

the formatting could be improved though because with everything in one giant 'Description' section only separated by new lines, it's a bit hard to tell which paragraph begins and ends for a particular field. I think just having them as their own bullet points would help distinguish each a bit more

[Ryo-N7]

this is a more general point re: documentation: the documentation should try to further explain ActivityInfo API concepts. like in the field schema docs, in Arguments it talks about presentation: Default is "automatic". but it doesn't give me any info on what presentation is. I'm sure this is all stuff that's just copy-pasted from the API docs but a bit more elaboration would help users.

[Ryo-N7]

importTable() bug? whenever I run the function without parentIdColumn I get the message >> argument 'parentIdColumn is missing, but function still works without it

still works despite no default stated so need to fix function parameters in the package?

function (formId, data, recordIdColumn, parentIdColumn) 
{
  parentId <- NULL
  schema <- activityinfo::getFormSchema(formId)
  schemaTable <- as.data.frame(schema)
  subform <- !is.null(schema$parentFormId)
  providedCols <- names(data)
  if (!missing(recordIdColumn)) {
    recordId <- recordIdFromData(data, recordIdColumn)
    providedCols <- providedCols[providedCols != recordIdColumn]
  }
  else {
    recordId <- rep.int(NA_character_, times = nrow(data))
  }
  if (subform) {
    parentId <- parentIdFromData(data, parentIdColumn, schema)
    providedCols <- providedCols[providedCols != parentIdColumn]
  }

[nickdickinson]

Some quick responses:

• We could change the select field argument to options... do we want to model more closely the API or the user interface? The UI has options.
• The options/values have to be built:

addFormField(singleSelectFieldSchema(label = "select from one of these options", 
                                       values = toSelectValues(list("jeff", "goldblum", "tevez", "horatio", "jimothy"))))

• Re: api documentation, for the most part, I built this initially using only the examples I generated from the API and watching the calls.
• Thanks for testing out the full flow. I wanted to finish a working example (vignette) and I'll be sure to make sure these additional steps are added to the package testing suite.
• We might consider the form schema to userFieldSchema instead of the databaseId... it might be a bit of an odd construction. Or eventually allow the individual userFieldSchema functions to be chained with a formField and return a formField instead of using addFormField()...

I agree it is a bit strange to add the databaseId but I think it is also the simplest solution at the moment.

[akbertram]

Note to self: also needs to work if a recordId is not provided.

[nickdickinson]

recordId bug: #44 (comment)

[nickdickinson]

While implementing migrateField() see if bug still exists (provide recordIds).

[Ryo-N7]

I'm getting a bug with importTable() where if i try to import data into a field that is single-select with values that are numeric/integer then the function bugs out and causes my session to crash

ex.

i have a "Fiscal Year" column that's set to numeric/integer in Excel/Access/data.frame/etc. but the form schema in activityinfo has it set as a single-select column with the options "2018", "2019", etc...

so when i try to push data from R with the "Fiscal Year" column with "2018" , "2019" ,etc. that are set as numeric/integer then my session crashes.
The way to solve this problem is to simple change "Fiscal Year" with as.character() and then run importTable()

but yeah it's a weird issue i've found, i'll post screenshots and a bit more detail tomorrow if i can replicate it elsewhere