Dictionary

The Dictionary component allows creating, updating and querying records within custom tables in the system.

It enables the manipulation of structured data, allowing greater flexibility to store and retrieve information with specific filters and parameters.

With it, it is possible to add new records to the dictionary, modify existing data, remove records, search for information by ID, and perform advanced queries filtering multiple criteria.

📂 Available Operations

Here are the operations that can be performed with this component:

Operation

Description

Create (create)

Adds a new record to the dictionary.

Update (update)

Modifies the data of an existing record.

Delete

Removes a record from the dictionary.

Get by ID (get_by_id)

Gets the details of a specific record.

Search by filter (get_by_filter)

Gets a list of records filtered by criteria.

📑 Variables Used in the Component

Below are the variables used in the component Dictionary, including their data types and whether they are required.

Field

Data Type

Required?

Description

Workspace ID

string

✅ Yes

Workspace ID where the dictionary table is located.

Table Name

string

✅ Yes

Identifier of the table in the dictionary where the data is stored.

Record ID

string

❌ No

Unique identifier of the record in the dictionary. Required for operations that manipulate a specific item.

Fields (JSON)

object

✅ Yes

Structure containing the data of the record to be created or updated.

Filter Method

string

❌ No

Defines whether the search by filter will be performed using the dictionary fields or via direct query.

Filter Parameters

object

❌ No

Structure containing the filters applied to the dictionary query.

Sorting

string

❌ No

Defines the sorting criterion of the returned records.

Sort Direction

string

❌ No

Indicates whether the sorting will be ascending (asc) or descending (desc).

Pagination (Page)

number

❌ No

Page number to be retrieved in the search by filter.

Pagination (Limit)

number

❌ No

Maximum number of records to be returned per page.

🎯 How to Configure an Operation

1️⃣ Access the Component

  1. In Hablla Studio, open the automation flow where you want to include the action.

  2. Add the block "Dictionary".

  3. In right side panel, select the desired operation.

2️⃣ Fill in the Required Fields

Depending on the chosen operation, some fields are mandatory. Consult the variables table above to understand which data must be filled in for each operation.

3️⃣ Save the Configuration

After filling in the fields, click the "Save" ✅.

Now, whenever this automation is triggered, the dictionary records will be managed according to the defined configuration.

📝 Operation Details

Each operation has required and optional fields that must be filled in as needed. Below, we will detail each of them:

1️⃣ Create Record in Dictionary 2️⃣ Update Record in Dictionary 3️⃣ Delete Record from Dictionary 4️⃣ Get Record by ID 5️⃣ Get Records by Filter

🚀 Continue to the next topics to configure each operation correctly!

Last updated

Was this helpful?