Overview
| Warning |
|---|
The Plugin Manager GUI is not currently compatible with IE. It is compatible with Chrome, Firefox, and Safari. |
...
| Info |
|---|
Note that only Administrators can upload JARs to be used by the plugin manager. Any user can run jobs based on JARs to which they have access. A built-in "Javascript Engine" plugin is provided that allows users to write javascript "scriptlets" and distribute them. This is described here. |
Logging In
The plugin manager can be accessed from <ROOT_URL>/manager/pluginManager.jsp (eg http://infinite.ikanow.com/manager/pluginManager.jsp). It can also be reached from the home page of the Manager webapp (itself linked from the main visualization GUI).
...
- The plugin manager shares its cookie with the main GUI, the file uploader, the source builder, and the person manager - logging into any of them will log into all of them.
Scheduling a new Map Reduce Plugin
The above figure shows the tool shortly after log-in.
...
Note: You can temporarily remove a combiner or reducer by putting "#" in front of it. Only the mapper is mandatory (others can be set to "none"), though normally at least the mapper and reducer are set.
Submit vs Quickrun
There are 2 options for submitting a job:
...
You can also debug tasks, this is described in the next section.
Debugging new and existing tasks
Just above "user arguments" there is a "Save and debug" button. This is very similar to pressing the "QuickRun" button described above, except:
- It will only run on the number of records specified in the text box next to the button.
- It will always run the Hadoop JAR in "local mode" (ie it won't be distributed to the Hadoop cluster, if one exists)
- Any log messages output by the Hadoop JAR (or in the javascript if running the prototype engine) are collected and output to the status message
- (Note that if running in local mode, then "QuickRun" will log error messages - nothing will be currently logged in the typical cluster mode though, so the debug mode is necessary in this case - the alternative is running and testing in eclipse as described here, which is quite involved)
Stopping a running task (kill)
Simply set the "Frequency" to "Don't Run" and re-submit. It may take up to a minute for the status to show the updated task status.
Scheduling a new Saved Query
If you want to schedule a saved query instead of a map reduce plugin you can follow the exact same process as scheduling a m/r job except for these few changes:
...
(From March 2014) Note that you can paste a saved workspace link into the query field (eg from the GUI) instead of typing out the JSON.
Editing existing plugins/saved queries
After log-in, all plugins you own can be seen from the top drop-down menu (initially called "Upload New File"). You can also see all plugins in your community (see info box below). If you an administrator, all plugins in the system can be seen. You can only edit plugins if you admin/community moderator/owner though you can see the results of any plugin in the dropdown.
...
Once a file has been chosen, it can be modified by changing the fields (and/or choosing a different file), and then selecting the "Submit" button.
Copying an existing custom task
Select the task to be copied from the top drop down menu, then select "Copy Current Plugin". You must change the title, edit other fields are required.
Deleting files
Log in and choose a file as above, then select the "Delete" button.
Running an existing job
If you want to start a job you can select for the option "Next scheduled time" to Once Only and it will be scheduled as soon as possible and only run once. If you want to schedule a job on a certain frequency you can adjust the frequency option to one of the other settings.
Following a job's progress
Once a job has been scheduled you will be able to track its progress by refreshing next to the run status, the current map and reduce completion status as well as any errors that may have occurred when running will be displayed in an informational header.
...