• Topic
  • Discussion
    • ODS.OdsBriefcaseBoxNet(1.3) -- DAVWikiAdmin? , 2018-04-05 18:05:36 Edit
    [TXT]
    [PLAIN]
    [DOCBOOK]
    WebDAV System Administrator 2018-04-05 18:05:36

    Using ODS-Briefcase to mediate access to data stored on Box (box.com a/k/a box.net)

    Introduction

    Box is an online file system service that enables users to share, store, and access files of any type from anywhere.

    Box file storage offers users a number of features:

    • Share, access, and collaborate on files of any type from anywhere and any device
    • Have complete control and access to your data including establishing permissions, and adding or removing collaborators
    • Data files are secure on Enterprise-grade servers, in multiple, geographically-separated facilities
    • All data requests pass through an audited verification code to ensure user authorization
    • Optional 256-bit Secured Socket Layer (SSL) security to encrypt data between the end user and Box
    • Ideal for remote access to your important files from multiple computers, any time and anywhere
    • Compatible with all major browsers and operating systems including both Windows and Mac
    • Free online storage: allows 5GB of free online storage

    ODS-Briefcase offers a new "Box" folder type which provides several additional features, once ODS has been configured to use a registered Box API key:

    • Specify credentials for authentication against Box, enabling retrieval of any or all of your folders and files, including any associated metadata
    • Specify which Sponger Extractor Cartridges and Sponger Meta Cartridges should be run against your Box data
    • Save fetched data, metadata, and Sponger output, into a newly created Box-specific RDF Graph in the Virtuoso RDF Quad Store
    • Specify other ODS Users or WebID ACLs which should be granted access to your Box data through ODS-Briefcase

    Example

    Here is a sample scenario showing the whole process, from setting the Box API key in ODS, to retrieving all Box content to ODS-Briefcase.

    Prerequisites

    Steps

    1 - Get a Box API key for use with ODS-Briefcase

    Note that at present, each Virtuoso + ODS instance can only be configured with a single Box API key, which will then be used by all ODS-Briefcase users when targeting Box from that instance. Box may impose limitations on this key's use. Such limitations are outside the scope of OpenLink or Virtuoso control.
    1. Browse to <https://www.box.com/developers/services/edit/>, and enter your Box user credentials:



    2. Enter a name for your Box client application (i.e., your ODS-Briefcase instance) to be known by, e.g., "MyExampleBox":



    3. Click the Create App button.
    4. You will be shown an API key for the newly registered application. (You can copy the API key now, or come back for it later; it will also show up on the "Edit" page. Do be aware that you will need this key in the steps that follow.) Click Edit this application.



    5. In the edit form, set the Redirect url to target the Box interface (access_box.vsp, by default) on your Virtuoso + ODS instance, http://<cname>[:<port>]/ods, e.g., <http://example.com/ods/access_box.vsp>, and click Save service.



    2 - Configure ODS to use your Box API key

    1. Browse to your Virtuoso + ODS instance, http://<cname>[:<port>]/ods, e.g., <http://example.com/ods/>, and click Sign In.



    2. Log in as a Virtuoso+ODS user with Administrator privileges, e.g., dba.



    3. Click on Site Settings:



    4. Click on Login Authentication Keys:



    5. Select Box API in the API Name menu, provide the Box API Key you got when you registered the application with Box, and click Add.



    6. ODS-Briefcase is now configured to use the Box API.



    3 - Access files stored on Box through ODS-Briefcase

    1. Browse to your Virtuoso + ODS instance, http://<cname>[:<port>]/ods, e.g., <http://example.com/ods/>.



    2. Log in as a Virtuoso+ODS user with normal privileges, e.g., demo.



    3. Click to the ODS-Briefcase application:



    4. Click New Folder from the main Briefcase control strip:



    5. In the New Folder form, specify a Folder Name, e.g., MyBoxFolder, and set the Folder type to Box Net:



    6. Click to the newly visible Box Net tab:



    7. All RDF data extracted from and otherwise collected about your Box files will be saved to a named graph, where the default name is constructed from the host ODS instance, the ODS username, and the Briefcase folder name -- http://<host>[:<port>]/DAV/home/<user-name>/<folder-name>#this -- so, in this example, the default graph would be named <http://example.com/ods/demo/MyBoxFolder#this>. Expert users may wish to change this graph name, but the default is suitable for most users.



    8. You can also turn on the Virtuoso Sponger, to process your Box files more comprehensively. When the Sponger is enabled for your folder, you can specify which "Sponger Extractor Cartridges" and "Sponger Meta Cartridges" will be run over the files in your Box. You can enable all cartridges, but this will introduce some processing overhead. It's generally best to enable only those cartridges which will be applicable to your files and their content. For instance, you may know that you'll only be storing Microsoft and Open Office documents here. Then, click "Authenticate", to connect your new folder to your Box:



    9. You'll be prompted to enter your Box user's credentials. Note that this Box user need not be the application owner/"developer" who got the API key earlier.



    10. Box will confirm that ODS has been authorized, and you can close that browser window/tab.



    11. Now click Create to finish the process.



    12. Your new Box-linked folder should now be displayed in your Briefcase resources list:



    13. Click the folder name to see the resources ODS-Briefcase has found in your Box Dataspace:



    Related