...
When a Skill is registered with a Box account, the invocation URL is provided. This URL will resolve to an endpoint in Fence.
Comparison of Approaches
| Box Tuned/Potentially Streamlined | Current "Standard" Approach | Box Tuned/Potentially Streamlined |
|---|---|---|
If using the /extractions/file endpoint the file is transferred three times:
If using the /extractions/url endpoint the file is transferred ?? times:
File lives in clowder until the cleanup script is run | File is downloaded once from box to the extractor container File lives in extractor and deleted at end of process_message by PyClowder (is this correct?) | |
| Box SDK only lives in the BoxClient service. No changes are required for elsewhere | Box SDK has to be introduced into Pyclowder library. Any other repos we want to support would also have to be included Burden of maintenance/adding new supported external services on our end vs on the client's end Is Pyclowder the right place for this? PyClowder is just a convenient wrapper mechanism for creating "some" extractors that happen to be written/wrapped in python | Box SDK only lives in the BoxClient service. No changes are required for elsewhere|
| Custom metadata structure for box would be implemented in the extractor. | An automated translation of clowder metadata to box skills cards would have to be developed. | Potential Bottlenecks for massive scaling:
Notes: Everything apart from Rabbit is stateless and can be horizontally scaledCustom metadata structure for box would be implemented in the extractor. |
Potential Bottlenecks for massive scaling:
Notes: We can't rely on threading in the BoxClient to do the polling since we would risk running out of threads. Would need to add some endpoints to fence | Potential Bottlenecks for massive scaling:
Notes: Everything apart from Rabbit is stateless and can be horizontally scaled. | |
Would need to deploy a new service and proxy it behind Apache. BoxClient would need to be allocated a service account and handle Brown Dog tokens | Would need to add some endpoints to fence | |
Errors can be reported in Clowder (not visible to the Box user) The BoxClient could potentially retry | Limited error logging and reporting Unsure about retry if an extraction fails Eventually we could create an app where user logs in via their Box credentials to see the history of extractions Errors can be reported in Clowder (not visible to the Box user) The BoxClient could potentially retry |
Skills Invocation
When a file is uploaded to a Box folder that has an attached skill, the following payload is POSTed to the fence endpoint:
...