https://step.dev/knowledgebase/30/categories/plugins/ Recent content in Plugins on Step Documentation Hugo -- gohugo.io en Wed, 29 Mar 2023 08:00:00 +0000 https://step.dev/knowledgebase/30/plugins/analytics-integrations/jdbc/ Wed, 17 Mar 2021 14:24:01 +0100 https://step.dev/knowledgebase/30/plugins/analytics-integrations/jdbc/ The JDBC plugin writes Step measurements to a SQL-based database such as PostgreSQL or MySQL. This allows you to query and visualize Step execution data using any SQL-compatible tool. The JDBC plugin exports measurements only — it does not export keyword-emitted metrics (counters, gauges, histograms). For full metrics export, use the Prometheus or Metrics Logger integration. The plugin has been tested with PostgreSQL 12 and MySQL 8. Data model Since keywords in Step can carry arbitrary custom attributes, each measurement contains a set of fixed fields and an open-ended set of custom fields: https://step.dev/knowledgebase/30/plugins/dotnetagent/ Wed, 10 Apr 2019 14:24:01 +0100 https://step.dev/knowledgebase/30/plugins/dotnetagent/ .NET Plugin Installation Installation Follow this link to install the .NET Step Agent : .NET Agent installation Keyword Project .NET Solution To create new keywords for the .NET agent with Visual Studio Solution, you must first create a new Console Application project in Visual Studio: You will then be able to choose between the latest .NET 5.0 framework or the legacy 4.x version (please note that only the latest 4.x version of the framework is tested before the release). https://step.dev/knowledgebase/30/plugins/ Wed, 13 Feb 2019 00:00:00 +0000 https://step.dev/knowledgebase/30/plugins/ Documentation of Step additional plugins https://step.dev/knowledgebase/30/plugins/analytics-integrations/prometheus/ Wed, 17 Mar 2021 14:24:01 +0100 https://step.dev/knowledgebase/30/plugins/analytics-integrations/prometheus/ Prometheus is a popular open-source monitoring and alerting system. The Step Prometheus plugin exposes measurements and metrics at a scrape endpoint that Prometheus polls at regular intervals. In addition to Step execution data, the plugin also exposes JVM and Jetty metrics for internal controller monitoring. Note that while not directly related to this plugin, other Step components such as the Grid proxy and Java agents can also expose these metrics to Prometheus via their own configuration. https://step.dev/knowledgebase/30/plugins/astra/ Wed, 10 Apr 2019 14:24:01 +0100 https://step.dev/knowledgebase/30/plugins/astra/ Astra is a next-generation automation solution for web applications. It enables fast and intuitive automation of web application using a no-code approach. Its modern AI-based recorder allows the recording of any web applications in just a few clicks. The Astra plugin for Step seamlessly integrates the Astra recorder and allows direct recording within Step. The combined power of Step and Astra enables instant creation of load tests, synthetic monitoring and RPA routines without writing a single line of code. https://step.dev/knowledgebase/30/plugins/cypress/ Wed, 10 Apr 2019 14:24:01 +0100 https://step.dev/knowledgebase/30/plugins/cypress/ This page describes how to install, configure and use the Step plugin for Cypress. The Cypress plugin allows you to declare Step Keywords that run Cypress specs or commands and thus leverage the combined power of Step and Cypress. Installation The Cypress plugin is enabled by default for the Enterprise and SaaS versions of Step. To use the plugin you simply have to install Node.js on the Step Agents you’ll want to run Cypress Keywords on. https://step.dev/knowledgebase/30/plugins/k6/ Wed, 10 Apr 2019 14:24:01 +0100 https://step.dev/knowledgebase/30/plugins/k6/ Grafana k6 is a powerful, open-source load testing tool developed by Grafana Labs. It is widely used for scripting and executing performance tests with high efficiency and developer-friendly ergonomics. The k6 plugin for Step enables seamless integration of existing k6 scripts into the Step platform, unlocking a broader range of automation capabilities. This integration allows users to combine the strengths of both tools, leveraging k6’s expressive scripting model alongside Step’s orchestration, scheduling, and extensibility. https://step.dev/knowledgebase/30/plugins/nodejs/ Wed, 10 Apr 2019 14:24:01 +0100 https://step.dev/knowledgebase/30/plugins/nodejs/ Agent Setup Installation Follow this link to install the NodeJS Step Agent : NodeJS Agent installation Validation You can now test the installation by first running the following command in a shell: You can check in Status -> Token Groups on the Step UI that a new agent of type “node” appears: Troubleshooting If you forget to pass the configuration file, the following error will be displayed: If you have the following error: This can mean that: https://step.dev/knowledgebase/30/plugins/sikulix/ Wed, 10 Apr 2019 14:24:01 +0100 https://step.dev/knowledgebase/30/plugins/sikulix/ SikuliX is a simple but efficient open source tool for UI automation. It provides an intuitive IDE to record and replay UI automation scripts based on image and text recognition. The SikuliX plugin for Step enables the out-of-the-box integration of SikuliX scripts in Step. The combined power of Step and SikuliX enables all-round UI automation at scale and makes it possible to create simple UI automation scripts and use them for Synthetic Monitoring, RPA, Performance Tests and all other features covered by Step. https://step.dev/knowledgebase/30/plugins/silk-performer/ Wed, 10 Apr 2019 14:24:01 +0100 https://step.dev/knowledgebase/30/plugins/silk-performer/ Silk Performer is a load testing tool by openText. Step can execute Silk Performer projects via a dedicated plugin available to Step enterprise customers. This page describes how to configure and use this plugins. Installation Before using this plugin, the Complete Installation of Silk Performer has to be done on the machine running your agents. Finally, you will specify the installation folder of Silk performer in the AgentConf.yaml of your agent: https://step.dev/knowledgebase/30/plugins/jira-xray/ Tue, 18 Oct 2022 10:24:01 +0100 https://step.dev/knowledgebase/30/plugins/jira-xray/ Starting with version 20, Step Enterprise Edition provides support for integration with the popular Xray Test Management plugin for Jira. Both the Cloud and the Server edition of Xray are supported. Installation and Configuration In order for Step to integrate with Jira and Xray, the systems will need to communicate with each other. The requirements differ between the editions of Xray, so please follow the steps for the Xray edition you want to integrate with. https://step.dev/knowledgebase/30/plugins/analytics-integrations/metrics-logger/ Wed, 17 Mar 2021 14:24:01 +0100 https://step.dev/knowledgebase/30/plugins/analytics-integrations/metrics-logger/ The Metrics Logger plugin writes Step measurements and metrics to structured log files using Logback. The log format is compatible with Splunk and other log aggregation tools. Enabling the plugin The plugin is disabled by default and must be explicitly enabled in step.properties: plugins.MetricsLoggerControllerPlugin.enabled=true Log configuration Log output is controlled by the CONTROLLER_DIR/bin/logback.xml file. The default configuration writes to a rolling file: <appender name="MEASUREMENTS" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>../log/measurement-logger.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> <fileNamePattern>../log/measurement-logger-%i.log</fileNamePattern> <minIndex>1</minIndex> <maxIndex>2</maxIndex> </rollingPolicy> <triggeringPolicy class="ch. https://step.dev/knowledgebase/30/plugins/hp_alm/ Wed, 10 Apr 2019 14:24:01 +0100 https://step.dev/knowledgebase/30/plugins/hp_alm/ The Micro Focus ALM integration plugin provides an out-of-the-box integration of Step with ALM. With the ALM integration plugin you create, design and manage your automated test cases in ALM, run them on step’s Execution Engine, and evaluate the run results and test reports at the same place in ALM. This plugins is therefore the perfect solution for users requiring the best of the 2 worlds: the unique power of the Step Execution Engine with the test management and reporting features of ALM. https://step.dev/knowledgebase/30/plugins/azuredevops/ Wed, 10 Apr 2019 14:24:01 +0100 https://step.dev/knowledgebase/30/plugins/azuredevops/ The Azure DevOps integration plugin provides an out-of-the-box integration of Step with the Azure Test Plans module of Azure DevOps. With the Azure DevOps plugin you create, design and manage your automated test cases in Azure Test Plans, run them on Step’s Execution Engine, and evaluate the run results and test reports at the same place in Azure Test Plans. This plugins is therefore the perfect solution for users requiring the best of the 2 worlds: the unique power of the Step Execution Engine with the test management and reporting features of Azure Test Plans. https://step.dev/knowledgebase/30/plugins/async-event/ Wed, 10 Apr 2019 14:24:01 +0100 https://step.dev/knowledgebase/30/plugins/async-event/ Async and event-driven functionality is implemented in Step in the form of what we called the Event Broker, a central component allowing developers and plan users to manage the transmission of events, as well as a series of controls and built-in keywords. Event Broker overview The basic semantics and the different means to access the broker are illustrated on the following figure: The private members of the Event are as follows. https://step.dev/knowledgebase/30/plugins/jmeter/ Wed, 10 Apr 2019 14:24:01 +0100 https://step.dev/knowledgebase/30/plugins/jmeter/ The JMeter integration plugin allows you to integrate existing JMeter tests into Step as Keywords, which can then be used in Plans like any other Keyword. This means that you can use existing JMeter tests for massively parallel load test executions (distributed across multiple Agents), synthetic monitoring or any other disciple supported by Step. It supports following features: Passing of Keyword inputs to JMeter Passing of Parameters (properties) to JMeter Automatic generation of performance measurements based on the JMeter samples Attachment of the JMeter logs Installation On-premises installation The JMeter plugin is provided by default with Step Open source and Step Enterprise, but JMeter needs to be downloaded separately on the controller and the following option should be modified accordingly in the step. https://step.dev/knowledgebase/30/plugins/soapui/ Wed, 10 Apr 2019 14:24:01 +0100 https://step.dev/knowledgebase/30/plugins/soapui/ The SoapUI plugin allows you to execute parametrized test cases on Step Java agents. Note that an example of a SoapUI project is available in our samples repository available on github. Installation In order to use the SoapUI plugin, you have to point the controller to your SoapUI installation. Note that the controller will automatically send to the agent the jar files needed from SoapUI. This configuration is done by adding the following property to your step. https://step.dev/knowledgebase/30/plugins/pdfcompare/ Wed, 10 Apr 2019 14:24:01 +0100 https://step.dev/knowledgebase/30/plugins/pdfcompare/ Step’s PDF and Image compare plugins allow users to respectively validate the exactness of a rendered PDF or image file (called actual) when compared against a model (called expected document). As the PDF default comparison is an image-based comparison of every page of the actual document against that of the expected document, and as image types with multiple pages (such as tiff) are supported, both plugins work in a very similar manner. https://step.dev/knowledgebase/30/plugins/maven-plugins/ Wed, 29 Mar 2023 08:00:00 +0000 https://step.dev/knowledgebase/30/plugins/maven-plugins/ The documentation of the Maven plugins was moved to the DevOps section and is available here. https://step.dev/knowledgebase/30/plugins/artifact-repository-connector/ Wed, 14 Oct 2020 08:00:00 +0000 https://step.dev/knowledgebase/30/plugins/artifact-repository-connector/ Description The artifact repository connector for Automation Packages provides a seamless integration with classical artifact repositories like Nexus. It enables the retrieval and execution of Automation Packages that are deployed on artifact repositories. The main use-case of this plugin is the integration with CI/CD pipelines. A common workflow relying on this feature looks as follows: Development of Step Automation Packages along with the source code of the application to be tested Build of the Automation Packages as part of the CI pipeline and deployment of the Automation Packages to an artifact repository Trigger of the central execution of the Automation Packages on a Step Controller by the CI pipeline via artifact repository plugin Usage The artifact repository connector works like any other repository plugin like ALM, Jira, etc. https://step.dev/knowledgebase/30/admindocs/role-management/ Mon, 17 Oct 2022 14:25:01 +0100 https://step.dev/knowledgebase/30/admindocs/role-management/ General concepts Every Step user is assigned a main role upon creation. With the default configuration of roles and rights, only users with the admin role can access Step projects without any further action. Users with other roles need to be added as members of specific projects; for each project membership, a specific role is defined. Role management is only available in the Enterprise Edition of Step. Pre-populated Roles Role Definition guest grants read-only access while preventing modifications or executions tester grants most privileges required to define and execute test plans developer in addition to tester rights, grants the ability to define keywords and administer individual projects admin grants all privileges Default access matrix By default, the following mapping of roles and rights is provided. https://step.dev/knowledgebase/30/plugins/analytics-integrations/ Wed, 17 Mar 2021 14:24:01 +0100 https://step.dev/knowledgebase/30/plugins/analytics-integrations/ Step records measurements and metrics for every execution and makes them available through its built-in analytics stack. For organizations that want to feed this data into their own monitoring stack such as Grafana, Splunk, or a custom SQL database, we provide a set of enterprise plugins that export data to external systems in real time. The following integrations are available: Integration Plugin class name Data written Enabled by default JDBC (SQL) JdbcMeasurementControllerPlugin Measurements No Prometheus PrometheusControllerPlugin Measurements + Metrics Yes Metrics Logger MetricsLoggerControllerPlugin Measurements + Metrics No Data export takes effect for new executions once the plugin is enabled. https://step.dev/knowledgebase/30/admindocs/projectmanagement/ Thu, 05 Dec 2019 14:25:01 +0100 https://step.dev/knowledgebase/30/admindocs/projectmanagement/ Multitenancy and project management helps isolating and managing assets (such as Plans, Keywords, Executions, etc) throughout the application. The main benefits of working with projects is the ability to serve multiple tenants and/or group of users with a single instance of Step facilitating the organization of your work and improving security. Except for administrators, user must be assigned to at least one project to be able to work with step.