MacroHealth Internal

Lookup Cases

Looks up cases from the persistence system by their document lookup fields, status and/or caseFileId.

Widget
Lookup_Cases.png
Configuration
LookupCases_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 LookupCases.

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

    • lookupFieldsDocumentName: The name of the document in the runtime context that the lookup fields come from.

      Should resolve to a document with the below structure:

      "data": { 
  "docTypeA": {
    "lookup-field-name": "<value>",
    "lookup-field2-name": "<value2>",
    "...", "..."
  },
  "docTypeB": {
    "lookup-field-name": "<value>",
    "lookup-field2-name": "<value2>",
    "...", "..."
  },
  "...", "..."
}

    • statuses: The status of the document. If specified only documents in the given status will be returned. (See Section : “CaseTypes, DocTypes, and Status Events”)

      The status is expected in the following format:

      {
  "docTypeA": "SomeStatus",
  "docTypeB": "AnotherStatus"
}

    • caseFields: The caseFileId of an associated CaseFile. If specified only documents with the given case file ID will be returned.

      {
  "docTypeA": "shovelExpressionToGetCaseFileID",
  "docTypeB": "shovelExpressionToGetCaseFileID"
}

    • responseDocumentName: This is the document in the runtime context where the retrieved cases will be added.

    • splitBy: If None, all the retrieved documents will be added to the incoming runtime context in a document (with the name specified by responseDocumentName property).

      Note

      Selecting None will return all found cases in a single context document, this is not recommended if the number of cases is expected to be large.

      If PerCaseSingleDoc, this will copy the incoming context once for each case retrieved and add the case as a new document (with name specified by responseDocumentName property) in the context. This means that a runtime context will be output for each case retrieved.

      If PerCaseMultiDoc, this will copy the incoming context once for each case retrieved and add each document in the case as a new document (with name prefixed with responseDocumentName property) in the context. This means that a runtime context will be output for each case retrieved.

      PerCaseMultiDoc is the default setting.

    • latestOnly: If true, this will return only the latest (last created) documents within a case. This will also flatten the output so as not to return an array. True is the default .

    • docTypeFilter: This is a comma separated list of document types to return. If specified only the document types listed here will be returned.

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

    NotesTab.jpg

  3. Click Save.

    LookupCasesSave.png

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

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

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.

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.

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.

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 persistance object for metadata that may contain files and 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 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 persistance object for metadata that may contain files and 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.

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.