https://step.dev/knowledgebase/30/userdocs/ Recent content in User guide on Step Documentation Hugo -- gohugo.io en Wed, 13 Feb 2019 00:00:00 +0000 https://step.dev/knowledgebase/30/userdocs/automation-package-ui/ Mon, 24 Nov 2025 08:08:01 +0100 https://step.dev/knowledgebase/30/userdocs/automation-package-ui/ While Automation Packages are primarily designed to be created, deployed, and executed through the CLI or Maven plugin as part of a CI/CD workflow, the Step UI also provides convenient tools to deploy and execute Automation Packages and their libraries directly. The UI is additionally the only place where you can view, inspect, and delete deployed Automation Packages and libraries, and where certain package-specific configuration options, such as routing rules or screen templates, are available. https://step.dev/knowledgebase/30/userdocs/agent-provisioning/ Mon, 30 Sep 2024 00:00:00 +0000 https://step.dev/knowledgebase/30/userdocs/agent-provisioning/ When running in Kubernetes, Step supports automatic provisioning of Agents (i.e. automatic provisioning of the containers responsible for executing Keywords) across multiple Kubernetes clusters. This page explains how to utilize Agent provisioning in Plans. For information on enabling or configuring Agent provisioning, please refer to the Agent Provisioning configuration page. How it works In a nutshell, the automatic Agent provisioning works as follows: Upon execution, Plans are scanned to determine the required Agents for execution Based on the calculation and the available Agent pools, the optimal number of Agents per Agent pool is calculated The required Agents are provisioned across the clusters of the selected Agent pools Once the Agents have joined the grid, the execution starts After execution, the agents are de-provisioned Configure provisioning settings in Plans When Agent provisioning is enabled in Step, users can configure the Agent provisioning settings in each plan (in the UI and in the automation packages). https://step.dev/knowledgebase/30/userdocs/schedulerview/ Sun, 29 Nov 2020 14:08:01 +0100 https://step.dev/knowledgebase/30/userdocs/schedulerview/ Schedules allow to configure the recurring or one-time execution of Plans, enabling automated, time-based workflow execution for tasks like synthetic monitoring and beyond. For the schedules to work correctly, ensure to properly set up the controller’s machine timezone before you start it. Description Let’s describe the Step schedules view: You can access it by clicking “Schedules” on the sidebar menu: Here is the column description: Name (1): the name of the schedule. https://step.dev/knowledgebase/30/userdocs/incidents/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/30/userdocs/incidents/ Incidents are used to be aware of problems in the infrastructure: for instance, Step can periodically run plans which test the behavior of a system. When these plans fail to execute correctly, or (user-defined) assertions concerning the performance do not hold, this constitutes an incident. Step allows incidents to be automatically created and managed according to user-defined alerting rules. These rules are evaluated in response to various events (most notably after every plan execution). https://step.dev/knowledgebase/30/userdocs/monitoringview/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/30/userdocs/monitoringview/ If you’ve purchased the Monitoring package or are running the Premium Enterprise version of Step, you’ll be able to view the status of your Plans scheduled entries. This is very useful for the purpose of building a monitoring dashboard that would be exposed to a support team. Monitoring View To open it select Reporting -> Monitoring in the sidebar menu. Name (2): the name of the Scheduler that is monitored - clicking it opens the schedules execution report Plan Link (3) navigate to the connected plan by clicking on the file icon next to the name Cron Expression (4): the expression used in the Plan scheduling entry Last execution (5): the last executions end date-time - clicking on the date navigates to that execution Last status change (6): the last time the Plan execution overall status has changed (from FAILED to PASSED for instance) Status (7): the last Plan execution status Action: execute (8), edit (9), or analyze (10) the Schedule Select which plans to monitor (1) The Monitoring View displays an entry for each Scheduler, so in order to monitor a plan it needs to have a scheduled execution. https://step.dev/knowledgebase/30/userdocs/parameters/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/30/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/30/userdocs/eventbrokermonitor/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/30/userdocs/eventbrokermonitor/ If you’ve purchased the Async package or are running the Premium Enterprise version of Step, you’ll be able to monitor in real time what’s happening in the EventBroker by navigating to the EventBrokerMonitor view: The Stats tab provides global statistics on the broker, such as the current amount of messages present in it and the high mark (or water mark), oldest & youngest events, etc. The next two tabs provide users with the ability to browse and search for events, and organizes the query results either by Id or Group. https://step.dev/knowledgebase/30/userdocs/import-export-entities/ Fri, 02 Oct 2020 08:08:01 +0100 https://step.dev/knowledgebase/30/userdocs/import-export-entities/ You may export the following entities: Plans Keywords Parameters The functionalities are similar for all supported types of entities. Export Export a single entity Export can be performed from the related table views using the actions buttons. For plans, single entity can also be exported from the Plan editor, click on the export button as shown in the following screenshot: Export all entities of one type Step also lets you export all entities of one type. https://step.dev/knowledgebase/30/userdocs/userpreferences/ Sun, 29 Nov 2020 14:08:01 +0100 https://step.dev/knowledgebase/30/userdocs/userpreferences/ User Settings Credentials and preferences can be defined from the User Settings page. Click on your username on the top right box, then on “User Settings”: User Credentials and API keys On the “User Settings”, you can modify your password as well as generate and revoke Api keys. Generate an API Key API keys are used to authenticate with Step when accessing the Step API, whether through direct REST calls, the Step client, or the CLI. https://step.dev/knowledgebase/30/userdocs/versioning/ Sun, 29 Nov 2020 14:08:01 +0100 https://step.dev/knowledgebase/30/userdocs/versioning/ Versioning is a feature to restore a previous version of an entity in Step Enterprise. This can be helpful to undo unintended changes or to revert a breaking change. How versioning works in Step Versioning is currently supported for the following entities: Plan Parameter Step automatically saves changes to these entities, aggregated to 1-minute intervals. This aggregation ensures, that a lot of small changes within a minute will only show as one change in the version history. https://step.dev/knowledgebase/30/userdocs/live-reporting/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/30/userdocs/live-reporting/ Live Reporting allows to obtain keyword data such as measurements, metrics, or attachments (for instance log files) in real time, while a keyword is running. Introduced in Step 29 for K6 and custom Java keywords, Live Reporting will see further improvements, such as .Net and nodeJS keywords support, in upcoming Step versions. Overview Traditionally, all keyword results, such as attachments or measurements, are gathered while a keyword is running, then returned once the execution is finished. https://step.dev/knowledgebase/30/userdocs/bookmarks/ Fri, 10 May 2024 14:08:01 +0100 https://step.dev/knowledgebase/30/userdocs/bookmarks/ Create bookmarks to easily reach frequently used pages over different projects Creating bookmarks (1) Navigate to any Step page that is frequently used by clicking the bookmark icon while the page is open. Select a name that describes the Project / Page combination. Manage bookmarks (2) Remove or rename bookmarks Open bookmark (3) Click the bookmark under the bookmarks category to open the page in the correct project