...
Source management is intrinsically a complex process (particularly when taking advantage of Infinit.e's customization engine).
Using the Source Manager
...
...
...
You have 2 options for creating a new source here:
- You can use an empty template, fill out the title/description/tags/community fields and click Create Source, you can build a source from scratch or paste one in on the next page.
- You can select a template to get you started as shown below
...
...
...
...
...
...
...
...
...
Edit Existing Sources
To edit an existing source click on the source's name in the list of Sources found on the left hand side of the page.
...
Info |
---|
If copying the logic of an existing source, it is recommended to first "scrub" it to remove any server-added fields (particularly "_id" and "key", which can overwrite the existing source). |
...
...
...
There are 3 tabs that can be edited:
- "JSON" - this is the full source including all fields
- New source pipeline:
- "JS" - The global script that all other elements can use - all of the logic can be written in here as separate functions, and then the scriptlets in other pipeline elements can be simple calls to these functions, to maximize the maintainability of the code in the source.
- "LS" - If generated Logstash sources, you can write the configuration directly into here
- "UI" (currently only supported in the enterprise build) - brings up the source builder GUI
- Legacy sources:
- "JS-U" - the Unstructured Analysis Module allows content to be transformed by "scriptlets" (xpath/regex/javascript) into document metadata. This view shows only the javascript maintained in "unstructuredAnalysis.script" - all of the logic can be written in here as separate functions, and then the scriptlets can be simple calls to these functions, to maximize the maintainability of the code in the source.
- "JS-S" - the Structured Analysis Module allows content to be transformed by "scriptlets" (xpath/regex/javascript) into document metadata. This view shows only the javascript maintained in "structuredAnalysis.script" - all of the logic can be written in here as separate functions, and then the scriptlets can be simple calls to these functions, to maximize the maintainability of the code in the source.
- "JS-RSS" - (only visible if the "searchConfig" field of "rss" is specified; use "Save Source" to reset visibility if it changes during editing) the Feed Harvester can use javascript (and xpath) to create multiple documents out of a single received feed. This view shows only the javascript maintained in "rss.searchConfig.globals" - all of the logic can be written in here as separate functions, and then the scriptlets can be simple calls to these functions, to maximize the maintainability of the code in the source.
...
...
- Go to the file uploader , filter on JSON type "source", select your source
- Share with a community in which your collaborator belongs (and is at least a "content publisher" if you want him to make changes)
- If you want to provide him with the ability to make changes, set the read access
- Warning - there is no automatic synchronization, so if you both make changes at the same time work can be lost
Validating the Source Format
...
If run on the "JS-U" or "JS-S" tabs then the javascript in "structuredAnalysis.script" or "unstructuredAnalysis.script" is checked instead.
...
...
...
...
...
...
...
...
...
...
...
...
As can be seen from the above screen capture, the pop up contains 2 text elements:
...
Based off the results from testing, the source can then be refined until the desired functionality is obtained.
...
...
...
...
...
...
...
If you submit (publish) a new source or to a community you do not own, then it is initially added in a "pending" state. An email is sent to the community owners and moderators, and they are given the option of allowing the source or not.
Editing sources that have previously been approved may not require further moderation, if only display fields have been modified; otherwise it is suspended pending approval as above.
Note that once a source has been published, its status can be monitored from "<ROOT URL>/InfiniteSourceMonitor.html" (eg http://infinite.ikanow.com/InfiniteSourceMonitor.html), provided you are logged into the main GUI or source builder.
After publishing a share, you should get an alert saying that the source has been published and the working copy "share" has been deleted. If you don't get this alert, then it is likely that an internal configuration error has occurred - contact your system administrator to get it fixed.
...
...
...
"Scrubbing" sources
...
...
Enabling/disabling sources
Sources can be disabled by setting their "searchCycle_secs" to a negative number. This button just automates that process.
...
...
...
...
...
...
...
...
...
...
Monitoring sources
There is a graphical utility to monitor sources available from the home page (Source Monitor link). It opens in a new tab and is pictured below. It is not possible to change any source information from this GUI.
A subset of this information can also be accessed from the Source Manager dialog of the main GUI.
The colors have the following meanings:
- Green: successfully harvested ("success")
- Blue: in progress ("in_progress")
- (or has partially harvested, "success_iteration" - means that the most recent harvest cycle completed but not all available documents were harvested because of document/cycle limitations)
- Red: harvested with errors ("error")
- Yellow: not yet seen by a harvester, or currently unapproved.
If the colored "Status" column contains numbers, eg "0/20" then it is referring to the (beta) distributed source function - the left number is the number of "in progress" threads, and the right number is the total number of threads.
Suspended sources retain their color status but have "[SUSPENDED]" prepended to their title.
Panel |
---|
Related Reference Documentation: |