Invoke Platform

This is a pre-built Action located within the @Generic Element. The functionality of this action in Avo Assure is to invoke or execute scripts from an external automation platform through a local path or from a connected Bitbucket repository.

Prerequisites

Before using the Invoke Platform action in Avo Assure, ensure the following requirements are fulfilled:

  1. Platform Setup: Ensure the external automation platform must be installed and configured on the system.

  2. Execution File Availability: The launching or executable file (e.g., .bat) for the selected platform must be available and accessible through a valid full file path.

  3. Bitbucket Access (if applicable):

    • A valid Bitbucket repository connection must be configured in Avo Assure if the scripts are stored in Bitbucket.

    • The Repo Path and Branch Name must be correctly specified in the input.

Syntax

Input Value: <Platform Name>;<Launching file full path>;<Repo Path>(Bitbucket);<Branch Name>(Bitbucket)

circle-info

Note:

  • This input specifies the platform to be invoked and the location of the script file. It also allows specifying repository details when using Bitbucket.

  • If Bitbucket is not used, provide only the first two parameters from the syntax.

Argument
Description

<Platform Name> (Required)

Provide the name of the platform from which the script needs to be invoked (e.g., Selenium, Safal, etc.).

<Launching file full path>

(Required)

Provide the complete path of the launching file to be triggered for script execution.

Note: The launch file format must be in .bat format.

<Repo Path> (Optional)

The path of the Bitbucket repository where the script or file is stored. Required only when scripts are fetched from Bitbucket.

<Branch Name> (Optional)

The name of the branch in Bitbucket from which the script is to be executed.

circle-info

Note: While using Bitbucket as the execution platform, make sure the launch file is already uploaded to the Bitbucket repository.

Output Value: N/A

Argument
Description

N/A

Not Applicable

Creating SAFAL CLI Launch File

​The launch file referenced in the Invoke Platform action must contain the commands required to execute the external automation platform.

​Below is an example of a valid .bat file used to run SAFAL automation scripts through the CLI.

Explanation

  • cd C:\Projects\SAFAL Moves to the directory where the SAFAL CLI executable is located.

  • .\SAFAL-Cli.exe Runs the SAFAL CLI executable from the current directory.

  • -scriptName "SAFAL_Testcase_filename.xlsx" Specifies the Excel file that contains the automation scripts to be executed.

  • -resultLocation "C:\Projects\SAFAL\Reports" Defines the folder where the execution reports and logs are stored.-scriptLocation "C:\Projects\SAFAL\Avo_safal_Orchestration\IBS_MOD_SAS\DOIITB\DevEnvironments" Specifies the directory that contains the script file mentioned in the -scriptName parameter.

circle-info

Note:

  • Ensure the executable name includes the .exe extension when calling the CLI.

  • Use .\ before the executable name to run the program from the current directory.

  • Verify that all paths used in the launch file are correct and accessible.

  • The Invoke Platform action does not validate the contents of the launch (.bat) file. If the batch file contains incorrect commands or paths, the internal execution may fail even though Avo Assure reports the step as Pass.

  • It is recommended to test the .bat file independently in the command prompt before using it in Avo Assure.

  • The command in the .bat file depends on the SAFAL setup.

Example 1: Invoking Selenium Script

In this example, we explain how to invoke the Selenium script directly from a local system.

The Invoke Platform action fetches the value from the Input Value column (Selenium;C:\Automation\LaunchFile.bat). The input includes the Platform Name (Selenium) and the Launching file full path (C:\Automation\LaunchFile.bat). This action invokes the Selenium script directly from the local system and executes it through Avo Assure platform.

Example 2: Invoking Safal Scripts Using All Parameters

In this example, we explain how to invoke the Safal scripts including Bitbucket repository details.

The Invoke Platform action takes the value from the Input Value column (Safal;C:\Automation\LaunchFile.bat;https://bitbucket.org/avoautomation/testrepo.git;main). The input includes the Platform Name (Safal), Launching file full path (C:\Automation\LaunchFile.bat), Repo Path (Bitbucket repository URL), and Branch Name (main) and Avo Assure automatically clones the specified Bitbucket repository, fetches the required test scripts, and executes the automation script using all four parameters.

Additional Examples

Here are the examples and report formats for other supported platforms:

Supported Platforms

Input Value (Syntax)

Result

Safal

Safal;C:\Automation\LaunchFile.bat

After execution, the results can be viewed in the HTML report format within the Reports page. You can also download the report in Excel format.

Safal + Bitbucket

Safal;C:\Automation\LaunchFile.bat; https://avoassure [email protected];Mainbranch

After execution, the results can be viewed in the HTML report format within the Reports page. You can also download the report in Excel format for validation.

Cucumber

Cucumber;C:\Automation\LaunchFile.bat

After execution, the results can be viewed in the HTML report format within the Reports page. You can also download the report in HTML format.

Cucumber + Bitbucket

Cucumber;C:\Automation\LaunchFile.bat; https://avoassure [email protected];Mainbranch

After execution, the results can be viewed in the HTML report format within the Reports page. You can also download the report in HTML format.

Karate

Karate;C:\Automation\LaunchFile.bat

After execution, the results can be viewed in the HTML report format within the Reports page. You can also download the report in HTML format.

Karate + Bitbucket

Karate;C:\Automation\LaunchFile.bat; https://avoassure [email protected];Mainbranch

After execution, the results can be viewed in the HTML report format within the Reports page. You can also download the report in HTML format.

Selenium

Selenium;C:\Automation\LaunchFile.bat

After execution, the results can be viewed in the HTML report format within the Reports page. You can also download the report in HTML format.

Selenium + Bitbucket

Selenium;C:\Automation\LaunchFile.bat; https://avoassure [email protected];Mainbranch

After execution, the results can be viewed in the HTML report format within the Reports page. You can also download the report in HTML format.

Last updated