Doc API - Create Document Record Report

[doug-lovett]

• Create report template
• Create report service
• Create API endpoint

Postman example with DEV endpoint for testing attached here. doc-api-unit.postman_collection.json.zip

[LizGovier]

Hey team! Please add your planning poker estimate with Zenhub @cameron-eyds @chdivyareddy @doug-lovett @flutistar

[doug-lovett]

@LizGovier Some first cut examples are attached. Here are some comments: Kevin requested "Verification" be changed from "Verification Statement". I added a background watermark so you can see if you want to keep it. The documents are not actually saved to a database so I changed it to "document storage". Description type is specific to an individual document: do you want it removed or moved to the Documents list? The examples are for the 3 possible scenarios where all, none, or some documents are uploaded.

verification-test-all.pdf

verification-test-none.pdf

verification-test-partial.pdf

[LizGovier]

Thanks @doug-lovett Because of the extra statements you provided, some of my comments may be out of scope. If so, I can create a new ticket and we could wait until the next sprint.

---

• [ ] I like your update to 'Document Service Statement' Could we also change the header from 'Document Indexing' to 'Document Services' so it aligns with your update.

---

• [ ] In first sentence, replace 'have been' with 'were'. Example: All documents were uploaded to document storage.

---

Partial Documents uploaded - verification-test-partial.pdf Would this be partial incase there was an error with one of the documents or it was too big? If so, I think we should add '2 of 3 documents have were upload' and add '(Upload Failed)' beside the documents that were not uploaded.

---

No Documents uploaded - verification-test-none.pdf

• [ ] Assuming this was if the user did not try to upload documents, there shouldn't be any documents listed

---

Description type is specific to an individual document: do you want it removed or moved to the Documents list?

Do you mean document type? If so, we should leave it in.

[doug-lovett]

Thanks @LizGovier, here are some updated examples. verification-test-all.pdf

verification-test-none.pdf

For the document type description (yes, I meant this), the API allows uploads at different times that are associated with the same document ID. Maybe this will never happen, but the report could include multiple documents that have different document types associated with the same document ID.

For a partial/incomplete upload, I was not thinking of an error scenario. If there is an error uploading no record is saved and the API returns an error. This may never happen in the UI, but the API allows creating records without uploading a file, and the record could include a file name. Multiple such records could be associated with a single document ID. Later on files can be uploaded, allowing the documents associated with a document ID to be in a partial/incomplete state.

For now, maybe we can defer if the above scenarios need to be considered to a later ticket?

[LizGovier]

Thanks @doug-lovett Doc Service statements look great. We may need to add other watermarks, but that could be post MVP so I'm good with leaving the current watermark you have.

Re: Document Type Description Each document type has to have it's own Doc ID. So as far as I know, we wouldn't be in a situation where multiple doc types would share the same ID.

Re: For a partial/incomplete upload If for some reason a file was not uploaded, would that document name be remove from the Document Service Statement? But yes, let's discuss this scenario with the team and see if it needs to be considered. We should have some kind of message or visual explanation in those rare cases a file doesn't make the cut.

All that to say, this is RFQA!

[doug-lovett]

Thanks Liz, here are the final examples with the name change to "Document Record". doc-record-test-all.pdf

doc-record-test-none.pdf

[LizGovier]

Looks great! Thank you Doug

[chdivyareddy]

Verified in DEV using postman.