{"id":6143,"date":"2025-10-31T11:58:48","date_gmt":"2025-10-31T08:58:48","guid":{"rendered":"https:\/\/help.bothelp.io\/?p=6143"},"modified":"2026-03-26T12:49:26","modified_gmt":"2026-03-26T09:49:26","slug":"shag-formula","status":"publish","type":"post","link":"https:\/\/help.bothelp.io\/en\/shag-formula\/","title":{"rendered":"Step formula"},"content":{"rendered":"

The \u201cFormula\u201d Step<\/strong> is a code editor block where you can perform logical and arithmetic operations, use built-in functions, and manage variables.
With it, you can assign values to fields and variables, calculate metrics, compare data, and build complex scenarios directly inside BotHelp.<\/p>\n

Where to Find It and How to Enable It<\/strong><\/h2>\n
    \n
  1. In the flow builder, select Add Step \u2192 Formula<\/strong>.<\/li>\n
  2. A code editor will open inside the step.<\/li>\n<\/ol>\n

    For convenience, you can use the expanded editing mode<\/strong> (the \u201cexpand\u201d icon).<\/p>\n

    How the \u201cFormula\u201d Step Works<\/strong><\/h2>\n
      \n
    1. The subscriber enters the step.<\/li>\n
    2. The code in the \u201cFormula\u201d editor is executed (from top to bottom, line by line).<\/li>\n
    3. If the execution is successful, the values are written to the selected variables, and the bot continues along the configured Next Step<\/strong> transition.<\/li>\n
    4. If an error occurs during execution (for example, division by zero, an empty value, or incompatible types), the execution stops at the line where the error occurred.
      The results from the lines that were successfully executed are saved, and the remaining code is not executed.
      After that, the subscriber proceeds to the next step via the Next Step<\/strong> transition.<\/li>\n<\/ol>\n
      \n
      \n
      \n
      \n
      \n
      \n

      Working with Variables<\/strong><\/h2>\n

      Inside the step, you can use variables of different types. They allow you to store and transfer values between steps, users, and bots.<\/p>\n

      There are three types available:<\/p>\n

        \n
      1. User Fields:<\/strong> available for reading and writing.
        Used with the prefix client.<\/code> or via {%variable_name%}<\/code>.
        Examples: client.price<\/code>, {%Position%}<\/code><\/li>\n
      2. Global Variables:<\/strong> available for reading and writing.
        Used with the prefix globals.<\/code> or via {@variable_name@}<\/code>.
        Examples: globals.order<\/code>, {@discount@}<\/code><\/li>\n
      3. Local Variables:<\/strong> used as helper variables and work only within a specific \u201cFormula\u201d step. Available for reading and writing.
        Used without a prefix.
        Example: age_years = 25<\/code><\/li>\n
      4. System Fields:<\/strong> UserId<\/code>, BotHelpId<\/code>, CUID<\/code> are read-only. Writing to them will cause an error.
        Accessible both with the client.<\/code> prefix (if applicable) and via macros.<\/li>\n<\/ol>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n

        Variable Naming Rules<\/strong><\/p>\n

        1. General Rules<\/p>\n

          \n
        1. A variable name can only start with a letter<\/strong>, not a number.
          \u2705 Sum1<\/code>\u2003\u2003\u274c 1Sum<\/code><\/li>\n<\/ol>\n