1. Home
  2. Docs
  3. Developer Documentation
  4. File Interface
  5. Interface Files

Interface Files

The lowest level of XcooBee interaction can take place through a file interface. You can upload and download different type of files for XcooBee to process.

User Data Files

This is the easier concept to understand. User data files are the files that users have uploaded to the system. They can be anything that complies with XcooBee file extensions Allowed File Extensions. For example images, contracts, proofs, spreadsheets, movies, etc.

In addition, XcooBee allows semantic and user specific tags to be added to each file via the directive files concept.

Directive Files

Directive files, are special files that users can submit to the system. Inside the directive file many aspects of the processing can be specified including the bees that will be used, the parameters that bees will need, the order in which the execution should take place, the semantic and user specific file tags, etc.

In other words, the directive files contain the information for the operations that should take place on the User Data Files that were supplied.

Thus, the Directive Files are uploaded after the User Data Files have been uploaded so that the system can immediately begin operations when a directive file is found.

Endpoints

Both Directive Files and User Data Files are uploaded to user endpoints. You can think of Endpoints as similar to directories in a file system. There are Endpoints for the Inbox and Outbox in XcooBee.

All developer interactions takes place with Outbox Endpoints.

Flex Endpoint

All users have a Flex endpoint. This is where individual uploads can be placed. Flex endpoints will begin processing your task with every directive file uploaded. Thus a directive file acts as a invocation to start the process. Given the construction method, directive files can be specific as to which User Data Files they operate on, so that many processes can run simultaneously.

Other Endpoints

Professional subscriptions and higher have the option to create many additional Endpoints inside their Outbox. Think of these as extra directories. The difference here is that no Directive File is needed. Endpoints that are created in this fashion already have their processing instructions and what ever is uploaded is immediately processed.

As with everything in XcooBee, there is a time to live and a right to be forgotten. We will remove uploaded and unprocessed files after seven days. All other files are removed based on your subscription level time-to-live.

Was this article helpful to you? Yes No

How can we help?