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.
Business Process Flow
Business Process Steps
Kuali Build
When a document that OnBase cares about is completed, the last step in the workflow will be an integration to this web service.
KB to OB Web Service
Exposed API
- exportPdf()
- KB will post the unique document ID to the service for a callback
Internal Methods
- getPDF()
- callback to KB using the document ID to export the PDF from KB
- generateIndexFile()
- index file specifications
- keywords+ | OnBase document type | PDF filename
- additional notes
each index file will have the naming convention kuali-build-index-docID-yyyymmddmmss.txt
each filename will have a distinct naming convention kuali-build-doc-docID-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
- sample index file
- UH# | LASTNAME | FIRSTNAME | MIDDLEINITIAL | SERVICEYEARS | SHIPNAME | DOCUMENTTYPE | FILENAME
- index file specifications
- transfer
- sftp the PDF and the index file to sftp.hawaii.edu
SFTP Server
This is a temporary holding spot where the PDFs and index files live until OnBase can stage them on it's DIP server.
sftp.test.hawaii.edu (access dev, tst, qa below using the kualibld departmental account located in LastPass) and sftp.hawaii.edu (account and folders not created yet)
for Dev:
cd /dev/kualibld/
for Tst:
cd /tst/kualibld/
for QA:
cd /qa/kualibld/
OnBase
OnBase will periodically pull files from the sftp server, stage them on a DIP server, and then ingest the PDF into OnBase.