Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Source management is intrinsically a complex process (particularly when taking advantage of Infinit.e's customization engine). 

The Infinit.e.Manager GUI Sources page provides a simple interface for adding and testing new sources, saving templates for future sources, and managing existing ones. Future iterations of the tool will provide actual support for the difficult bits of source writing, such as writing Javascript and regexes.

...

To create a new source click on the New Source button in the upper right hand corner of the page. The Infinit.e.Manager application will forward you to the Create New Source page shown below:

Image Added

You have 2 options for creating a new source here:Image Removed

  1. 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.
  2. You can select a template to get you started as shown below

To create a source from a template, choose a dropdown option from the "Create a New Source" box.

Once you have selected a template, fill out the title/description/tags/community fields and click create source.  You will be able too modify the source on the next page before it starts running.

Image AddedImage Added

Once you've created your source you can follow these instructions for how to use the source builder.

Info

When copying an existing source into the New Source window, that existing source should be "scrubbed" first (middle right, "Scrub" button) - otherwise the presence of the "_id"/"key" fields will mean that the old source is modified instead of a new one being created.

 

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.

...

  • "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.
Info

By default only you can see your temporary copies of sources (so for example you cannot share links to sources being edited). You can use the file uploader to share in either read or read-write:

  • 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

...