Package Documentation

Storm Package: synapse-orkl

The following Commands are available from this package. This documentation is generated for version 0.2.1 of the package.

Storm Commands

This package implements the following Storm Commands.

orkl.report.feed

Ingest a feed of ORKL reports.

This command will automatically store progress of the ingest,
starting first with ingesting all available records and then
proceeding to use the created date to ingest new records.
The use of the created date is due to a limitation of the API,
however if new reports are encountered with orkl.report.search
they will be updated.

It is recommended to create a single cron job to run this command
so that results are contiguous in the view it is running.

If available, the report PDFs will also be downloaded and parsed
using Synapse-FileParser.

Examples:

  // Ingest all reports records
  orkl.report.feed

  // Create a cron job to ingest new results every day
  cron.add --name orkl.report.feed --hour 3 { orkl.report.feed }

  // Reset the stored progress and ingest records from index 0
  orkl.report.feed --reset


Usage: orkl.report.feed [options]

Options:

  --help                      : Display the command usage.
  --debug                     : Show verbose debug output.
  --yield                     : Yield the newly created nodes.
  --reset                     : Reset the stored progress offset.

orkl.report.search

Search and ingest ORKL reports.

This command will also create an it:exec:query node to represent the
query syntax and link resulting nodes to it via -(found)> edges.

If available, the report PDFs will also be downloaded and parsed
using Synapse-FileParser.

Examples:

  // Search by a keyword and yield media:news nodes
  orkl.report.search log4j --yield


Usage: orkl.report.search [options] <query>

Options:

  --help                      : Display the command usage.
  --debug                     : Show verbose debug output.
  --size <size>               : Limit the number of results ingested to the given size (per-node).
  --yield                     : Yield the newly created nodes.

Arguments:

  <query>                     : The query string.

orkl.setup.tagprefix

Set the tag prefix used when recording ORKL data as tags.
The default tag prefix is "rep.orkl" if not specified.

Any tags provided by the ORKL API will be added within the given namespace.
For example, the item "foo" would result in "#rep.orkl.foo".  Any
characters incompatible with tag names are replaced with "_".

Usage: orkl.setup.tagprefix [options] <tagname>

Options:

  --help                      : Display the command usage.

Arguments:

  <tagname>                   : The tag prefix to use.

Storm Modules

This package does not export any Storm APIs.