Get Entity List (Activity)


  • Purpose: To retrieve a list or collection of data entities from the system's data store, potentially with filtering, sorting, and pagination.

  • Functionality: The "Get Entity List" activity allows you to query and retrieve multiple records or objects of a defined entity type. You would typically configure this activity with:
    • Entity Type: The type of entity to retrieve a list of (e.g., "Customer", "Order", "Product").
    • Filters/Criteria: Conditions to filter the entities to be retrieved (e.g., "get all orders placed in the last month", "get all customers with status 'active'").
    • Sorting: Specify how the retrieved list should be sorted (e.g., by date, by name, by ID).
    • Pagination (Potentially): Settings for retrieving data in pages or batches if the result set is large.
    • Output: The activity will output a list or collection of entity data, which can then be iterated over using looping activities or used for data aggregation and reporting.

  • Use Cases:
    • Data Reporting and Analytics: Retrieving lists of entities to generate reports, dashboards, or perform data analysis.
    • Populating Lists in Applications: Fetching lists of data to display in user interfaces (e.g., lists of customers, products, or tasks).
    • Bulk Processing of Entities: Retrieving a list of entities to be processed in bulk using looping activities like "For Each" or "Parallel For Each".