Add KeyView Extraction

The first step in this example ingestion pipeline is KeyView Extraction. Extraction extracts individual files from containers (such as zip files or other types of archives) so that they can be processed by other processors.

To add KeyView Extraction

  1. Add a processor, by dragging the processor icon from the components toolbar to the canvas.

    The Add Processor dialog box opens.

  2. In the Source list, click idol.nifi.

    The list of processors is filtered to those that are provided in the NiFi Ingest distribution.

  3. Select the KeyViewExtractFiles processor and click ADD.

    The processor is added to the canvas.

  4. Create a connection between the GetFileSystem connector and the KeyViewExtractFiles processor. Hover the mouse over the connector until you see the connection icon - - and then drag the icon to the KeyViewExtractFiles processor.

    The Create Connection dialog box opens.

  5. In the For Relationships area, select the success check box so that documents that were successfully retrieved are queued for extraction. Then, click ADD.

    The connection appears on the canvas. NiFi automatically adds a queue between the connector and the KeyViewExtractFiles processor.

    In its default configuration, the KeyViewExtractFiles processor creates new documents for extracted subfiles but does not extract subfiles recursively. This means that if a zip file contains another zip file, the second is not automatically extracted. The new (extracted) documents are routed to a relationship named subfile, so to extract subfiles recursively route this relationship back to the processor as described in the next step.

  6. Create a connection from the KeyViewExtractFiles processor to itself. Hover the mouse over the processor until you see the connection icon - - and then drag the icon away from and back to the processor.

    The Create Connection dialog box opens.

  7. In the For Relationships area, select the subfile check box and click ADD.

    The connection appears on the canvas. By default, the name above the queue (in this case "subfile") matches the relationship(s) that you selected.

  8. Right-click the KeyViewExtractFiles processor and click Configure.

    The Configure Processor dialog box opens.

  9. Click the Properties tab.
  10. In the properties list, set the IDOL License Service property to the name of the IDOL License Service that you created in Create a License Service.
  11. In the properties list, set the KeyView Filter Service property to the name of the service that you created in Add a KeyView Service.

    To find out more about this processor and the properties that you can set, see the documentation for the KeyViewExtractFiles processor.

  12. Click Apply.
_FT_HTML5_bannerTitle.htm