Overview
The file uploader provides a simple web-based user interface for uploading new files to the system, and for sharing them across the different communities.
...
But the share interface is completely generic, and widgets can be developed that allow communities of users to share app-specific binary and text files between them. In addition, roadmap items to both the core platform and visualization framework include query sharing and per-user/community synonym handling that will use the share interface.
| Table of Contents |
|---|
Using the File Uploader
Logging In
The file uploader shares its cookie with the main GUI, the widget uploader, the source builder, and the person manager - logging into any of them will log into all of them.
To login
- Provide your credentials when prompted by any of the above mentioned GUIs.
Root URL Access
The widget uploader can be accessed from th eroot url by using the following url format:
<ROOT_URL>/manager/fileUploader.jsp (
eg http://infinite.ikanow.com/manager/fileUploader.jsp). It can also be reached from the home page of the Manager webapp (itself linked from the main visualization GUI).
The following URL parameters are supported:
...
This brings up username and password fields and a login button. (Unless already logged in, eg into the manager or main GUI - in which case skip to the next section).
Note that:
- The file uploader shares its cookie with the main GUI, the widget uploader, the source builder, and the person manager - logging into any of them will log into all of them.
Uploading a new "binary" file
(Note "binary" here refers to anything except for JSON)
The above figure shows the tool shortly after log-in
| Anchor | ||||
|---|---|---|---|---|
|
You can use the File Uploader to upload binary file types (anything other than JSON).
To upload the file, simply fill in the fields, select the file from your hard drive and network drives, and select "Submit". Note that at present all uploaded files are treated as binary not JSON.Note that you
- You can leave Filter On blank
- Ensure that the Action dropdown specific "Upload New File."
- Provide a Title, description, and applicable communities.
You can select either a single or multiple (CTRL+click) communities. You can share files with any available community. If you upload to only your personal community, only you (and system administrators) will have access to the file.
4.Select the file from your hard drive and network drives, and select "Submit".
The system will automatically detect the MIME type and store this - this will be used both in filtering (see below) and for the content-type for when that file is served from the REST API.
Uploading a new "JSON" file
You can use the File Uploader to upload JSON files.
Infinit.e handles JSON with some additional support. The process is the same as above, except:
...
, and there is an additional field "type" that can be any string value.
This type is used in a few different ways:
- It can be filtered on from the "Filter On" drop down menu in this GUI
- It can be used as an efficient search object in the Social - Share - Search API call.
- Shares of type "infinite-entity-alias" are used by the framework for aliasing.
- Shares of type "source_template" are used by the Source Editor GUI as shareable templates.
- Shares of type "widgetsave" are used the main GUI to store per-user or per-community settings
- developer info here (uses map widget KML layers as an example)
- (And of course any other Infinit.e application can use it for internal purposes)
To upload the JSON file
- Select "Upload New JSON" (instead of "Upload New File").
- Specify the Type field as appropriate.
- Fill in the other fields as per binary file types. The JSON is checked on ingest and an error thrown if it is invalid.
Sharing an existing Infinit.e (JSON) object
JSON objects from various internal Infinit.e databases can be shared to communities by selecting "Share existing object". This generates the following fields:
...
. When sharing to communities you must specify the type field, as when uploading a JSON file, as well as reference informaton:
- A "reference location" dropdown which allows the user to choose from the available databases:
- Custom Plugin Collection: the first object from this custom job is shared
- (eg the "_id" of the job can be see next to the "Title" field of the plugin manager, or the Custom - Get Jobs API call)
- Document Metadata Collection: the document with the specified "_id" field is shared
- Aggregated Entity Collection: the entity object with the specified "_id" field is shared
- Aggregated Association Collection: the association object with the specified "_id" field is shared
- Local files (see below)
- Custom Plugin Collection: the first object from this custom job is shared
- A "reference doc id" field that must contain the "_id" field of the object chosen above.
- (By contrast the "File" field is removed compared to JSON/binary shares)
...
To share an existing JSON object
- From the Actions dropdown, selecting "Share existing object".
- Configure the "Type" field as required. For more information, see File Uploader Interface.
- Configure "Reference location" and "Reference doc id."
- Click on Submit.
Create Shares Pointing to the Local File System
It is possible to create shares that return the local files as binary or JSON shares (on multi-node clusters, the same version of the file must be present on all nodes or unpredictable behavior will ensue). .
This can be used to "publish" common local files but with security restrictions.
Only administrators can use this function.
| Info |
|---|
On multi-node clusters, the same version of the file must be present on all nodes or unpredictable behavior will ensue. |
...
To local file system shares
- From the actions dropdown select "share existing object."
- For Type select "binary" as the type if the object is not JSON
...
- For "reference location"
...
- select "Local File (admin only)"
...
- For "Reference doc id"
...
- select the absolute path of the file to be shared.
| Warning |
|---|
This provides non-admin users who belong to the shared communities with (read only) access rights to that file. |
Editing
...
Existing Shares
After log-in, all files you own can be seen from the top drop-down menu (initially called "Upload New File"). If you are a community owner or moderator, all files in your communities can be seen in addition. If you an administrator, all files in the system can be seen.
...