Skip to main content

Legacy Guide: Managing Variables in v1.x

Learn the traditional configuration and management logic for v1.x environments to ensure workflow stability and compatibility.

Sophie avatar
Written by Sophie
Updated yesterday

Version Compatibility: This guide is specifically for Octoparse AI 1.x. If you are using the latest version, please refer to our v2.0 Variable Implementation Guide is the interface and classification logic have been significantly updated.

The Variable Logic in v1.x

In Octoparse AI 1.x, variables are categorized based on who creates them and whether they are configurable:

  • Custom Variables: Manually created and defined by the user. These are the core tools for active data design.

  • Flow Variables: Automatically generated by the system or specific instructions (e.g., the output of a "Get Text" command). These are reactive products of the process and cannot be manually created or redefined.

Custom Variables: Creating Your Data Containers

All custom variables are managed via the Variables Panel on the right side of the editor.

Setup Steps:

  1. Click the [ + ] icon at the top of the variable list.

  2. Basic Configuration:

    1. Name: Assign a unique name for reference.

    2. Data Type: Choose between basic types: Text, Number, or Boolean. (Note: These are the types that can be exposed as startup parameters).

    3. Default Value: Set an initial value. This value is primarily used when running the flow in Test run mode within the editor.

Key Feature: "Set as Startup Parameter"

This is the core mechanism in v1.x for making a workflow configurable. It changes the scope of a custom variable:

  • Internal Variable (Default): When unchecked, the variable is only accessible within the flow logic.

  • Input Parameter (Checked): When "Set as Startup Parameter" is enabled, the variable becomes an external interface. When the app is run by a user, a dialog box will appear requesting the user to fill in this value.

Parameter Widgets

For Text type startup parameters, you can select user-friendly input controls:

  • Text Box / Multi-line Text Box

  • Folder Picker

  • Dropdown Menu (Single Select)

  • Date/Time Pickers

  • Password Box

Flow Variables: On-the-Fly Runtime Data

  • Nature: These are variables created automatically during execution, such as the result of a data extraction step.

  • Usage: In any input field that supports variables, click the variable button and look under the "Process" category.

  • Characteristics: You cannot manually create or modify their definitions. Their values update dynamically as the flow runs, serving as a window into the intermediate state of your automation.

Running and Debugging in v1.x

  • Production Run: When starting the app from "My Apps," the parameter window will pop up. Checking "Remember Content" will auto-fill values from the previous run.

  • Editor Debugging: When debugging inside the editor, the system will use the Default Value of the custom variable directly. The parameter popup will not appear in this mode.

Did this answer your question?