Get Entity Record by Reference

The Get Entity Record by Reference workflow action retrieves a specific record from an entity based on a reference ID. This action is useful for fetching records when you have a reference ID and need to access the record's details in the workflow.

Key Configuration Fields

• Name

  • Enter a unique name for this workflow action.

  • Validation Rules:

    1. The name must be unique.

    2. The name length must be between 2 and 100 characters.

    3. The name cannot be empty.

    4. The name cannot include special characters, or spaces, or start with a numeric character.

• Entity

  • Select from a list of all variables of type Entity available in the workflow context. This selection determines which entity’s record will be retrieved based on the provided reference ID.

  • Validation Rules:

    1. The entity field cannot be empty.

    2. The entity cannot be changed once the action is referenced in subsequent steps.

• Record ID

  • Specify the reference ID for the record you wish to retrieve. This ID should correspond to a record in the selected entity.

  • Validation Rules:

    1. The Record ID cannot be empty.

• Continue on Error (Optional)

  • A toggle allowing the workflow to continue even if an error occurs while retrieving the entity record. When set to True, the workflow will bypass the error and proceed without pausing.

Behavior After Configuration

Upon submission, the system retrieves the specified record based on the reference ID and puts the record’s properties into the workflow context. These properties become available for use in subsequent workflow actions.

Editing the Get Entity Record by Reference

• Fields

  • Always Disabled: Name field

  • Always Editable: Description field, Record ID field, Continue on Error toggle

  • Disabled Once Used or Referenced in Another Workflow Action: Entity field