https://step.dev/knowledgebase/31/categories/plan-editor/ Recent content in Plan Editor on Step Documentation Hugo -- gohugo.io en Mon, 19 Oct 2026 00:00:00 +0000 https://step.dev/knowledgebase/31/userdocs/plans/keywords-in-plans/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/userdocs/plans/keywords-in-plans/ Keywords serve as the fundamental building blocks for implementing automation. From a business perspective, a Keyword symbolizes a functionality to be automated. It might represent a fully automated flow or be as simple as a single user action or service call. A Plan represents an automated scenario and will normally consist of one or more Keywords. Whenever a Keyword is encountered during Plan execution, it leads to a Keyword call. This section focuses on the usage of Keywords within a Plan. https://step.dev/knowledgebase/31/libraries/plans_lib/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/libraries/plans_lib/ All of the plans documented in this section can be downloaded and then imported into your own private instance by following this procedure. Basics Here are a few basic, yet non-trivial plans which will help you get started with the most useful and common constructs. We will be practicing with a very simple source type called “Json String”, which will help us distribute data across iterations and threads. We can pass an arbitrary array of Json objects and then access them object by object. https://step.dev/knowledgebase/31/devops/step-studio/ Mon, 19 Oct 2026 00:00:00 +0000 https://step.dev/knowledgebase/31/devops/step-studio/ Step Studio brings the visual editors of the Step platform to your local machine. It lets you create and maintain Automation Packages, execute Plans locally, and execute or deploy your automation on a remote Step instance. Studio works directly on the Automation Package files in your project, including its YAML descriptor and Plan fragments, alongside the source code and resources used by your Keywords. You can use Studio and your IDE on the same project without maintaining separate copies of the automation. https://step.dev/knowledgebase/31/userdocs/plans/controls/ Thu, 23 May 2019 07:00:01 +0100 https://step.dev/knowledgebase/31/userdocs/plans/controls/ Step supports a wide range of so-called controls to build-up complex flows in Plans. The supported controls range from classical control structures (like if blocks, loops, etc) to use-case specific controls like thread groups for load-testing, data-sets, etc. This page provides details about all the controls supported by Step. General controls Set The Set control allows to define a variable and assign it a value. Variables defined with Set controls can be accessed according to their scope throughout Plans and sub Plans. https://step.dev/knowledgebase/31/libraries/groovy_lib/ Wed, 22 May 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/libraries/groovy_lib/ Select For Update (atomic transaction) Below an example of Groovy script used to open an sql connection, update a column of the first row of a table, then close the connection. sql = groovy.sql.Sql.newInstance('jdbc:mysql://localhost/step','step','init') sql.execute('begin') sql.firstRow('select myColumn from myTable for update')[0] sql.execute('update myTable set myColumn = myColumn + 1'); sql.execute('commit') sql.close() Copy a file from a path to another java.nio.file.Files.copy(java.nio.file.Paths.get(file), java.nio.file.Paths.get(file+'2')) REST call with JSON response response = new URL("http://localhost:8080/rest/grid/agent").text json = new com. https://step.dev/knowledgebase/31/userdocs/plans/plans-variables/ Thu, 23 May 2019 07:00:01 +0100 https://step.dev/knowledgebase/31/userdocs/plans/plans-variables/ Variables are used throughout plans to pass information from one node to another, or to store the result of a dynamic computation. Variable types Similar to any programming language, Step supports the use of variables in Plans. The variables declared and used in a Plan are called Plan variables. A Plan variable is a container that stores a data value under a specific name. Like in classical programming languages, Step supports the following types of variables: https://step.dev/knowledgebase/31/devops/automation-package-yaml/ Wed, 22 May 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/devops/automation-package-yaml/ Automation Packages are defined in a declarative way using YAML alongside the automation code. The Step Automation Package YAML syntax is specified by the Automation Package JSON schema, for more convenient work you can configure the embedded file editor in your IDE (IntelliJ IDEA or Visual Studio) to associate this schema with the Step YAML automation packages. For Java Automation Packages, it is possible to directly declare certain entities in the code in addition to the YAML descriptor. https://step.dev/knowledgebase/31/userdocs/plans/other-plans/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/userdocs/plans/other-plans/ Calling another Plan To enable modular design of Plans Step makes it possible to recursively call other Plans. Using the Visual Plan Editor you can easily call other Plans using the tab “Other plans” from the component list: Using the plain-text syntax other plans can be called using the following syntax Call plan "Test Case 01" Call plan "Test Case 02" Call plan "Test Case 03" Composite Keywords You can also achieve modularity using so called composite keywords. https://step.dev/knowledgebase/31/userdocs/plans/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/userdocs/plans/ A Plan in Step is the implementation of an automation scenario such as a functional test case, a load test, an RPA routine, or a synthetic monitoring probe. Plans combine building blocks called Keywords with various controls that build up the execution logic of the automation scenario. As a beginner, make sure to understand the key concepts explained in the following sections before creating your first Plan. You will also find various ways to create different types of Plans in our tutorials. https://step.dev/knowledgebase/31/userdocs/plans/visual_plan_editor/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/userdocs/plans/visual_plan_editor/ The Visual plan editor is the most basic and straight-forward way to create a Plan in Step. When using the Visual interface, you create your Plan in a code-free intuitive editor that gives instant access to the libraries of available Keywords and Controls. Using the Visual interface makes it possible to create a Plan in an intuitive manner without technical skills and prior knowledge of Step. It is also well-suited for complex automation plans which require a visual representation of the Plan. https://step.dev/knowledgebase/31/userdocs/plans/plaintext_plans/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/userdocs/plans/plaintext_plans/ In addition to the Visual Plan editor Step comes along with a full-featured parser which enables the creation of Plans using a plain-text human-friendly syntax. The plain-text format has different advantages over the Visual interface. Using the plain-text format makes it possible to manage Plans in a same manner as code and thus enables the use of version control system like git, text editors, etc. It also enables the integration with classical Test-Management Tools initially developed for manual test specification and thus based on plain-text test-cases specifications. https://step.dev/knowledgebase/31/userdocs/parameters/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/userdocs/parameters/ Parameters are centrally defined variables that can be accessed by both Keywords and Plans in Step. They offer several key capabilities: Scope Assignment: Parameters can be assigned to specific scopes, restricting their visibility and access to certain applications or keywords. Protection of Sensitive Parameters: Sensitive parameters can be protected to hide their values from users, ensuring secure handling of critical data. Activation Expressions: Parameters can be dynamically assigned or mapped to specific environments, users, or other conditions using activation expressions. https://step.dev/knowledgebase/31/setup/configuration/customization/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/setup/configuration/customization/ Cosmetics Cosmetics customization is only available as part of step enterprise Customization of step’s static resources (images, stylesheets, …) is made possible in a generic way using the two following properties: cosmetics.folder: This property points to a local folder on the controller’s host in which alternate cosmetic resources are stored (conf/cosmetics/ by default). cosmetics.interceptedResourceList: A comma-separated list of resources which are supposed to be replaces with custom resources. Defaults to step-variables. https://step.dev/knowledgebase/31/userdocs/ Wed, 13 Feb 2019 00:00:00 +0000 https://step.dev/knowledgebase/31/userdocs/ This section groups the documentation related to the use of Step. If you’re using Step for the first time, it is recommended to get started with on the tutorials