Yola Script

The Proto script and template language provides users with the ability to utilize simple scripting for data manipulation within the platform. This includes processing JSON API responses, modifying values in the Modify Variable block, and adding conditions in the Branch block, among other functionalities.

Proto Script

You can use Proto Script in the following actions:

Bot Message
Branch
Carousel
Create Case
Email
JSON API
Hyperlink
Modify Variable
Survey

Proto Script Delimiter

{ … } - to print out the variable/script values

Requires { … } delimiter

Bot Message
Carousel
Create Case
Email
Hyperlink
Survey

Do not require { … } delimiter

Branch
JSON API
Modify Variable

Proto Script

`_.dt_diff(datetime1, datetime2, unit)`

Calculates the difference between two datetime objects and returns the result in the specified time unit. Unit - d for day, h for hour, m for minute, s for second.

Example

dt1 = datetime.datetime(2022, 4, 12, 12, 0, 0)
dt2 = datetime.datetime(2022, 4, 11, 12, 0, 0)

seconds_diff = _.dt_diff(dt1, dt2,'s')
Output: 86400

hours_diff = _.dt_diff(dt1, dt2,'h')
Output: 24

`_.fmt(string, value)`

Formats the specified value(s) and insert them inside the string's placeholder.

Example

_.fmt("Hello, %s!", "world")
Output: "Hello, world!"

`_.format_time(datetime, format, timezone)`

Format datetime.

Example

_.format_time(datetime.datetime.now(), "%Y-%m-%d %H:%M:%S", "America/New_York"))
Output: Formatted time in New York timezone

 _.formatTime(_.str2datetime(timestamp), '%Y-%m-%d %H:%M:%S', 'America/Toronto')
Output: Formatted time in Toronto timezone

`_.join(separator, items)`

Join all items in a tuple into a string, using a character as a separator.

Example

items = ["apple", "banana"", "cherry"]
_.join("", "", items)
Output: "apple, banana, cherry"

`_.json_parse(data)`

Parses a JSON string and returns a Python object.

Example

json_data = '{"name": "Alice", "age": 25}'
_.json_parse(json_data)
Output: {'name': 'Alice', 'age': 25}

`_.json_stringify(data)`

Serializes Python objects into JSON format. It returns a JSON string representing the input data.

Example

data = {"name": "John", "age": 30}
_.json_stringify(data)
Output: '{"name": "John", "age": 30}'

`_.len(x)`

The number of characters in a variable.

Example

_.len("hello")
Output: 5

`_.lower(string)`

Convert string to lowercase.

Example

_.lower("WORLD")
Output: "world"

`_.now(timezone, format)`

Retrieves the current date and time in the Coordinated Universal Time (UTC) timezone. If a timezone is define, it would display the current year and hour based on the timezone, formatted as a string. If a dateime format code is define, it will output based on the format set.

Example

_.now()
Output: Current date and time in UTC timezone

example time now at Manila is 2024-04-15 10:30:00
_.now('Asia/Manila', '%Y %H')
Output: 2024 10

`_.replace(string, search, replacement)`

Replaces a specified phrase with another specified phrase.

Example

_.replace("hello world", "world", "universe")
Output: "hello universe"

`_.split(string, separator)`

Split a string into a list where each word is a list item.

Example

string = "apple, banana, cherry"
_.split(string, "", "")
Output: ['apple', 'banana', 'cherry']

`_.str2datetime(timestring, format)`

Convert string to datetime.

Example

_.str2datetime("2023-12-25"))
Output: 2023-12-25 00:00:00

`_.upper(string)`

Convert string to uppercase.

Example

_.upper("hello))  
Output: "HELLO"

`_.as_int(string)`

Convert string to integer.

Example

_.as_int("10") 
Output: 10

`_.as_float(string)`

Convert string to float.

Example

_.as_float("3.14")
Output: 3.14

`_.as_str(string)`

Convert specified value to string.

Example

_.as_str(42))
Output: "42"

`_.round_num(number,precision)`

Returns a floating point number that is a rounded version of the specified number.

Example

_.round_num(3.14159, 2) 
Output: 3.14

`_.random_num(min,max)`

Returns an integer number selected element from the specified range.

Example

_.random_num(1, 10)
Output: Random integer between 1 and 10

`_.random_choice(list)`

Returns a randomly selected element from the specified sequence. The sequence can be a string, a range, a list, a tuple, or any other kind of sequence.

Example

_.random_choice(["apple", "banana", "cherry"])
Output: Randomly chosen item from the list

`_.match_pattern(string, pattern)`

Search the regular expression pattern and return the first occurrence.

Example

email = "example@email.com"
pattern = r"^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$"
_.match_pattern(email,pattern)

`_.obj_keys(dictionary)`

Takes a dictionary as input and returns a list containing all the keys from the input dictionary.

Example

my_dict = {'a': 1, 'b': 2, 'c': 3}
result = _.obj_keys(my_dict)
Output: [a, b, c]

`_.obj_values(dictionary)`

Takes a dictionary as input and returns a list containing all the values from the input dictionary.

Example

my_dict = {'a': 1, 'b': 2, 'c': 3}
result = _.obj_values(my_dict)
Output: [1, 2, 3]

`_.get(dictionary, path)`

Retrieves the value at a specified path within a nested dictionary or list.

Example

object = {
    'a': [
        {'b': {'c': 3}}
    ]
}

 _.get(object, 'a')
Output: [{'b': {'c': 3}}]

 _.get(object, 'a[0].b.c')
Output: 3

_.get(object, ['a', '0', 'b', 'c'])
Output: 3

`_.map_get(list[dict], path)`

Maps the get function over a list of dictionaries. It retrieves the value at a specified path within each dictionary in the list.

Example

list_d = [
    {'a': {'b': 1}},
    {'a': {'b': 2}},
    {'a': {'b': 3}}
]

_.map_get(list_d, 'a.b')
Output: [1, 2, 3]

PreviousChatbots NextVariables