MacroHealth Internal

Search Enrollment Cases

Looks up existing enrollment data based on specified search fields.

Widget
Search_Enrolment_Cases.png
Configuration
Search_Enrolment_Cases_Config_2.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 SearchEnrollmentCases.

    • initialFilterDocName: The name of the runtime document containing the query query to apply as the initial filter. This is a arbitrary String value. E.g., a query to select all member records that came from a single file.

    • mostRecentMemberRecord: The default setting is False, however, it is suggested to set to True if the initial filter is not specific enough (or doesn’t exist) to return one record per member.

    • memberSort: A comma separated list of LookupField names and sort direction. When member records for the same memberId are sorted in this way, the first record should be the most recent.

      Example:

      sourceFileTimestamp=-1, TsSequenceInFile=-1, memberSequenceInTs=-1)

    • documentType: The document type to retrieve, eg.,: OutgoingEnrollment. (See Section : “CaseTypes, DocTypes, and Status Events”)

    • CaseType: The case type to retrieve, e.g., Enrollment. (See Section : “CaseTypes, DocTypes, and Status Events”)

    • responseDocumentName: The name of the document that will be added to the Context Document, where the retrieved cases will be added. This is an arbitrary String value.

    • queryBatchSize: The number of results to return in each page of data. The default is 1000.

    • outputSortField: LookupField used to sort the output followed by sort direction in the form of sequenceInFile=1. This will determine the sorting order of how the results will come in (e,g,. timestamp=1).

      Note

      1 represents an ascending order, while -1 represents a descending order.

    • transactionSetGroupField: The LookupField used to group member records together into a transaction set.

      Example:

      subscriberId

      Note

      If you want to have one output flow file per each member record you need to set this to a field that returns an unique value.

    • transactionSetSortField: The name of the LookupField used to sort member records within a transaction set followed by a sort direction. This is an arbitrary String value.

      Example:

      loopSplitFragmentIndex=1

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

    NotesTab.jpg

  3. Click Save.

    SearchEnrollCasesGC.png

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

    SearchEnrollCasesSave.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.

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

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.

A persistance object for metadata that may contain files and documents.

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.

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.