MacroHealth Internal

Stage For External Sink

Marks the file to be sent to the indicated external service.

Note

This widget is now used in replacement of the previous "SFTP Sink" widget.

Widget
Stage_From_External_Sink.png
Configuration
Stage_From_External_Sink_Config.png

  1. Fill in the following fields:

    • Description: Allows changing the name that appears on the widget. This may be useful to quickly find a particular widget or distinguishing it from other similar shovel operation widgets when building large flows.

      Description.png

    • Shovel Operation: The name of the Shovel Operation. Pre-configured to StageForExternalSink.

    • Id: ID for this Shovel Operation. Needs to be unique within an integration in the format of a UUID. An online generator may be used to produce the ID. This is an arbitrary String value. (E.g., 9538e014-2f3a-4b7e-b9de-09eb37565e77)

    • connectionId: Unique identifier of the specific connection to source documents from. The configuration depends on the specific type of external destination, as identified by the connectionId field, e.i. the ID of the connection that was created in the Connections step. (See Section : “Adding a Connection”[→Adding a Connection]).

    • FileType: The file type. Can be any random string value. This value is used to organize/group out-going files.

    • FileStatus: The status of the file to persist. (See Section : “CaseTypes, DocTypes, and Status Events”)

    • fileMetadataDocumentName: The name of the Context Document that will be saved as a metadata as a file. This is an arbitrary String value. (E.g., the total number of claims in the file or the group control number of the file) Empty = none.

    • lookupFieldsDocumentName: The Context Document name to persist as file lookup fields. This document is used to save lookup fields to be used to search later on. Empty = none.

    When the connection is an SFTP connection:

    • directory: The specific directory to send files to.

    • readFromId: This is a uniquely generated ID used to associate this shovel operation with an SFTP sink.

    • destinationFileName: The name used to create the file within the sftp destination.

  2. If necessary, click the Notes tab and enter any relevant information.

    NotesTab.jpg

  3. Click Save.

    StageForExternalSinkSave.png

  4. The widget will be marked with a green check.

    StageForExternalSink.png
In this section:

A Shovel Operation is the simplest building block that can be used to build flows. Shovel Operations define configuration, inputs and outputs and are combined together in order to build more complex flows.

A Shovel Operation is the simplest building block that can be used to build flows. Shovel Operations define configuration, inputs and outputs and are combined together in order to build more complex flows.

An integration is a collection of platform flows that build a complete document processing solution.

  • raw, vendor supplied

  • nifi: flowfile in single mode

A field in json a document that contains all the information the is saved while the file is moving through the flow and that serves to make decisions at certain stages of that flow.

  • raw, vendor supplied

  • nifi: flowfile in single mode

A field in json a document that contains all the information the is saved while the file is moving through the flow and that serves to make decisions at certain stages of that flow.

Single json representation of a document in standard runtime. Documents are contained within a document context. Document also defines a type and associated metadata for the documents.

  • raw, vendor supplied

  • nifi: flowfile in single mode