Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This web service will expose a POST method that Kuali Build applications can call to transmit completed KB documents into OnBase, UH's document imaging system.

...

  • getPDF()
    • callback to KB using the document ID to export the PDF from KB
    • What about attachments on the Kuali document? Can these be exported along with the document?
    • Use GraphQL API to pull the PDF from KB
      • Testing against any of our environments can be done against /app/api/v0/graphiql. It loads up a playground against our KB data to help figure out how to write the queries.  Currently, all documentation lives in the GraphQL playground (schema and docs tab), but more user-friendly docs (see draft) are forthcoming.
  • generateIndexFile()
    • index file specifications
      • keywords+ | OnBase document type | PDF filename
      • additional notes
        • each index file will have the naming convention kuali-build-index-yyyymmddmmss.txt

        • each filename will have a distinct naming convention kuali-build-doc-yyyymmddmmss.pdf

        • This will allow all the pairings (of index and PDF) to get saved in the same directory

          • On the OnBase side, they'd search for something like kuali-build-index*.txt

        • Our service will create 1 entry per index file even though OnBase supports multiple records per index file.
      • sample index file
        • UH# | LASTNAME | FIRSTNAME | MIDDLEINITIAL | SERVICEYEARS | SHIPNAME | DOCUMENTTYPE | FILENAME
  • transfer
    • sftp the PDF and the index file to the SFTP Server

...