Definition

The List Records by Id action retrieves specific records from a Zenphi data model table by their unique record IDs. This action is particularly useful for fetching targeted data from your table and returning only the fields you need. With its selective retrieval and flexibility, it streamlines processes by providing precise data for further automation steps.

Example Use Cases

1. Fetch Specific Customer Data

Retrieve customer details from a table by their unique record IDs to personalize email communication or generate reports.

2. Update Targeted Records

Use the action to fetch records that need updates and pass them to subsequent actions for modifications.

3. Generate Custom Reports

Retrieve only the required fields from specific records to create tailored reports or dashboards.

4. Verify Record Existence

Quickly confirm whether specific record IDs exist in a table before proceeding with additional workflow steps.

Inputs

1. Table

• Description: Select the Zenphi Table from which you want to retrieve records.
• Purpose: Specifies the data model table to query.
• How to Use: Choose an existing table from the dropdown menu or search for it by name.

2. Record Ids

• Description: Provide the unique identifiers (IDs) of the records you want to retrieve.
• Purpose: Determines which specific records will be fetched from the table.
• How to Use: Enter one or more record IDs, separated by commas if multiple records are needed.

3. Select Fields to Return

• Description: Choose the specific fields you want to include in the output.
• Purpose: Limits the data retrieved to only the fields you need, improving efficiency.
• How to Use: Use the dropdown to select one or more fields.

Step-by-Step Guide

1. Add the Action to Your Flow

   • Drag and drop the "List Records by Id" action into your flow where you need to fetch specific records.

2. Select the Table

   • In the Table field, choose the appropriate Zenphi table from which you want to retrieve records. This table should already contain the records you're targeting.

3. Provide Record IDs

   • In the Record Ids field, enter the unique IDs of the records you wish to fetch. You can input multiple IDs separated by commas if you need to retrieve several records at once.

4. Choose Fields to Return

   • In the Select Fields to Return field, select the specific fields you want to retrieve from the records. If you need all the fields, you can leave this field blank. Otherwise, choose only the relevant fields for your use case.

5. Connect Further Actions

   • After retrieving the records, you can connect this action to other actions in your flow, using the retrieved data as input for further processing, updates, or decisions.

6. Run the Flow

   • Once everything is set up, run the flow. The action will fetch the specified records from the selected table, based on the provided record IDs, and only the selected fields will be returned.

By following these steps, you can efficiently retrieve specific records from a Zenphi table and use the data within your workflow.

Outputs

The List Records by Id action provides the following output:

• Result with Items
  • This output returns the records that match the specified record IDs from the table. The result will include the fields you selected in the "Select fields to return" field.
  • Structure: The output is typically a collection or array of records, where each record is an object containing the field values you requested.
  • Use Case: You can use this output to extract and process specific data, such as updating records, triggering conditions based on retrieved data, or sending the data to other actions within your flow.
  • Example: If you requested the "Name" and "Email" fields, the output will contain the names and emails of the records with the specified IDs.

This output is crucial for working with data from Zenphi tables, allowing you to retrieve and manipulate records dynamically within your workflow.